Package org.junit.jupiter.engine.descriptor

Class ClassBasedTestDescriptor

java.lang.Object

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

org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

org.junit.jupiter.engine.descriptor.ClassBasedTestDescriptor

All Implemented Interfaces:

Node<JupiterEngineExecutionContext>, TestDescriptor

Direct Known Subclasses:

ClassTestDescriptor, NestedClassTestDescriptor

@API(status=INTERNAL,
     since="5.5")
public abstract class ClassBasedTestDescriptor
extends JupiterTestDescriptor

TestDescriptor for tests based on Java classes.

Since:

5.5

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	Description
private List<Method>	afterAllMethods
private List<Method>	beforeAllMethods
private Node.ExecutionMode	defaultChildExecutionMode
private static final ExecutableInvoker	executableInvoker
protected final TestInstance.Lifecycle	lifecycle
protected final Set<TestTag>	tags
private final Class<?>	testClass
private TestInstanceFactory	testInstanceFactory

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	Description
ClassBasedTestDescriptor(UniqueId uniqueId, Class<?> testClass, Supplier<String> displayNameSupplier, JupiterConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	after(JupiterEngineExecutionContext context)	Execute the after behavior of this node.
JupiterEngineExecutionContext	before(JupiterEngineExecutionContext context)	Execute the before behavior of this node.
private void	executeAndMaskThrowable(Executable executable)
protected Optional<Node.ExecutionMode>	getDefaultChildExecutionMode()
abstract List<Class<?>>	getEnclosingTestClasses()
Set<ExclusiveResource>	getExclusiveResources()	Get the set of exclusive resources required to execute this node.
protected Optional<Node.ExecutionMode>	getExplicitExecutionMode()
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.
final Class<?>	getTestClass()
TestDescriptor.Type	getType()	Determine the TestDescriptor.Type of this descriptor.
private TestInstances	instantiateAndPostProcessTestInstance(JupiterEngineExecutionContext parentExecutionContext, ExtensionContext extensionContext, ExtensionRegistry registry, ExtensionRegistrar registrar, ThrowableCollector throwableCollector)
protected TestInstances	instantiateTestClass(Optional<TestInstances> outerInstances, ExtensionRegistry registry, ExtensionContext extensionContext)
protected abstract TestInstances	instantiateTestClass(JupiterEngineExecutionContext parentExecutionContext, ExtensionRegistry registry, ExtensionRegistrar registrar, ExtensionContext extensionContext, ThrowableCollector throwableCollector)
private void	invokeAfterAllCallbacks(JupiterEngineExecutionContext context)
private void	invokeAfterAllMethodExecutionExceptionHandlers(ExtensionRegistry registry, ExtensionContext context, Throwable throwable)
private void	invokeAfterAllMethods(JupiterEngineExecutionContext context)
private void	invokeBeforeAllCallbacks(JupiterEngineExecutionContext context)
private void	invokeBeforeAllMethodExecutionExceptionHandlers(ExtensionRegistry registry, ExtensionContext context, Throwable throwable)
private void	invokeBeforeAllMethods(JupiterEngineExecutionContext context)
private void	invokeMethodInExtensionContext(Method method, ExtensionContext context, ExtensionRegistry registry, ExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall interceptorCall)
private Object	invokeTestClassConstructor(Optional<Object> outerInstance, ExtensionRegistry registry, ExtensionContext extensionContext)
private Object	invokeTestInstanceFactory(Optional<Object> outerInstance, ExtensionContext extensionContext)
private void	invokeTestInstancePostProcessors(Object instance, ExtensionRegistry registry, ExtensionContext context)
private void	invokeTestInstancePreDestroyCallbacks(JupiterEngineExecutionContext context)
private boolean	isPerClassLifecycle(JupiterEngineExecutionContext context)
JupiterEngineExecutionContext	prepare(JupiterEngineExecutionContext context)	Must be overridden and return a new context so cleanUp() does not accidentally close the parent context.
private void	registerAfterEachMethodAdapters(ExtensionRegistrar registrar)
private void	registerBeforeEachMethodAdapters(ExtensionRegistrar registrar)
private void	registerMethodsAsExtensions(List<Method> methods, ExtensionRegistrar registrar, Function<Method,Extension> extensionSynthesizer)
private TestInstanceFactory	resolveTestInstanceFactory(ExtensionRegistry registry)
void	setDefaultChildExecutionMode(Node.ExecutionMode defaultChildExecutionMode)
private AfterEachMethodAdapter	synthesizeAfterEachMethodAdapter(Method method)
private BeforeEachMethodAdapter	synthesizeBeforeEachMethodAdapter(Method method)
private TestInstancesProvider	testInstancesProvider(JupiterEngineExecutionContext parentExecutionContext, ClassExtensionContext extensionContext)

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

cleanUp, getExclusiveResourcesFromAnnotation, getExecutionMode, getExecutionModeFromAnnotation, getTags, invokeExecutionExceptionHandlers, shouldBeSkipped, toExecutionMode

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

around, execute, nodeFinished, nodeSkipped

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

accept, getDescendants, isContainer, isRoot, isTest, mayRegisterTests, prune

Field Details

executableInvoker

private static final ExecutableInvoker executableInvoker

testClass

private final Class<?> testClass

tags

protected final Set<TestTag> tags

lifecycle

protected final TestInstance.Lifecycle lifecycle

defaultChildExecutionMode

private Node.ExecutionMode defaultChildExecutionMode

testInstanceFactory

private TestInstanceFactory testInstanceFactory

beforeAllMethods

private List<Method> beforeAllMethods

afterAllMethods

private List<Method> afterAllMethods

Constructor Details

ClassBasedTestDescriptor

ClassBasedTestDescriptor(UniqueId uniqueId,
 Class<?> testClass,
 Supplier<String> displayNameSupplier,
 JupiterConfiguration configuration)

Method Details

getTestClass

public final Class<?> getTestClass()

getEnclosingTestClasses

public abstract List<Class<?>> getEnclosingTestClasses()

getType

public TestDescriptor.Type getType()

Description copied from interface: TestDescriptor

Determine the TestDescriptor.Type of this descriptor.

Returns:

the descriptor type; never null.

See Also:

• TestDescriptor.isContainer()
• TestDescriptor.isTest()

getLegacyReportingName

public 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 simply delegates to TestDescriptor.getDisplayName().

Returns:

the legacy reporting name; never null or blank

getExplicitExecutionMode

protected Optional<Node.ExecutionMode> getExplicitExecutionMode()

Overrides:

getExplicitExecutionMode in class JupiterTestDescriptor

getDefaultChildExecutionMode

protected Optional<Node.ExecutionMode> getDefaultChildExecutionMode()

Overrides:

getDefaultChildExecutionMode in class JupiterTestDescriptor

setDefaultChildExecutionMode

public void setDefaultChildExecutionMode(Node.ExecutionMode defaultChildExecutionMode)

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.

Returns:

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

See Also:

• ExclusiveResource

prepare

public JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext context)

Description copied from class: JupiterTestDescriptor

Must be overridden and return a new context so cleanUp() does not accidentally close the parent context.

Specified by:

prepare in interface Node<JupiterEngineExecutionContext>

Specified by:

prepare in class JupiterTestDescriptor

See Also:

• Node.cleanUp(EngineExecutionContext)

before

public JupiterEngineExecutionContext before(JupiterEngineExecutionContext context)

Description copied from interface: Node

Execute the before behavior of this node.

This method will be called once before execution of this node.

The default implementation returns the supplied context unmodified.

Parameters:

context - the context to execute in

Returns:

the new context to be used for children of this node; never null

See Also:

• Node.execute(EngineExecutionContext, DynamicTestExecutor)
• Node.after(EngineExecutionContext)

after

public void after(JupiterEngineExecutionContext context)

Description copied from interface: Node

Execute the after behavior of this node.

This method will be called once after execution of this node.

The default implementation does nothing.

Parameters:

context - the context to execute in

See Also:

• Node.before(C)
• Node.execute(C, org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor)

resolveTestInstanceFactory

private TestInstanceFactory resolveTestInstanceFactory(ExtensionRegistry registry)

testInstancesProvider

private TestInstancesProvider testInstancesProvider(JupiterEngineExecutionContext parentExecutionContext,
 ClassExtensionContext extensionContext)

instantiateAndPostProcessTestInstance

private TestInstances instantiateAndPostProcessTestInstance(JupiterEngineExecutionContext parentExecutionContext,
 ExtensionContext extensionContext,
 ExtensionRegistry registry,
 ExtensionRegistrar registrar,
 ThrowableCollector throwableCollector)

instantiateTestClass

protected abstract TestInstances instantiateTestClass(JupiterEngineExecutionContext parentExecutionContext,
 ExtensionRegistry registry,
 ExtensionRegistrar registrar,
 ExtensionContext extensionContext,
 ThrowableCollector throwableCollector)

instantiateTestClass

protected TestInstances instantiateTestClass(Optional<TestInstances> outerInstances,
 ExtensionRegistry registry,
 ExtensionContext extensionContext)

invokeTestInstanceFactory

private Object invokeTestInstanceFactory(Optional<Object> outerInstance,
 ExtensionContext extensionContext)

invokeTestClassConstructor

private Object invokeTestClassConstructor(Optional<Object> outerInstance,
 ExtensionRegistry registry,
 ExtensionContext extensionContext)

invokeTestInstancePostProcessors

private void invokeTestInstancePostProcessors(Object instance,
 ExtensionRegistry registry,
 ExtensionContext context)

executeAndMaskThrowable

private void executeAndMaskThrowable(Executable executable)

invokeBeforeAllCallbacks

private void invokeBeforeAllCallbacks(JupiterEngineExecutionContext context)

invokeBeforeAllMethods

private void invokeBeforeAllMethods(JupiterEngineExecutionContext context)

invokeBeforeAllMethodExecutionExceptionHandlers

private void invokeBeforeAllMethodExecutionExceptionHandlers(ExtensionRegistry registry,
 ExtensionContext context,
 Throwable throwable)

invokeAfterAllMethods

private void invokeAfterAllMethods(JupiterEngineExecutionContext context)

invokeAfterAllMethodExecutionExceptionHandlers

private void invokeAfterAllMethodExecutionExceptionHandlers(ExtensionRegistry registry,
 ExtensionContext context,
 Throwable throwable)

invokeAfterAllCallbacks

private void invokeAfterAllCallbacks(JupiterEngineExecutionContext context)

invokeTestInstancePreDestroyCallbacks

private void invokeTestInstancePreDestroyCallbacks(JupiterEngineExecutionContext context)

isPerClassLifecycle

private boolean isPerClassLifecycle(JupiterEngineExecutionContext context)

registerBeforeEachMethodAdapters

private void registerBeforeEachMethodAdapters(ExtensionRegistrar registrar)

registerAfterEachMethodAdapters

private void registerAfterEachMethodAdapters(ExtensionRegistrar registrar)

registerMethodsAsExtensions

private void registerMethodsAsExtensions(List<Method> methods,
 ExtensionRegistrar registrar,
 Function<Method,Extension> extensionSynthesizer)

synthesizeBeforeEachMethodAdapter

private BeforeEachMethodAdapter synthesizeBeforeEachMethodAdapter(Method method)

synthesizeAfterEachMethodAdapter

private AfterEachMethodAdapter synthesizeAfterEachMethodAdapter(Method method)

invokeMethodInExtensionContext

private void invokeMethodInExtensionContext(Method method,
 ExtensionContext context,
 ExtensionRegistry registry,
 ExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall interceptorCall)