org.junit.jupiter.engine.descriptor

Class MethodBasedTestDescriptor

java.lang.Object

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

org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

org.junit.jupiter.engine.descriptor.MethodBasedTestDescriptor

All Implemented Interfaces:

Node<JupiterEngineExecutionContext>, TestDescriptor

Direct Known Subclasses:

TestMethodTestDescriptor, TestTemplateTestDescriptor

@API(status=INTERNAL,
     since="5.0")
public abstract class MethodBasedTestDescriptor
extends JupiterTestDescriptor

Base class for TestDescriptors based on Java methods.

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from class org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

JupiterTestDescriptor.ExceptionHandlerInvoker<E extends Extension>

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

Modifier and Type	Field and Description
private static Logger	logger
private java.util.Set<TestTag>	tags Set of method-level tags; does not contain tags from parent.
private java.lang.Class<?>	testClass
private java.lang.reflect.Method	testMethod

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 and Description
MethodBasedTestDescriptor(UniqueId uniqueId, java.lang.Class<?> testClass, java.lang.reflect.Method testMethod, JupiterConfiguration configuration)
MethodBasedTestDescriptor(UniqueId uniqueId, java.lang.String displayName, java.lang.Class<?> testClass, java.lang.reflect.Method testMethod, JupiterConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
java.util.Set<ExclusiveResource>	getExclusiveResources() Get the set of exclusive resources required to execute this node.
protected java.util.Optional<Node.ExecutionMode>	getExplicitExecutionMode()
java.lang.String	getLegacyReportingName() Get the name of this descriptor in a format that is suitable for legacy reporting infrastructure — for example, for reporting systems built on the Ant-based XML reporting format for JUnit 4.
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	invokeTestWatchers(JupiterEngineExecutionContext context, boolean reverseOrder, java.util.function.Consumer<TestWatcher> callback)
void	nodeSkipped(JupiterEngineExecutionContext context, TestDescriptor descriptor, Node.SkipResult result) Invoke TestWatcher.testDisabled(ExtensionContext, Optional) on each registered TestWatcher, in registration order.

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

cleanUp, getDefaultChildExecutionMode, getExclusiveResourcesFromAnnotation, getExecutionMode, getExecutionModeFromAnnotation, getTags, invokeExecutionExceptionHandlers, prepare, 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, execute, nodeFinished

Methods inherited from interface org.junit.platform.engine.TestDescriptor

accept, containsTests, getAncestors, getDescendants, getType, isContainer, isRoot, isTest, mayRegisterTests, prune

Field Detail

logger

private static final Logger logger

testClass

private final java.lang.Class<?> testClass

testMethod

private final java.lang.reflect.Method testMethod

tags

private final java.util.Set<TestTag> tags

Set of method-level tags; does not contain tags from parent.

Constructor Detail

MethodBasedTestDescriptor

MethodBasedTestDescriptor(UniqueId uniqueId,
                          java.lang.Class<?> testClass,
                          java.lang.reflect.Method testMethod,
                          JupiterConfiguration configuration)

MethodBasedTestDescriptor

MethodBasedTestDescriptor(UniqueId uniqueId,
                          java.lang.String displayName,
                          java.lang.Class<?> testClass,
                          java.lang.reflect.Method testMethod,
                          JupiterConfiguration configuration)

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

getExclusiveResources

public java.util.Set<ExclusiveResource> getExclusiveResources()

Description copied from interface: Node

Get the set of exclusive resources required to execute this node.

The default implementation returns an empty set.

Returns:

the set of exclusive resources required by this node; never null but potentially empty

See Also:

ExclusiveResource

getExplicitExecutionMode

protected java.util.Optional<Node.ExecutionMode> getExplicitExecutionMode()

Overrides:

getExplicitExecutionMode in class JupiterTestDescriptor

getTestClass

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

getTestMethod

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

getLegacyReportingName

public java.lang.String getLegacyReportingName()

Description copied from interface: TestDescriptor

Get the name of this descriptor in a format that is suitable for legacy reporting infrastructure — for example, for reporting systems built on the Ant-based XML reporting format for JUnit 4.

The default implementation delegates to TestDescriptor.getDisplayName().

Returns:

the legacy reporting name; never null or blank

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

invokeTestWatchers

protected void invokeTestWatchers(JupiterEngineExecutionContext context,
                                  boolean reverseOrder,
                                  java.util.function.Consumer<TestWatcher> callback)

Since:

5.4