org.junit.gen5.launcher.main.DiscoveryRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of junit-launcher Show documentation
Module "junit-launcher" of JUnit 5.
The newest version!
/*
 * Copyright 2015-2016 the original author or authors.
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution and is available at
 *
 * http://www.eclipse.org/legal/epl-v10.html
 */

package org.junit.gen5.launcher.main;

import static java.util.Collections.unmodifiableList;
import static java.util.stream.Collectors.toList;

import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

import org.junit.gen5.engine.DiscoveryFilter;
import org.junit.gen5.engine.DiscoverySelector;
import org.junit.gen5.engine.TestEngine;
import org.junit.gen5.launcher.EngineIdFilter;
import org.junit.gen5.launcher.PostDiscoveryFilter;
import org.junit.gen5.launcher.TestDiscoveryRequest;

/**
 * The {@code DiscoveryRequest} represents the configuration for the test
 * discovery and execution. It is passed to every active {@link TestEngine}
 * and should be used to lookup tests for the given configuration.
 *
 * A {@code DiscoveryRequest} contains different configuration options.
 *
 * 

 * {@link DiscoverySelector}: A selector defines location(s) a
 * {@link TestEngine} should lookup tests at
 * {@link EngineIdFilter}: A special filter that is applied before an
 * {@link TestEngine} is executed
 * {@link DiscoveryFilter}: A filter that should be applied by the
 * {@link TestEngine} during test discovery.
 * {@link PostDiscoveryFilter}: A filter that will be applied after
 * test discovery.
 * 
 *
 * @since 5.0
 * @see DiscoverySelector
 * @see EngineIdFilter
 * @see DiscoveryFilter
 * @see PostDiscoveryFilter
 */
final class DiscoveryRequest implements TestDiscoveryRequest {

	// Selectors provided to the engines to be used for finding tests
	private final List selectors = new LinkedList<>();

	// Filter based on the engine id
	private final List engineIdFilters = new LinkedList<>();

	// Discovery filters are handed through to all test engines to be applied during discovery
	private final List> discoveryFilters = new LinkedList<>();

	// Descriptor Filters are evaluated by the launcher itself after engines have done their discovery.
	private final List postDiscoveryFilters = new LinkedList<>();

	@Override
	public void addSelector(DiscoverySelector selector) {
		this.selectors.add(selector);
	}

	@Override
	public void addSelectors(Collection selectors) {
		selectors.forEach(this::addSelector);
	}

	@Override
	public void addEngineIdFilter(EngineIdFilter engineIdFilter) {
		this.engineIdFilters.add(engineIdFilter);
	}

	@Override
	public void addEngineIdFilters(Collection engineIdFilters) {
		this.engineIdFilters.addAll(engineIdFilters);
	}

	@Override
	public void addFilter(DiscoveryFilter discoveryFilter) {
		this.discoveryFilters.add(discoveryFilter);
	}

	@Override
	public void addFilters(Collection> discoveryFilters) {
		this.discoveryFilters.addAll(discoveryFilters);
	}

	@Override
	public void addPostFilter(PostDiscoveryFilter postDiscoveryFilter) {
		this.postDiscoveryFilters.add(postDiscoveryFilter);
	}

	@Override
	public void addPostFilters(Collection postDiscoveryFilters) {
		this.postDiscoveryFilters.addAll(postDiscoveryFilters);
	}

	@Override
	public List getSelectors() {
		return unmodifiableList(this.selectors);
	}

	@Override
	public  List getSelectorsByType(Class selectorType) {
		return this.selectors.stream().filter(selectorType::isInstance).map(selectorType::cast).collect(toList());
	}

	@Override
	public List getEngineIdFilters() {
		return unmodifiableList(this.engineIdFilters);
	}

	@Override
	public > List getDiscoveryFiltersByType(Class filterType) {
		return this.discoveryFilters.stream().filter(filterType::isInstance).map(filterType::cast).collect(toList());
	}

	@Override
	public List getPostDiscoveryFilters() {
		return unmodifiableList(this.postDiscoveryFilters);
	}

}