cucumber.api

Interface Scenario

public interface Scenario

Before or After Hooks that declare a parameter of this type will receive an instance of this class. It allows writing text and embedding media into reports, as well as inspecting results (in an After block).

Method Summary

Modifier and Type	Method and Description
void	embed(byte[] data, java.lang.String mimeType) Embeds data into the report(s).
java.lang.String	getId()
java.util.List<java.lang.Integer>	getLines()
java.lang.String	getName()
java.util.Collection<java.lang.String>	getSourceTagNames()
Result.Type	getStatus()
java.lang.String	getUri()
boolean	isFailed()
void	write(java.lang.String text) Outputs some text into the report.

Method Detail

getSourceTagNames

java.util.Collection<java.lang.String> getSourceTagNames()

Returns:

source_tag_names. Needed for compatibility with Capybara.

getStatus

Result.Type getStatus()

Returns:

the most severe status of the Scenario's Steps.

isFailed

boolean isFailed()

Returns:

true if and only if getStatus() returns "failed"

embed

void embed(byte[] data,
           java.lang.String mimeType)

Embeds data into the report(s). Some reporters (such as the progress one) don't embed data, but others do (html and json). Example:

 
 // Embed a screenshot. See your UI automation tool's docs for
 // details about how to take a screenshot.
 scenario.embed(pngBytes, "image/png");
 
 

Parameters:

data - what to embed, for example an image.

mimeType - what is the data?

write

void write(java.lang.String text)

Outputs some text into the report.

Parameters:

text - what to put in the report.

getName

java.lang.String getName()

Returns:

the name of the Scenario

getId

java.lang.String getId()

Returns:

the id of the Scenario.

getUri

java.lang.String getUri()

Returns:

the uri of the feature file of the Scenario.

getLines

java.util.List<java.lang.Integer> getLines()

Returns:

the line(s) in the feature file of the Scenario. Scenarios form Scenario Outlines return both the line of the example row the the line of the scenario outline.