JUnit 6.0.1 · org.junit.platform.engine.TestEngine · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public TestDescriptor	Returns: the root `TestDescriptor` of this engine, typically an instance of `EngineDescriptor` discover(EngineDiscoveryRequest the discovery request; never `null` discoveryRequest, UniqueId the unique ID to be used for this test engine's `TestDescriptor`; never `null` uniqueId) Discover tests according to the supplied `EngineDiscoveryRequest`.
public void	execute(ExecutionRequest the request to execute tests for; never `null` request) Execute tests according to the supplied `ExecutionRequest`.
public default Optional<String>	Returns: an `Optional` containing the module name or artifact ID; never `null` but potentially empty if neither the module name nor the artifact ID can be determined getArtifactId() Get the Module Name or Artifact ID of the JAR in which this test engine is packaged.
public default Optional<String>	Returns: an `Optional` containing the group ID; never `null` but potentially empty if the group ID is unknown getGroupId() Get the Group ID of the JAR in which this test engine is packaged.
public String	Returns: the ID of this test engine; never `null` or blank getId() Get the ID that uniquely identifies this test engine.
public default Optional<String>	Returns: an `Optional` containing the version; never `null` but potentially empty if the version is unknown getVersion() Get the version of this test engine.

Method Detail

discover back to summary

discover	back to summary
public TestDescriptor discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) 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`. Furthermore, implementations must publish events about test discovery via the supplied `EngineDiscoveryListener`. Parameters discoveryRequest:EngineDiscoveryRequest the discovery request; never `null` uniqueId:UniqueId the unique ID to be used for this test engine's `TestDescriptor`; never `null` Returns:TestDescriptor the root `TestDescriptor` of this engine, typically an instance of `EngineDescriptor` See Also `org.junit.platform.engine.support.descriptor.EngineDescriptor`

public TestDescriptor discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId)

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.

Furthermore, implementations must publish events about test discovery via the supplied EngineDiscoveryListener.

Parameters

discoveryRequest:EngineDiscoveryRequest: the discovery request; never null
uniqueId:UniqueId: the unique ID to be used for this test engine's TestDescriptor; never null

Returns:TestDescriptor

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

execute back to summary

execute	back to summary
public void execute(ExecutionRequest request) Execute tests according to the supplied `ExecutionRequest`. The `request` passed to this method contains the root `TestDescriptor` that was previously returned by `discover`, the `EngineExecutionListener` to be notified of test execution events, and `ConfigurationParameters` that may influence test execution. Parameters request:ExecutionRequest the request to execute tests for; never `null`

public void execute(ExecutionRequest request)

Execute tests according to the supplied ExecutionRequest.

The request passed to this method contains the root TestDescriptor that was previously returned by discover, the EngineExecutionListener to be notified of test execution events, and ConfigurationParameters that may influence test execution.

Parameters

request:ExecutionRequest: the request to execute tests for; never null

getArtifactId back to summary

getArtifactId	back to summary
public default Optional<String> getArtifactId() Get the Module Name or Artifact ID of the JAR in which this test engine is packaged. This information is used solely for debugging and reporting purposes. The default implementation first attempts to retrieve the name of the `Module` in which the engine resides. If the module name is not available, the default implementation then attempts to retrieve the artifact ID as explained below. The default implementation assumes the implementation title is equivalent to the artifact ID and therefore attempts to query the implementation title from the package attributes for the `Package` in which the engine resides. Note that a package only has attributes if the information is defined in the `Manifest` of the JAR containing that package, and if the class loader created the `Package` instance with the attributes from the manifest. If the implementation title cannot be queried from the package attributes, the default implementation returns an empty `Optional`. Concrete test engine implementations may override this method in order to determine the artifact ID by some other means. Returns:Optional<String> an `Optional` containing the module name or artifact ID; never `null` but potentially empty if neither the module name nor the artifact ID can be determined See Also `Module#getName()`, `Class#getPackage()`, `Package#getImplementationTitle()`, `getGroupId()`, `getVersion()`

public default Optional<String> getArtifactId()

Get the Module Name or Artifact ID of the JAR in which this test engine is packaged.

This information is used solely for debugging and reporting purposes.

The default implementation first attempts to retrieve the name of the Module in which the engine resides. If the module name is not available, the default implementation then attempts to retrieve the artifact ID as explained below.

The default implementation assumes the implementation title is equivalent to the artifact ID and therefore attempts to query the implementation title from the package attributes for the Package in which the engine resides. Note that a package only has attributes if the information is defined in the Manifest of the JAR containing that package, and if the class loader created the Package instance with the attributes from the manifest.

If the implementation title cannot be queried from the package attributes, the default implementation returns an empty Optional.

Concrete test engine implementations may override this method in order to determine the artifact ID by some other means.

Returns:Optional<String>: an Optional containing the module name or artifact ID; never null but potentially empty if neither the module name nor the artifact ID can be determined
See Also: Module#getName(), Class#getPackage(), Package#getImplementationTitle(), getGroupId(), getVersion()

getGroupId back to summary

getGroupId	back to summary
public default Optional<String> getGroupId() Get the Group ID of the JAR in which this test engine is packaged. This information is used solely for debugging and reporting purposes. The default implementation returns an empty `Optional`, signaling that the group ID is unknown. Concrete test engine implementations may override this method in order to provide a known group ID. Returns:Optional<String> an `Optional` containing the group ID; never `null` but potentially empty if the group ID is unknown See Also `getArtifactId()`, `getVersion()`

public default Optional<String> getGroupId()

Get the Group ID of the JAR in which this test engine is packaged.

This information is used solely for debugging and reporting purposes.

The default implementation returns an empty Optional, signaling that the group ID is unknown.

Concrete test engine implementations may override this method in order to provide a known group ID.

Returns:Optional<String>: an Optional containing the group ID; never null but potentially empty if the group ID is unknown
See Also: getArtifactId(), getVersion()

getId back to summary

getId	back to summary
public String getId() 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. Returns:String the ID of this test engine; never `null` or blank

public String getId()

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.

Returns:String: the ID of this test engine; never null or blank

getVersion back to summary

getVersion	back to summary
public default Optional<String> getVersion() Get the version of this test engine. This information is used solely for debugging and reporting purposes. The default implementation first attempts to retrieve the version from the JAR manifest attribute named `"Engine-Version-" + getId()`. If the manifest attribute is not available, an attempt is made to retrieve the raw version of the `Module` in which the engine resides. If the module version is not available, an attempt is made to query the implementation version from the package attributes for the `Package` in which the engine resides. Note that a package only has attributes if the information is defined in the `Manifest` of the JAR containing that package, and if the class loader created the `Package` instance with the attributes from the manifest. If the implementation version cannot be determined, the default implementation returns `"DEVELOPMENT"`. Concrete test engine implementations may override this method to determine the version by some other means. Returns:Optional<String> an `Optional` containing the version; never `null` but potentially empty if the version is unknown See Also `Class#getPackage()`, `Package#getImplementationVersion()`, `getGroupId()`, `getArtifactId()`

public default Optional<String> getVersion()

Get the version of this test engine.

This information is used solely for debugging and reporting purposes.

The default implementation first attempts to retrieve the version from the JAR manifest attribute named "Engine-Version-" + getId().

If the manifest attribute is not available, an attempt is made to retrieve the raw version of the Module in which the engine resides.

If the module version is not available, an attempt is made to query the implementation version from the package attributes for the Package in which the engine resides. Note that a package only has attributes if the information is defined in the Manifest of the JAR containing that package, and if the class loader created the Package instance with the attributes from the manifest.

If the implementation version cannot be determined, the default implementation returns "DEVELOPMENT".

Concrete test engine implementations may override this method to determine the version by some other means.

Returns:Optional<String>: an Optional containing the version; never null but potentially empty if the version is unknown
See Also: Class#getPackage(), Package#getImplementationVersion(), getGroupId(), getArtifactId()

public Interface TestEngine

Method Summary

Method Detail