Package org.junit.jupiter.engine.descriptor

Class TestMethodTestDescriptor

java.lang.Object

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

org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor

All Implemented Interfaces:

Node<JupiterEngineExecutionContext>, TestDescriptor

Direct Known Subclasses:

TestFactoryTestDescriptor, TestTemplateInvocationTestDescriptor

@API(status=INTERNAL,
     since="5.0")
public class TestMethodTestDescriptor
extends JupiterTestDescriptor

TestDescriptor for tests based on Java methods.

Default Display Names

The default display name for a test method is the name of the method concatenated with a comma-separated list of parameter types in parentheses. The names of parameter types are retrieved using Class.getSimpleName(). For example, the default display name for the following test method is testUser(TestInfo, User).

   @Test
   void testUser(TestInfo testInfo, @Mock User user) { ... }
 

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
TestMethodTestDescriptor(UniqueId uniqueId, Class<?> testClass, Method testMethod)

Method Summary

Modifier and Type	Method	Description
JupiterEngineExecutionContext	execute(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)	Execute the behavior of this node.
Set<ExclusiveResource>	getExclusiveResources()	Get the set of exclusive resources required to execute this node.
protected Optional<Node.ExecutionMode>	getExplicitExecutionMode()
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.
protected void	invokeTestMethod(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)
protected ExtensionRegistry	populateNewExtensionRegistry(JupiterEngineExecutionContext context)
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, getDefaultChildExecutionMode, getExclusiveResourcesFromAnnotation, getExecutionMode, getExecutionModeFromAnnotation, 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, mayRegisterTests, prune

Constructor Detail

TestMethodTestDescriptor

public TestMethodTestDescriptor(UniqueId uniqueId,
                                Class<?> testClass,
                                Method testMethod)

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()

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)

populateNewExtensionRegistry

protected ExtensionRegistry populateNewExtensionRegistry(JupiterEngineExecutionContext context)

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.

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)

invokeTestMethod

protected void invokeTestMethod(JupiterEngineExecutionContext context,
                                Node.DynamicTestExecutor dynamicTestExecutor)

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 exclusive resources required to execute this node.

The default implementation returns an empty set.

Returns:

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

See Also:

ExclusiveResource

getExplicitExecutionMode

protected Optional<Node.ExecutionMode> getExplicitExecutionMode()

Overrides:

getExplicitExecutionMode in class JupiterTestDescriptor

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