Package org.junit.jupiter.engine.descriptor

Class JupiterTestDescriptor

java.lang.Object

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

org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

All Implemented Interfaces:

org.junit.platform.engine.support.hierarchical.Node<JupiterEngineExecutionContext>, org.junit.platform.engine.TestDescriptor

Direct Known Subclasses:

ClassBasedTestDescriptor, ClassTemplateInvocationTestDescriptor, DynamicNodeTestDescriptor, MethodBasedTestDescriptor

@API(status=INTERNAL,
     since="5.0")
public abstract class JupiterTestDescriptor
extends org.junit.platform.engine.support.descriptor.AbstractTestDescriptor
implements org.junit.platform.engine.support.hierarchical.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 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
private static final ConditionEvaluator	conditionEvaluator
(package private) final JupiterConfiguration	configuration

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

children

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private IntStream	asStream(OptionalInt optInt)
void	cleanUp(JupiterEngineExecutionContext context)
protected JupiterTestDescriptor	copyIncludingDescendants(UnaryOperator<org.junit.platform.engine.UniqueId> uniqueIdTransformer)	Returns a deep copy (with copies of children) of this descriptor with the supplied unique ID.
(package private) Optional<org.junit.platform.engine.support.hierarchical.Node.ExecutionMode>	getDefaultChildExecutionMode()
Set<org.junit.platform.engine.support.hierarchical.ExclusiveResource>	getExclusiveResources()
org.junit.platform.engine.support.hierarchical.Node.ExecutionMode	getExecutionMode()
(package private) Optional<org.junit.platform.engine.support.hierarchical.Node.ExecutionMode>	getExecutionModeFromAnnotation(AnnotatedElement element)
(package private) Optional<org.junit.platform.engine.support.hierarchical.Node.ExecutionMode>	getExplicitExecutionMode()
protected String	getLegacyReportingBaseName()
protected OptionalInt	getLegacyReportingIndex()
private IntStream	getLegacyReportingIndexes()
final String	getLegacyReportingName()
(package private) static Set<org.junit.platform.engine.TestTag>	getTags(AnnotatedElement element, Supplier<String> elementDescription, Supplier<org.junit.platform.engine.TestSource> sourceProvider, Consumer<org.junit.platform.engine.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.
org.junit.platform.engine.support.hierarchical.Node.SkipResult	shouldBeSkipped(JupiterEngineExecutionContext context)
static org.junit.platform.engine.support.hierarchical.Node.ExecutionMode	toExecutionMode(org.junit.jupiter.api.parallel.ExecutionMode mode)
private org.junit.platform.engine.support.hierarchical.Node.SkipResult	toSkipResult(org.junit.jupiter.api.extension.ConditionEvaluationResult evaluationResult)
protected abstract JupiterTestDescriptor	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.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, getType, isContainer, isRoot, isTest, mayRegisterTests, prune

Field Details

conditionEvaluator

private static final ConditionEvaluator conditionEvaluator

configuration

final JupiterConfiguration configuration

Constructor Details

JupiterTestDescriptor

JupiterTestDescriptor(org.junit.platform.engine.UniqueId uniqueId,
 AnnotatedElement element,
 Supplier<String> displayNameSupplier,
 org.junit.platform.engine.TestSource source,
 JupiterConfiguration configuration)

JupiterTestDescriptor

JupiterTestDescriptor(org.junit.platform.engine.UniqueId uniqueId,
 String displayName,
 org.junit.platform.engine.TestSource source,
 JupiterConfiguration configuration)

Method Details

getLegacyReportingName

public final String getLegacyReportingName()

Specified by:

getLegacyReportingName in interface org.junit.platform.engine.TestDescriptor

getLegacyReportingBaseName

protected String getLegacyReportingBaseName()

getLegacyReportingIndexes

private IntStream getLegacyReportingIndexes()

asStream

private IntStream asStream(OptionalInt optInt)

getLegacyReportingIndex

protected OptionalInt getLegacyReportingIndex()

getTags

static Set<org.junit.platform.engine.TestTag> getTags(AnnotatedElement element,
 Supplier<String> elementDescription,
 Supplier<org.junit.platform.engine.TestSource> sourceProvider,
 Consumer<org.junit.platform.engine.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 org.junit.platform.engine.support.hierarchical.Node.ExecutionMode getExecutionMode()

Specified by:

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

getExplicitExecutionMode

Optional<org.junit.platform.engine.support.hierarchical.Node.ExecutionMode> getExplicitExecutionMode()

getDefaultChildExecutionMode

Optional<org.junit.platform.engine.support.hierarchical.Node.ExecutionMode> getDefaultChildExecutionMode()

getExecutionModeFromAnnotation

Optional<org.junit.platform.engine.support.hierarchical.Node.ExecutionMode> getExecutionModeFromAnnotation(AnnotatedElement element)

toExecutionMode

public static org.junit.platform.engine.support.hierarchical.Node.ExecutionMode toExecutionMode(org.junit.jupiter.api.parallel.ExecutionMode mode)

getExclusiveResources

public Set<org.junit.platform.engine.support.hierarchical.ExclusiveResource> getExclusiveResources()

Specified by:

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

shouldBeSkipped

public org.junit.platform.engine.support.hierarchical.Node.SkipResult shouldBeSkipped(JupiterEngineExecutionContext context)

Specified by:

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

toSkipResult

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

Throws:

Exception

cleanUp

public void cleanUp(JupiterEngineExecutionContext context)
             throws Exception

Specified by:

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

Throws:

Exception

copyIncludingDescendants

protected JupiterTestDescriptor copyIncludingDescendants(UnaryOperator<org.junit.platform.engine.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<org.junit.platform.engine.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