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.MethodBasedTestDescriptor

org.junit.jupiter.engine.descriptor.TestTemplateTestDescriptor

All Implemented Interfaces:

Node<JupiterEngineExecutionContext>, TestDescriptor

@API(status=INTERNAL,
     since="5.0")
public class TestTemplateTestDescriptor
extends MethodBasedTestDescriptor

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.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 and Description
TestTemplateTestDescriptor(UniqueId uniqueId, java.lang.Class<?> testClass, java.lang.reflect.Method templateMethod)

Method Summary

Modifier and Type	Method and Description
private TestDescriptor	createInvocationTestDescriptor(TestTemplateInvocationContext invocationContext, int index)
JupiterEngineExecutionContext	execute(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor) Execute the behavior of this node.
private void	execute(Node.DynamicTestExecutor dynamicTestExecutor, TestDescriptor testDescriptor)
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) Prepare the supplied context prior to execution.
private java.util.List<TestTemplateInvocationContextProvider>	validateProviders(ExtensionContext extensionContext, ExtensionRegistry extensionRegistry)
private void	validateWasAtLeastInvokedOnce(int invocationIndex)

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

getLegacyReportingName, getTags, getTestClass, getTestMethod

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

determineDisplayName, executeAndMaskThrowable, getTags, populateNewExtensionRegistryFromExtendWith, shouldBeSkipped

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 java.lang.Object

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

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

after, before

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

accept, containsTests, getDescendants, isContainer, isRoot, isTest, prune

Constructor Detail

TestTemplateTestDescriptor

public TestTemplateTestDescriptor(UniqueId uniqueId,
                                  java.lang.Class<?> testClass,
                                  java.lang.reflect.Method templateMethod)

Method Detail

getType

public TestDescriptor.Type getType()

Description copied from interface: TestDescriptor

Determine the TestDescriptor.Type of this descriptor.

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.

prepare

public JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext context)
                                      throws java.lang.Exception

Description copied from interface: Node

Prepare the supplied context prior to execution.

The default implementation returns the supplied context unmodified.

Throws:

java.lang.Exception

execute

public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext context,
                                             Node.DynamicTestExecutor dynamicTestExecutor)
                                      throws java.lang.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.

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:

java.lang.Exception

See Also:

Node.before(C), Node.after(C)

validateProviders

private java.util.List<TestTemplateInvocationContextProvider> validateProviders(ExtensionContext extensionContext,
                                                                                ExtensionRegistry extensionRegistry)

createInvocationTestDescriptor

private TestDescriptor createInvocationTestDescriptor(TestTemplateInvocationContext invocationContext,
                                                      int index)

execute

private void execute(Node.DynamicTestExecutor dynamicTestExecutor,
                     TestDescriptor testDescriptor)

validateWasAtLeastInvokedOnce

private void validateWasAtLeastInvokedOnce(int invocationIndex)