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

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 MethodBasedTestDescriptor

TestDescriptor for @Test 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.Invocation<C extends EngineExecutionContext>, 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.jupiter.engine.descriptor.JupiterTestDescriptor

configuration

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

children

Constructor Summary

Constructors

Constructor	Description
TestMethodTestDescriptor(UniqueId uniqueId, Class<?> testClass, Method testMethod, JupiterConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
JupiterEngineExecutionContext	execute(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)	Execute the behavior of this node.
TestDescriptor.Type	getType()	Determine the TestDescriptor.Type of this descriptor.
protected void	invokeTestMethod(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)
void	nodeFinished(JupiterEngineExecutionContext context, TestDescriptor descriptor, TestExecutionResult result)	Invoke testSuccessful(), testAborted(), or testFailed() on each registered TestWatcher according to the status of the supplied TestExecutionResult, in reverse registration order.
void	nodeSkipped(JupiterEngineExecutionContext context, TestDescriptor descriptor, Node.SkipResult result)	Invoke TestWatcher.testDisabled(ExtensionContext, Optional) on each registered TestWatcher, in registration order.
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.jupiter.engine.descriptor.MethodBasedTestDescriptor

getExclusiveResources, getExplicitExecutionMode, getLegacyReportingName, getTags, getTestClass, getTestMethod

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

cleanUp, executeAndMaskThrowable, getDefaultChildExecutionMode, getExclusiveResourcesFromAnnotation, getExecutionMode, getExecutionModeFromAnnotation, getTags, shouldBeSkipped, toExecutionMode

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, around, before

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,
                                JupiterConfiguration configuration)

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)

nodeSkipped

public void nodeSkipped(JupiterEngineExecutionContext context,
                        TestDescriptor descriptor,
                        Node.SkipResult result)

Invoke TestWatcher.testDisabled(ExtensionContext, Optional) on each registered TestWatcher, in registration order.

Parameters:

context - the execution context

descriptor - the test descriptor that was skipped

result - the result of skipped execution

Since:

5.4

nodeFinished

public void nodeFinished(JupiterEngineExecutionContext context,
                         TestDescriptor descriptor,
                         TestExecutionResult result)

Invoke testSuccessful(), testAborted(), or testFailed() on each registered TestWatcher according to the status of the supplied TestExecutionResult, in reverse registration order.

Parameters:

context - the execution context

descriptor - the test descriptor that was executed

result - the result of the execution

Since:

5.4