Class EngineTestKit.Builder

java.lang.Object

org.junit.platform.testkit.engine.EngineTestKit.Builder

Enclosing class:

EngineTestKit

public static final class EngineTestKit.Builder
extends Object

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()

Method Summary

Modifier and Type	Method	Description
EngineTestKit.Builder	configurationParameter(String key, String value)	Add the supplied configuration parameter.
EngineTestKit.Builder	configurationParameters(Map<String,String> configurationParameters)	Add all of the supplied configuration parameters.
EngineDiscoveryResults	discover()	Discover tests for the configured TestEngine, discovery selectors, discovery filters, and configuration parameters.
EngineTestKit.Builder	enableImplicitConfigurationParameters(boolean enabled)	Configure whether implicit configuration parameters should be considered.
EngineExecutionResults	execute()	Execute tests for the configured TestEngine, discovery selectors, discovery filters, and configuration parameters.
EngineTestKit.Builder	filters(Filter<?>... filters)	Add all of the supplied filters.
EngineTestKit.Builder	outputDirectoryProvider(OutputDirectoryProvider outputDirectoryProvider)	Set the OutputDirectoryProvider to use.
EngineTestKit.Builder	selectors(DiscoverySelector... selectors)	Add all of the supplied discovery selectors.

Methods inherited from class java.lang.Object

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

Method Details

selectors

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 DiscoverySelectors.

Parameters:

selectors - the discovery selectors to add; never null

Returns:

this builder for method chaining

See Also:

• filters(Filter...)
• configurationParameter(String, String)
• configurationParameters(Map)
• execute()

filters

@API(status=STABLE,
     since="1.10")
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 ClassNameFilter and PackageNameFilter.

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

Parameters:

filters - the filters to add; never null

Returns:

this builder for method chaining

Since:

1.7

See Also:

• selectors(DiscoverySelector...)
• configurationParameter(String, String)
• configurationParameters(Map)
• execute()

configurationParameter

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

Add the supplied configuration parameter.

Parameters:

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

value - the value to store

Returns:

this builder for method chaining

See Also:

• selectors(DiscoverySelector...)
• filters(Filter...)
• configurationParameters(Map)
• execute()
• ConfigurationParameters

configurationParameters

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

Add all of the supplied configuration parameters.

Parameters:

configurationParameters - the map of configuration parameters to add; never null

Returns:

this builder for method chaining

See Also:

• selectors(DiscoverySelector...)
• filters(Filter...)
• configurationParameter(String, String)
• execute()
• ConfigurationParameters

enableImplicitConfigurationParameters

@API(status=STABLE,
     since="1.10")
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.

See Also:

• configurationParameter(String, String)
• configurationParameters(Map)

outputDirectoryProvider

@API(status=EXPERIMENTAL,
     since="1.12")
public EngineTestKit.Builder outputDirectoryProvider(OutputDirectoryProvider outputDirectoryProvider)

Set the 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 - the output directory provider to use; never null

Returns:

this builder for method chaining

Since:

1.12

See Also:

• OutputDirectoryProvider

discover

@API(status=EXPERIMENTAL,
     since="1.13")
public EngineDiscoveryResults discover()

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

Returns:

the recorded EngineDiscoveryResults

Since:

1.13

See Also:

• selectors(DiscoverySelector...)
• filters(Filter...)
• configurationParameter(String, String)
• configurationParameters(Map)

execute

public EngineExecutionResults execute()

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

Returns:

the recorded EngineExecutionResults

See Also:

• selectors(DiscoverySelector...)
• filters(Filter...)
• configurationParameter(String, String)
• configurationParameters(Map)