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:

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

Direct Known Subclasses:

ClassTemplateTestDescriptor, ClassTestDescriptor, NestedClassTestDescriptor

@API(status=INTERNAL,
     since="5.5")
public abstract class ClassBasedTestDescriptor
extends JupiterTestDescriptor
implements 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

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
protected final ClassBasedTestDescriptor.ClassInfo	classInfo

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

children

Method Summary

Modifier and Type	Method	Description
final void	after(JupiterEngineExecutionContext context)
final JupiterEngineExecutionContext	before(JupiterEngineExecutionContext context)
void	cleanUp(JupiterEngineExecutionContext context)
default Stream<org.junit.platform.engine.support.hierarchical.ExclusiveResource>	determineExclusiveResources()
default Stream<org.junit.platform.engine.support.hierarchical.ExclusiveResource>	determineOwnExclusiveResources(Function<org.junit.jupiter.api.parallel.ResourceLocksProvider,Set<org.junit.jupiter.api.parallel.ResourceLocksProvider.Lock>> providerToLocks)
protected final Optional<org.junit.platform.engine.support.hierarchical.Node.ExecutionMode>	getDefaultChildExecutionMode()
final org.junit.jupiter.engine.descriptor.ExclusiveResourceCollector	getExclusiveResourceCollector()
protected final Optional<org.junit.platform.engine.support.hierarchical.Node.ExecutionMode>	getExplicitExecutionMode()
final String	getLegacyReportingName()
Function<org.junit.jupiter.api.parallel.ResourceLocksProvider,Set<org.junit.jupiter.api.parallel.ResourceLocksProvider.Lock>>	getResourceLocksProviderEvaluator()
final Class<?>	getTestClass()
final org.junit.platform.engine.TestDescriptor.Type	getType()
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)
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.
final void	setDefaultChildExecutionMode(org.junit.platform.engine.support.hierarchical.Node.ExecutionMode defaultChildExecutionMode)
final void	validate(org.junit.platform.engine.support.discovery.DiscoveryIssueReporter reporter)	Validate the state of this descriptor and report any issues found to the supplied DiscoveryIssueReporter.
protected void	validateClassTemplateInvocationLifecycleMethods(org.junit.platform.engine.support.discovery.DiscoveryIssueReporter reporter)
protected void	validateCoreLifecycleMethods(org.junit.platform.engine.support.discovery.DiscoveryIssueReporter reporter)

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

copyIncludingDescendants, getExclusiveResources, getExecutionMode, shouldBeSkipped, toExecutionMode, withUniqueId

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

around, execute, nodeFinished, nodeSkipped

Methods inherited from interface org.junit.jupiter.engine.descriptor.TestClassAware

getEnclosingTestClasses

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

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

Field Details

classInfo

protected final ClassBasedTestDescriptor.ClassInfo classInfo

Method Details

getTestClass

public final Class<?> getTestClass()

Specified by:

getTestClass in interface TestClassAware

getType

public final org.junit.platform.engine.TestDescriptor.Type getType()

Specified by:

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

getLegacyReportingName

public final String getLegacyReportingName()

Specified by:

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

validate

public final void validate(org.junit.platform.engine.support.discovery.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

validateCoreLifecycleMethods

protected void validateCoreLifecycleMethods(org.junit.platform.engine.support.discovery.DiscoveryIssueReporter reporter)

validateClassTemplateInvocationLifecycleMethods

protected void validateClassTemplateInvocationLifecycleMethods(org.junit.platform.engine.support.discovery.DiscoveryIssueReporter reporter)

getExplicitExecutionMode

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

getDefaultChildExecutionMode

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

setDefaultChildExecutionMode

public final void setDefaultChildExecutionMode(org.junit.platform.engine.support.hierarchical.Node.ExecutionMode defaultChildExecutionMode)

getExclusiveResourceCollector

public final org.junit.jupiter.engine.descriptor.ExclusiveResourceCollector getExclusiveResourceCollector()

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

Specified by:

prepare in class JupiterTestDescriptor

before

public final JupiterEngineExecutionContext before(JupiterEngineExecutionContext context)

Specified by:

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

after

public final void after(JupiterEngineExecutionContext context)

Specified by:

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

cleanUp

public void cleanUp(JupiterEngineExecutionContext context)
             throws Exception

Specified by:

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

Overrides:

cleanUp in class JupiterTestDescriptor

Throws:

Exception

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)

determineExclusiveResources

default Stream<org.junit.platform.engine.support.hierarchical.ExclusiveResource> determineExclusiveResources()

determineOwnExclusiveResources

default Stream<org.junit.platform.engine.support.hierarchical.ExclusiveResource> determineOwnExclusiveResources(Function<org.junit.jupiter.api.parallel.ResourceLocksProvider,Set<org.junit.jupiter.api.parallel.ResourceLocksProvider.Lock>> providerToLocks)

getResourceLocksProviderEvaluator

Function<org.junit.jupiter.api.parallel.ResourceLocksProvider,Set<org.junit.jupiter.api.parallel.ResourceLocksProvider.Lock>> getResourceLocksProviderEvaluator()