dev.jeka.core.api.testing

Class JkTestSelection

java.lang.Object

dev.jeka.core.api.testing.JkTestSelection

All Implemented Interfaces:

java.io.Serializable

public final class JkTestSelection
extends java.lang.Object
implements java.io.Serializable

Mutable object to specify a set of test to run according class root dirs, file patterns and tags.

By default, when no include/exclude pattern/tag are specified, the selector get all classes under defined class root dirs.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	E2E_PATTERN A regular expression that matches strings beginning with "e2e.".
static java.lang.String	IT_PATTERN A regular expression pattern for selecting integration test classes.
static java.lang.String	MAVEN_INCLUDE_PATTERN

Method Summary

Modifier and Type	Method and Description
JkTestSelection	addExcludePatterns(java.lang.Iterable<java.lang.String> patterns)
JkTestSelection	addExcludePatterns(java.lang.String... patterns) Adds the specified exclude patterns to the current test selection.
JkTestSelection	addExcludePatternsIf(boolean condition, java.lang.String... patterns)
JkTestSelection	addExcludeTags(java.lang.Iterable<java.lang.String> patterns)
JkTestSelection	addExcludeTags(java.lang.String... patterns)
JkTestSelection	addIncludeMavenPatterns()
JkTestSelection	addIncludePatterns(java.lang.Iterable<java.lang.String> patterns)
JkTestSelection	addIncludePatterns(java.lang.String... patterns)
JkTestSelection	addIncludePatternsIf(boolean condition, java.lang.String... patterns)
JkTestSelection	addIncludeTags(java.lang.Iterable<java.lang.String> patterns)
JkTestSelection	addIncludeTags(java.lang.String... patterns)
JkTestSelection	copy()
JkUnaryOperator<org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder>	getDiscoveryConfigurer()
java.util.Set<java.lang.String>	getExcludePatterns() Returns an unmodifiable set of exclude classname patterns.
java.util.Set<java.lang.String>	getExcludeTags()
java.util.Set<java.lang.String>	getIncludePatterns() Returns an unmodifiable set of include classname patterns (ex : ".*IT")
java.util.Set<java.lang.String>	getIncludeTags()
JkPathSequence	getTestClassRoots() Returns the test class rot dirs to discover the tests from.
static JkTestSelection	of() Creates an empty testSet The created instance does not include any include filter nor class root dirs so no test will be included out of the box.
JkTestSelection	setDiscoveryConfigurer(JkUnaryOperator<org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder> discoveryConfigurer) Set a native Junit-platform configurer to build the LauncherDiscoveryRequest passed to Junit-platform.
JkTestSelection	setIncludePatterns(java.util.Collection<java.lang.String> includePatterns) Sets the include patterns for selecting test classes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAVEN_INCLUDE_PATTERN

public static final java.lang.String MAVEN_INCLUDE_PATTERN

See Also:

Constant Field Values

IT_PATTERN

public static final java.lang.String IT_PATTERN

A regular expression pattern for selecting integration test classes. The pattern `.*IT` matches test class names ending with "IT".

Integration tests are tests run within the regular test phase but running slower than regular unit tests.

See Also:

Constant Field Values

E2E_PATTERN

public static final java.lang.String E2E_PATTERN

A regular expression that matches strings beginning with "e2e.".

This regular expression is commonly used to identify fully qualified end-to-end (E2E) classes that belong to the e2e package.

End-to-end tests are tests running in e2eTest after the application or library has been packaged.

See Also:

Constant Field Values

Method Detail

of

public static JkTestSelection of()

Creates an empty testSet The created instance does not include any include filter nor class root dirs so no test will be included out of the box.

getTestClassRoots

public JkPathSequence getTestClassRoots()

Returns the test class rot dirs to discover the tests from.

getIncludePatterns

public java.util.Set<java.lang.String> getIncludePatterns()

Returns an unmodifiable set of include classname patterns (ex : ".*IT")

addIncludePatterns

public JkTestSelection addIncludePatterns(java.lang.Iterable<java.lang.String> patterns)

addIncludeMavenPatterns

public JkTestSelection addIncludeMavenPatterns()

addIncludePatterns

public JkTestSelection addIncludePatterns(java.lang.String... patterns)

addIncludePatternsIf

public JkTestSelection addIncludePatternsIf(boolean condition,
                                            java.lang.String... patterns)

getExcludePatterns

public java.util.Set<java.lang.String> getExcludePatterns()

Returns an unmodifiable set of exclude classname patterns.

addExcludePatterns

public JkTestSelection addExcludePatterns(java.lang.Iterable<java.lang.String> patterns)

addExcludePatterns

public JkTestSelection addExcludePatterns(java.lang.String... patterns)

Adds the specified exclude patterns to the current test selection. Exclude patterns are regular expressions used to filter test class names.

addExcludePatternsIf

public JkTestSelection addExcludePatternsIf(boolean condition,
                                            java.lang.String... patterns)

See Also:

addExcludePatterns(java.lang.Iterable<java.lang.String>)

getIncludeTags

public java.util.Set<java.lang.String> getIncludeTags()

addIncludeTags

public JkTestSelection addIncludeTags(java.lang.Iterable<java.lang.String> patterns)

addIncludeTags

public JkTestSelection addIncludeTags(java.lang.String... patterns)

getExcludeTags

public java.util.Set<java.lang.String> getExcludeTags()

addExcludeTags

public JkTestSelection addExcludeTags(java.lang.Iterable<java.lang.String> patterns)

addExcludeTags

public JkTestSelection addExcludeTags(java.lang.String... patterns)

getDiscoveryConfigurer

public JkUnaryOperator<org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder> getDiscoveryConfigurer()

setIncludePatterns

public JkTestSelection setIncludePatterns(java.util.Collection<java.lang.String> includePatterns)

Sets the include patterns for selecting test classes. Include patterns are regular expressions used to filter test class names. Only test classes whose names match at least one of the specified patterns will be included.

setDiscoveryConfigurer

public JkTestSelection setDiscoveryConfigurer(JkUnaryOperator<org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder> discoveryConfigurer)

Set a native Junit-platform configurer to build the LauncherDiscoveryRequest passed to Junit-platform. The configurer will apply on a builder instance created from patterns, tags and class root dirs defined in this instance.

     
         setDiscoveryConfigurer(classpath, builder -> builder
                 .filters(
                         ClassNameFilter.includeClassNamePatterns(ClassNameFilter.STANDARD_INCLUDE_PATTERN)
                 )
                 .selectors(DiscoverySelectors.selectMethod("mytest.MyTest#toto"))
                 .configurationParameter("run.it", "false")
         );
     
 

copy

public JkTestSelection copy()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object