io.cucumber.junit.Cucumber Maven / Gradle / Ivy
package io.cucumber.junit;
import io.cucumber.core.eventbus.EventBus;
import io.cucumber.core.feature.FeatureParser;
import io.cucumber.core.filter.Filters;
import io.cucumber.core.gherkin.Feature;
import io.cucumber.core.gherkin.Pickle;
import io.cucumber.core.options.Constants;
import io.cucumber.core.options.CucumberOptionsAnnotationParser;
import io.cucumber.core.options.CucumberProperties;
import io.cucumber.core.options.CucumberPropertiesParser;
import io.cucumber.core.options.RuntimeOptions;
import io.cucumber.core.plugin.PluginFactory;
import io.cucumber.core.plugin.Plugins;
import io.cucumber.core.resource.ClassLoaders;
import io.cucumber.core.runtime.BackendServiceLoader;
import io.cucumber.core.runtime.BackendSupplier;
import io.cucumber.core.runtime.CucumberExecutionContext;
import io.cucumber.core.runtime.ExitStatus;
import io.cucumber.core.runtime.FeaturePathFeatureSupplier;
import io.cucumber.core.runtime.ObjectFactoryServiceLoader;
import io.cucumber.core.runtime.ObjectFactorySupplier;
import io.cucumber.core.runtime.ThreadLocalObjectFactorySupplier;
import io.cucumber.core.runtime.ThreadLocalRunnerSupplier;
import io.cucumber.core.runtime.TimeServiceEventBus;
import org.apiguardian.api.API;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.runner.Description;
import org.junit.runner.notification.RunNotifier;
import org.junit.runners.ParentRunner;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.RunnerScheduler;
import org.junit.runners.model.Statement;
import java.time.Clock;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;
import java.util.function.Predicate;
import java.util.function.Supplier;
import static io.cucumber.core.runtime.SynchronizedEventBus.synchronize;
import static io.cucumber.junit.FileNameCompatibleNames.uniqueSuffix;
import static java.util.stream.Collectors.groupingBy;
import static java.util.stream.Collectors.toList;
/**
* Cucumber JUnit Runner.
*
* A class annotated with {@code @RunWith(Cucumber.class)} will run feature
* files as junit tests. In general, the runner class should be empty without
* any fields or methods. For example:
*
*
* @RunWith(Cucumber.class)
* @CucumberOptions(plugin = "pretty")
* public class RunCucumberTest {
* }
*
*
*
*
* By default Cucumber will look for {@code .feature} and glue files on the
* classpath, using the same resource path as the annotated class. For example,
* if the annotated class is {@code com.example.RunCucumber} then features and
* glue are assumed to be located in {@code com.example}.
*
* Options can be provided in by (order of precedence):
*
* - Properties from {@link System#getProperties()} ()}
* - Properties from in {@link System#getenv()}
* - Annotating the runner class with {@link CucumberOptions}
* - Properties from {@value Constants#CUCUMBER_PROPERTIES_FILE_NAME}
*
* For available properties see {@link Constants}.
*
* Cucumber also supports JUnits {@link ClassRule}, {@link BeforeClass} and
* {@link AfterClass} annotations. These will be executed before and after all
* scenarios. Using these is not recommended as it limits the portability
* between different runners; they may not execute correctly when using the
* commandline, IntelliJ IDEA or Cucumber-Eclipse. Instead it is recommended to
* use Cucumbers `Before` and `After` hooks.
*
* @see CucumberOptions
*/
@API(status = API.Status.STABLE)
public final class Cucumber extends ParentRunner> {
private final List> children;
private final EventBus bus;
private final Plugins plugins;
private final CucumberExecutionContext context;
private boolean multiThreadingAssumed = false;
/**
* Constructor called by JUnit.
*
* @param clazz the class with
* the @RunWith
* annotation.
* @throws org.junit.runners.model.InitializationError if there is another
* problem
*/
public Cucumber(Class clazz) throws InitializationError {
super(clazz);
Assertions.assertNoCucumberAnnotatedMethods(clazz);
// Parse the options early to provide fast feedback about invalid
// options
RuntimeOptions propertiesFileOptions = new CucumberPropertiesParser()
.parse(CucumberProperties.fromPropertiesFile())
.build();
RuntimeOptions annotationOptions = new CucumberOptionsAnnotationParser()
.withOptionsProvider(new JUnitCucumberOptionsProvider())
.parse(clazz)
.build(propertiesFileOptions);
RuntimeOptions environmentOptions = new CucumberPropertiesParser()
.parse(CucumberProperties.fromEnvironment())
.build(annotationOptions);
RuntimeOptions runtimeOptions = new CucumberPropertiesParser()
.parse(CucumberProperties.fromSystemProperties())
.enablePublishPlugin()
.build(environmentOptions);
// Next parse the junit options
JUnitOptions junitPropertiesFileOptions = new JUnitOptionsParser()
.parse(CucumberProperties.fromPropertiesFile())
.build();
JUnitOptions junitAnnotationOptions = new JUnitOptionsParser()
.parse(clazz)
.build(junitPropertiesFileOptions);
JUnitOptions junitEnvironmentOptions = new JUnitOptionsParser()
.parse(CucumberProperties.fromEnvironment())
.build(junitAnnotationOptions);
JUnitOptions junitOptions = new JUnitOptionsParser()
.parse(CucumberProperties.fromSystemProperties())
.build(junitEnvironmentOptions);
this.bus = synchronize(new TimeServiceEventBus(Clock.systemUTC(), UUID::randomUUID));
// Parse the features early. Don't proceed when there are lexer errors
FeatureParser parser = new FeatureParser(bus::generateId);
Supplier classLoader = ClassLoaders::getDefaultClassLoader;
FeaturePathFeatureSupplier featureSupplier = new FeaturePathFeatureSupplier(classLoader, runtimeOptions,
parser);
List features = featureSupplier.get();
// Create plugins after feature parsing to avoid the creation of empty
// files on lexer errors.
this.plugins = new Plugins(new PluginFactory(), runtimeOptions);
ExitStatus exitStatus = new ExitStatus(runtimeOptions);
this.plugins.addPlugin(exitStatus);
ObjectFactoryServiceLoader objectFactoryServiceLoader = new ObjectFactoryServiceLoader(classLoader,
runtimeOptions);
ObjectFactorySupplier objectFactorySupplier = new ThreadLocalObjectFactorySupplier(objectFactoryServiceLoader);
BackendSupplier backendSupplier = new BackendServiceLoader(clazz::getClassLoader, objectFactorySupplier);
ThreadLocalRunnerSupplier runnerSupplier = new ThreadLocalRunnerSupplier(runtimeOptions, bus, backendSupplier,
objectFactorySupplier);
this.context = new CucumberExecutionContext(bus, exitStatus, runnerSupplier);
Predicate filters = new Filters(runtimeOptions);
Map, List> groupedByName = features.stream()
.collect(groupingBy(Feature::getName));
this.children = features.stream()
.map(feature -> {
Integer uniqueSuffix = uniqueSuffix(groupedByName, feature, Feature::getName);
return FeatureRunner.create(feature, uniqueSuffix, filters, context, junitOptions);
})
.filter(runner -> !runner.isEmpty())
.collect(toList());
}
@Override
protected List> getChildren() {
return children;
}
@Override
protected Description describeChild(ParentRunner child) {
return child.getDescription();
}
@Override
protected void runChild(ParentRunner child, RunNotifier notifier) {
child.run(notifier);
}
@Override
protected Statement childrenInvoker(RunNotifier notifier) {
Statement statement = super.childrenInvoker(notifier);
statement = new StartAndFinishTestRun(statement);
return statement;
}
@Override
public void setScheduler(RunnerScheduler scheduler) {
super.setScheduler(scheduler);
multiThreadingAssumed = true;
}
private class StartAndFinishTestRun extends Statement {
private final Statement next;
public StartAndFinishTestRun(Statement next) {
this.next = next;
}
@Override
public void evaluate() {
if (multiThreadingAssumed) {
plugins.setSerialEventBusOnEventListenerPlugins(bus);
} else {
plugins.setEventBusOnEventListenerPlugins(bus);
}
context.runFeatures(next::evaluate);
}
}
}