Module org.junit.platform.suite.engine

Package org.junit.platform.suite.engine

Class SuiteTestEngine

java.lang.Object

org.junit.platform.suite.engine.SuiteTestEngine

All Implemented Interfaces:

TestEngine

@API(status=INTERNAL,
     since="5.8")
public final class SuiteTestEngine
extends Object
implements TestEngine

The JUnit Platform Suite TestEngine.

Since:

5.8

Constructor Summary

Constructors

Constructor	Description
SuiteTestEngine()

Method Summary

Modifier and Type	Method	Description
TestDescriptor	discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId)	Discover tests according to the supplied EngineDiscoveryRequest.
void	execute(ExecutionRequest request)	Execute tests according to the supplied ExecutionRequest.
Optional<String>	getArtifactId()	Returns junit-platform-suite-engine as the artifact ID.
Optional<String>	getGroupId()	Returns org.junit.platform as the group ID.
String	getId()	Get the ID that uniquely identifies this test engine.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.junit.platform.engine.TestEngine

getVersion

Constructor Details

SuiteTestEngine

public SuiteTestEngine()

Method Details

getId

public String getId()

Description copied from interface: TestEngine

Get the ID that uniquely identifies this test engine.

Each test engine must provide a unique ID. For example, JUnit Vintage and JUnit Jupiter use "junit-vintage" and "junit-jupiter", respectively. When in doubt, you may use the fully qualified name of your custom TestEngine implementation class.

Specified by:

getId in interface TestEngine

getGroupId

public Optional<String> getGroupId()

Returns org.junit.platform as the group ID.

Specified by:

getGroupId in interface TestEngine

Returns:

an Optional containing the group ID; never null but potentially empty if the group ID is unknown

See Also:

TestEngine.getArtifactId(), TestEngine.getVersion()

getArtifactId

public Optional<String> getArtifactId()

Returns junit-platform-suite-engine as the artifact ID.

Specified by:

getArtifactId in interface TestEngine

Returns:

an Optional containing the artifact ID; never null but potentially empty if the artifact ID is unknown

See Also:

Class.getPackage(), Package.getImplementationTitle(), TestEngine.getGroupId(), TestEngine.getVersion()

discover

public TestDescriptor discover(EngineDiscoveryRequest discoveryRequest,
UniqueId uniqueId)

Description copied from interface: TestEngine

Discover tests according to the supplied EngineDiscoveryRequest.

The supplied UniqueId must be used as the unique ID of the returned root TestDescriptor. In addition, the UniqueId must be used to create unique IDs for children of the root's descriptor by calling UniqueId.append(java.lang.String, java.lang.String).

Specified by:

discover in interface TestEngine

Parameters:

discoveryRequest - the discovery request; never null

uniqueId - the unique ID to be used for this test engine's TestDescriptor; never null

Returns:

the root TestDescriptor of this engine, typically an instance of EngineDescriptor

See Also:

EngineDescriptor

execute

public void execute(ExecutionRequest request)

Description copied from interface: TestEngine

Execute tests according to the supplied ExecutionRequest.

The request passed to this method contains the root TestDescriptor that was previously returned by TestEngine.discover(org.junit.platform.engine.EngineDiscoveryRequest, org.junit.platform.engine.UniqueId), the EngineExecutionListener to be notified of test execution events, and ConfigurationParameters that may influence test execution.

Specified by:

execute in interface TestEngine

Parameters:

request - the request to execute tests for; never null