Top Description Fields Constructors Methods
org.junit.jupiter.engine.descriptor

public Class TestMethodTestDescriptor

extends MethodBasedTestDescriptor
Class Inheritance
Known Direct Subclasses
org.junit.jupiter.engine.descriptor.TestTemplateInvocationTestDescriptor, org.junit.jupiter.engine.descriptor.TestFactoryTestDescriptor
Annotations
@API
status:INTERNAL
since:5.0
Static Imports
org.apiguardian.api.API.Status.INTERNAL, org.junit.jupiter.engine.descriptor.CallbackSupport.invokeAfterCallbacks, .CallbackSupport.invokeBeforeCallbacks, .ExtensionUtils.populateNewExtensionRegistryFromExtendWithAnnotation, .ExtensionUtils.registerExtensionsFromExecutableParameters, org.junit.jupiter.engine.support.JupiterThrowableCollectorFactory.createThrowableCollector
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

Field Summary

Modifier and TypeField and Description
private static final InterceptingExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall
defaultInterceptorCall

private static final InterceptingExecutableInvoker
executableInvoker

private final InterceptingExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall
interceptorCall

public static final String
SEGMENT_TYPE

Constructor Summary

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

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

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

Method Summary

Modifier and TypeMethod and Description
public void
cleanUp(JupiterEngineExecutionContext context)

Overrides org.junit.jupiter.engine.descriptor.JupiterTestDescriptor.cleanUp.

Overrides default org.junit.platform.engine.support.hierarchical.Node.cleanUp.

Clean up the supplied context after execution.

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

Overrides default org.junit.platform.engine.support.hierarchical.Node.execute.

Execute the behavior of this node.

public TestDescriptor.Type
getType()

Implements org.junit.platform.engine.TestDescriptor.getType.

Determine the Type of this descriptor.

private void
invokeAfterEachCallbacks(JupiterEngineExecutionContext context)

private void
invokeAfterEachExecutionExceptionHandlers(ExtensionContext context, ExtensionRegistry registry, Throwable throwable)

private void
invokeAfterEachMethods(JupiterEngineExecutionContext context)

private void
invokeAfterTestExecutionCallbacks(JupiterEngineExecutionContext context)

private void
invokeBeforeEachCallbacks(JupiterEngineExecutionContext context)

private void
invokeBeforeEachExecutionExceptionHandlers(ExtensionContext context, ExtensionRegistry registry, Throwable throwable)

private void
invokeBeforeEachMethods(JupiterEngineExecutionContext context)

private void
invokeBeforeTestExecutionCallbacks(JupiterEngineExecutionContext context)

private void
invokeTestExecutionExceptionHandlers(ExtensionRegistry registry, ExtensionContext context, Throwable throwable)

private void
invokeTestInstancePreDestroyCallbacks(JupiterEngineExecutionContext context)

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

private boolean
isPerMethodLifecycle(JupiterEngineExecutionContext context)

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

Overrides default org.junit.platform.engine.support.hierarchical.Node.nodeFinished.

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)

public JupiterEngineExecutionContext
prepare(JupiterEngineExecutionContext context)

Overrides default org.junit.platform.engine.support.hierarchical.Node.prepare.

Implements abstract org.junit.jupiter.engine.descriptor.JupiterTestDescriptor.prepare.

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

protected void
prepareExtensionContext(ExtensionContext extensionContext)

protected TestMethodTestDescriptor
withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)

Implements abstract org.junit.jupiter.engine.descriptor.JupiterTestDescriptor.withUniqueId.

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

Inherited from org.junit.jupiter.engine.descriptor.MethodBasedTestDescriptor:
getEnclosingTestClassesgetExclusiveResourceCollectorgetExplicitExecutionModegetLegacyReportingNamegetResourceLocksProviderEvaluatorgetTagsgetTestClassgetTestMethodinvokeTestWatchersnodeSkippedvalidate

Field Detail

defaultInterceptorCallback to summary
private static final InterceptingExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall defaultInterceptorCall
executableInvokerback to summary
private static final InterceptingExecutableInvoker executableInvoker
interceptorCallback to summary
private final InterceptingExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall interceptorCall
SEGMENT_TYPEback to summary
public static final String SEGMENT_TYPE

Constructor Detail

TestMethodTestDescriptorback to summary
public TestMethodTestDescriptor(UniqueId uniqueId, Class<?> testClass, Method testMethod, Supplier<List<Class<?>>> enclosingInstanceTypes, JupiterConfiguration configuration)
TestMethodTestDescriptorback to summary
pack-priv TestMethodTestDescriptor(UniqueId uniqueId, String displayName, Class<?> testClass, Method testMethod, JupiterConfiguration configuration)
TestMethodTestDescriptorback to summary
pack-priv TestMethodTestDescriptor(UniqueId uniqueId, String displayName, Class<?> testClass, Method testMethod, JupiterConfiguration configuration, InterceptingExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall interceptorCall)

Method Detail

cleanUpback to summary
public void cleanUp(JupiterEngineExecutionContext context) throws Exception

Overrides org.junit.jupiter.engine.descriptor.JupiterTestDescriptor.cleanUp.

Overrides default org.junit.platform.engine.support.hierarchical.Node.cleanUp.

Doc from org.junit.platform.engine.support.hierarchical.Node.cleanUp.

Clean up the supplied context after execution.

The default implementation does nothing.

Annotations
@Override
executeback to summary
public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)

Overrides default org.junit.platform.engine.support.hierarchical.Node.execute.

Doc from org.junit.platform.engine.support.hierarchical.Node.execute.

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.

Annotations
@Override
getTypeback to summary
public TestDescriptor.Type getType()

Implements org.junit.platform.engine.TestDescriptor.getType.

Doc from org.junit.platform.engine.TestDescriptor.getType.

Determine the Type of this descriptor.

Annotations
@Override
invokeAfterEachCallbacksback to summary
private void invokeAfterEachCallbacks(JupiterEngineExecutionContext context)
invokeAfterEachExecutionExceptionHandlersback to summary
private void invokeAfterEachExecutionExceptionHandlers(ExtensionContext context, ExtensionRegistry registry, Throwable throwable)
invokeAfterEachMethodsback to summary
private void invokeAfterEachMethods(JupiterEngineExecutionContext context)
invokeAfterTestExecutionCallbacksback to summary
private void invokeAfterTestExecutionCallbacks(JupiterEngineExecutionContext context)
invokeBeforeEachCallbacksback to summary
private void invokeBeforeEachCallbacks(JupiterEngineExecutionContext context)
invokeBeforeEachExecutionExceptionHandlersback to summary
private void invokeBeforeEachExecutionExceptionHandlers(ExtensionContext context, ExtensionRegistry registry, Throwable throwable)
invokeBeforeEachMethodsback to summary
private void invokeBeforeEachMethods(JupiterEngineExecutionContext context)
invokeBeforeTestExecutionCallbacksback to summary
private void invokeBeforeTestExecutionCallbacks(JupiterEngineExecutionContext context)
invokeTestExecutionExceptionHandlersback to summary
private void invokeTestExecutionExceptionHandlers(ExtensionRegistry registry, ExtensionContext context, Throwable throwable)
invokeTestInstancePreDestroyCallbacksback to summary
private void invokeTestInstancePreDestroyCallbacks(JupiterEngineExecutionContext context)
invokeTestMethodback to summary
protected void invokeTestMethod(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)
isPerMethodLifecycleback to summary
private boolean isPerMethodLifecycle(JupiterEngineExecutionContext context)
nodeFinishedback to summary
public void nodeFinished(JupiterEngineExecutionContext context, TestDescriptor descriptor, TestExecutionResult result)

Overrides default org.junit.platform.engine.support.hierarchical.Node.nodeFinished.

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

Annotations
@Override
Since
5.4
populateNewExtensionRegistryback to summary
protected MutableExtensionRegistry populateNewExtensionRegistry(JupiterEngineExecutionContext context)
prepareback to summary
public JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext context)

Overrides default org.junit.platform.engine.support.hierarchical.Node.prepare.

Implements abstract org.junit.jupiter.engine.descriptor.JupiterTestDescriptor.prepare.

Doc from org.junit.jupiter.engine.descriptor.JupiterTestDescriptor.prepare.

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

Annotations
@Override
prepareExtensionContextback to summary
protected void prepareExtensionContext(ExtensionContext extensionContext)
withUniqueIdback to summary
protected TestMethodTestDescriptor withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)

Implements abstract org.junit.jupiter.engine.descriptor.JupiterTestDescriptor.withUniqueId.

Doc from org.junit.jupiter.engine.descriptor.JupiterTestDescriptor.withUniqueId.

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

Annotations
@Override