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, MethodBasedTestDescriptor

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

Since:

5.0

Nested Class Summary

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 inherited from class org.junit.platform.engine.support.descriptor.AbstractTestDescriptor

children

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.
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.
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(ExecutionMode mode)
protected abstract JupiterTestDescriptor	withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)	Returns shallow copy (without children) of this descriptor with the supplied unique ID.

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

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

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

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

Method Details

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

toExecutionMode

public static Node.ExecutionMode toExecutionMode(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>

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