org.junit.platform.launcher.core

Class LauncherDiscoveryRequestBuilder

java.lang.Object

org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder

@API(status=STABLE,
     since="1.0")
public final class LauncherDiscoveryRequestBuilder
extends java.lang.Object

The LauncherDiscoveryRequestBuilder provides a light-weight DSL for generating a LauncherDiscoveryRequest.

Example

 import static org.junit.platform.engine.discovery.DiscoverySelectors.*;
 import static org.junit.platform.engine.discovery.ClassNameFilter.*;
 import static org.junit.platform.launcher.EngineFilter.*;
 import static org.junit.platform.launcher.TagFilter.*;

 // ...

   LauncherDiscoveryRequestBuilder.request()
     .selectors(
        selectPackage("org.example.user"),
        selectClass("org.example.payment.PaymentTests"),
        selectClass(ShippingTests.class),
        selectMethod("org.example.order.OrderTests#test1"),
        selectMethod("org.example.order.OrderTests#test2()"),
        selectMethod("org.example.order.OrderTests#test3(java.lang.String)"),
        selectMethod("org.example.order.OrderTests", "test4"),
        selectMethod(OrderTests.class, "test5"),
        selectMethod(OrderTests.class, testMethod),
        selectClasspathRoots(Collections.singleton(new File("/my/local/path1"))),
        selectUniqueId("unique-id-1"),
        selectUniqueId("unique-id-2")
     )
     .filters(
        includeEngines("junit-jupiter", "spek"),
        // excludeEngines("junit-vintage"),
        includeTags("fast"),
        // excludeTags("slow"),
        includeClassNamePatterns(".*Test[s]?")
        // includeClassNamePatterns("org\.example\.tests.*")
     )
     .configurationParameter("key1", "value1")
     .configurationParameters(configParameterMap)
     .build();
 

Since:

1.0

See Also:

DiscoverySelectors, ClassNameFilter, EngineFilter, TagFilter

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.String>	configurationParameters
static java.lang.String	DEFAULT_DISCOVERY_LISTENER_CONFIGURATION_PROPERTY_NAME Property name used to set the default discovery listener that is added to all : "junit.platform.discovery.listener.default"
private java.util.List<DiscoveryFilter<?>>	discoveryFilters
private java.util.List<LauncherDiscoveryListener>	discoveryListeners
private java.util.List<EngineFilter>	engineFilters
private java.util.List<PostDiscoveryFilter>	postDiscoveryFilters
private java.util.List<DiscoverySelector>	selectors

Constructor Summary

Constructors

Constructor and Description
LauncherDiscoveryRequestBuilder()

Method Summary

Modifier and Type	Method and Description
LauncherDiscoveryRequest	build() Build the LauncherDiscoveryRequest that has been configured via this builder.
LauncherDiscoveryRequestBuilder	configurationParameter(java.lang.String key, java.lang.String value) Add the supplied configuration parameter to the request.
LauncherDiscoveryRequestBuilder	configurationParameters(java.util.Map<java.lang.String,java.lang.String> configurationParameters) Add all of the supplied configuration parameters to the request.
LauncherDiscoveryRequestBuilder	filters(Filter<?>... filters) Add all of the supplied filters to the request.
private LauncherDiscoveryListener	getLauncherDiscoveryListener(ConfigurationParameters configurationParameters)
LauncherDiscoveryRequestBuilder	listeners(LauncherDiscoveryListener... listeners) Add all of the supplied discovery listeners to the request.
static LauncherDiscoveryRequestBuilder	request() Create a new LauncherDiscoveryRequestBuilder.
LauncherDiscoveryRequestBuilder	selectors(DiscoverySelector... selectors) Add all of the supplied selectors to the request.
LauncherDiscoveryRequestBuilder	selectors(java.util.List<? extends DiscoverySelector> selectors) Add all of the supplied selectors to the request.
private void	storeFilter(Filter<?> filter)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DISCOVERY_LISTENER_CONFIGURATION_PROPERTY_NAME

public static final java.lang.String DEFAULT_DISCOVERY_LISTENER_CONFIGURATION_PROPERTY_NAME

Property name used to set the default discovery listener that is added to all : "junit.platform.discovery.listener.default"

Supported Values

Supported values are "logging" and "abortOnFailure".

If not specified, the default is "logging".

See Also:

Constant Field Values

selectors

private java.util.List<DiscoverySelector> selectors

engineFilters

private java.util.List<EngineFilter> engineFilters

discoveryFilters

private java.util.List<DiscoveryFilter<?>> discoveryFilters

postDiscoveryFilters

private java.util.List<PostDiscoveryFilter> postDiscoveryFilters

configurationParameters

private java.util.Map<java.lang.String,java.lang.String> configurationParameters

discoveryListeners

private java.util.List<LauncherDiscoveryListener> discoveryListeners

Constructor Detail

LauncherDiscoveryRequestBuilder

public LauncherDiscoveryRequestBuilder()

Method Detail

request

public static LauncherDiscoveryRequestBuilder request()

Create a new LauncherDiscoveryRequestBuilder.

Returns:

a new builder

selectors

public LauncherDiscoveryRequestBuilder selectors(DiscoverySelector... selectors)

Add all of the supplied selectors to the request.

Parameters:

selectors - the DiscoverySelectors to add; never null

Returns:

this builder for method chaining

selectors

public LauncherDiscoveryRequestBuilder selectors(java.util.List<? extends DiscoverySelector> selectors)

Add all of the supplied selectors to the request.

Parameters:

selectors - the DiscoverySelectors to add; never null

Returns:

this builder for method chaining

filters

public LauncherDiscoveryRequestBuilder filters(Filter<?>... filters)

Add all of the supplied filters to the request.

The filters are combined using AND semantics, i.e. all of them have to include a resource for it to end up in the test plan.

Warning: be cautious when registering multiple competing include EngineFilters or multiple competing exclude EngineFilters for the same discovery request since doing so will likely lead to undesirable results (i.e., zero engines being active).

Parameters:

filters - the Filters to add; never null

Returns:

this builder for method chaining

configurationParameter

public LauncherDiscoveryRequestBuilder configurationParameter(java.lang.String key,
                                                              java.lang.String value)

Add the supplied configuration parameter to the request.

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

configurationParameters

public LauncherDiscoveryRequestBuilder configurationParameters(java.util.Map<java.lang.String,java.lang.String> configurationParameters)

Add all of the supplied configuration parameters to the request.

Parameters:

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

Returns:

this builder for method chaining

See Also:

configurationParameter(String, String)

listeners

@API(status=EXPERIMENTAL,
     since="1.6")
public LauncherDiscoveryRequestBuilder listeners(LauncherDiscoveryListener... listeners)

Add all of the supplied discovery listeners to the request.

In addition to the listeners registered using this method, this builder will add a default listener to this request that can be specified using the configuration parameter.

Parameters:

listeners - the LauncherDiscoveryListeners to add; never null

Returns:

this builder for method chaining

See Also:

LauncherDiscoveryListener, LauncherDiscoveryListeners, DEFAULT_DISCOVERY_LISTENER_CONFIGURATION_PROPERTY_NAME

storeFilter

private void storeFilter(Filter<?> filter)

build

public LauncherDiscoveryRequest build()

Build the LauncherDiscoveryRequest that has been configured via this builder.

getLauncherDiscoveryListener

private LauncherDiscoveryListener getLauncherDiscoveryListener(ConfigurationParameters configurationParameters)