Package org.junit.jupiter.engine.descriptor

Class TestTemplateTestDescriptor

java.lang.Object

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

org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

org.junit.jupiter.engine.descriptor.TestTemplateTestDescriptor

All Implemented Interfaces:

Filterable, Node<JupiterEngineExecutionContext>, TestDescriptor

@API(status=INTERNAL,
     since="5.0")
public class TestTemplateTestDescriptor
extends JupiterTestDescriptor
implements Filterable

TestDescriptor for @TestTemplate methods.

Since:

5.0

Nested Class Summary

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

Node.DynamicTestExecutor, Node.ExecutionMode, Node.SkipResult

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

TestDescriptor.Type, TestDescriptor.Visitor

Field Summary

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

children

Constructor Summary

Constructors

Constructor	Description
TestTemplateTestDescriptor(UniqueId uniqueId, Class<?> testClass, Method templateMethod)

Method Summary

Modifier and Type	Method	Description
JupiterEngineExecutionContext	execute(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)	Execute the behavior of this node.
DynamicDescendantFilter	getDynamicDescendantFilter()
Set<ExclusiveResource>	getExclusiveResources()	Get the set of resources required to execute this node.
Node.ExecutionMode	getExecutionMode()	Get the preferred of execution mode for parallel execution of this node.
String	getLegacyReportingName()	Get the name of this descriptor in a format that is suitable for legacy reporting infrastructure — for example, for reporting systems built on the Ant-based XML reporting format for JUnit 4.
Set<TestTag>	getTags()	Get the set of tags associated with this descriptor.
Class<?>	getTestClass()
Method	getTestMethod()
TestDescriptor.Type	getType()	Determine the TestDescriptor.Type of this descriptor.
boolean	mayRegisterTests()	Determine if this descriptor may register dynamic tests during execution.
JupiterEngineExecutionContext	prepare(JupiterEngineExecutionContext context)	Must be overridden and return a new context so cleanUp() does not accidentally close the parent context.

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

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

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

cleanUp, determineDisplayName, executeAndMaskThrowable, getExclusiveResources, getExecutionMode, getTags, shouldBeSkipped

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

after, before

Methods inherited from class java.lang.Object

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

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

accept, getDescendants, isContainer, isRoot, isTest, prune

Constructor Detail

TestTemplateTestDescriptor

public TestTemplateTestDescriptor(UniqueId uniqueId,
                                  Class<?> testClass,
                                  Method templateMethod)

Method Detail

getDynamicDescendantFilter

public DynamicDescendantFilter getDynamicDescendantFilter()

Specified by:

getDynamicDescendantFilter in interface Filterable

getType

public TestDescriptor.Type getType()

Description copied from interface: TestDescriptor

Determine the TestDescriptor.Type of this descriptor.

Specified by:

getType in interface TestDescriptor

Returns:

the descriptor type; never null.

See Also:

TestDescriptor.isContainer(), TestDescriptor.isTest()

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

prepare

public JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext context)
                                      throws Exception

Description copied from class: JupiterTestDescriptor

Must be overridden and return a new context so cleanUp() does not accidentally close the parent context.

Specified by:

prepare in interface Node<JupiterEngineExecutionContext>

Specified by:

prepare in class JupiterTestDescriptor

Throws:

Exception

See Also:

Node.cleanUp(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.

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)

getTags

public final 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

getExclusiveResources

public Set<ExclusiveResource> getExclusiveResources()

Description copied from interface: Node

Get the set of resources required to execute this node.

Returns:

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

See Also:

ExclusiveResource

getExecutionMode

public Node.ExecutionMode getExecutionMode()

Description copied from interface: Node

Get the preferred of execution mode for parallel execution of this node.

Returns:

the preferred execution mode of this node; never null

See Also:

Node.ExecutionMode

getTestClass

public final Class<?> getTestClass()

getTestMethod

public final Method getTestMethod()

getLegacyReportingName

public String getLegacyReportingName()

Description copied from interface: TestDescriptor

Get the name of this descriptor in a format that is suitable for legacy reporting infrastructure — for example, for reporting systems built on the Ant-based XML reporting format for JUnit 4.

The default implementation simply delegates to TestDescriptor.getDisplayName().

Returns:

the legacy reporting name; never null or blank