dev.jeka.core.api.testing

Class JkTestProcessor

java.lang.Object

dev.jeka.core.api.testing.JkTestProcessor

public final class JkTestProcessor
extends java.lang.Object

Processor executing a given bunch of tests existing in compiled Java classes.

This relies on Junit-platform (junit5), but having Junit-platform libraries on the classpath is optional. For most of the cases, processors can be used without coding against junit-platform API but, it is possible to use directly Junit-platform API for fine-tuning.

Users can configure

• Runtime support : classpath, forked process
• Engine behavior : listeners, reports, progress display
• The tests to run: discovery, selectors, filters, ...

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkTestProcessor.JkEngineBehavior
static class	JkTestProcessor.JkProgressStyle Style of progress mark to display on console while the tests are running.

Field Summary

Fields

Modifier and Type	Field and Description
JkTestProcessor.JkEngineBehavior	engineBehavior
JkRunnables	postActions Collection of Runnables to be executed after the test processor has run.
JkRunnables	preActions

Method Summary

Modifier and Type	Method and Description
JkJavaProcess	getForkingProcess()
java.lang.String	getJunitPlatformVersion()
static boolean	isEngineTestPresent()
JkTestResult	launch() Deprecated. Use #run instead
static void	main(java.lang.String[] args) Non-public API.
static JkTestProcessor	of(JkPathSequence testClasspath, java.lang.Iterable<java.nio.file.Path> testClassRootDirs)
static JkTestProcessor	of(java.util.function.Supplier<JkPathSequence> testClasspath, java.util.function.Supplier<java.lang.Iterable<java.nio.file.Path>> testClassRootDirs)
JkTestResult	run() Launches the default test selection using the underlying JUnit Platform setup.
JkTestResult	run(JkTestSelection testSelection) Launches the specified test set with the underlying junit-platform.
JkTestResult	runMatchingPatterns(java.lang.String... patterns) Launches the specified test set by including the provided patterns, using the underlying junit-platform setup.
JkTestProcessor	setForkingProcess(boolean fork)
JkTestProcessor	setForkingProcess(JkJavaProcess process)
JkTestProcessor	setJunitPlatformVersion(java.lang.String junitPlatformVersion)
JkTestProcessor	setRepoSetSupplier(java.util.function.Supplier<JkRepoSet> repoSetSupplier)
JkTestProcessor	setToolChain(JkJavaCompilerToolChain.JkJdks jdks, JkJavaVersion javaVersion)

Methods inherited from class java.lang.Object

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

Field Detail

engineBehavior

public final JkTestProcessor.JkEngineBehavior engineBehavior

preActions

public final JkRunnables preActions

postActions

public final JkRunnables postActions

Collection of Runnables to be executed after the test processor has run.

It is typically used for generating reports after a test definition has run.

If you want to run another test 'suite', you'll need to use JkProjectTesting.postActions instead.

Method Detail

of

public static JkTestProcessor of(java.util.function.Supplier<JkPathSequence> testClasspath,
                                 java.util.function.Supplier<java.lang.Iterable<java.nio.file.Path>> testClassRootDirs)

of

public static JkTestProcessor of(JkPathSequence testClasspath,
                                 java.lang.Iterable<java.nio.file.Path> testClassRootDirs)

isEngineTestPresent

public static boolean isEngineTestPresent()

getForkingProcess

public JkJavaProcess getForkingProcess()

setForkingProcess

public JkTestProcessor setForkingProcess(JkJavaProcess process)

setToolChain

public JkTestProcessor setToolChain(JkJavaCompilerToolChain.JkJdks jdks,
                                    JkJavaVersion javaVersion)

setForkingProcess

public JkTestProcessor setForkingProcess(boolean fork)

getJunitPlatformVersion

public java.lang.String getJunitPlatformVersion()

setJunitPlatformVersion

public JkTestProcessor setJunitPlatformVersion(java.lang.String junitPlatformVersion)

setRepoSetSupplier

public JkTestProcessor setRepoSetSupplier(java.util.function.Supplier<JkRepoSet> repoSetSupplier)

run

public JkTestResult run(JkTestSelection testSelection)

Launches the specified test set with the underlying junit-platform. The classloader running the tests includes the classpath of the current classloader plus the specified one.

runMatchingPatterns

public JkTestResult runMatchingPatterns(java.lang.String... patterns)

Launches the specified test set by including the provided patterns, using the underlying junit-platform setup. The method processes the given inclusion patterns to determine which tests to run and executes them.

See Also:

run(JkTestSelection), JkTestSelection.IT_PATTERN, JkTestSelection.E2E_PATTERN

launch

@Deprecated
public JkTestResult launch()

Deprecated. Use #run instead

run

public JkTestResult run()

Launches the default test selection using the underlying JUnit Platform setup. This method executes tests defined within the provided test classpath and root directories.

main

public static void main(java.lang.String[] args)

Non-public API. Used by #launchInClassloader.