org.junit.jupiter.engine.descriptor

Class MethodTestDescriptor

java.lang.Object

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

org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

org.junit.jupiter.engine.descriptor.MethodTestDescriptor

All Implemented Interfaces:

Node<JupiterEngineExecutionContext>, TestDescriptor

Direct Known Subclasses:

TestFactoryTestDescriptor

@API(value=Internal)
public class MethodTestDescriptor
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.SkipResult

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

TestDescriptor.Visitor

Constructor Summary

Constructors

Constructor and Description
MethodTestDescriptor(UniqueId uniqueId, java.lang.Class<?> testClass, java.lang.reflect.Method testMethod)

Method Summary

Modifier and Type	Method and Description
JupiterEngineExecutionContext	execute(JupiterEngineExecutionContext context) Execute the behavior of this node.
protected static java.lang.String	generateDefaultDisplayName(java.lang.reflect.Method testMethod)
java.util.Set<TestTag>	getTags() Get the set of tags associated with this descriptor.
java.lang.Class<?>	getTestClass()
java.lang.reflect.Method	getTestMethod()
protected void	invokeTestMethod(JupiterEngineExecutionContext context)
boolean	isContainer() Determine if this descriptor describes a container.
boolean	isTest() Determine if this descriptor describes a test.
JupiterEngineExecutionContext	prepare(JupiterEngineExecutionContext context) Prepare the supplied context prior to execution.
Node.SkipResult	shouldBeSkipped(JupiterEngineExecutionContext context) Determine if the execution of the supplied context should be skipped.

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

determineDisplayName, executeAndMaskThrowable, getTags, isLeaf, populateNewExtensionRegistryFromExtendWith

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

addChild, equals, findByUniqueId, getChildren, getDisplayName, getParent, getSource, getUniqueId, hashCode, removeChild, removeFromHierarchy, setParent, setSource, 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, getAllDescendants, hasTests, isRoot

Constructor Detail

MethodTestDescriptor

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

Method Detail

getTags

public final java.util.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

getTestClass

public final java.lang.Class<?> getTestClass()

getTestMethod

public final java.lang.reflect.Method getTestMethod()

isTest

public boolean isTest()

Description copied from interface: TestDescriptor

Determine if this descriptor describes a test.

isContainer

public boolean isContainer()

Description copied from interface: TestDescriptor

Determine if this descriptor describes a container.

generateDefaultDisplayName

protected static java.lang.String generateDefaultDisplayName(java.lang.reflect.Method testMethod)

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

shouldBeSkipped

public Node.SkipResult shouldBeSkipped(JupiterEngineExecutionContext context)
                                throws java.lang.Exception

Description copied from interface: Node

Determine if the execution of the supplied context should be skipped.

The default implementation returns Node.SkipResult.doNotSkip().

Throws:

java.lang.Exception

execute

public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext context)
                                      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.

Parameters:

context - the context to execute in

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)

invokeTestMethod

protected void invokeTestMethod(JupiterEngineExecutionContext context)