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, ResourceLockAware, TestClassAware, Validatable, 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 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
static final String	DYNAMIC_CONTAINER_SEGMENT_TYPE
static final String	DYNAMIC_TEST_SEGMENT_TYPE
private final DynamicDescendantFilter	dynamicDescendantFilter
private static final InterceptingExecutableInvoker	executableInvoker
private static final InterceptingExecutableInvoker.ReflectiveInterceptorCall<Method,Object>	interceptorCall
static final String	SEGMENT_TYPE

Fields inherited from class JupiterTestDescriptor

configuration

Fields inherited from class AbstractTestDescriptor

children

Constructor Summary

Constructors

Modifier	Constructor	Description
	TestFactoryTestDescriptor(UniqueId uniqueId, Class<?> testClass, Method testMethod, Supplier<List<Class<?>>> enclosingInstanceTypes, JupiterConfiguration configuration)
private	TestFactoryTestDescriptor(UniqueId uniqueId, String displayName, Class<?> testClass, Method testMethod, JupiterConfiguration configuration, DynamicDescendantFilter dynamicDescendantFilter)

Method Summary

Modifier and Type	Method	Description
(package private) static Optional<JupiterTestDescriptor>	createDynamicDescriptor(JupiterTestDescriptor parent, org.junit.jupiter.api.DynamicNode node, int index, TestSource defaultTestSource, DynamicDescendantFilter dynamicDescendantFilter, JupiterConfiguration configuration)
(package private) static TestSource	fromUri(URI uri)
DynamicDescendantFilter	getDynamicDescendantFilter()
TestDescriptor.Type	getType()	Determine the TestDescriptor.Type of this descriptor.
private org.junit.platform.commons.JUnitException	invalidReturnTypeException(Throwable cause)
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(JupiterEngineExecutionContext, TestDescriptor, 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(JupiterEngineExecutionContext, TestDescriptor, Node.SkipResult) as a no-op, since the TestWatcher API is not supported for @TestFactory containers.
private Stream<org.junit.jupiter.api.DynamicNode>	toDynamicNodeStream(Object testFactoryMethodResult)
protected TestFactoryTestDescriptor	withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)	Returns shallow copy (without children) of this descriptor with the supplied unique ID.

Methods inherited from class TestMethodTestDescriptor

cleanUp, execute, populateNewExtensionRegistry, prepare, prepareExtensionContext

Methods inherited from class MethodBasedTestDescriptor

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

Methods inherited from class JupiterTestDescriptor

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

Methods inherited from class AbstractTestDescriptor

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

after, around, before

Methods inherited from interface ResourceLockAware

determineExclusiveResources, determineOwnExclusiveResources

Methods inherited from interface 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

interceptorCall

private static final InterceptingExecutableInvoker.ReflectiveInterceptorCall<Method,Object> interceptorCall

executableInvoker

private static final InterceptingExecutableInvoker executableInvoker

dynamicDescendantFilter

private final DynamicDescendantFilter dynamicDescendantFilter

Constructor Details

TestFactoryTestDescriptor

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

TestFactoryTestDescriptor

private TestFactoryTestDescriptor(UniqueId uniqueId,
 String displayName,
 Class<?> testClass,
 Method testMethod,
 JupiterConfiguration configuration,
 DynamicDescendantFilter dynamicDescendantFilter)

Method Details

withUniqueId

protected TestFactoryTestDescriptor withUniqueId(UnaryOperator<UniqueId> uniqueIdTransformer)

Description copied from class: JupiterTestDescriptor

Returns shallow copy (without children) of this descriptor with the supplied unique ID.

Overrides:

withUniqueId in class TestMethodTestDescriptor

Returns:

shallow copy (without children) of this descriptor with the supplied unique ID

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

toDynamicNodeStream

private Stream<org.junit.jupiter.api.DynamicNode> toDynamicNodeStream(Object testFactoryMethodResult)

invalidReturnTypeException

private org.junit.platform.commons.JUnitException invalidReturnTypeException(Throwable cause)

createDynamicDescriptor

static Optional<JupiterTestDescriptor> createDynamicDescriptor(JupiterTestDescriptor parent,
 org.junit.jupiter.api.DynamicNode node,
 int index,
 TestSource defaultTestSource,
 DynamicDescendantFilter dynamicDescendantFilter,
 JupiterConfiguration configuration)

fromUri

static TestSource fromUri(URI uri)

Since:

5.3

nodeSkipped

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

Override MethodBasedTestDescriptor.nodeSkipped(JupiterEngineExecutionContext, TestDescriptor, 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(JupiterEngineExecutionContext, TestDescriptor, 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