cucumber.api.junit

Class Cucumber

java.lang.Object

org.junit.runner.Runner

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

cucumber.api.junit.Cucumber

All Implemented Interfaces:

Describable, Filterable, Sortable

public class Cucumber
extends ParentRunner<cucumber.runtime.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 RunCukesTest {

 }
 

Cucumber will look for a .feature file on the classpath, using the same resource path as the annotated class (.class substituted by .feature).

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

Cucumber also supports JUnits ClassRule, BeforeClass and AfterClass annotations. These will be invoked around the suite of features" and moved to the end of the java doc.

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(RunNotifier notifier)
protected cucumber.runtime.Runtime	createRuntime(cucumber.runtime.io.ResourceLoader resourceLoader, ClassLoader classLoader, cucumber.runtime.RuntimeOptions runtimeOptions) Deprecated. Neither the runtime nor the backend or any of the classes involved in their construction are part of the public API. As such they should not be exposed. The recommended way to observe the cucumber process is to listen to events by using a plugin. For example the JSONFormatter.
protected Description	describeChild(cucumber.runtime.junit.FeatureRunner child)
List<cucumber.runtime.junit.FeatureRunner>	getChildren()
protected void	runChild(cucumber.runtime.junit.FeatureRunner child, RunNotifier notifier)

Methods inherited from class org.junit.runners.ParentRunner

classBlock, classRules, collectInitializationErrors, createTestClass, filter, getDescription, getName, getRunnerAnnotations, getTestClass, isIgnored, run, runLeaf, setScheduler, 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,
                IOException

Constructor called by JUnit.

Parameters:

clazz - the class with the @RunWith annotation.

Throws:

IOException - if there is a problem

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

Method Detail

createRuntime

@Deprecated
protected cucumber.runtime.Runtime createRuntime(cucumber.runtime.io.ResourceLoader resourceLoader,
                                                             ClassLoader classLoader,
                                                             cucumber.runtime.RuntimeOptions runtimeOptions)
                                                      throws org.junit.runners.model.InitializationError,
                                                             IOException

Deprecated. Neither the runtime nor the backend or any of the classes involved in their construction are part of the public API. As such they should not be exposed. The recommended way to observe the cucumber process is to listen to events by using a plugin. For example the JSONFormatter.

Create the Runtime. Can be overridden to customize the runtime or backend.

Parameters:

resourceLoader - used to load resources

classLoader - used to load classes

runtimeOptions - configuration

Returns:

a new runtime

Throws:

org.junit.runners.model.InitializationError - if a JUnit error occurred

IOException - if a class or resource could not be loaded

getChildren

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

Specified by:

getChildren in class ParentRunner<cucumber.runtime.junit.FeatureRunner>

describeChild

protected Description describeChild(cucumber.runtime.junit.FeatureRunner child)

Specified by:

describeChild in class ParentRunner<cucumber.runtime.junit.FeatureRunner>

runChild

protected void runChild(cucumber.runtime.junit.FeatureRunner child,
                        RunNotifier notifier)

Specified by:

runChild in class ParentRunner<cucumber.runtime.junit.FeatureRunner>

childrenInvoker

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

Overrides:

childrenInvoker in class ParentRunner<cucumber.runtime.junit.FeatureRunner>