Package dev.galasa.framework

Class FrameworkRuns

java.lang.Object

dev.galasa.framework.FrameworkRuns

All Implemented Interfaces:

IFrameworkRuns

public class FrameworkRuns
extends Object
implements IFrameworkRuns

Nested Class Summary

Nested classes/interfaces inherited from interface dev.galasa.framework.spi.IFrameworkRuns

IFrameworkRuns.SharedEnvironmentPhase

Constructor Summary

Constructors

Constructor	Description
FrameworkRuns(IFramework framework)
FrameworkRuns(IFramework framework, ITimeService timeService)

Method Summary

Modifier and Type	Method	Description
void	addRunRasAction(IRun run, RunRasAction rasActionToAdd)
void	clearRunInterrupt(String runName)	Clears all interrupt-related properties for a run with the given name from the DSS.
boolean	delete(String runname)
@NotNull Set<String>	getActiveRunNames()
List<IRun>	getActiveRuns()
List<IRun>	getAllGroupedRuns(@NotNull String groupName)
List<IRun>	getAllRuns()
Map<String,String>	getCpsPropertiesAndOverridesUsedByTestRun(String runName, List<String> namespaces)	Returns a map of CPS properties and overrides that were used by a test run with the given run name.
@NotNull List<IRun>	getQueuedRuns()
IRun	getRun(String runname)
boolean	markRunCancelling(String runName, TestRunLifecycleStatus currentStatus)	Marks the specified run as finished in the DSS.
void	markRunFinished(String runName, String result)
boolean	markRunInterrupted(String runName, String interruptReason)
boolean	reset(String runName)
@NotNull @NotNull IRun	submitRun(String runType, String requestor, String bundleName, @NotNull String testName, String groupName, String mavenRepository, String obr, String stream, boolean local, boolean trace, Set<String> tags, Properties overrides, IFrameworkRuns.SharedEnvironmentPhase sharedEnvironmentPhase, String sharedEnvironmentRunName, String language, String submissionId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FrameworkRuns

public FrameworkRuns(IFramework framework)
              throws FrameworkException

Throws:

FrameworkException

FrameworkRuns

public FrameworkRuns(IFramework framework,
 ITimeService timeService)
              throws FrameworkException

Throws:

FrameworkException

Method Details

getActiveRuns

@Override
public List<IRun> getActiveRuns()
                         throws FrameworkException

Specified by:

getActiveRuns in interface IFrameworkRuns

Throws:

FrameworkException

getQueuedRuns

@Override
@NotNull
public @NotNull List<IRun> getQueuedRuns()
                                  throws FrameworkException

Specified by:

getQueuedRuns in interface IFrameworkRuns

Throws:

FrameworkException

getAllRuns

@Override
public List<IRun> getAllRuns()
                      throws FrameworkException

Specified by:

getAllRuns in interface IFrameworkRuns

Throws:

FrameworkException

getAllGroupedRuns

@Override
public List<IRun> getAllGroupedRuns(@NotNull
 @NotNull String groupName)
                             throws FrameworkException

Specified by:

getAllGroupedRuns in interface IFrameworkRuns

Throws:

FrameworkException

getActiveRunNames

@Override
@NotNull
public @NotNull Set<String> getActiveRunNames()
                                       throws FrameworkException

Specified by:

getActiveRunNames in interface IFrameworkRuns

Throws:

FrameworkException

submitRun

@Override
@NotNull @NotNull
public @NotNull @NotNull IRun submitRun(String runType,
 String requestor,
 String bundleName,
 @NotNull
 @NotNull String testName,
 String groupName,
 String mavenRepository,
 String obr,
 String stream,
 boolean local,
 boolean trace,
 Set<String> tags,
 Properties overrides,
 IFrameworkRuns.SharedEnvironmentPhase sharedEnvironmentPhase,
 String sharedEnvironmentRunName,
 String language,
 String submissionId)
                                 throws FrameworkException

Specified by:

submitRun in interface IFrameworkRuns

Throws:

FrameworkException

delete

@Override
public boolean delete(String runname)
               throws DynamicStatusStoreException

Specified by:

delete in interface IFrameworkRuns

Throws:

DynamicStatusStoreException

reset

@Override
public boolean reset(String runName)
              throws DynamicStatusStoreException

Specified by:

reset in interface IFrameworkRuns

Throws:

DynamicStatusStoreException

addRunRasAction

@Override
public void addRunRasAction(IRun run,
 RunRasAction rasActionToAdd)
                     throws DynamicStatusStoreException

Specified by:

addRunRasAction in interface IFrameworkRuns

Throws:

DynamicStatusStoreException

markRunInterrupted

@Override
public boolean markRunInterrupted(String runName,
 String interruptReason)
                           throws DynamicStatusStoreException

Specified by:

markRunInterrupted in interface IFrameworkRuns

Throws:

DynamicStatusStoreException

clearRunInterrupt

@Override
public void clearRunInterrupt(String runName)
                       throws DynamicStatusStoreException

Description copied from interface: IFrameworkRuns

Clears all interrupt-related properties for a run with the given name from the DSS.

Specified by:

clearRunInterrupt in interface IFrameworkRuns

Parameters:

runName - the run to remove interrupt properties for

Throws:

DynamicStatusStoreException - if there was an issue accessing the DSS

markRunFinished

@Override
public void markRunFinished(String runName,
 String result)
                     throws DynamicStatusStoreException

Specified by:

markRunFinished in interface IFrameworkRuns

Throws:

DynamicStatusStoreException

markRunCancelling

@Override
public boolean markRunCancelling(String runName,
 TestRunLifecycleStatus currentStatus)
                          throws DynamicStatusStoreException

Description copied from interface: IFrameworkRuns

Marks the specified run as finished in the DSS. Only if the state of the test run is as we expect. Other processes may have moved the status of the test run without us knowing.

Specified by:

markRunCancelling in interface IFrameworkRuns

currentStatus - The current status of the test run, the status we want to change it from

Returns:

True if the test was marked as finished, false if not. For example, someother process marked it as starting or building ahead of us marking it as finished here.

Throws:

DynamicStatusStoreException

getRun

@Override
public IRun getRun(String runname)
            throws DynamicStatusStoreException

Specified by:

getRun in interface IFrameworkRuns

Throws:

DynamicStatusStoreException

getCpsPropertiesAndOverridesUsedByTestRun

@Override
public Map<String,String> getCpsPropertiesAndOverridesUsedByTestRun(String runName,
 List<String> namespaces)
                                                             throws FrameworkException

Description copied from interface: IFrameworkRuns

Returns a map of CPS properties and overrides that were used by a test run with the given run name. The returned map combines the current CPS properties from the given namespaces with the overrides associated with the given test run, so any overrides that were used will take precedence. If no test run with the given run name exists, then the current CPS properties from the provided namespaces will be returned.

Specified by:

getCpsPropertiesAndOverridesUsedByTestRun in interface IFrameworkRuns

Parameters:

runName - the name of the existing test run to get the CPS properties that were used

namespaces - a list of CPS namespaces to get CPS properties from

Returns:

a map of CPS properties combined with any overrides for the given test run

Throws:

FrameworkException - if there was an issue accessing the CPS or the DSS