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:

ResourceLockAware, TestClassAware, Validatable, 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 class JupiterTestDescriptor

JupiterTestDescriptor.ExceptionHandlerInvoker<E>

Nested classes/interfaces inherited from interface Node

Node.DynamicTestExecutor, Node.ExecutionMode, Node.Invocation<C>, Node.SkipResult

Nested classes/interfaces inherited from interface TestDescriptor

TestDescriptor.Type, TestDescriptor.Visitor

Field Summary

Fields

Modifier and Type	Field	Description
private static final InterceptingExecutableInvoker.ReflectiveInterceptorCall<Method,Void>	defaultInterceptorCall
private static final InterceptingExecutableInvoker	executableInvoker
private final InterceptingExecutableInvoker.ReflectiveInterceptorCall<Method,Void>	interceptorCall
static final String	SEGMENT_TYPE

Fields inherited from class JupiterTestDescriptor

configuration

Fields inherited from class AbstractTestDescriptor

children

Constructor Summary

Constructors

Constructor	Description
TestMethodTestDescriptor(UniqueId uniqueId, Class<?> testClass, Method testMethod, Supplier<List<Class<?>>> enclosingInstanceTypes, JupiterConfiguration configuration)
TestMethodTestDescriptor(UniqueId uniqueId, String displayName, Class<?> testClass, Method testMethod, JupiterConfiguration configuration)
TestMethodTestDescriptor(UniqueId uniqueId, String displayName, Class<?> testClass, Method testMethod, JupiterConfiguration configuration, InterceptingExecutableInvoker.ReflectiveInterceptorCall<Method,Void> interceptorCall)

Method Summary

Modifier and Type	Method	Description
void	cleanUp(JupiterEngineExecutionContext context)	Clean up the supplied context after execution.
JupiterEngineExecutionContext	execute(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)	Execute the behavior of this node.
TestDescriptor.Type	getType()	Determine the TestDescriptor.Type of this descriptor.
private void	invokeAfterEachCallbacks(JupiterEngineExecutionContext context)
private void	invokeAfterEachExecutionExceptionHandlers(org.junit.jupiter.api.extension.ExtensionContext context, ExtensionRegistry registry, Throwable throwable)
private void	invokeAfterEachMethods(JupiterEngineExecutionContext context)
private void	invokeAfterTestExecutionCallbacks(JupiterEngineExecutionContext context)
private void	invokeBeforeEachCallbacks(JupiterEngineExecutionContext context)
private void	invokeBeforeEachExecutionExceptionHandlers(org.junit.jupiter.api.extension.ExtensionContext context, ExtensionRegistry registry, Throwable throwable)
private void	invokeBeforeEachMethods(JupiterEngineExecutionContext context)
private void	invokeBeforeTestExecutionCallbacks(JupiterEngineExecutionContext context)
private void	invokeTestExecutionExceptionHandlers(ExtensionRegistry registry, org.junit.jupiter.api.extension.ExtensionContext context, Throwable throwable)
private void	invokeTestInstancePreDestroyCallbacks(JupiterEngineExecutionContext context)
protected void	invokeTestMethod(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)
private boolean	isPerMethodLifecycle(JupiterEngineExecutionContext context)
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.
protected MutableExtensionRegistry	populateNewExtensionRegistry(JupiterEngineExecutionContext context)
JupiterEngineExecutionContext	prepare(JupiterEngineExecutionContext context)	Must be overridden and return a new context with a new ExtensionContext so cleanUp() does not accidentally close the parent context.
protected void	prepareExtensionContext(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
protected TestMethodTestDescriptor	withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)	Returns shallow copy (without children) of this descriptor with the supplied unique ID.

Methods inherited from class MethodBasedTestDescriptor

getEnclosingTestClasses, getExclusiveResourceCollector, getExplicitExecutionMode, getLegacyReportingName, getResourceLocksProviderEvaluator, getTags, getTestClass, getTestMethod, invokeTestWatchers, nodeSkipped, validate

Methods inherited from class JupiterTestDescriptor

copyIncludingDescendants, getDefaultChildExecutionMode, getExclusiveResources, getExecutionMode, getExecutionModeFromAnnotation, getTags, invokeExecutionExceptionHandlers, shouldBeSkipped, toExecutionMode

Methods inherited from class AbstractTestDescriptor

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

Methods inherited from class Object

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

Methods inherited from interface Node

after, around, before

Methods inherited from interface ResourceLockAware

determineExclusiveResources, determineOwnExclusiveResources

Methods inherited from interface TestDescriptor

accept, addChild, findByUniqueId, getAncestors, getChildren, getDescendants, getDisplayName, getParent, getSource, getUniqueId, isContainer, isRoot, isTest, mayRegisterTests, orderChildren, prune, removeChild, removeFromHierarchy, setParent

Field Details

SEGMENT_TYPE

public static final String SEGMENT_TYPE

See Also:

• Constant Field Values

executableInvoker

private static final InterceptingExecutableInvoker executableInvoker

defaultInterceptorCall

private static final InterceptingExecutableInvoker.ReflectiveInterceptorCall<Method,Void> defaultInterceptorCall

interceptorCall

private final InterceptingExecutableInvoker.ReflectiveInterceptorCall<Method,Void> interceptorCall

Constructor Details

TestMethodTestDescriptor

public TestMethodTestDescriptor(UniqueId uniqueId,
 Class<?> testClass,
 Method testMethod,
 Supplier<List<Class<?>>> enclosingInstanceTypes,
 JupiterConfiguration configuration)

TestMethodTestDescriptor

TestMethodTestDescriptor(UniqueId uniqueId,
 String displayName,
 Class<?> testClass,
 Method testMethod,
 JupiterConfiguration configuration)

TestMethodTestDescriptor

TestMethodTestDescriptor(UniqueId uniqueId,
 String displayName,
 Class<?> testClass,
 Method testMethod,
 JupiterConfiguration configuration,
 InterceptingExecutableInvoker.ReflectiveInterceptorCall<Method,Void> interceptorCall)

Method Details

withUniqueId

protected TestMethodTestDescriptor withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)

Description copied from class: JupiterTestDescriptor

Returns shallow copy (without children) of this descriptor with the supplied unique ID.

Specified by:

withUniqueId in class JupiterTestDescriptor

Returns:

shallow copy (without children) of this descriptor with the supplied unique ID

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)

Description copied from class: JupiterTestDescriptor

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

Specified by:

prepare in interface Node<JupiterEngineExecutionContext>

Specified by:

prepare in class JupiterTestDescriptor

See Also:

• Node.cleanUp(EngineExecutionContext)

prepareExtensionContext

protected void prepareExtensionContext(org.junit.jupiter.api.extension.ExtensionContext extensionContext)

populateNewExtensionRegistry

protected MutableExtensionRegistry populateNewExtensionRegistry(JupiterEngineExecutionContext context)

execute

public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext context,
 Node.DynamicTestExecutor dynamicTestExecutor)

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

See Also:

• Node.before(C)
• Node.after(C)

cleanUp

public void cleanUp(JupiterEngineExecutionContext context)
             throws Exception

Description copied from interface: Node

Clean up the supplied context after execution.

The default implementation does nothing.

Specified by:

cleanUp in interface Node<JupiterEngineExecutionContext>

Overrides:

cleanUp in class JupiterTestDescriptor

Parameters:

context - the context to execute in

Throws:

Exception

See Also:

• Node.prepare(EngineExecutionContext)

isPerMethodLifecycle

private boolean isPerMethodLifecycle(JupiterEngineExecutionContext context)

invokeBeforeEachCallbacks

private void invokeBeforeEachCallbacks(JupiterEngineExecutionContext context)

invokeBeforeEachMethods

private void invokeBeforeEachMethods(JupiterEngineExecutionContext context)

invokeBeforeEachExecutionExceptionHandlers

private void invokeBeforeEachExecutionExceptionHandlers(org.junit.jupiter.api.extension.ExtensionContext context,
 ExtensionRegistry registry,
 Throwable throwable)

invokeBeforeTestExecutionCallbacks

private void invokeBeforeTestExecutionCallbacks(JupiterEngineExecutionContext context)

invokeTestMethod

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

invokeTestExecutionExceptionHandlers

private void invokeTestExecutionExceptionHandlers(ExtensionRegistry registry,
 org.junit.jupiter.api.extension.ExtensionContext context,
 Throwable throwable)

invokeAfterTestExecutionCallbacks

private void invokeAfterTestExecutionCallbacks(JupiterEngineExecutionContext context)

invokeAfterEachMethods

private void invokeAfterEachMethods(JupiterEngineExecutionContext context)

invokeAfterEachExecutionExceptionHandlers

private void invokeAfterEachExecutionExceptionHandlers(org.junit.jupiter.api.extension.ExtensionContext context,
 ExtensionRegistry registry,
 Throwable throwable)

invokeAfterEachCallbacks

private void invokeAfterEachCallbacks(JupiterEngineExecutionContext context)

invokeTestInstancePreDestroyCallbacks

private void invokeTestInstancePreDestroyCallbacks(JupiterEngineExecutionContext context)

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