Module org.junit.jupiter.engine

Package org.junit.jupiter.engine.descriptor

Class TestFactoryTestDescriptor

java.lang.Object

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

org.junit.jupiter.engine.descriptor.JupiterTestDescriptor

org.junit.jupiter.engine.descriptor.MethodBasedTestDescriptor

org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor

org.junit.jupiter.engine.descriptor.TestFactoryTestDescriptor

All Implemented Interfaces:

Filterable, Node<JupiterEngineExecutionContext>, TestDescriptor

@API(status=INTERNAL,
     since="5.0")
public class TestFactoryTestDescriptor
extends TestMethodTestDescriptor
implements Filterable

TestDescriptor for @TestFactory methods.

Since:

5.0

Nested Class Summary

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
static final String	DYNAMIC_CONTAINER_SEGMENT_TYPE
static final String	DYNAMIC_TEST_SEGMENT_TYPE
static final String	SEGMENT_TYPE

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

children

Constructor Summary

Constructors

Constructor	Description
TestFactoryTestDescriptor(UniqueId uniqueId, Class<?> testClass, Method testMethod, Supplier<List<Class<?>>> enclosingInstanceTypes, JupiterConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
default Stream<ExclusiveResource>	determineExclusiveResources()
default Stream<ExclusiveResource>	determineOwnExclusiveResources(Function<ResourceLocksProvider,Set<ResourceLocksProvider.Lock>> providerToLocks)
DynamicDescendantFilter	getDynamicDescendantFilter()
TestDescriptor.Type	getType()	Determine the TestDescriptor.Type of this descriptor.
protected void	invokeTestMethod(JupiterEngineExecutionContext context, Node.DynamicTestExecutor dynamicTestExecutor)
boolean	mayRegisterTests()	Determine if this descriptor may register dynamic tests during execution.
void	nodeFinished(JupiterEngineExecutionContext context, TestDescriptor descriptor, TestExecutionResult result)	Override TestMethodTestDescriptor.nodeFinished(org.junit.jupiter.engine.execution.JupiterEngineExecutionContext, org.junit.platform.engine.TestDescriptor, org.junit.platform.engine.TestExecutionResult) as a no-op, since the TestWatcher API is not supported for @TestFactory containers.
void	nodeSkipped(JupiterEngineExecutionContext context, TestDescriptor descriptor, Node.SkipResult result)	Override MethodBasedTestDescriptor.nodeSkipped(org.junit.jupiter.engine.execution.JupiterEngineExecutionContext, org.junit.platform.engine.TestDescriptor, org.junit.platform.engine.support.hierarchical.Node.SkipResult) as a no-op, since the TestWatcher API is not supported for @TestFactory containers.

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

cleanUp, execute, populateNewExtensionRegistry, prepare

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

getExclusiveResourceCollector, getExplicitExecutionMode, getLegacyReportingName, getResourceLocksProviderEvaluator, getTags, getTestClass, getTestMethod, invokeTestWatchers

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

getExclusiveResources, getExecutionMode, shouldBeSkipped, toExecutionMode

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

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

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

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

Field Details

SEGMENT_TYPE

public static final String SEGMENT_TYPE

See Also:

• Constant Field Values

DYNAMIC_CONTAINER_SEGMENT_TYPE

public static final String DYNAMIC_CONTAINER_SEGMENT_TYPE

See Also:

• Constant Field Values

DYNAMIC_TEST_SEGMENT_TYPE

public static final String DYNAMIC_TEST_SEGMENT_TYPE

See Also:

• Constant Field Values

Constructor Details

TestFactoryTestDescriptor

public TestFactoryTestDescriptor(UniqueId uniqueId,
 Class<?> testClass,
 Method testMethod,
 Supplier<List<Class<?>>> enclosingInstanceTypes,
 JupiterConfiguration configuration)

Method Details

getDynamicDescendantFilter

public DynamicDescendantFilter getDynamicDescendantFilter()

Specified by:

getDynamicDescendantFilter in interface Filterable

getType

public TestDescriptor.Type getType()

Description copied from interface: TestDescriptor

Determine the TestDescriptor.Type of this descriptor.

Specified by:

getType in interface TestDescriptor

Overrides:

getType in class TestMethodTestDescriptor

Returns:

the descriptor type; never null.

See Also:

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

mayRegisterTests

public boolean mayRegisterTests()

Description copied from interface: TestDescriptor

Determine if this descriptor may register dynamic tests during execution.

The default implementation assumes tests are usually known during discovery and thus returns false.

Specified by:

mayRegisterTests in interface TestDescriptor

invokeTestMethod

protected void invokeTestMethod(JupiterEngineExecutionContext context,
 Node.DynamicTestExecutor dynamicTestExecutor)

Overrides:

invokeTestMethod in class TestMethodTestDescriptor

nodeSkipped

public void nodeSkipped(JupiterEngineExecutionContext context,
 TestDescriptor descriptor,
 Node.SkipResult result)

Override MethodBasedTestDescriptor.nodeSkipped(org.junit.jupiter.engine.execution.JupiterEngineExecutionContext, org.junit.platform.engine.TestDescriptor, org.junit.platform.engine.support.hierarchical.Node.SkipResult) as a no-op, since the TestWatcher API is not supported for @TestFactory containers.

Specified by:

nodeSkipped in interface Node<JupiterEngineExecutionContext>

Overrides:

nodeSkipped in class MethodBasedTestDescriptor

Parameters:

context - the execution context

descriptor - the test descriptor that was skipped

result - the result of skipped execution

Since:

5.4

nodeFinished

public void nodeFinished(JupiterEngineExecutionContext context,
 TestDescriptor descriptor,
 TestExecutionResult result)

Override TestMethodTestDescriptor.nodeFinished(org.junit.jupiter.engine.execution.JupiterEngineExecutionContext, org.junit.platform.engine.TestDescriptor, org.junit.platform.engine.TestExecutionResult) as a no-op, since the TestWatcher API is not supported for @TestFactory containers.

Specified by:

nodeFinished in interface Node<JupiterEngineExecutionContext>

Overrides:

nodeFinished in class TestMethodTestDescriptor

Parameters:

context - the execution context

descriptor - the test descriptor that was executed

result - the result of the execution

Since:

5.4

determineExclusiveResources

default Stream<ExclusiveResource> determineExclusiveResources()

determineOwnExclusiveResources

default Stream<ExclusiveResource> determineOwnExclusiveResources(Function<ResourceLocksProvider,Set<ResourceLocksProvider.Lock>> providerToLocks)