Modifier and Type	Class and Description
public static class	EngineTestKit.Builder `TestEngine` execution builder.

Access	Constructor and Description
private	EngineTestKit()

Method Summary

Modifier and Type	Method and Description
public static EngineDiscoveryResults	Returns: the results of the discovery discover(String the ID of the `TestEngine` to use; must not be `null` or blank engineId, LauncherDiscoveryRequest the `LauncherDiscoveryRequest` to use discoveryRequest) Discover tests for the given `LauncherDiscoveryRequest` using the `TestEngine` with the supplied ID. The `TestEngine` will be loaded via Java's `ServiceLoader` mechanism, analogous to the manner in which test engines are loaded in the JUnit Platform Launcher API.
public static EngineDiscoveryResults	Returns: the recorded `EngineExecutionResults` discover(TestEngine the `TestEngine` to use; must not be `null` testEngine, LauncherDiscoveryRequest the `EngineDiscoveryResults` to use; must not be `null` discoveryRequest) Discover tests for the given `LauncherDiscoveryRequest` using the supplied `TestEngine`.
private static LauncherDiscoveryResult	discoverUsingOrchestrator(TestEngine testEngine, LauncherDiscoveryRequest discoveryRequest)
public static EngineTestKit.Builder	Returns: the engine execution `Builder` engine(String the ID of the `TestEngine` to use; must not be `null` or blank engineId) Create an execution `Builder` for the `TestEngine` with the supplied ID. The `TestEngine` will be loaded via Java's `ServiceLoader` mechanism, analogous to the manner in which test engines are loaded in the JUnit Platform Launcher API.
public static EngineTestKit.Builder	Returns: the engine execution `Builder` engine(TestEngine the `TestEngine` to use; must not be `null` testEngine) Create an execution `Builder` for the supplied `TestEngine`.
public static EngineExecutionResults	Returns: the results of the execution execute(String the ID of the `TestEngine` to use; must not be `null` or blank engineId, LauncherDiscoveryRequest the `LauncherDiscoveryRequest` to use discoveryRequest) Execute tests for the given `LauncherDiscoveryRequest` using the `TestEngine` with the supplied ID. The `TestEngine` will be loaded via Java's `ServiceLoader` mechanism, analogous to the manner in which test engines are loaded in the JUnit Platform Launcher API.
public static EngineExecutionResults	Returns: the recorded `EngineExecutionResults` execute(TestEngine the `TestEngine` to use; must not be `null` testEngine, LauncherDiscoveryRequest the `LauncherDiscoveryRequest` to use; must not be `null` discoveryRequest) Execute tests for the given `LauncherDiscoveryRequest` using the supplied `TestEngine`.
private static void	executeUsingLauncherOrchestration(TestEngine testEngine, LauncherDiscoveryRequest discoveryRequest, EngineExecutionListener listener, CancellationToken cancellationToken)
private static TestEngine	loadTestEngine(String engineId)
private static NamespacedHierarchicalStore<Namespace>	newStore(@Nullable NamespacedHierarchicalStore<Namespace> parentStore)
private static void	withRequestLevelStore(Consumer<NamespacedHierarchicalStore<Namespace>> action)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

EngineTestKit	back to summary
private EngineTestKit()

Method Detail

discover back to summary

discover	back to summary
public static EngineDiscoveryResults discover(String engineId, LauncherDiscoveryRequest discoveryRequest) Discover tests for the given `LauncherDiscoveryRequest` using the `TestEngine` with the supplied ID. The `TestEngine` will be loaded via Java's `ServiceLoader` mechanism, analogous to the manner in which test engines are loaded in the JUnit Platform Launcher API. `org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder` provides a convenient way to build an appropriate discovery request to supply to this method. As an alternative, consider using `engine(TestEngine)` for a more fluent API. Parameters engineId:String the ID of the `TestEngine` to use; must not be `null` or blank discoveryRequest:LauncherDiscoveryRequest the `LauncherDiscoveryRequest` to use Returns:EngineDiscoveryResults the results of the discovery Annotations @API status:EXPERIMENTAL since:6.0 Exceptions PreconditionViolationException: for invalid arguments or if the `TestEngine` with the supplied ID cannot be loaded Since 1.13 See Also `discover(TestEngine, LauncherDiscoveryRequest)`, `engine(String)`, `engine(TestEngine)`

public static EngineDiscoveryResults discover(String engineId, LauncherDiscoveryRequest discoveryRequest)

Discover tests for the given LauncherDiscoveryRequest using the TestEngine with the supplied ID.

The TestEngine will be loaded via Java's ServiceLoader mechanism, analogous to the manner in which test engines are loaded in the JUnit Platform Launcher API.

org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder provides a convenient way to build an appropriate discovery request to supply to this method. As an alternative, consider using engine(TestEngine) for a more fluent API.

Parameters

engineId:String: the ID of the TestEngine to use; must not be null or blank
discoveryRequest:LauncherDiscoveryRequest: the LauncherDiscoveryRequest to use

Returns:EngineDiscoveryResults

the results of the discovery

Annotations

@API
status:EXPERIMENTAL
since:6.0

Exceptions

PreconditionViolationException:: for invalid arguments or if the TestEngine with the supplied ID cannot be loaded

Since

1.13

discover back to summary

discover	back to summary
public static EngineDiscoveryResults discover(TestEngine testEngine, LauncherDiscoveryRequest discoveryRequest) Discover tests for the given `LauncherDiscoveryRequest` using the supplied `TestEngine`. `org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder` provides a convenient way to build an appropriate discovery request to supply to this method. As an alternative, consider using `engine(TestEngine)` for a more fluent API. Parameters testEngine:TestEngine the `TestEngine` to use; must not be `null` discoveryRequest:LauncherDiscoveryRequest the `EngineDiscoveryResults` to use; must not be `null` Returns:EngineDiscoveryResults the recorded `EngineExecutionResults` Annotations @API status:EXPERIMENTAL since:6.0 Exceptions PreconditionViolationException: for invalid arguments Since 1.13 See Also `discover(String, LauncherDiscoveryRequest)`, `engine(String)`, `engine(TestEngine)`

public static EngineDiscoveryResults discover(TestEngine testEngine, LauncherDiscoveryRequest discoveryRequest)

Discover tests for the given LauncherDiscoveryRequest using the supplied TestEngine.

Parameters

testEngine:TestEngine: the TestEngine to use; must not be null
discoveryRequest:LauncherDiscoveryRequest: the EngineDiscoveryResults to use; must not be null

Returns:EngineDiscoveryResults

the recorded EngineExecutionResults

Annotations

@API
status:EXPERIMENTAL
since:6.0

Exceptions

PreconditionViolationException:: for invalid arguments

Since

1.13

discoverUsingOrchestrator	back to summary
private static LauncherDiscoveryResult discoverUsingOrchestrator(TestEngine testEngine, LauncherDiscoveryRequest discoveryRequest)

engine back to summary

engine	back to summary
public static EngineTestKit.Builder engine(String engineId) Create an execution `Builder` for the `TestEngine` with the supplied ID. The `TestEngine` will be loaded via Java's `ServiceLoader` mechanism, analogous to the manner in which test engines are loaded in the JUnit Platform Launcher API. Example Usage EngineTestKit .engine("junit-jupiter") .selectors(selectClass(MyTests.class)) .execute() .testEvents() .assertStatistics(stats -> stats.started(2).finished(2)); Parameters engineId:String the ID of the `TestEngine` to use; must not be `null` or blank Returns:EngineTestKit.Builder the engine execution `Builder` Exceptions PreconditionViolationException: if the supplied ID is `null` or blank, or if the `TestEngine` with the supplied ID cannot be loaded See Also `engine(TestEngine)`, `execute(String, LauncherDiscoveryRequest)`, `execute(TestEngine, LauncherDiscoveryRequest)`

public static EngineTestKit.Builder engine(String engineId)

Create an execution Builder for the TestEngine with the supplied ID.

The TestEngine will be loaded via Java's ServiceLoader mechanism, analogous to the manner in which test engines are loaded in the JUnit Platform Launcher API.

Example Usage

EngineTestKit
    .engine("junit-jupiter")
    .selectors(selectClass(MyTests.class))
    .execute()
    .testEvents()
    .assertStatistics(stats -> stats.started(2).finished(2));

Parameters

engineId:String: the ID of the TestEngine to use; must not be null or blank

Returns:EngineTestKit.Builder

the engine execution Builder

Exceptions

PreconditionViolationException:: if the supplied ID is null or blank, or if the TestEngine with the supplied ID cannot be loaded

engine back to summary

engine	back to summary
public static EngineTestKit.Builder engine(TestEngine testEngine) Create an execution `Builder` for the supplied `TestEngine`. Example Usage EngineTestKit .engine(new MyTestEngine()) .selectors(selectClass(MyTests.class)) .execute() .testEvents() .assertStatistics(stats -> stats.started(2).finished(2)); Parameters testEngine:TestEngine the `TestEngine` to use; must not be `null` Returns:EngineTestKit.Builder the engine execution `Builder` Exceptions PreconditionViolationException: if the `TestEngine` is `null` See Also `engine(String)`, `execute(String, LauncherDiscoveryRequest)`, `execute(TestEngine, LauncherDiscoveryRequest)`

public static EngineTestKit.Builder engine(TestEngine testEngine)

Create an execution Builder for the supplied TestEngine.

Example Usage

EngineTestKit
    .engine(new MyTestEngine())
    .selectors(selectClass(MyTests.class))
    .execute()
    .testEvents()
    .assertStatistics(stats -> stats.started(2).finished(2));

Parameters

testEngine:TestEngine: the TestEngine to use; must not be null

Returns:EngineTestKit.Builder

the engine execution Builder

Exceptions

PreconditionViolationException:: if the TestEngine is null

execute back to summary

execute	back to summary
public static EngineExecutionResults execute(String engineId, LauncherDiscoveryRequest discoveryRequest) Execute tests for the given `LauncherDiscoveryRequest` using the `TestEngine` with the supplied ID. The `TestEngine` will be loaded via Java's `ServiceLoader` mechanism, analogous to the manner in which test engines are loaded in the JUnit Platform Launcher API. `org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder` provides a convenient way to build an appropriate discovery request to supply to this method. As an alternative, consider using `engine(TestEngine)` for a more fluent API. Parameters engineId:String the ID of the `TestEngine` to use; must not be `null` or blank discoveryRequest:LauncherDiscoveryRequest the `LauncherDiscoveryRequest` to use Returns:EngineExecutionResults the results of the execution Exceptions PreconditionViolationException: for invalid arguments or if the `TestEngine` with the supplied ID cannot be loaded Since 1.7 See Also `execute(TestEngine, LauncherDiscoveryRequest)`, `engine(String)`, `engine(TestEngine)`

public static EngineExecutionResults execute(String engineId, LauncherDiscoveryRequest discoveryRequest)

Execute tests for the given LauncherDiscoveryRequest using the TestEngine with the supplied ID.

The TestEngine will be loaded via Java's ServiceLoader mechanism, analogous to the manner in which test engines are loaded in the JUnit Platform Launcher API.

Parameters

engineId:String: the ID of the TestEngine to use; must not be null or blank
discoveryRequest:LauncherDiscoveryRequest: the LauncherDiscoveryRequest to use

Returns:EngineExecutionResults

the results of the execution

Exceptions

PreconditionViolationException:: for invalid arguments or if the TestEngine with the supplied ID cannot be loaded

Since

1.7

execute back to summary

execute	back to summary
public static EngineExecutionResults execute(TestEngine testEngine, LauncherDiscoveryRequest discoveryRequest) Execute tests for the given `LauncherDiscoveryRequest` using the supplied `TestEngine`. `org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder` provides a convenient way to build an appropriate discovery request to supply to this method. As an alternative, consider using `engine(TestEngine)` for a more fluent API. Parameters testEngine:TestEngine the `TestEngine` to use; must not be `null` discoveryRequest:LauncherDiscoveryRequest the `LauncherDiscoveryRequest` to use; must not be `null` Returns:EngineExecutionResults the recorded `EngineExecutionResults` Exceptions PreconditionViolationException: for invalid arguments Since 1.7 See Also `execute(String, LauncherDiscoveryRequest)`, `engine(String)`, `engine(TestEngine)`

public static EngineExecutionResults execute(TestEngine testEngine, LauncherDiscoveryRequest discoveryRequest)

Execute tests for the given LauncherDiscoveryRequest using the supplied TestEngine.

Parameters

testEngine:TestEngine: the TestEngine to use; must not be null
discoveryRequest:LauncherDiscoveryRequest: the LauncherDiscoveryRequest to use; must not be null

Returns:EngineExecutionResults

the recorded EngineExecutionResults

Exceptions

PreconditionViolationException:: for invalid arguments

Since

1.7

executeUsingLauncherOrchestration	back to summary
private static void executeUsingLauncherOrchestration(TestEngine testEngine, LauncherDiscoveryRequest discoveryRequest, EngineExecutionListener listener, CancellationToken cancellationToken)

loadTestEngine	back to summary
private static TestEngine loadTestEngine(String engineId) Annotations @SuppressWarnings:unchecked

newStore	back to summary
private static NamespacedHierarchicalStore<Namespace> newStore(@Nullable NamespacedHierarchicalStore<Namespace> parentStore)

withRequestLevelStore	back to summary
private static void withRequestLevelStore(Consumer<NamespacedHierarchicalStore<Namespace>> action)

org.junit.platform.testkit.engine back to summary

public final Class EngineTestKit.Builder

Class Inheritance

extends Object

java.lang.Object
org.junit.platform.testkit.engine.EngineTestKit.Builder

TestEngine execution builder.

See EngineTestKit#engine(String) and EngineTestKit#engine(TestEngine) for example usage.

Since: 1.4
See Also: selectors(DiscoverySelector...), filters(Filter...), configurationParameter(String, String), configurationParameters(Map), execute()

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	EngineTestKit.Builder.DisabledOutputDirectoryCreator

Field Summary

Modifier and Type	Field and Description
private @Nullable CancellationToken	cancellationToken
private final LauncherDiscoveryRequestBuilder	requestBuilder
private final TestEngine	testEngine

Constructor Summary

Access	Constructor and Description
private	Builder(TestEngine testEngine)

Method Summary

Modifier and Type	Method and Description
public EngineTestKit.Builder	Returns: this builder for method chaining cancellationToken(CancellationToken the cancellation token to use; never `null` cancellationToken) Set the `CancellationToken` to use for execution.
public EngineTestKit.Builder	Returns: this builder for method chaining configurationParameter(String the configuration parameter key under which to store the value; never `null` or blank key, String the value to store value) Add the supplied configuration parameter.
public EngineTestKit.Builder	Returns: this builder for method chaining configurationParameters(Map<String, String> the map of configuration parameters to add; never `null` configurationParameters) Add all of the supplied configuration parameters.
public EngineDiscoveryResults	Returns: the recorded `EngineDiscoveryResults` discover() Discover tests for the configured `TestEngine`, discovery selectors, discovery filters, and configuration parameters.
public EngineTestKit.Builder	enableImplicitConfigurationParameters(boolean enabled) Configure whether implicit configuration parameters should be considered.
public EngineExecutionResults	Returns: the recorded `EngineExecutionResults` execute() Execute tests for the configured `TestEngine`, discovery selectors, discovery filters, and configuration parameters.
public EngineTestKit.Builder	Returns: this builder for method chaining filters(Filter<?>... the filters to add; never `null` filters) Add all of the supplied filters.
public EngineTestKit.Builder	Returns: this builder for method chaining outputDirectoryCreator(OutputDirectoryCreator the output directory creator to use; never `null` outputDirectoryCreator) Set the `OutputDirectoryCreator` to use.
public EngineTestKit.Builder	Returns: this builder for method chaining outputDirectoryProvider(OutputDirectoryProvider the output directory provider to use; never `null` outputDirectoryProvider) Deprecated for removal since 1.14. Please use `outputDirectoryCreator(OutputDirectoryCreator)` instead Set the `org.junit.platform.engine.reporting.OutputDirectoryProvider` to use.
public EngineTestKit.Builder	Returns: this builder for method chaining selectors(DiscoverySelector... the discovery selectors to add; never `null` selectors) Add all of the supplied discovery selectors.
public EngineTestKit.Builder	Returns: this builder for method chaining selectors(List<? extends DiscoverySelector> the discovery selectors to add; never `null` selectors) Add all of the supplied discovery selectors.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cancellationToken	back to summary
private @Nullable CancellationToken cancellationToken

requestBuilder	back to summary
private final LauncherDiscoveryRequestBuilder requestBuilder

testEngine	back to summary
private final TestEngine testEngine

Constructor Detail

Builder	back to summary
private Builder(TestEngine testEngine)

Method Detail

cancellationToken back to summary

cancellationToken	back to summary
public EngineTestKit.Builder cancellationToken(CancellationToken cancellationToken) Set the `CancellationToken` to use for execution. Parameters cancellationToken:CancellationToken the cancellation token to use; never `null` Returns:EngineTestKit.Builder this builder for method chaining Annotations @API status:EXPERIMENTAL since:6.0 Since 6.0 See Also `CancellationToken`

public EngineTestKit.Builder cancellationToken(CancellationToken cancellationToken)

Set the CancellationToken to use for execution.

Parameters

cancellationToken:CancellationToken: the cancellation token to use; never null

Returns:EngineTestKit.Builder

this builder for method chaining

Annotations

@API
status:EXPERIMENTAL
since:6.0

Since

6.0

See Also

CancellationToken

configurationParameter back to summary

configurationParameter	back to summary
public EngineTestKit.Builder configurationParameter(String key, String value) Add the supplied configuration parameter. Parameters key:String the configuration parameter key under which to store the value; never `null` or blank value:String the value to store Returns:EngineTestKit.Builder this builder for method chaining See Also `selectors(DiscoverySelector...)`, `filters(Filter...)`, `configurationParameters(Map)`, `execute()`, `org.junit.platform.engine.ConfigurationParameters`

public EngineTestKit.Builder configurationParameter(String key, String value)

Add the supplied configuration parameter.

Parameters

key:String: the configuration parameter key under which to store the value; never null or blank
value:String: the value to store

Returns:EngineTestKit.Builder

this builder for method chaining

configurationParameters back to summary

configurationParameters	back to summary
public EngineTestKit.Builder configurationParameters(Map<String, String> configurationParameters) Add all of the supplied configuration parameters. Parameters configurationParameters:Map<String, String> the map of configuration parameters to add; never `null` Returns:EngineTestKit.Builder this builder for method chaining See Also `selectors(DiscoverySelector...)`, `filters(Filter...)`, `configurationParameter(String, String)`, `execute()`, `org.junit.platform.engine.ConfigurationParameters`

public EngineTestKit.Builder configurationParameters(Map<String, String> configurationParameters)

Add all of the supplied configuration parameters.

Parameters

configurationParameters:Map<String, String>: the map of configuration parameters to add; never null

Returns:EngineTestKit.Builder

this builder for method chaining

discover back to summary

discover	back to summary
public EngineDiscoveryResults discover() Discover tests for the configured `TestEngine`, discovery selectors, discovery filters, and configuration parameters. Returns:EngineDiscoveryResults the recorded `EngineDiscoveryResults` Annotations @API status:EXPERIMENTAL since:6.0 Since 1.13 See Also `selectors(DiscoverySelector...)`, `filters(Filter...)`, `configurationParameter(String, String)`, `configurationParameters(Map)`

public EngineDiscoveryResults discover()

Discover tests for the configured TestEngine, discovery selectors, discovery filters, and configuration parameters.

Returns:EngineDiscoveryResults

the recorded EngineDiscoveryResults

Annotations

@API
status:EXPERIMENTAL
since:6.0

Since

1.13

enableImplicitConfigurationParameters back to summary

enableImplicitConfigurationParameters	back to summary
public EngineTestKit.Builder enableImplicitConfigurationParameters(boolean enabled) Configure whether implicit configuration parameters should be considered. By default, only configuration parameters that are passed explicitly to this builder are taken into account. Passing `true` to this method, enables additionally reading configuration parameters from implicit sources, i.e. system properties and the `junit-platform.properties` classpath resource. Annotations @API status:STABLE since:1.10 See Also `configurationParameter(String, String)`, `configurationParameters(Map)`

public EngineTestKit.Builder enableImplicitConfigurationParameters(boolean enabled)

Configure whether implicit configuration parameters should be considered.

By default, only configuration parameters that are passed explicitly to this builder are taken into account. Passing true to this method, enables additionally reading configuration parameters from implicit sources, i.e. system properties and the junit-platform.properties classpath resource.

Annotations

@API
status:STABLE
since:1.10

execute back to summary

execute	back to summary
public EngineExecutionResults execute() Execute tests for the configured `TestEngine`, discovery selectors, discovery filters, and configuration parameters. Returns:EngineExecutionResults the recorded `EngineExecutionResults` See Also `selectors(DiscoverySelector...)`, `filters(Filter...)`, `configurationParameter(String, String)`, `configurationParameters(Map)`

public EngineExecutionResults execute()

Execute tests for the configured TestEngine, discovery selectors, discovery filters, and configuration parameters.

Returns:EngineExecutionResults: the recorded EngineExecutionResults
See Also: selectors(DiscoverySelector...), filters(Filter...), configurationParameter(String, String), configurationParameters(Map)

filters back to summary

filters	back to summary
public EngineTestKit.Builder filters(Filter<?>... filters) Add all of the supplied filters. Built-in discovery filters can be created via the static factory methods in `org.junit.platform.engine.discovery.ClassNameFilter` and `org.junit.platform.engine.discovery.PackageNameFilter`. Built-in post-discovery filters can be created via the static factory methods in `org.junit.platform.launcher.TagFilter`. Parameters filters:Filter<?>[] the filters to add; never `null` Returns:EngineTestKit.Builder this builder for method chaining Annotations @API status:STABLE since:1.10 Since 1.7 See Also `selectors(DiscoverySelector...)`, `configurationParameter(String, String)`, `configurationParameters(Map)`, `execute()`

public EngineTestKit.Builder filters(Filter<?>... filters)

Add all of the supplied filters.

Built-in discovery filters can be created via the static factory methods in org.junit.platform.engine.discovery.ClassNameFilter and org.junit.platform.engine.discovery.PackageNameFilter.

Built-in post-discovery filters can be created via the static factory methods in org.junit.platform.launcher.TagFilter.

Parameters

filters:Filter<?>[]: the filters to add; never null

Returns:EngineTestKit.Builder

this builder for method chaining

Annotations

@API
status:STABLE
since:1.10

Since

1.7

outputDirectoryCreator back to summary

outputDirectoryCreator	back to summary
public EngineTestKit.Builder outputDirectoryCreator(OutputDirectoryCreator outputDirectoryCreator) Set the `OutputDirectoryCreator` to use. If not specified, a default implementation will be used that throws an exception when attempting to create output directories. This is done to avoid accidentally writing output files to the file system. Parameters outputDirectoryCreator:OutputDirectoryCreator the output directory creator to use; never `null` Returns:EngineTestKit.Builder this builder for method chaining Annotations @API status:MAINTAINED since:1.14 Since 1.12 See Also `OutputDirectoryCreator`

public EngineTestKit.Builder outputDirectoryCreator(OutputDirectoryCreator outputDirectoryCreator)

Set the OutputDirectoryCreator to use.

If not specified, a default implementation will be used that throws an exception when attempting to create output directories. This is done to avoid accidentally writing output files to the file system.

Parameters

outputDirectoryCreator:OutputDirectoryCreator: the output directory creator to use; never null

Returns:EngineTestKit.Builder

this builder for method chaining

Annotations

@API
status:MAINTAINED
since:1.14

Since

1.12

See Also

OutputDirectoryCreator

outputDirectoryProvider back to summary

outputDirectoryProvider	back to summary
public EngineTestKit.Builder outputDirectoryProvider(OutputDirectoryProvider outputDirectoryProvider) Deprecated for removal since 1.14. Please use `outputDirectoryCreator(OutputDirectoryCreator)` instead Set the `org.junit.platform.engine.reporting.OutputDirectoryProvider` to use. If not specified, a default provider will be used that throws an exception when attempting to create output directories. This is done to avoid accidentally writing output files to the file system. Parameters outputDirectoryProvider:OutputDirectoryProvider the output directory provider to use; never `null` Returns:EngineTestKit.Builder this builder for method chaining Annotations @SuppressWarnings:removal @Deprecated since:1.14 forRemoval:true @API status:DEPRECATED since:1.14 Since 1.12 See Also `org.junit.platform.engine.reporting.OutputDirectoryProvider`

public EngineTestKit.Builder outputDirectoryProvider(OutputDirectoryProvider outputDirectoryProvider)

Deprecated

for removal since 1.14.

Please use outputDirectoryCreator(OutputDirectoryCreator) instead

Set the org.junit.platform.engine.reporting.OutputDirectoryProvider to use.

If not specified, a default provider will be used that throws an exception when attempting to create output directories. This is done to avoid accidentally writing output files to the file system.

Parameters

outputDirectoryProvider:OutputDirectoryProvider: the output directory provider to use; never null

Returns:EngineTestKit.Builder

this builder for method chaining

Annotations

@SuppressWarnings:removal
@Deprecated
since:1.14
forRemoval:true
@API
status:DEPRECATED
since:1.14

Since

1.12

selectors back to summary

selectors	back to summary
public EngineTestKit.Builder selectors(DiscoverySelector... selectors) Add all of the supplied discovery selectors. Built-in discovery selectors can be created via the static factory methods in `org.junit.platform.engine.discovery.DiscoverySelectors`. Parameters selectors:DiscoverySelector[] the discovery selectors to add; never `null` Returns:EngineTestKit.Builder this builder for method chaining See Also `selectors(List)`, `filters(Filter...)`, `configurationParameter(String, String)`, `configurationParameters(Map)`, `execute()`

public EngineTestKit.Builder selectors(DiscoverySelector... selectors)

Add all of the supplied discovery selectors.

Built-in discovery selectors can be created via the static factory methods in org.junit.platform.engine.discovery.DiscoverySelectors.

Parameters

selectors:DiscoverySelector[]: the discovery selectors to add; never null

Returns:EngineTestKit.Builder

this builder for method chaining

selectors back to summary

selectors	back to summary
public EngineTestKit.Builder selectors(List<? extends DiscoverySelector> selectors) Add all of the supplied discovery selectors. Built-in discovery selectors can be created via the static factory methods in `org.junit.platform.engine.discovery.DiscoverySelectors`. Parameters selectors:List<? extends DiscoverySelector> the discovery selectors to add; never `null` Returns:EngineTestKit.Builder this builder for method chaining Annotations @API status:MAINTAINED since:6.0 Since 6.0 See Also `selectors(DiscoverySelector...)`, `filters(Filter...)`, `configurationParameter(String, String)`, `configurationParameters(Map)`, `execute()`

public EngineTestKit.Builder selectors(List<? extends DiscoverySelector> selectors)

Add all of the supplied discovery selectors.

Built-in discovery selectors can be created via the static factory methods in org.junit.platform.engine.discovery.DiscoverySelectors.

Parameters

selectors:List<? extends DiscoverySelector>: the discovery selectors to add; never null

Returns:EngineTestKit.Builder

this builder for method chaining

Annotations

@API
status:MAINTAINED
since:6.0

Since

6.0

org.junit.platform.testkit.engine back to summary

private Class EngineTestKit.Builder.DisabledOutputDirectoryCreator

Class Inheritance

extends Object
implements OutputDirectoryCreator

java.lang.Object
org.junit.platform.testkit.engine.EngineTestKit.Builder.DisabledOutputDirectoryCreator

All Implemented Interfaces

org.junit.platform.engine.OutputDirectoryCreator

Field Summary

Modifier and Type	Field and Description
private static final String	FAILURE_MESSAGE
private static final OutputDirectoryCreator	INSTANCE

Constructor Summary

Access	Constructor and Description
private	DisabledOutputDirectoryCreator()

Method Summary

Modifier and Type	Method and Description
public Path	createOutputDirectory(TestDescriptor testDescriptor) Implements org.junit.platform.engine.OutputDirectoryCreator.createOutputDirectory. Create an output directory for the supplied test descriptor.
public Path	getRootDirectory() Implements org.junit.platform.engine.OutputDirectoryCreator.getRootDirectory. Returns the root directory for all output files; never `null`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

FAILURE_MESSAGE	back to summary
private static final String FAILURE_MESSAGE

INSTANCE	back to summary
private static final OutputDirectoryCreator INSTANCE

Constructor Detail

DisabledOutputDirectoryCreator	back to summary
private DisabledOutputDirectoryCreator()

Method Detail

createOutputDirectory	back to summary
public Path createOutputDirectory(TestDescriptor testDescriptor) Implements org.junit.platform.engine.OutputDirectoryCreator.createOutputDirectory. Doc from org.junit.platform.engine.OutputDirectoryCreator.createOutputDirectory. Create an output directory for the supplied test descriptor. Annotations @Override

createOutputDirectory

back to summary

public Path createOutputDirectory(TestDescriptor testDescriptor)

Implements org.junit.platform.engine.OutputDirectoryCreator.createOutputDirectory.

Doc from org.junit.platform.engine.OutputDirectoryCreator.createOutputDirectory.

Create an output directory for the supplied test descriptor.

Annotations

@Override

getRootDirectory back to summary

getRootDirectory	back to summary
public Path getRootDirectory() Implements org.junit.platform.engine.OutputDirectoryCreator.getRootDirectory. Doc from org.junit.platform.engine.OutputDirectoryCreator.getRootDirectory. Returns the root directory for all output files; never `null`. Annotations @Override

public Path getRootDirectory()

Implements org.junit.platform.engine.OutputDirectoryCreator.getRootDirectory.

Doc from org.junit.platform.engine.OutputDirectoryCreator.getRootDirectory.

Returns the root directory for all output files; never null.

Annotations

@Override