Module org.junit.jupiter.engine

Package org.junit.jupiter.engine.descriptor

Class ClassTemplateTestDescriptor

java.lang.Object

org.junit.platform.engine.support.descriptor.AbstractTestDescriptor

org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

org.junit.jupiter.engine.descriptor.ClassBasedTestDescriptor

org.junit.jupiter.engine.descriptor.ClassTemplateTestDescriptor

All Implemented Interfaces:

Filterable, TestClassAware, Validatable, Node<JupiterEngineExecutionContext>, TestDescriptor

@API(status=INTERNAL,
     since="5.13")
public class ClassTemplateTestDescriptor
extends ClassBasedTestDescriptor
implements Filterable

Since:

5.13

Nested Class Summary

Nested classes/interfaces inherited from class org.junit.jupiter.engine.descriptor.ClassBasedTestDescriptor

ClassBasedTestDescriptor.ClassInfo

Nested classes/interfaces inherited from interface org.junit.platform.engine.support.hierarchical.Node

Node.DynamicTestExecutor, Node.ExecutionMode, Node.Invocation<C extends EngineExecutionContext>, Node.SkipResult

Nested classes/interfaces inherited from interface org.junit.platform.engine.TestDescriptor

TestDescriptor.Type, TestDescriptor.Visitor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NESTED_CLASS_SEGMENT_TYPE
static final String	STANDALONE_CLASS_SEGMENT_TYPE

Fields inherited from class org.junit.jupiter.engine.descriptor.ClassBasedTestDescriptor

classInfo

Fields inherited from class org.junit.platform.engine.support.descriptor.AbstractTestDescriptor

children

Constructor Summary

Constructors

Constructor	Description
ClassTemplateTestDescriptor(UniqueId uniqueId, ClassBasedTestDescriptor delegate)

Method Summary

Modifier and Type	Method	Description
void	cleanUp(JupiterEngineExecutionContext context)	Clean up the supplied context after execution.
protected JupiterTestDescriptor	copyIncludingDescendants(UnaryOperator<UniqueId> uniqueIdTransformer)	Returns a deep copy (with copies of children) of this descriptor with the supplied unique ID.
default Stream<ExclusiveResource>	determineExclusiveResources()
default Stream<ExclusiveResource>	determineOwnExclusiveResources(Function<ResourceLocksProvider,Set<ResourceLocksProvider.Lock>> providerToLocks)
JupiterEngineExecutionContext	execute(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)	Execute the behavior of this node.
DynamicDescendantFilter	getDynamicDescendantFilter()
List<Class<?>>	getEnclosingTestClasses()
Set<ExclusiveResource>	getExclusiveResources()	Get the set of exclusive resources required to execute this node.
Function<ResourceLocksProvider,Set<ResourceLocksProvider.Lock>>	getResourceLocksProviderEvaluator()
Set<TestTag>	getTags()	Get the set of tags associated with this descriptor.
TestInstances	instantiateTestClass(JupiterEngineExecutionContext parentExecutionContext, ExtensionContextSupplier extensionContext, ExtensionRegistry registry, JupiterEngineExecutionContext context)
boolean	mayRegisterTests()	Determine if this descriptor may register dynamic tests during execution.
void	prune()	Remove this descriptor from the hierarchy unless it is a root or contains tests.
protected void	validateClassTemplateInvocationLifecycleMethods(DiscoveryIssueReporter reporter)
protected void	validateCoreLifecycleMethods(DiscoveryIssueReporter reporter)
protected ClassTemplateTestDescriptor	withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)	Returns shallow copy (without children) of this descriptor with the supplied unique ID.

Methods inherited from class org.junit.jupiter.engine.descriptor.ClassBasedTestDescriptor

after, before, getDefaultChildExecutionMode, getExclusiveResourceCollector, getExplicitExecutionMode, getLegacyReportingName, getTestClass, getType, instantiateTestClass, prepare, setDefaultChildExecutionMode, validate

Methods inherited from class org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

getExecutionMode, shouldBeSkipped, toExecutionMode

Methods inherited from class org.junit.platform.engine.support.descriptor.AbstractTestDescriptor

addChild, equals, findByUniqueId, getChildren, getDisplayName, getParent, getSource, getUniqueId, hashCode, orderChildren, removeChild, removeFromHierarchy, setParent, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.junit.platform.engine.support.hierarchical.Node

around, nodeFinished, nodeSkipped

Methods inherited from interface org.junit.platform.engine.TestDescriptor

accept, addChild, findByUniqueId, getAncestors, getChildren, getDescendants, getDisplayName, getParent, getSource, getUniqueId, isContainer, isRoot, isTest, orderChildren, removeChild, removeFromHierarchy, setParent

Field Details

STANDALONE_CLASS_SEGMENT_TYPE

public static final String STANDALONE_CLASS_SEGMENT_TYPE

See Also:

• Constant Field Values

NESTED_CLASS_SEGMENT_TYPE

public static final String NESTED_CLASS_SEGMENT_TYPE

See Also:

• Constant Field Values

Constructor Details

ClassTemplateTestDescriptor

public ClassTemplateTestDescriptor(UniqueId uniqueId,
 ClassBasedTestDescriptor delegate)

Method Details

getTags

public Set<TestTag> getTags()

Description copied from interface: TestDescriptor

Get the set of tags associated with this descriptor.

Specified by:

getTags in interface TestDescriptor

Overrides:

getTags in class AbstractTestDescriptor

Returns:

the set of tags associated with this descriptor; never null but potentially empty

See Also:

• TestTag

validateCoreLifecycleMethods

protected void validateCoreLifecycleMethods(DiscoveryIssueReporter reporter)

Overrides:

validateCoreLifecycleMethods in class ClassBasedTestDescriptor

validateClassTemplateInvocationLifecycleMethods

protected void validateClassTemplateInvocationLifecycleMethods(DiscoveryIssueReporter reporter)

Overrides:

validateClassTemplateInvocationLifecycleMethods in class ClassBasedTestDescriptor

getDynamicDescendantFilter

public DynamicDescendantFilter getDynamicDescendantFilter()

Specified by:

getDynamicDescendantFilter in interface Filterable

copyIncludingDescendants

protected JupiterTestDescriptor copyIncludingDescendants(UnaryOperator<UniqueId> uniqueIdTransformer)

Description copied from class: JupiterTestDescriptor

Returns a deep copy (with copies of children) of this descriptor with the supplied unique ID.

Overrides:

copyIncludingDescendants in class JupiterTestDescriptor

Returns:

a deep copy (with copies of children) of this descriptor with the supplied unique ID

withUniqueId

protected ClassTemplateTestDescriptor withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)

Description copied from class: JupiterTestDescriptor

Returns shallow copy (without children) of this descriptor with the supplied unique ID.

Specified by:

withUniqueId in class JupiterTestDescriptor

Returns:

shallow copy (without children) of this descriptor with the supplied unique ID

prune

public void prune()

Description copied from interface: TestDescriptor

Remove this descriptor from the hierarchy unless it is a root or contains tests.

A concrete TestEngine may override this method in order to implement a different algorithm or to skip pruning altogether.

Specified by:

prune in interface TestDescriptor

See Also:

• TestDescriptor.isRoot()
• TestDescriptor.containsTests(TestDescriptor)
• TestDescriptor.removeFromHierarchy()

mayRegisterTests

public boolean mayRegisterTests()

Description copied from interface: TestDescriptor

Determine if this descriptor may register dynamic tests during execution.

The default implementation assumes tests are usually known during discovery and thus returns false.

Specified by:

mayRegisterTests in interface TestDescriptor

getEnclosingTestClasses

public List<Class<?>> getEnclosingTestClasses()

Specified by:

getEnclosingTestClasses in interface TestClassAware

instantiateTestClass

public TestInstances instantiateTestClass(JupiterEngineExecutionContext parentExecutionContext,
 ExtensionContextSupplier extensionContext,
 ExtensionRegistry registry,
 JupiterEngineExecutionContext context)

Specified by:

instantiateTestClass in class ClassBasedTestDescriptor

getResourceLocksProviderEvaluator

public Function<ResourceLocksProvider,Set<ResourceLocksProvider.Lock>> getResourceLocksProviderEvaluator()

getExclusiveResources

public Set<ExclusiveResource> getExclusiveResources()

Description copied from interface: Node

Get the set of exclusive resources required to execute this node.

The default implementation returns an empty set.

Specified by:

getExclusiveResources in interface Node<JupiterEngineExecutionContext>

Overrides:

getExclusiveResources in class JupiterTestDescriptor

Returns:

the set of exclusive resources required by this node; never null but potentially empty

See Also:

• ExclusiveResource

cleanUp

public void cleanUp(JupiterEngineExecutionContext context)
             throws Exception

Description copied from interface: Node

Clean up the supplied context after execution.

The default implementation does nothing.

Specified by:

cleanUp in interface Node<JupiterEngineExecutionContext>

Overrides:

cleanUp in class ClassBasedTestDescriptor

Parameters:

context - the context to execute in

Throws:

Exception

See Also:

• Node.prepare(EngineExecutionContext)

execute

public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext context,
 Node.DynamicTestExecutor dynamicTestExecutor)
                                      throws Exception

Description copied from interface: Node

Execute the behavior of this node.

Containers typically do not implement this method since the HierarchicalTestEngine handles execution of their children.

The supplied dynamicTestExecutor may be used to submit additional dynamic tests for immediate execution.

The default implementation returns the supplied context unmodified.

Specified by:

execute in interface Node<JupiterEngineExecutionContext>

Parameters:

context - the context to execute in

dynamicTestExecutor - the executor to submit dynamic tests to

Returns:

the new context to be used for children of this node and for the after behavior of the parent of this node, if any

Throws:

Exception

See Also:

• Node.before(C)
• Node.after(C)

determineExclusiveResources

default Stream<ExclusiveResource> determineExclusiveResources()

determineOwnExclusiveResources

default Stream<ExclusiveResource> determineOwnExclusiveResources(Function<ResourceLocksProvider,Set<ResourceLocksProvider.Lock>> providerToLocks)