Class EngineDiscoveryOrchestrator

java.lang.Object

org.junit.platform.launcher.core.EngineDiscoveryOrchestrator

@API(status=INTERNAL,
     since="1.7",
     consumers={"org.junit.platform.testkit","org.junit.platform.suite.engine"})
public class EngineDiscoveryOrchestrator
extends Object

Orchestrates test discovery using the configured test engines.

Since:

1.7

Field Summary

Fields

Modifier and Type	Field	Description
private final EngineDiscoveryResultValidator	discoveryResultValidator
private final ListenerRegistry<LauncherDiscoveryListener>	launcherDiscoveryListenerRegistry
private static final org.junit.platform.commons.logging.Logger	logger
private final Collection<PostDiscoveryFilter>	postDiscoveryFilters
private final Iterable<TestEngine>	testEngines

Constructor Summary

Constructors

Constructor	Description
EngineDiscoveryOrchestrator(Iterable<TestEngine> testEngines, Collection<PostDiscoveryFilter> postDiscoveryFilters)
EngineDiscoveryOrchestrator(Iterable<TestEngine> testEngines, Collection<PostDiscoveryFilter> postDiscoveryFilters, ListenerRegistry<LauncherDiscoveryListener> launcherDiscoveryListenerRegistry)

Method Summary

Modifier and Type	Method	Description
private void	acceptInAllTestEngines(Map<TestEngine, LauncherDiscoveryResult.EngineResultInfo> testEngineResults, TestDescriptor.Visitor visitor)
private void	applyPostDiscoveryFilters(Map<TestEngine, LauncherDiscoveryResult.EngineResultInfo> testEngineDescriptors, List<PostDiscoveryFilter> filters)
LauncherDiscoveryResult	discover(LauncherDiscoveryRequest request)	Discovers tests for the supplied request using the configured test engines.
private LauncherDiscoveryResult	discover(LauncherDiscoveryRequest request, Optional<LauncherPhase> phase, Function<String,UniqueId> uniqueIdCreator)
LauncherDiscoveryResult	discover(LauncherDiscoveryRequest request, UniqueId parentId)	Discovers tests for the supplied request in the supplied phase using the configured test engines to be used by the suite engine.
(package private) LauncherDiscoveryResult	discover(LauncherDiscoveryRequest request, LauncherPhase phase)
private LauncherDiscoveryResult.EngineResultInfo	discoverEngineRoot(TestEngine testEngine, LauncherDiscoveryRequest request, DiscoveryIssueCollector issueCollector, Function<String,UniqueId> uniqueIdCreator)
private Map<TestEngine, LauncherDiscoveryResult.EngineResultInfo>	discoverSafely(LauncherDiscoveryRequest request, Optional<LauncherPhase> phase, DiscoveryIssueCollector issueCollector, Function<String,UniqueId> uniqueIdCreator)
(package private) LauncherDiscoveryListener	getLauncherDiscoveryListener(LauncherDiscoveryRequest discoveryRequest, DiscoveryIssueCollector issueCollector)
private boolean	isExcluded(TestDescriptor descriptor, FilterResult filterResult)
private void	logTestDescriptorExclusionReasons(Map<String, List<TestDescriptor>> excludedTestDescriptorsByReason)
private void	populateExclusionReasonInMap(Optional<String> reason, TestDescriptor testDescriptor, Map<String, List<TestDescriptor>> excludedTestDescriptorsByReason)
private void	prune(Map<TestEngine, LauncherDiscoveryResult.EngineResultInfo> testEngineResults)	Prune all branches in the tree of TestDescriptors that do not have executable tests.
private static void	reportDiscoveryIssues(LauncherDiscoveryResult discoveryResult)
private static boolean	shouldReportDiscoveryIssues(LauncherDiscoveryRequest request, Optional<LauncherPhase> phase)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

private static final org.junit.platform.commons.logging.Logger logger

discoveryResultValidator

private final EngineDiscoveryResultValidator discoveryResultValidator

testEngines

private final Iterable<TestEngine> testEngines

postDiscoveryFilters

private final Collection<PostDiscoveryFilter> postDiscoveryFilters

launcherDiscoveryListenerRegistry

private final ListenerRegistry<LauncherDiscoveryListener> launcherDiscoveryListenerRegistry

Constructor Details

EngineDiscoveryOrchestrator

public EngineDiscoveryOrchestrator(Iterable<TestEngine> testEngines,
 Collection<PostDiscoveryFilter> postDiscoveryFilters)

EngineDiscoveryOrchestrator

EngineDiscoveryOrchestrator(Iterable<TestEngine> testEngines,
 Collection<PostDiscoveryFilter> postDiscoveryFilters,
 ListenerRegistry<LauncherDiscoveryListener> launcherDiscoveryListenerRegistry)

Method Details

discover

public LauncherDiscoveryResult discover(LauncherDiscoveryRequest request)

Discovers tests for the supplied request using the configured test engines.

Applies engine filters and post-discovery filters and prunes the resulting test tree.

discover

LauncherDiscoveryResult discover(LauncherDiscoveryRequest request,
 LauncherPhase phase)

discover

public LauncherDiscoveryResult discover(LauncherDiscoveryRequest request,
 UniqueId parentId)

Discovers tests for the supplied request in the supplied phase using the configured test engines to be used by the suite engine.

Applies engine filters and post-discovery filters and prunes the resulting test tree.

Note: The test descriptors in the discovery result can safely be used as non-root descriptors. Engine-test descriptor entries are pruned from the returned result. As such execution by EngineExecutionOrchestrator will not emit start or emit events for engines without tests.

discover

private LauncherDiscoveryResult discover(LauncherDiscoveryRequest request,
 Optional<LauncherPhase> phase,
 Function<String,UniqueId> uniqueIdCreator)

shouldReportDiscoveryIssues

private static boolean shouldReportDiscoveryIssues(LauncherDiscoveryRequest request,
 Optional<LauncherPhase> phase)

reportDiscoveryIssues

private static void reportDiscoveryIssues(LauncherDiscoveryResult discoveryResult)

discoverSafely

private Map<TestEngine, LauncherDiscoveryResult.EngineResultInfo> discoverSafely(LauncherDiscoveryRequest request,
 Optional<LauncherPhase> phase,
 DiscoveryIssueCollector issueCollector,
 Function<String,UniqueId> uniqueIdCreator)

discoverEngineRoot

private LauncherDiscoveryResult.EngineResultInfo discoverEngineRoot(TestEngine testEngine,
 LauncherDiscoveryRequest request,
 DiscoveryIssueCollector issueCollector,
 Function<String,UniqueId> uniqueIdCreator)

getLauncherDiscoveryListener

LauncherDiscoveryListener getLauncherDiscoveryListener(LauncherDiscoveryRequest discoveryRequest,
 DiscoveryIssueCollector issueCollector)

applyPostDiscoveryFilters

private void applyPostDiscoveryFilters(Map<TestEngine, LauncherDiscoveryResult.EngineResultInfo> testEngineDescriptors,
 List<PostDiscoveryFilter> filters)

populateExclusionReasonInMap

private void populateExclusionReasonInMap(Optional<String> reason,
 TestDescriptor testDescriptor,
 Map<String, List<TestDescriptor>> excludedTestDescriptorsByReason)

logTestDescriptorExclusionReasons

private void logTestDescriptorExclusionReasons(Map<String, List<TestDescriptor>> excludedTestDescriptorsByReason)

prune

private void prune(Map<TestEngine, LauncherDiscoveryResult.EngineResultInfo> testEngineResults)

Prune all branches in the tree of TestDescriptors that do not have executable tests.

If a TestEngine ends up with no TestDescriptors after pruning, it will not be removed.

isExcluded

private boolean isExcluded(TestDescriptor descriptor,
 FilterResult filterResult)

acceptInAllTestEngines

private void acceptInAllTestEngines(Map<TestEngine, LauncherDiscoveryResult.EngineResultInfo> testEngineResults,
 TestDescriptor.Visitor visitor)