Package org.junit.platform.engine

Class ExecutionRequest

java.lang.Object

org.junit.platform.engine.ExecutionRequest

@API(status=STABLE,
     since="1.0")
public class ExecutionRequest
extends java.lang.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

Field Summary

Fields

Modifier and Type	Field	Description
private ConfigurationParameters	configurationParameters
private EngineExecutionListener	engineExecutionListener
private OutputDirectoryCreator	outputDirectoryCreator
private NamespacedHierarchicalStore<Namespace>	requestLevelStore
private TestDescriptor	rootTestDescriptor

Constructor Summary

Constructors

Modifier	Constructor	Description
	ExecutionRequest(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters)	Deprecated. without replacement because it's an internal API.
private	ExecutionRequest(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters, OutputDirectoryCreator outputDirectoryCreator, NamespacedHierarchicalStore<Namespace> requestLevelStore)

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)	Factory for creating an execution request.
ConfigurationParameters	getConfigurationParameters()	{@return the {@link ConfigurationParameters} that the engine may use to influence test execution}
EngineExecutionListener	getEngineExecutionListener()	{@return the {@link EngineExecutionListener} to be notified of test execution events}
OutputDirectoryCreator	getOutputDirectoryCreator()	{@return the {@link OutputDirectoryCreator} for this request for writing reports and other output files}
OutputDirectoryProvider	getOutputDirectoryProvider()	Deprecated. Please use getOutputDirectoryCreator() instead
TestDescriptor	getRootTestDescriptor()	{@return the root {@link TestDescriptor} of the engine that processes this request}
NamespacedHierarchicalStore<Namespace>	getStore()	{@return the {@link 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

Field Detail

rootTestDescriptor

private final TestDescriptor rootTestDescriptor

engineExecutionListener

private final EngineExecutionListener engineExecutionListener

configurationParameters

private final ConfigurationParameters configurationParameters

outputDirectoryCreator

private final OutputDirectoryCreator outputDirectoryCreator

requestLevelStore

private final NamespacedHierarchicalStore<Namespace> requestLevelStore

Constructor Detail

ExecutionRequest

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

Deprecated.

without replacement because it's an internal API.

ExecutionRequest

private ExecutionRequest(TestDescriptor rootTestDescriptor,
                         EngineExecutionListener engineExecutionListener,
                         ConfigurationParameters configurationParameters,
                         OutputDirectoryCreator outputDirectoryCreator,
                         NamespacedHierarchicalStore<Namespace> requestLevelStore)

Method Detail

create

@Deprecated
@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="1.13")
public static ExecutionRequest create(TestDescriptor rootTestDescriptor,
                                      EngineExecutionListener engineExecutionListener,
                                      ConfigurationParameters configurationParameters,
                                      OutputDirectoryCreator outputDirectoryCreator,
                                      NamespacedHierarchicalStore<Namespace> requestLevelStore)

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:

1.13

getRootTestDescriptor

public TestDescriptor getRootTestDescriptor()

{@return the root {@link TestDescriptor} of the engine that processes this request}

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

getEngineExecutionListener

public EngineExecutionListener getEngineExecutionListener()

{@return the {@link EngineExecutionListener} to be notified of test execution events}

getConfigurationParameters

public ConfigurationParameters getConfigurationParameters()

{@return the {@link ConfigurationParameters} that the engine may use to influence test execution}

getOutputDirectoryProvider

@Deprecated
@API(status=DEPRECATED,
     since="1.14")
public OutputDirectoryProvider getOutputDirectoryProvider()

Deprecated.

Please use getOutputDirectoryCreator() instead

{@return the {@link org.junit.platform.engine.reporting.OutputDirectoryProvider} for this request for writing reports and other output files}

Throws:

org.junit.platform.commons.PreconditionViolationException - if the output directory provider is not available

Since:

1.12

getOutputDirectoryCreator

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

{@return the {@link OutputDirectoryCreator} for this request for writing reports and other output files}

Throws:

org.junit.platform.commons.PreconditionViolationException - if the output directory creator is not available

Since:

1.14

getStore

@API(status=MAINTAINED,
     since="1.13.3")
public NamespacedHierarchicalStore<Namespace> getStore()

{@return the {@link 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.

Since:

1.13

See Also:

NamespacedHierarchicalStore