Package dev.galasa.framework.spi

Interface IFrameworkRuns

All Known Implementing Classes:

FrameworkRuns

public interface IFrameworkRuns

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IFrameworkRuns.SharedEnvironmentPhase

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()
@NotNull List<IRun>	getActiveRuns()
@NotNull List<IRun>	getAllGroupedRuns(@NotNull String groupName)
@NotNull 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 IRun	submitRun(String type, String requestor, String bundleName, 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)

Method Details

getActiveRuns

@NotNull
@NotNull List<IRun> getActiveRuns()
                           throws FrameworkException

Throws:

FrameworkException

getQueuedRuns

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

Throws:

FrameworkException

getAllRuns

@NotNull
@NotNull List<IRun> getAllRuns()
                        throws FrameworkException

Throws:

FrameworkException

getAllGroupedRuns

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

Throws:

FrameworkException

getActiveRunNames

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

Throws:

FrameworkException

submitRun

@NotNull
@NotNull IRun submitRun(String type,
 String requestor,
 String bundleName,
 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

Throws:

FrameworkException

delete

boolean delete(String runname)
        throws DynamicStatusStoreException

Throws:

DynamicStatusStoreException

getRun

IRun getRun(String runname)
     throws DynamicStatusStoreException

Throws:

DynamicStatusStoreException

reset

boolean reset(String runname)
       throws DynamicStatusStoreException

Throws:

DynamicStatusStoreException

markRunInterrupted

boolean markRunInterrupted(String runName,
 String interruptReason)
                    throws DynamicStatusStoreException

Throws:

DynamicStatusStoreException

clearRunInterrupt

void clearRunInterrupt(String runName)
                throws DynamicStatusStoreException

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

Parameters:

runName - the run to remove interrupt properties for

Throws:

DynamicStatusStoreException - if there was an issue accessing the DSS

markRunFinished

void markRunFinished(String runName,
 String result)
              throws DynamicStatusStoreException

Throws:

DynamicStatusStoreException

markRunCancelling

boolean markRunCancelling(String runName,
 TestRunLifecycleStatus currentStatus)
                   throws DynamicStatusStoreException

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.

Parameters:

runName -

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

addRunRasAction

void addRunRasAction(IRun run,
 RunRasAction rasActionToAdd)
              throws DynamicStatusStoreException

Throws:

DynamicStatusStoreException

getCpsPropertiesAndOverridesUsedByTestRun

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

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.

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