io.cucumber.junit

Class Cucumber

java.lang.Object

org.junit.runner.Runner

org.junit.runners.ParentRunner<io.cucumber.junit.FeatureRunner>

io.cucumber.junit.Cucumber

All Implemented Interfaces:

org.junit.runner.Describable, org.junit.runner.manipulation.Filterable, org.junit.runner.manipulation.Sortable

Direct Known Subclasses:

Cucumber

@API(status=STABLE)
public class Cucumber
extends org.junit.runners.ParentRunner<io.cucumber.junit.FeatureRunner>

Classes annotated with @RunWith(Cucumber.class) will run a Cucumber Feature. 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 .feature and glue files on the classpath, using the same resource path as the annotated class. For example, if the annotated class is com.example.RunCucumber then features and glue are assumed to be located in com.example.

Additional hints can be provided to Cucumber by annotating the class with CucumberOptions.

Cucumber also supports JUnits ClassRule, BeforeClass and 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 Also:

CucumberOptions

Constructor Summary

Constructors

Constructor and Description
Cucumber(Class clazz) Constructor called by JUnit.

Method Summary

Modifier and Type	Method and Description
protected org.junit.runners.model.Statement	childrenInvoker(org.junit.runner.notification.RunNotifier notifier)
protected org.junit.runner.Description	describeChild(io.cucumber.junit.FeatureRunner child)
List<io.cucumber.junit.FeatureRunner>	getChildren()
protected void	runChild(io.cucumber.junit.FeatureRunner child, org.junit.runner.notification.RunNotifier notifier)
void	setScheduler(org.junit.runners.model.RunnerScheduler scheduler)

Methods inherited from class org.junit.runners.ParentRunner

classBlock, classRules, collectInitializationErrors, createTestClass, filter, getDescription, getName, getRunnerAnnotations, getTestClass, isIgnored, run, runLeaf, sort, validatePublicVoidNoArgMethods, withAfterClasses, withBeforeClasses

Methods inherited from class org.junit.runner.Runner

testCount

Methods inherited from class java.lang.Object

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

Constructor Detail

Cucumber

public Cucumber(Class clazz)
         throws org.junit.runners.model.InitializationError

Constructor called by JUnit.

Parameters:

clazz - the class with the @RunWith annotation.

Throws:

org.junit.runners.model.InitializationError - if there is another problem

Method Detail

getChildren

public List<io.cucumber.junit.FeatureRunner> getChildren()

Specified by:

getChildren in class org.junit.runners.ParentRunner<io.cucumber.junit.FeatureRunner>

describeChild

protected org.junit.runner.Description describeChild(io.cucumber.junit.FeatureRunner child)

Specified by:

describeChild in class org.junit.runners.ParentRunner<io.cucumber.junit.FeatureRunner>

runChild

protected void runChild(io.cucumber.junit.FeatureRunner child,
                        org.junit.runner.notification.RunNotifier notifier)

Specified by:

runChild in class org.junit.runners.ParentRunner<io.cucumber.junit.FeatureRunner>

childrenInvoker

protected org.junit.runners.model.Statement childrenInvoker(org.junit.runner.notification.RunNotifier notifier)

Overrides:

childrenInvoker in class org.junit.runners.ParentRunner<io.cucumber.junit.FeatureRunner>

setScheduler

public void setScheduler(org.junit.runners.model.RunnerScheduler scheduler)

Overrides:

setScheduler in class org.junit.runners.ParentRunner<io.cucumber.junit.FeatureRunner>