Uses of Interface
org.junit.platform.engine.TestDescriptor
Package
Description
Core package for the JUnit Jupiter test engine.
Test descriptors used within the JUnit Jupiter test engine.
Public API for test engines.
TestDescriptor
-related support classes
intended to be used by test engine implementations and clients of
the launcher.Configurable test discovery implementation that can be reused by different test engines.
Support classes and base implementation for any
TestEngine
that wishes to organize test suites
hierarchically based on the
Node
abstraction.Public API for configuring and launching test plans.
Core support classes for the
Launcher
including the LauncherFactory
and the LauncherDiscoveryRequestBuilder
.Core package for the JUnit Platform Suite test engine.
Test Kit for testing the execution of a
TestEngine
running on the JUnit Platform.Core package for the JUnit Vintage test engine.
Test descriptors used within the JUnit Vintage test engine.
-
Uses of TestDescriptor in org.junit.jupiter.engine
Modifier and TypeMethodDescriptionJupiterTestEngine.discover
(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) -
Uses of TestDescriptor in org.junit.jupiter.engine.descriptor
Modifier and TypeClassDescriptionclass
TestDescriptor
for tests based on Java classes.class
TestDescriptor
for tests based on Java classes.class
class
class
Base class forTestDescriptors
based on Java methods.class
TestDescriptor
for tests based on nested (but not static) Java classes.class
TestDescriptor
for@TestFactory
methods.class
TestDescriptor
for@Test
methods.class
TestDescriptor
for a@TestTemplate
invocation.class
TestDescriptor
for@TestTemplate
methods.Modifier and TypeMethodDescriptionvoid
TestFactoryTestDescriptor.nodeFinished
(JupiterEngineExecutionContext context, TestDescriptor descriptor, TestExecutionResult result) OverrideTestMethodTestDescriptor.nodeFinished(org.junit.jupiter.engine.execution.JupiterEngineExecutionContext, org.junit.platform.engine.TestDescriptor, org.junit.platform.engine.TestExecutionResult)
as a no-op, since theTestWatcher
API is not supported for@TestFactory
containers.void
TestMethodTestDescriptor.nodeFinished
(JupiterEngineExecutionContext context, TestDescriptor descriptor, TestExecutionResult result) InvoketestSuccessful()
,testAborted()
, ortestFailed()
on each registeredTestWatcher
according to the status of the suppliedTestExecutionResult
, in reverse registration order.void
MethodBasedTestDescriptor.nodeSkipped
(JupiterEngineExecutionContext context, TestDescriptor descriptor, Node.SkipResult result) InvokeTestWatcher.testDisabled(ExtensionContext, Optional)
on each registeredTestWatcher
, in registration order.void
TestFactoryTestDescriptor.nodeSkipped
(JupiterEngineExecutionContext context, TestDescriptor descriptor, Node.SkipResult result) OverrideMethodBasedTestDescriptor.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 theTestWatcher
API is not supported for@TestFactory
containers. -
Uses of TestDescriptor in org.junit.platform.engine
Modifier and TypeMethodDescriptionTestEngine.discover
(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) Discover tests according to the suppliedEngineDiscoveryRequest
.ExecutionRequest.getRootTestDescriptor()
Get the rootTestDescriptor
of the engine that processes this request.Modifier and TypeMethodDescriptionOptional
<? extends TestDescriptor> TestDescriptor.findByUniqueId
(UniqueId uniqueId) Find the descriptor with the supplied unique ID.default Set
<? extends TestDescriptor> TestDescriptor.getAncestors()
Get the immutable set of all ancestors of this descriptor.Set
<? extends TestDescriptor> TestDescriptor.getChildren()
Get the immutable set of children of this descriptor.default Set
<? extends TestDescriptor> TestDescriptor.getDescendants()
Get the immutable set of all descendants of this descriptor.TestDescriptor.getParent()
Get the parent of this descriptor, if available.Modifier and TypeMethodDescriptionvoid
TestDescriptor.addChild
(TestDescriptor descriptor) Add a child to this descriptor.static boolean
TestDescriptor.containsTests
(TestDescriptor testDescriptor) Determine if the supplied descriptor (or any of its descendants) is a test or may potentially register tests dynamically.static ExecutionRequest
ExecutionRequest.create
(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters) Factory for creating an execution request.default void
EngineExecutionListener.dynamicTestRegistered
(TestDescriptor testDescriptor) Must be called when a new, dynamicTestDescriptor
has been registered.default void
EngineExecutionListener.executionFinished
(TestDescriptor testDescriptor, TestExecutionResult testExecutionResult) Must be called when the execution of a leaf or subtree of the test tree has finished, regardless of the outcome.default void
EngineExecutionListener.executionSkipped
(TestDescriptor testDescriptor, String reason) Must be called when the execution of a leaf or subtree of the test tree has been skipped.default void
EngineExecutionListener.executionStarted
(TestDescriptor testDescriptor) Must be called when the execution of a leaf or subtree of the test tree is about to be started.void
TestDescriptor.removeChild
(TestDescriptor descriptor) Remove a child from this descriptor.default void
EngineExecutionListener.reportingEntryPublished
(TestDescriptor testDescriptor, ReportEntry entry) Can be called for anyTestDescriptor
in order to publish additional information to the reporting infrastructure — for example: Output that would otherwise go toSystem.out
Information about test context or test datavoid
TestDescriptor.setParent
(TestDescriptor parent) Set the parent of this descriptor.void
TestDescriptor.Visitor.visit
(TestDescriptor descriptor) Visit aTestDescriptor
.ModifierConstructorDescriptionExecutionRequest
(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters) -
Uses of TestDescriptor in org.junit.platform.engine.support.descriptor
Modifier and TypeClassDescriptionclass
Abstract base implementation ofTestDescriptor
that may be used by customTestEngines
.class
Modifier and TypeFieldDescriptionprotected final Set
<TestDescriptor> AbstractTestDescriptor.children
The synchronized set of children associated with thisTestDescriptor
.Modifier and TypeMethodDescriptionOptional
<? extends TestDescriptor> AbstractTestDescriptor.findByUniqueId
(UniqueId uniqueId) final Set
<? extends TestDescriptor> AbstractTestDescriptor.getChildren()
final Optional
<TestDescriptor> AbstractTestDescriptor.getParent()
Modifier and TypeMethodDescriptionvoid
AbstractTestDescriptor.addChild
(TestDescriptor child) void
AbstractTestDescriptor.removeChild
(TestDescriptor child) final void
AbstractTestDescriptor.setParent
(TestDescriptor parent) -
Uses of TestDescriptor in org.junit.platform.engine.support.discovery
Modifier and TypeClassDescriptionclass
EngineDiscoveryRequestResolver<T extends TestDescriptor>
Configurable test discovery implementation based onSelectorResolver
andTestDescriptor.Visitor
that can be reused by differentTestEngines
.static class
Builder forEngineDiscoveryRequestResolver
.static interface
The initialization context for creating resolvers and visitors that depend on theEngineDiscoveryRequest
to be resolved or the engine descriptor that will be used to collect the results.Modifier and TypeMethodDescription<T extends TestDescriptor>
Optional<T> SelectorResolver.Context.addToParent
(Function<TestDescriptor, Optional<T>> creator) Add aTestDescriptor
to an unspecified parent, usually the engine descriptor, by applying the suppliedFunction
to the new parent.<T extends TestDescriptor>
Optional<T> SelectorResolver.Context.addToParent
(Supplier<DiscoverySelector> parentSelectorSupplier, Function<TestDescriptor, Optional<T>> creator) Add aTestDescriptor
to a parent, specified by theDiscoverySelector
returned by the suppliedSupplier
, by applying the suppliedFunction
to the new parent.static <T extends TestDescriptor>
EngineDiscoveryRequestResolver.Builder<T> EngineDiscoveryRequestResolver.builder()
Create a newEngineDiscoveryRequestResolver.Builder
for creating aEngineDiscoveryRequestResolver
.Modifier and TypeMethodDescriptionSelectorResolver.Match.getTestDescriptor()
Get the containedTestDescriptor
.Modifier and TypeMethodDescriptionSelectorResolver.Context.resolve
(DiscoverySelector selector) Resolve the suppliedTestDescriptor
, if possible.Modifier and TypeMethodDescriptionstatic SelectorResolver.Match
SelectorResolver.Match.exact
(TestDescriptor testDescriptor) Factory for creating an exact match without any children.static SelectorResolver.Match
SelectorResolver.Match.exact
(TestDescriptor testDescriptor, Supplier<Set<? extends DiscoverySelector>> childSelectorsSupplier) Factory for creating an exact match with potential children.static SelectorResolver.Match
SelectorResolver.Match.partial
(TestDescriptor testDescriptor) Factory for creating a partial match without any children.static SelectorResolver.Match
SelectorResolver.Match.partial
(TestDescriptor testDescriptor, Supplier<Set<? extends DiscoverySelector>> childSelectorsSupplier) Factory for creating a partial match with potential children.Modifier and TypeMethodDescription<T extends TestDescriptor>
Optional<T> SelectorResolver.Context.addToParent
(Function<TestDescriptor, Optional<T>> creator) Add aTestDescriptor
to an unspecified parent, usually the engine descriptor, by applying the suppliedFunction
to the new parent.<T extends TestDescriptor>
Optional<T> SelectorResolver.Context.addToParent
(Supplier<DiscoverySelector> parentSelectorSupplier, Function<TestDescriptor, Optional<T>> creator) Add aTestDescriptor
to a parent, specified by theDiscoverySelector
returned by the suppliedSupplier
, by applying the suppliedFunction
to the new parent. -
Uses of TestDescriptor in org.junit.platform.engine.support.hierarchical
Modifier and TypeMethodDescriptionvoid
Node.DynamicTestExecutor.execute
(TestDescriptor testDescriptor) Submit a dynamic test descriptor for immediate execution.Future
<?> Node.DynamicTestExecutor.execute
(TestDescriptor testDescriptor, EngineExecutionListener executionListener) Submit a dynamic test descriptor for immediate execution with a custom, potentially no-op, execution listener.default void
Node.nodeFinished
(C context, TestDescriptor testDescriptor, TestExecutionResult result) Callback invoked when the execution of this node has finished.default void
Node.nodeSkipped
(C context, TestDescriptor testDescriptor, Node.SkipResult result) Callback invoked when the execution of this node has been skipped. -
Uses of TestDescriptor in org.junit.platform.launcher
Modifier and TypeMethodDescriptionstatic TestIdentifier
TestIdentifier.from
(TestDescriptor testDescriptor) Factory for creating a newTestIdentifier
from aTestDescriptor
.Modifier and TypeMethodDescriptionstatic TestPlan
TestPlan.from
(Collection<TestDescriptor> engineDescriptors, ConfigurationParameters configurationParameters) Construct a newTestPlan
from the supplied collection ofTestDescriptors
. -
Uses of TestDescriptor in org.junit.platform.launcher.core
Modifier and TypeMethodDescriptionLauncherDiscoveryResult.getEngineTestDescriptor
(TestEngine testEngine) Modifier and TypeMethodDescriptionLauncherDiscoveryResult.withRetainedEngines
(Predicate<? super TestDescriptor> predicate) -
Uses of TestDescriptor in org.junit.platform.suite.engine
Modifier and TypeMethodDescriptionSuiteTestEngine.discover
(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) -
Uses of TestDescriptor in org.junit.platform.testkit.engine
Modifier and TypeMethodDescriptionEvent.getTestDescriptor()
Get theTestDescriptor
associated with thisEvent
.Execution.getTestDescriptor()
Get theTestDescriptor
for thisExecution
.Modifier and TypeMethodDescriptionstatic Event
Event.dynamicTestRegistered
(TestDescriptor testDescriptor) Create anEvent
for the dynamic registration of the suppliedTestDescriptor
.void
ExecutionRecorder.dynamicTestRegistered
(TestDescriptor testDescriptor) Record anEvent
for a dynamically registered container or test.static Event
Event.executionFinished
(TestDescriptor testDescriptor, TestExecutionResult result) void
ExecutionRecorder.executionFinished
(TestDescriptor testDescriptor, TestExecutionResult testExecutionResult) Record anEvent
for a container or test that completed with the providedTestExecutionResult
.static Event
Event.executionSkipped
(TestDescriptor testDescriptor, String reason) void
ExecutionRecorder.executionSkipped
(TestDescriptor testDescriptor, String reason) Record anEvent
for a container or test that was skipped.static Event
Event.executionStarted
(TestDescriptor testDescriptor) Create a startedEvent
for the suppliedTestDescriptor
.void
ExecutionRecorder.executionStarted
(TestDescriptor testDescriptor) Record anEvent
for a container or test that started.static Execution
Execution.finished
(TestDescriptor testDescriptor, Instant startInstant, Instant endInstant, TestExecutionResult executionResult) Create a new instance of anExecution
that finished with the providedTestExecutionResult
.static Event
Event.reportingEntryPublished
(TestDescriptor testDescriptor, ReportEntry entry) void
ExecutionRecorder.reportingEntryPublished
(TestDescriptor testDescriptor, ReportEntry entry) Record anEvent
for a publishedReportEntry
.static Execution
Execution.skipped
(TestDescriptor testDescriptor, Instant startInstant, Instant endInstant, String skipReason) Create a new instance of anExecution
that was skipped with the providedskipReason
.Modifier and TypeMethodDescriptionEvent.byTestDescriptor
(Predicate<? super TestDescriptor> testDescriptorPredicate) -
Uses of TestDescriptor in org.junit.vintage.engine
Modifier and TypeMethodDescriptionVintageTestEngine.discover
(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) -
Uses of TestDescriptor in org.junit.vintage.engine.descriptor
Modifier and TypeClassDescriptionclass
class
class