Uses of Interface
org.junit.platform.engine.TestDescriptor
Packages that use 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.
Classes used by test engines to report additional data to execution
listeners.
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
Methods in org.junit.jupiter.engine that return TestDescriptorModifier and TypeMethodDescriptionJupiterTestEngine.discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) -
Uses of TestDescriptor in org.junit.jupiter.engine.descriptor
Classes in org.junit.jupiter.engine.descriptor that implement TestDescriptorModifier and TypeClassDescriptionclassTestDescriptorfor tests based on Java classes.classclassclassTestDescriptorfor tests based on Java classes.classclassclassBase class forTestDescriptorsbased on Java methods.classTestDescriptorfor tests based on nested (but not static) Java classes.classTestDescriptorfor@TestFactorymethods.classTestDescriptorfor@Testmethods.classTestDescriptorfor a@TestTemplateinvocation.classTestDescriptorfor@TestTemplatemethods.Methods in org.junit.jupiter.engine.descriptor with parameters of type TestDescriptorModifier and TypeMethodDescriptionNestedClassTestDescriptor.getEnclosingTestClasses(@Nullable TestDescriptor parent) voidTestFactoryTestDescriptor.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 theTestWatcherAPI is not supported for@TestFactorycontainers.voidTestMethodTestDescriptor.nodeFinished(JupiterEngineExecutionContext context, TestDescriptor descriptor, TestExecutionResult result) InvoketestSuccessful(),testAborted(), ortestFailed()on each registeredTestWatcheraccording to the status of the suppliedTestExecutionResult, in reverse registration order.voidMethodBasedTestDescriptor.nodeSkipped(JupiterEngineExecutionContext context, TestDescriptor descriptor, Node.SkipResult result) InvokeTestWatcher.testDisabled(ExtensionContext, Optional)on each registeredTestWatcher, in registration order.voidTestFactoryTestDescriptor.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 theTestWatcherAPI is not supported for@TestFactorycontainers. -
Uses of TestDescriptor in org.junit.platform.engine
Methods in org.junit.platform.engine that return TestDescriptorModifier and TypeMethodDescriptionTestEngine.discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) Discover tests according to the suppliedEngineDiscoveryRequest.ExecutionRequest.getRootTestDescriptor()Returns the rootTestDescriptorof the engine that processes this request.Methods in org.junit.platform.engine that return types with arguments of type TestDescriptorModifier 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.Methods in org.junit.platform.engine with parameters of type TestDescriptorModifier and TypeMethodDescriptionvoidTestDescriptor.addChild(TestDescriptor descriptor) Add a child to this descriptor.static booleanTestDescriptor.containsTests(TestDescriptor testDescriptor) Determine if the supplied descriptor (or any of its descendants) is a test or may potentially register tests dynamically.static ExecutionRequestExecutionRequest.create(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters) Deprecated.without replacementstatic ExecutionRequestExecutionRequest.create(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters, OutputDirectoryProvider outputDirectoryProvider, NamespacedHierarchicalStore<Namespace> requestLevelStore, CancellationToken cancellationToken) Factory for creating an execution request.default voidEngineExecutionListener.dynamicTestRegistered(TestDescriptor testDescriptor) Must be called when a new, dynamicTestDescriptorhas been registered.default voidEngineExecutionListener.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 voidEngineExecutionListener.executionSkipped(TestDescriptor testDescriptor, String reason) Must be called when the execution of a leaf or subtree of the test tree has been skipped.default voidEngineExecutionListener.executionStarted(TestDescriptor testDescriptor) Must be called when the execution of a leaf or subtree of the test tree is about to be started.default voidEngineExecutionListener.fileEntryPublished(TestDescriptor testDescriptor, FileEntry file) Can be called for anyTestDescriptorin order to attach a file to a test or container — for example: Screenshots Logs Output files written by the code under testvoidTestDescriptor.removeChild(TestDescriptor descriptor) Remove a child from this descriptor.default voidEngineExecutionListener.reportingEntryPublished(TestDescriptor testDescriptor, ReportEntry entry) Can be called for anyTestDescriptorin order to publish additional information to the reporting infrastructure — for example: Output that would otherwise go toSystem.outInformation about test context or test datavoidTestDescriptor.setParent(@Nullable TestDescriptor parent) Set the parent of this descriptor.voidTestDescriptor.Visitor.visit(TestDescriptor descriptor) Visit aTestDescriptor.Method parameters in org.junit.platform.engine with type arguments of type TestDescriptorModifier and TypeMethodDescriptiondefault voidTestDescriptor.orderChildren(UnaryOperator<List<TestDescriptor>> orderer) Order the children of this descriptor.Constructors in org.junit.platform.engine with parameters of type TestDescriptorModifierConstructorDescriptionExecutionRequest(TestDescriptor rootTestDescriptor, EngineExecutionListener engineExecutionListener, ConfigurationParameters configurationParameters) Deprecated. -
Uses of TestDescriptor in org.junit.platform.engine.reporting
Methods in org.junit.platform.engine.reporting with parameters of type TestDescriptorModifier and TypeMethodDescriptionOutputDirectoryProvider.createOutputDirectory(TestDescriptor testDescriptor) Create an output directory for the supplied test descriptor. -
Uses of TestDescriptor in org.junit.platform.engine.support.descriptor
Classes in org.junit.platform.engine.support.descriptor that implement TestDescriptorModifier and TypeClassDescriptionclassAbstract base implementation ofTestDescriptorthat may be used by customTestEngines.classFields in org.junit.platform.engine.support.descriptor with type parameters of type TestDescriptorModifier and TypeFieldDescriptionprotected final Set<TestDescriptor> AbstractTestDescriptor.childrenThe synchronized set of children associated with thisTestDescriptor.Methods in org.junit.platform.engine.support.descriptor that return types with arguments of type TestDescriptorModifier and TypeMethodDescriptionOptional<? extends TestDescriptor> AbstractTestDescriptor.findByUniqueId(UniqueId uniqueId) final Set<? extends TestDescriptor> AbstractTestDescriptor.getChildren()final Optional<TestDescriptor> AbstractTestDescriptor.getParent()Methods in org.junit.platform.engine.support.descriptor with parameters of type TestDescriptorModifier and TypeMethodDescriptionvoidAbstractTestDescriptor.addChild(TestDescriptor child) voidAbstractTestDescriptor.removeChild(TestDescriptor child) final voidAbstractTestDescriptor.setParent(@Nullable TestDescriptor parent) Method parameters in org.junit.platform.engine.support.descriptor with type arguments of type TestDescriptorModifier and TypeMethodDescriptionvoidAbstractTestDescriptor.orderChildren(UnaryOperator<List<TestDescriptor>> orderer) Order the children of this descriptor. -
Uses of TestDescriptor in org.junit.platform.engine.support.discovery
Classes in org.junit.platform.engine.support.discovery with type parameters of type TestDescriptorModifier and TypeClassDescriptionclassEngineDiscoveryRequestResolver<T extends TestDescriptor>Configurable test discovery implementation based onSelectorResolverandTestDescriptor.Visitorthat can be reused by differentTestEngines.static classBuilder forEngineDiscoveryRequestResolver.static interfaceThe initialization context for creating resolvers and visitors that depend on theEngineDiscoveryRequestto be resolved or the engine descriptor that will be used to collect the results.Methods in org.junit.platform.engine.support.discovery with type parameters of type TestDescriptorModifier and TypeMethodDescription<T extends TestDescriptor>
Optional<T> SelectorResolver.Context.addToParent(Function<TestDescriptor, Optional<T>> creator) Add aTestDescriptorto an unspecified parent, usually the engine descriptor, by applying the suppliedFunctionto the new parent.<T extends TestDescriptor>
Optional<T> SelectorResolver.Context.addToParent(Supplier<DiscoverySelector> parentSelectorSupplier, Function<TestDescriptor, Optional<T>> creator) Add aTestDescriptorto a parent, specified by theDiscoverySelectorreturned by the suppliedSupplier, by applying the suppliedFunctionto the new parent.static <T extends TestDescriptor>
EngineDiscoveryRequestResolver.Builder<T> EngineDiscoveryRequestResolver.builder()Create a newEngineDiscoveryRequestResolver.Builderfor creating aEngineDiscoveryRequestResolver.Methods in org.junit.platform.engine.support.discovery that return TestDescriptorModifier and TypeMethodDescriptionSelectorResolver.Match.getTestDescriptor()Get the containedTestDescriptor.Methods in org.junit.platform.engine.support.discovery that return types with arguments of type TestDescriptorModifier and TypeMethodDescriptionSelectorResolver.Context.resolve(DiscoverySelector selector) Resolve the suppliedTestDescriptor, if possible.Methods in org.junit.platform.engine.support.discovery with parameters of type TestDescriptorModifier and TypeMethodDescriptionstatic SelectorResolver.MatchSelectorResolver.Match.exact(TestDescriptor testDescriptor) Factory for creating an exact match without any children.static SelectorResolver.MatchSelectorResolver.Match.exact(TestDescriptor testDescriptor, Supplier<Set<? extends DiscoverySelector>> childSelectorsSupplier) Factory for creating an exact match with potential children.static SelectorResolver.MatchSelectorResolver.Match.partial(TestDescriptor testDescriptor) Factory for creating a partial match without any children.static SelectorResolver.MatchSelectorResolver.Match.partial(TestDescriptor testDescriptor, Supplier<Set<? extends DiscoverySelector>> childSelectorsSupplier) Factory for creating a partial match with potential children.Method parameters in org.junit.platform.engine.support.discovery with type arguments of type TestDescriptorModifier and TypeMethodDescription<T extends TestDescriptor>
Optional<T> SelectorResolver.Context.addToParent(Function<TestDescriptor, Optional<T>> creator) Add aTestDescriptorto an unspecified parent, usually the engine descriptor, by applying the suppliedFunctionto the new parent.<T extends TestDescriptor>
Optional<T> SelectorResolver.Context.addToParent(Supplier<DiscoverySelector> parentSelectorSupplier, Function<TestDescriptor, Optional<T>> creator) Add aTestDescriptorto a parent, specified by theDiscoverySelectorreturned by the suppliedSupplier, by applying the suppliedFunctionto the new parent. -
Uses of TestDescriptor in org.junit.platform.engine.support.hierarchical
Methods in org.junit.platform.engine.support.hierarchical that return TestDescriptorModifier and TypeMethodDescriptiondefault TestDescriptorHierarchicalTestExecutorService.TestTask.getTestDescriptor()Get the test descriptor of this task.Methods in org.junit.platform.engine.support.hierarchical with parameters of type TestDescriptorModifier and TypeMethodDescriptionvoidNode.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 voidNode.nodeFinished(C context, TestDescriptor testDescriptor, TestExecutionResult result) Callback invoked when the execution of this node has finished.default voidNode.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
Subinterfaces with type arguments of type TestDescriptor in org.junit.platform.launcherModifier and TypeInterfaceDescriptioninterfaceAPostDiscoveryFilteris applied toTestDescriptorsafter test discovery.Methods in org.junit.platform.launcher with parameters of type TestDescriptorModifier and TypeMethodDescriptionstatic TestIdentifierTestIdentifier.from(TestDescriptor testDescriptor) Factory for creating a newTestIdentifierfrom aTestDescriptor.Method parameters in org.junit.platform.launcher with type arguments of type TestDescriptorModifier and TypeMethodDescriptionstatic TestPlanTestPlan.from(boolean containsTests, Collection<TestDescriptor> engineDescriptors, ConfigurationParameters configurationParameters, OutputDirectoryProvider outputDirectoryProvider) Construct a newTestPlanfrom the supplied collection ofTestDescriptors. -
Uses of TestDescriptor in org.junit.platform.launcher.core
Methods in org.junit.platform.launcher.core that return TestDescriptorModifier and TypeMethodDescriptionLauncherDiscoveryResult.getEngineTestDescriptor(TestEngine testEngine) Method parameters in org.junit.platform.launcher.core with type arguments of type TestDescriptorModifier and TypeMethodDescriptionLauncherDiscoveryResult.withRetainedEngines(Predicate<? super TestDescriptor> predicate) -
Uses of TestDescriptor in org.junit.platform.suite.engine
Methods in org.junit.platform.suite.engine that return TestDescriptorModifier and TypeMethodDescriptionSuiteTestEngine.discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) -
Uses of TestDescriptor in org.junit.platform.testkit.engine
Methods in org.junit.platform.testkit.engine that return TestDescriptorModifier and TypeMethodDescriptionEngineDiscoveryResults.getEngineDescriptor()Returns the rootTestDescriptorof the engine.Event.getTestDescriptor()Get theTestDescriptorassociated with thisEvent.Execution.getTestDescriptor()Get theTestDescriptorfor thisExecution.Methods in org.junit.platform.testkit.engine with parameters of type TestDescriptorModifier and TypeMethodDescriptionstatic EventEvent.dynamicTestRegistered(TestDescriptor testDescriptor) Create anEventfor the dynamic registration of the suppliedTestDescriptor.voidExecutionRecorder.dynamicTestRegistered(TestDescriptor testDescriptor) Record anEventfor a dynamically registered container or test.static EventEvent.executionFinished(TestDescriptor testDescriptor, TestExecutionResult result) voidExecutionRecorder.executionFinished(TestDescriptor testDescriptor, TestExecutionResult testExecutionResult) Record anEventfor a container or test that completed with the providedTestExecutionResult.static EventEvent.executionSkipped(TestDescriptor testDescriptor, @Nullable String reason) voidExecutionRecorder.executionSkipped(TestDescriptor testDescriptor, String reason) Record anEventfor a container or test that was skipped.static EventEvent.executionStarted(TestDescriptor testDescriptor) Create a startedEventfor the suppliedTestDescriptor.voidExecutionRecorder.executionStarted(TestDescriptor testDescriptor) Record anEventfor a container or test that started.static EventEvent.fileEntryPublished(TestDescriptor testDescriptor, FileEntry file) voidExecutionRecorder.fileEntryPublished(TestDescriptor testDescriptor, FileEntry file) static ExecutionExecution.finished(TestDescriptor testDescriptor, Instant startInstant, Instant endInstant, TestExecutionResult executionResult) Create a new instance of anExecutionthat finished with the providedTestExecutionResult.static EventEvent.reportingEntryPublished(TestDescriptor testDescriptor, ReportEntry entry) voidExecutionRecorder.reportingEntryPublished(TestDescriptor testDescriptor, ReportEntry entry) Record anEventfor a publishedReportEntry.static ExecutionExecution.skipped(TestDescriptor testDescriptor, Instant startInstant, Instant endInstant, String skipReason) Create a new instance of anExecutionthat was skipped with the providedskipReason.Method parameters in org.junit.platform.testkit.engine with type arguments of type TestDescriptorModifier and TypeMethodDescriptionEvent.byTestDescriptor(Predicate<? super TestDescriptor> testDescriptorPredicate) -
Uses of TestDescriptor in org.junit.vintage.engine
Methods in org.junit.vintage.engine that return TestDescriptorModifier and TypeMethodDescriptionVintageTestEngine.discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) Deprecated. -
Uses of TestDescriptor in org.junit.vintage.engine.descriptor
Classes in org.junit.vintage.engine.descriptor that implement TestDescriptorModifier and TypeClassDescriptionclassclassclassMethods in org.junit.vintage.engine.descriptor that return types with arguments of type TestDescriptor