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:

Node<JupiterEngineExecutionContext>, TestDescriptor

Direct Known Subclasses:

ClassTestDescriptor, TestMethodTestDescriptor, TestTemplateTestDescriptor

@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.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 and Description
void	cleanUp(JupiterEngineExecutionContext context) Cleanup the supplied context after execution.
protected static <E extends AnnotatedElement> String	determineDisplayName(E element, Function<E,String> defaultDisplayNameGenerator)
protected void	executeAndMaskThrowable(Executable executable) Execute the supplied Executable and mask any exception thrown as an unchecked exception.
protected static Set<TestTag>	getTags(AnnotatedElement element)
abstract JupiterEngineExecutionContext	prepare(JupiterEngineExecutionContext context) Must be overridden and return a new context 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.

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

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

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

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

Method Detail

getTags

protected static Set<TestTag> getTags(AnnotatedElement element)

determineDisplayName

protected static <E extends AnnotatedElement> String determineDisplayName(E element,
                                                                          Function<E,String> defaultDisplayNameGenerator)

shouldBeSkipped

public Node.SkipResult shouldBeSkipped(JupiterEngineExecutionContext context)
                                throws Exception

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>

Throws:

Exception

prepare

public abstract JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext context)
                                               throws Exception

Must be overridden and return a new context 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

Cleanup the supplied context after execution.

The default implementation does nothing.

Specified by:

cleanUp in interface Node<JupiterEngineExecutionContext>

Throws:

Exception

See Also:

Node.prepare(EngineExecutionContext)

executeAndMaskThrowable

protected void executeAndMaskThrowable(Executable executable)

Execute the supplied Executable and mask any exception thrown as an unchecked exception.

Parameters:

executable - the Executable to execute

See Also:

ExceptionUtils.throwAsUncheckedException(Throwable)