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:

TestClassAware, Validatable, org.junit.platform.engine.support.hierarchical.Node<JupiterEngineExecutionContext>, org.junit.platform.engine.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

org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor, org.junit.platform.engine.support.hierarchical.Node.ExecutionMode, org.junit.platform.engine.support.hierarchical.Node.Invocation<C extends org.junit.platform.engine.support.hierarchical.EngineExecutionContext>, org.junit.platform.engine.support.hierarchical.Node.SkipResult

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

org.junit.platform.engine.TestDescriptor.Type, org.junit.platform.engine.TestDescriptor.Visitor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEGMENT_TYPE

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

children

Constructor Summary

Constructors

Constructor	Description
TestMethodTestDescriptor(org.junit.platform.engine.UniqueId uniqueId, Class<?> testClass, Method testMethod, Supplier<List<Class<?>>> enclosingInstanceTypes, JupiterConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	cleanUp(JupiterEngineExecutionContext context)
default Stream<org.junit.platform.engine.support.hierarchical.ExclusiveResource>	determineExclusiveResources()
default Stream<org.junit.platform.engine.support.hierarchical.ExclusiveResource>	determineOwnExclusiveResources(Function<org.junit.jupiter.api.parallel.ResourceLocksProvider,Set<org.junit.jupiter.api.parallel.ResourceLocksProvider.Lock>> providerToLocks)
JupiterEngineExecutionContext	execute(JupiterEngineExecutionContext context, org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor)
org.junit.platform.engine.TestDescriptor.Type	getType()
protected void	invokeTestMethod(JupiterEngineExecutionContext context, org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor)
void	nodeFinished(JupiterEngineExecutionContext context, org.junit.platform.engine.TestDescriptor descriptor, org.junit.platform.engine.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<org.junit.platform.engine.UniqueId> uniqueIdTransformer)	Returns shallow copy (without children) of this descriptor with the supplied unique ID.

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

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

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

copyIncludingDescendants, getExclusiveResources, getExecutionMode, shouldBeSkipped, toExecutionMode

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

addChild, equals, findByUniqueId, getChildren, getDisplayName, getParent, getSource, getUniqueId, hashCode, orderChildren, 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, 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

Constructor Details

TestMethodTestDescriptor

public TestMethodTestDescriptor(org.junit.platform.engine.UniqueId uniqueId,
 Class<?> testClass,
 Method testMethod,
 Supplier<List<Class<?>>> enclosingInstanceTypes,
 JupiterConfiguration configuration)

Method Details

withUniqueId

protected TestMethodTestDescriptor withUniqueId(UnaryOperator<org.junit.platform.engine.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 org.junit.platform.engine.TestDescriptor.Type getType()

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 org.junit.platform.engine.support.hierarchical.Node<JupiterEngineExecutionContext>

Specified by:

prepare in class JupiterTestDescriptor

prepareExtensionContext

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

populateNewExtensionRegistry

protected MutableExtensionRegistry populateNewExtensionRegistry(JupiterEngineExecutionContext context)

execute

public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext context,
 org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor)

cleanUp

public void cleanUp(JupiterEngineExecutionContext context)
             throws Exception

Specified by:

cleanUp in interface org.junit.platform.engine.support.hierarchical.Node<JupiterEngineExecutionContext>

Overrides:

cleanUp in class JupiterTestDescriptor

Throws:

Exception

invokeTestMethod

protected void invokeTestMethod(JupiterEngineExecutionContext context,
 org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor dynamicTestExecutor)

nodeFinished

public void nodeFinished(JupiterEngineExecutionContext context,
 org.junit.platform.engine.TestDescriptor descriptor,
 org.junit.platform.engine.TestExecutionResult result)

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

Since:

5.4

determineExclusiveResources

default Stream<org.junit.platform.engine.support.hierarchical.ExclusiveResource> determineExclusiveResources()

determineOwnExclusiveResources

default Stream<org.junit.platform.engine.support.hierarchical.ExclusiveResource> determineOwnExclusiveResources(Function<org.junit.jupiter.api.parallel.ResourceLocksProvider,Set<org.junit.jupiter.api.parallel.ResourceLocksProvider.Lock>> providerToLocks)