org.junit.jupiter.api

Class DynamicTest

java.lang.Object

org.junit.jupiter.api.DynamicTest

@API(value=Experimental)
public class DynamicTest
extends java.lang.Object

A DynamicTest is a test case generated at runtime.

It is composed of a display name and an Executable.

Instances of DynamicTest must be generated by factory methods annotated with @TestFactory.

Note that dynamic tests are quite different from standard @Test cases since callbacks such as @BeforeEach and @AfterEach methods are not executed for dynamic tests.

Since:

5.0

See Also:

dynamicTest(String, Executable), stream(Iterator, Function, Consumer), Test, TestFactory, Executable

Method Summary

Modifier and Type	Method and Description
static DynamicTest	dynamicTest(java.lang.String displayName, Executable executable) Factory for creating a new DynamicTest for the supplied display name and executable code block.
java.lang.String	getDisplayName() Get the display name of this DynamicTest.
Executable	getExecutable() Get the executable code block associated with this DynamicTest.
static <T> java.util.stream.Stream<DynamicTest>	stream(java.util.Iterator<T> inputGenerator, java.util.function.Function<? super T,java.lang.String> displayNameGenerator, java.util.function.Consumer<? super T> testExecutor) Generate a stream of dynamic tests based on the supplied generators and test executor.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

dynamicTest

public static DynamicTest dynamicTest(java.lang.String displayName,
                                      Executable executable)

Factory for creating a new DynamicTest for the supplied display name and executable code block.

Parameters:

displayName - the display name for the dynamic test; never null or blank

executable - the executable code block for the dynamic test; never null

See Also:

stream(Iterator, Function, Consumer)

stream

public static <T> java.util.stream.Stream<DynamicTest> stream(java.util.Iterator<T> inputGenerator,
                                                              java.util.function.Function<? super T,java.lang.String> displayNameGenerator,
                                                              java.util.function.Consumer<? super T> testExecutor)

Generate a stream of dynamic tests based on the supplied generators and test executor.

Use this method when the set of dynamic tests is nondeterministic in nature.

The supplied inputGenerator is responsible for generating input values. A DynamicTest will be added to the resulting stream for each dynamically generated input value, using the supplied displayNameGenerator and testExecutor.

Type Parameters:

T - the type of input generated by the inputGenerator and used by the displayNameGenerator and testExecutor

Parameters:

inputGenerator - an Iterator that serves as a dynamic input generator; never null

displayNameGenerator - a function that generates a display name based on an input value; never null

testExecutor - a consumer that executes a test based on an input value; never null

Returns:

a stream of dynamic tests based on the supplied generators and executor; never null

See Also:

dynamicTest(String, Executable)

getDisplayName

public java.lang.String getDisplayName()

Get the display name of this DynamicTest.

getExecutable

public Executable getExecutable()

Get the executable code block associated with this DynamicTest.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object