Class JupiterTestDescriptor

java.lang.Object

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

org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

All Implemented Interfaces:

Node<JupiterEngineExecutionContext>, TestDescriptor

Direct Known Subclasses:

ClassBasedTestDescriptor, ClassTemplateInvocationTestDescriptor, DynamicNodeTestDescriptor, MethodBasedTestDescriptor

@API(status=INTERNAL,
     since="5.0")
public abstract class JupiterTestDescriptor
extends AbstractTestDescriptor
implements Node<JupiterEngineExecutionContext>

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	JupiterTestDescriptor.ExceptionHandlerInvoker<E extends org.junit.jupiter.api.extension.Extension>

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 ConditionEvaluator	conditionEvaluator
(package private) final JupiterConfiguration	configuration

Fields inherited from class AbstractTestDescriptor

children

Constructor Summary

Constructors

Constructor	Description
JupiterTestDescriptor(UniqueId uniqueId, AnnotatedElement element, Supplier<String> displayNameSupplier, TestSource source, JupiterConfiguration configuration)
JupiterTestDescriptor(UniqueId uniqueId, String displayName, TestSource source, JupiterConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	cleanUp(JupiterEngineExecutionContext context)	Clean up the supplied context after execution.
protected JupiterTestDescriptor	copyIncludingDescendants(UnaryOperator<UniqueId> uniqueIdTransformer)	Returns a deep copy (with copies of children) of this descriptor with the supplied unique ID.
(package private) Optional<Node.ExecutionMode>	getDefaultChildExecutionMode()
Set<ExclusiveResource>	getExclusiveResources()	Get the set of exclusive resources required to execute this node.
Node.ExecutionMode	getExecutionMode()	Get the preferred of execution mode for parallel execution of this node.
(package private) Optional<Node.ExecutionMode>	getExecutionModeFromAnnotation(AnnotatedElement element)
(package private) Optional<Node.ExecutionMode>	getExplicitExecutionMode()
(package private) static Set<TestTag>	getTags(AnnotatedElement element, Supplier<String> elementDescription, Supplier<TestSource> sourceProvider, Consumer<DiscoveryIssue> issueCollector)
(package private) <E extends org.junit.jupiter.api.extension.Extension> void	invokeExecutionExceptionHandlers(Class<E> handlerType, ExtensionRegistry registry, Throwable throwable, JupiterTestDescriptor.ExceptionHandlerInvoker<E> handlerInvoker)	Invoke exception handlers for the supplied Throwable one-by-one until none are left or the throwable to handle has been swallowed.
private <E extends org.junit.jupiter.api.extension.Extension> void	invokeExecutionExceptionHandlers(List<E> exceptionHandlers, Throwable throwable, JupiterTestDescriptor.ExceptionHandlerInvoker<E> handlerInvoker)
abstract 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.
Node.SkipResult	shouldBeSkipped(JupiterEngineExecutionContext context)	Determine if the execution of the supplied context should be skipped.
static Node.ExecutionMode	toExecutionMode(org.junit.jupiter.api.parallel.ExecutionMode mode)
private Node.SkipResult	toSkipResult(org.junit.jupiter.api.extension.ConditionEvaluationResult evaluationResult)
protected abstract JupiterTestDescriptor	withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)	Returns shallow copy (without children) of this descriptor with the supplied unique ID.

Methods inherited from class AbstractTestDescriptor

addChild, equals, findByUniqueId, getChildren, getDisplayName, getParent, getSource, getTags, 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, execute, nodeFinished, nodeSkipped

Methods inherited from interface TestDescriptor

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

Field Details

conditionEvaluator

private static final ConditionEvaluator conditionEvaluator

configuration

final JupiterConfiguration configuration

Constructor Details

JupiterTestDescriptor

JupiterTestDescriptor(UniqueId uniqueId,
 AnnotatedElement element,
 Supplier<String> displayNameSupplier,
 TestSource source,
 JupiterConfiguration configuration)

JupiterTestDescriptor

JupiterTestDescriptor(UniqueId uniqueId,
 String displayName,
 TestSource source,
 JupiterConfiguration configuration)

Method Details

getTags

static Set<TestTag> getTags(AnnotatedElement element,
 Supplier<String> elementDescription,
 Supplier<TestSource> sourceProvider,
 Consumer<DiscoveryIssue> issueCollector)

invokeExecutionExceptionHandlers

<E extends org.junit.jupiter.api.extension.Extension>
void invokeExecutionExceptionHandlers(Class<E> handlerType,
 ExtensionRegistry registry,
 Throwable throwable,
 JupiterTestDescriptor.ExceptionHandlerInvoker<E> handlerInvoker)

Invoke exception handlers for the supplied Throwable one-by-one until none are left or the throwable to handle has been swallowed.

invokeExecutionExceptionHandlers

private <E extends org.junit.jupiter.api.extension.Extension>
void invokeExecutionExceptionHandlers(List<E> exceptionHandlers,
 Throwable throwable,
 JupiterTestDescriptor.ExceptionHandlerInvoker<E> handlerInvoker)

getExecutionMode

public Node.ExecutionMode getExecutionMode()

Description copied from interface: Node

Get the preferred of execution mode for parallel execution of this node.

The default implementation returns Node.ExecutionMode.CONCURRENT.

Specified by:

getExecutionMode in interface Node<JupiterEngineExecutionContext>

Returns:

the preferred execution mode of this node; never null

See Also:

• Node.ExecutionMode

getExplicitExecutionMode

Optional<Node.ExecutionMode> getExplicitExecutionMode()

getDefaultChildExecutionMode

Optional<Node.ExecutionMode> getDefaultChildExecutionMode()

getExecutionModeFromAnnotation

Optional<Node.ExecutionMode> getExecutionModeFromAnnotation(AnnotatedElement element)

toExecutionMode

public static Node.ExecutionMode toExecutionMode(org.junit.jupiter.api.parallel.ExecutionMode mode)

getExclusiveResources

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

Specified by:

getExclusiveResources in interface Node<JupiterEngineExecutionContext>

Returns:

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

See Also:

• ExclusiveResource

shouldBeSkipped

public Node.SkipResult shouldBeSkipped(JupiterEngineExecutionContext context)

Description copied from interface: Node

Determine if the execution of the supplied context should be skipped.

The default implementation returns Node.SkipResult.doNotSkip().

Specified by:

shouldBeSkipped in interface Node<JupiterEngineExecutionContext>

toSkipResult

private Node.SkipResult toSkipResult(org.junit.jupiter.api.extension.ConditionEvaluationResult evaluationResult)

prepare

public abstract JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext context)
                                               throws Exception

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>

Throws:

Exception

See Also:

• Node.cleanUp(EngineExecutionContext)

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>

Parameters:

context - the context to execute in

Throws:

Exception

See Also:

• Node.prepare(EngineExecutionContext)

copyIncludingDescendants

protected JupiterTestDescriptor copyIncludingDescendants(UnaryOperator<UniqueId> uniqueIdTransformer)

Returns a deep copy (with copies of children) of this descriptor with the supplied unique ID.

Returns:

a deep copy (with copies of children) of this descriptor with the supplied unique ID

withUniqueId

protected abstract JupiterTestDescriptor withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)

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

Returns:

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