org.junit.gen5.launcher

Class TestPlan

java.lang.Object

org.junit.gen5.launcher.TestPlan

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

TestPlan describes the tree of tests and containers as discovered by a Launcher.

Tests and containers are represented by TestIdentifier instances. The complete set of identifiers comprises a tree-like structure. However, each identifier only stores the unique ID of its parent. This class provides a number of helpful methods to retrieve the parent, children, and descendants of an identifier.

While the contained instances of TestIdentifier are immutable, instances of this class contain mutable state. For example, when a dynamic test is registered at runtime, it is added to the original test plan and reported to TestExecutionListener implementations.

Since:

5.0

See Also:

Launcher, TestExecutionListener

Method Summary

Modifier and Type	Method and Description
void	add(TestIdentifier testIdentifier) Add the supplied TestIdentifier to this test plan.
long	countTestIdentifiers(java.util.function.Predicate<? super TestIdentifier> predicate) Count all identifiers that satisfy the given predicate.
static TestPlan	from(java.util.Collection<org.junit.gen5.engine.TestDescriptor> engineDescriptors)
java.util.Set<TestIdentifier>	getChildren(TestId parentId) Get the children of the supplied TestId.
java.util.Set<TestIdentifier>	getChildren(TestIdentifier parent) Get the children of supplied TestIdentifier.
java.util.Set<TestIdentifier>	getDescendants(TestIdentifier parent) Get all descendants of the supplied TestIdentifier (i.e., all of its children and their children, recursively).
java.util.Optional<TestIdentifier>	getParent(TestIdentifier child) Get the parent of supplied TestIdentifier.
java.util.Set<TestIdentifier>	getRoots() Get the root identifiers of this test plan.
TestIdentifier	getTestIdentifier(TestId testId) Get the TestIdentifier with the specified TestId.

Methods inherited from class java.lang.Object

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

Method Detail

from

public static TestPlan from(java.util.Collection<org.junit.gen5.engine.TestDescriptor> engineDescriptors)

add

public void add(TestIdentifier testIdentifier)

Add the supplied TestIdentifier to this test plan.

Parameters:

testIdentifier - the identifier to add

getRoots

public java.util.Set<TestIdentifier> getRoots()

Get the root identifiers of this test plan.

Returns:

an unmodifiable set of the root identifiers

getParent

public java.util.Optional<TestIdentifier> getParent(TestIdentifier child)

Get the parent of supplied TestIdentifier.

Parameters:

child - the identifier to look up the parent for

Returns:

an Optional containing the parent, if present

getChildren

public java.util.Set<TestIdentifier> getChildren(TestIdentifier parent)

Get the children of supplied TestIdentifier.

Parameters:

parent - the identifier to look up the children for

Returns:

an unmodifiable set of the parent's children, potentially empty

See Also:

getChildren(TestId)

getChildren

public java.util.Set<TestIdentifier> getChildren(TestId parentId)

Get the children of the supplied TestId.

Parameters:

parentId - the ID to look up the children for

Returns:

an unmodifiable set of the parent's children, potentially empty

See Also:

getChildren(TestIdentifier)

getTestIdentifier

public TestIdentifier getTestIdentifier(TestId testId)
                                 throws org.junit.gen5.commons.util.PreconditionViolationException

Get the TestIdentifier with the specified TestId.

Parameters:

testId - the unique ID to look up the identifier for

Returns:

the identifier with the specified unique ID

Throws:

org.junit.gen5.commons.util.PreconditionViolationException - if no TestIdentifier with the specified unique ID is present in this test plan

countTestIdentifiers

public long countTestIdentifiers(java.util.function.Predicate<? super TestIdentifier> predicate)

Count all identifiers that satisfy the given predicate.

Parameters:

predicate - a predicate which returns true for identifiers to be counted

Returns:

the number of identifiers that satisfy the specified predicate

getDescendants

public java.util.Set<TestIdentifier> getDescendants(TestIdentifier parent)

Get all descendants of the supplied TestIdentifier (i.e., all of its children and their children, recursively).

Parameters:

parent - the identifier to look up the descendants for

Returns:

an unmodifiable set of the parent's descendants, potentially empty