Class ExecutionRequest

java.lang.Object

org.junit.platform.engine.ExecutionRequest

@API(status=STABLE,
     since="1.0")
public class ExecutionRequest
extends Object

Provides a single TestEngine access to the information necessary to execute its tests.

A request contains an engine's root TestDescriptor, the EngineExecutionListener to be notified of test execution events, the ConfigurationParameters that the engine may use to influence test execution, and an OutputDirectoryCreator for writing reports and other output files.

Since:

1.0

See Also:

• TestEngine

Constructor Summary

Constructors

Constructor	Description
ExecutionRequest(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters)	Deprecated. without replacement because it's an internal API.

Method Summary

Modifier and Type	Method	Description
static ExecutionRequest	create(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters)	Deprecated. without replacement
static ExecutionRequest	create(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters, OutputDirectoryCreator outputDirectoryCreator, NamespacedHierarchicalStore<Namespace> requestLevelStore, CancellationToken cancellationToken)	Factory for creating an execution request.
CancellationToken	getCancellationToken()	Returns the CancellationToken for this request for engines to check whether they should cancel execution.
ConfigurationParameters	getConfigurationParameters()	Returns the ConfigurationParameters that the engine may use to influence test execution.
EngineExecutionListener	getEngineExecutionListener()	Returns the EngineExecutionListener to be notified of test execution events.
OutputDirectoryCreator	getOutputDirectoryCreator()	Returns the OutputDirectoryCreator for this request for writing reports and other output files.
OutputDirectoryProvider	getOutputDirectoryProvider()	Deprecated, for removal: This API element is subject to removal in a future version. Please use getOutputDirectoryCreator() instead
TestDescriptor	getRootTestDescriptor()	Returns the root TestDescriptor of the engine that processes this request.
NamespacedHierarchicalStore<Namespace>	getStore()	Returns the NamespacedHierarchicalStore for this request for storing request-scoped data.

Methods inherited from class java.lang.Object

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

Constructor Details

ExecutionRequest

@Deprecated(since="1.11")
@API(status=DEPRECATED,
     since="1.11")
public ExecutionRequest(TestDescriptor rootTestDescriptor,
 EngineExecutionListener engineExecutionListener,
 ConfigurationParameters configurationParameters)

Deprecated.

without replacement because it's an internal API.

Method Details

create

@Deprecated(since="1.11")
@API(status=DEPRECATED,
     since="1.11")
public static ExecutionRequest create(TestDescriptor rootTestDescriptor,
 EngineExecutionListener engineExecutionListener,
 ConfigurationParameters configurationParameters)

Deprecated.

without replacement

Factory for creating an execution request.

Parameters:

rootTestDescriptor - the engine's root TestDescriptor

engineExecutionListener - the EngineExecutionListener to be notified of test execution events

configurationParameters - ConfigurationParameters that the engine may use to influence test execution

Returns:

a new ExecutionRequest; never null

Since:

1.9

create

@API(status=INTERNAL,
     since="6.0")
public static ExecutionRequest create(TestDescriptor rootTestDescriptor,
 EngineExecutionListener engineExecutionListener,
 ConfigurationParameters configurationParameters,
 OutputDirectoryCreator outputDirectoryCreator,
 NamespacedHierarchicalStore<Namespace> requestLevelStore,
 CancellationToken cancellationToken)

Factory for creating an execution request.

Parameters:

rootTestDescriptor - the engine's root TestDescriptor; never null

engineExecutionListener - the EngineExecutionListener to be notified of test execution events; never null

configurationParameters - ConfigurationParameters that the engine may use to influence test execution; never null

outputDirectoryCreator - OutputDirectoryCreator for writing reports and other output files; never null

requestLevelStore - NamespacedHierarchicalStore for storing request-scoped data; never null

Returns:

a new ExecutionRequest; never null

Since:

6.0

getRootTestDescriptor

public TestDescriptor getRootTestDescriptor()

Returns the root TestDescriptor of the engine that processes this request.

Note: the root descriptor is the TestDescriptor returned by TestEngine.discover(EngineDiscoveryRequest, UniqueId).

Returns:

the root TestDescriptor of the engine that processes this request

getEngineExecutionListener

public EngineExecutionListener getEngineExecutionListener()

Returns the EngineExecutionListener to be notified of test execution events.

Returns:

the EngineExecutionListener to be notified of test execution events

getConfigurationParameters

public ConfigurationParameters getConfigurationParameters()

Returns the ConfigurationParameters that the engine may use to influence test execution.

Returns:

the ConfigurationParameters that the engine may use to influence test execution

getOutputDirectoryProvider

@Deprecated(since="6.0",
            forRemoval=true)
@API(status=DEPRECATED,
     since="6.0")
public OutputDirectoryProvider getOutputDirectoryProvider()

Deprecated, for removal: This API element is subject to removal in a future version.

Please use getOutputDirectoryCreator() instead

Returns the OutputDirectoryProvider for this request for writing reports and other output files.

Returns:

the OutputDirectoryProvider for this request for writing reports and other output files

Throws:

PreconditionViolationException - if the output directory provider is not available

Since:

1.12

getOutputDirectoryCreator

@API(status=MAINTAINED,
     since="6.0")
public OutputDirectoryCreator getOutputDirectoryCreator()

Returns the OutputDirectoryCreator for this request for writing reports and other output files.

Returns:

the OutputDirectoryCreator for this request for writing reports and other output files

Throws:

PreconditionViolationException - if the output directory creator is not available

Since:

6.0

getStore

@API(status=EXPERIMENTAL,
     since="6.0")
public NamespacedHierarchicalStore<Namespace> getStore()

Returns the NamespacedHierarchicalStore for this request for storing request-scoped data.

All stored values that implement AutoCloseable are notified by invoking their close() methods when this request has been executed.

Returns:

the NamespacedHierarchicalStore for this request for storing request-scoped data

Since:

1.13

See Also:

• NamespacedHierarchicalStore

getCancellationToken

@API(status=EXPERIMENTAL,
     since="6.0")
public CancellationToken getCancellationToken()

Returns the CancellationToken for this request for engines to check whether they should cancel execution.

Returns:

the CancellationToken for this request for engines to check whether they should cancel execution

Since:

6.0

See Also:

• CancellationToken.isCancellationRequested()