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:

ResourceLockAware, TestClassAware, Validatable, Node<JupiterEngineExecutionContext>, TestDescriptor

Direct Known Subclasses:

ClassTemplateTestDescriptor, ClassTestDescriptor, NestedClassTestDescriptor

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

TestDescriptor for tests based on Java classes.

Since:

5.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ClassBasedTestDescriptor.ClassInfo
private static class	ClassBasedTestDescriptor.LifecycleMethods

Nested classes/interfaces inherited from class JupiterTestDescriptor

JupiterTestDescriptor.ExceptionHandlerInvoker<E>

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
protected final ClassBasedTestDescriptor.ClassInfo	classInfo
private static final InterceptingExecutableInvoker	executableInvoker
private ClassBasedTestDescriptor.LifecycleMethods	lifecycleMethods
private org.junit.jupiter.api.extension.TestInstanceFactory	testInstanceFactory

Fields inherited from class JupiterTestDescriptor

configuration

Fields inherited from class AbstractTestDescriptor

children

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final void	after(JupiterEngineExecutionContext context)	Execute the after behavior of this node.
final JupiterEngineExecutionContext	before(JupiterEngineExecutionContext context)	Execute the before behavior of this node.
void	cleanUp(JupiterEngineExecutionContext context)	Clean up the supplied context after execution.
private void	executeAndMaskThrowable(org.junit.jupiter.api.function.Executable executable)
protected final Optional<Node.ExecutionMode>	getDefaultChildExecutionMode()
final ExclusiveResourceCollector	getExclusiveResourceCollector()
protected final Optional<Node.ExecutionMode>	getExplicitExecutionMode()
final 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()
final TestDescriptor.Type	getType()	Determine the TestDescriptor.Type of this descriptor.
private org.junit.jupiter.api.extension.TestInstances	instantiateAndPostProcessTestInstance(JupiterEngineExecutionContext parentExecutionContext, ClassExtensionContext ourExtensionContext, ExtensionRegistry registry, JupiterEngineExecutionContext context)
protected final org.junit.jupiter.api.extension.TestInstances	instantiateTestClass(Optional<org.junit.jupiter.api.extension.TestInstances> outerInstances, ExtensionRegistry registry, ExtensionContextSupplier extensionContext)
protected abstract org.junit.jupiter.api.extension.TestInstances	instantiateTestClass(JupiterEngineExecutionContext parentExecutionContext, ExtensionContextSupplier extensionContext, ExtensionRegistry registry, JupiterEngineExecutionContext context)
private void	invokeAfterAllCallbacks(JupiterEngineExecutionContext context)
private void	invokeAfterAllMethodExecutionExceptionHandlers(ExtensionRegistry registry, org.junit.jupiter.api.extension.ExtensionContext context, Throwable throwable)
private void	invokeAfterAllMethods(JupiterEngineExecutionContext context)
private void	invokeBeforeAllCallbacks(JupiterEngineExecutionContext context)
private void	invokeBeforeAllMethodExecutionExceptionHandlers(ExtensionRegistry registry, org.junit.jupiter.api.extension.ExtensionContext context, Throwable throwable)
private void	invokeBeforeAllMethods(JupiterEngineExecutionContext context)
private void	invokeMethodInExtensionContext(Method method, org.junit.jupiter.api.extension.ExtensionContext context, ExtensionRegistry registry, InterceptingExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall interceptorCall)
private Object	invokeTestClassConstructor(Optional<Object> outerInstance, ExtensionRegistry registry, ExtensionContextSupplier extensionContext)
private Object	invokeTestInstanceFactory(Optional<Object> outerInstance, ExtensionContextSupplier extensionContext)
private void	invokeTestInstancePostProcessors(Object instance, ExtensionRegistry registry, ExtensionContextSupplier context)
private void	invokeTestInstancePreConstructCallbacks(org.junit.jupiter.api.extension.TestInstanceFactoryContext factoryContext, ExtensionRegistry registry, ExtensionContextSupplier context)
private void	invokeTestInstancePreDestroyCallbacks(JupiterEngineExecutionContext context)
private boolean	isPerClassLifecycle(JupiterEngineExecutionContext context)
final 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.
private void	registerAfterEachMethodAdapters(ExtensionRegistrar registrar)
private void	registerBeforeEachMethodAdapters(ExtensionRegistrar registrar)
private void	registerMethodsAsExtensions(List<Method> methods, ExtensionRegistrar registrar, Function<Method, org.junit.jupiter.api.extension.Extension> extensionSynthesizer)
private org.junit.jupiter.api.extension.TestInstanceFactory	resolveTestInstanceFactory(ExtensionRegistry registry)
final void	setDefaultChildExecutionMode(Node.ExecutionMode defaultChildExecutionMode)
private AfterEachMethodAdapter	synthesizeAfterEachMethodAdapter(Method method)
private BeforeEachMethodAdapter	synthesizeBeforeEachMethodAdapter(Method method)
private TestInstancesProvider	testInstancesProvider(JupiterEngineExecutionContext parentExecutionContext, ClassExtensionContext ourExtensionContext)
final void	validate(DiscoveryIssueReporter reporter)	Validate the state of this descriptor and report any issues found to the supplied DiscoveryIssueReporter.
protected void	validateClassTemplateInvocationLifecycleMethods(DiscoveryIssueReporter reporter)
protected void	validateCoreLifecycleMethods(DiscoveryIssueReporter reporter)
private void	validateDisplayNameAnnotation(DiscoveryIssueReporter reporter)
private void	validateTags(DiscoveryIssueReporter reporter)

Methods inherited from class JupiterTestDescriptor

copyIncludingDescendants, getExclusiveResources, getExecutionMode, getExecutionModeFromAnnotation, getTags, invokeExecutionExceptionHandlers, shouldBeSkipped, toExecutionMode, withUniqueId

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

around, execute, nodeFinished, nodeSkipped

Methods inherited from interface ResourceLockAware

determineExclusiveResources, determineOwnExclusiveResources, getResourceLocksProviderEvaluator

Methods inherited from interface TestClassAware

getEnclosingTestClasses

Methods inherited from interface TestDescriptor

accept, addChild, findByUniqueId, getAncestors, getChildren, getDescendants, getDisplayName, getParent, getSource, getTags, getUniqueId, isContainer, isRoot, isTest, mayRegisterTests, orderChildren, prune, removeChild, removeFromHierarchy, setParent

Field Details

executableInvoker

private static final InterceptingExecutableInvoker executableInvoker

classInfo

protected final ClassBasedTestDescriptor.ClassInfo classInfo

lifecycleMethods

private ClassBasedTestDescriptor.LifecycleMethods lifecycleMethods

testInstanceFactory

private org.junit.jupiter.api.extension.TestInstanceFactory testInstanceFactory

Constructor Details

ClassBasedTestDescriptor

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

ClassBasedTestDescriptor

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

Method Details

getTestClass

public final Class<?> getTestClass()

Specified by:

getTestClass in interface TestClassAware

getType

public final TestDescriptor.Type getType()

Description copied from interface: TestDescriptor

Determine the TestDescriptor.Type of this descriptor.

Specified by:

getType in interface TestDescriptor

Returns:

the descriptor type; never null.

See Also:

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

getLegacyReportingName

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

Specified by:

getLegacyReportingName in interface TestDescriptor

Returns:

the legacy reporting name; never null or blank

validate

public final void validate(DiscoveryIssueReporter reporter)

Description copied from interface: Validatable

Validate the state of this descriptor and report any issues found to the supplied DiscoveryIssueReporter.

Specified by:

validate in interface Validatable

validateDisplayNameAnnotation

private void validateDisplayNameAnnotation(DiscoveryIssueReporter reporter)

validateCoreLifecycleMethods

protected void validateCoreLifecycleMethods(DiscoveryIssueReporter reporter)

validateClassTemplateInvocationLifecycleMethods

protected void validateClassTemplateInvocationLifecycleMethods(DiscoveryIssueReporter reporter)

validateTags

private void validateTags(DiscoveryIssueReporter reporter)

getExplicitExecutionMode

protected final Optional<Node.ExecutionMode> getExplicitExecutionMode()

Overrides:

getExplicitExecutionMode in class JupiterTestDescriptor

getDefaultChildExecutionMode

protected final Optional<Node.ExecutionMode> getDefaultChildExecutionMode()

Overrides:

getDefaultChildExecutionMode in class JupiterTestDescriptor

setDefaultChildExecutionMode

public final void setDefaultChildExecutionMode(Node.ExecutionMode defaultChildExecutionMode)

getExclusiveResourceCollector

public final ExclusiveResourceCollector getExclusiveResourceCollector()

Specified by:

getExclusiveResourceCollector in interface ResourceLockAware

prepare

public final JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext context)

Description copied from class: JupiterTestDescriptor

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>

Specified by:

prepare in class JupiterTestDescriptor

See Also:

• Node.cleanUp(EngineExecutionContext)

before

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

Specified by:

before in interface Node<JupiterEngineExecutionContext>

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

Specified by:

after in interface Node<JupiterEngineExecutionContext>

Parameters:

context - the context to execute in

See Also:

• Node.before(C)
• Node.execute(C, Node.DynamicTestExecutor)

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>

Overrides:

cleanUp in class JupiterTestDescriptor

Parameters:

context - the context to execute in

Throws:

Exception

See Also:

• Node.prepare(EngineExecutionContext)

resolveTestInstanceFactory

private org.junit.jupiter.api.extension.TestInstanceFactory resolveTestInstanceFactory(ExtensionRegistry registry)

testInstancesProvider

private TestInstancesProvider testInstancesProvider(JupiterEngineExecutionContext parentExecutionContext,
 ClassExtensionContext ourExtensionContext)

instantiateAndPostProcessTestInstance

private org.junit.jupiter.api.extension.TestInstances instantiateAndPostProcessTestInstance(JupiterEngineExecutionContext parentExecutionContext,
 ClassExtensionContext ourExtensionContext,
 ExtensionRegistry registry,
 JupiterEngineExecutionContext context)

instantiateTestClass

protected abstract org.junit.jupiter.api.extension.TestInstances instantiateTestClass(JupiterEngineExecutionContext parentExecutionContext,
 ExtensionContextSupplier extensionContext,
 ExtensionRegistry registry,
 JupiterEngineExecutionContext context)

instantiateTestClass

protected final org.junit.jupiter.api.extension.TestInstances instantiateTestClass(Optional<org.junit.jupiter.api.extension.TestInstances> outerInstances,
 ExtensionRegistry registry,
 ExtensionContextSupplier extensionContext)

invokeTestInstanceFactory

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

invokeTestClassConstructor

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

invokeTestInstancePreConstructCallbacks

private void invokeTestInstancePreConstructCallbacks(org.junit.jupiter.api.extension.TestInstanceFactoryContext factoryContext,
 ExtensionRegistry registry,
 ExtensionContextSupplier context)

invokeTestInstancePostProcessors

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

executeAndMaskThrowable

private void executeAndMaskThrowable(org.junit.jupiter.api.function.Executable executable)

invokeBeforeAllCallbacks

private void invokeBeforeAllCallbacks(JupiterEngineExecutionContext context)

invokeBeforeAllMethods

private void invokeBeforeAllMethods(JupiterEngineExecutionContext context)

invokeBeforeAllMethodExecutionExceptionHandlers

private void invokeBeforeAllMethodExecutionExceptionHandlers(ExtensionRegistry registry,
 org.junit.jupiter.api.extension.ExtensionContext context,
 Throwable throwable)

invokeAfterAllMethods

private void invokeAfterAllMethods(JupiterEngineExecutionContext context)

invokeAfterAllMethodExecutionExceptionHandlers

private void invokeAfterAllMethodExecutionExceptionHandlers(ExtensionRegistry registry,
 org.junit.jupiter.api.extension.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, org.junit.jupiter.api.extension.Extension> extensionSynthesizer)

synthesizeBeforeEachMethodAdapter

private BeforeEachMethodAdapter synthesizeBeforeEachMethodAdapter(Method method)

synthesizeAfterEachMethodAdapter

private AfterEachMethodAdapter synthesizeAfterEachMethodAdapter(Method method)

invokeMethodInExtensionContext

private void invokeMethodInExtensionContext(Method method,
 org.junit.jupiter.api.extension.ExtensionContext context,
 ExtensionRegistry registry,
 InterceptingExecutableInvoker.ReflectiveInterceptorCall.VoidMethodInterceptorCall interceptorCall)