io.cucumber.core.backend

Interface TestCaseState

@API(status=STABLE)
public interface TestCaseState

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).

Note: This class is not intended to be used to create reports. To create custom reports use the io.cucumber.plugin.Plugin class. The plugin system provides a much richer access to Cucumbers then hooks after could provide. For an example see io.cucumber.core.plugin.PrettyFormatter.

Method Summary

Modifier and Type	Method and Description
void	embed(byte[] data, String mimeType) Deprecated. use embed(byte[], String, String) instead.
void	embed(byte[] data, String mimeType, String name) Like embed(byte[], String), but with name for the embedding.
String	getId()
Integer	getLine()
String	getName()
Collection<String>	getSourceTagNames()
Status	getStatus()
URI	getUri()
boolean	isFailed()
void	write(String text) Outputs some text into the report.

Method Detail

getSourceTagNames

Collection<String> getSourceTagNames()

Returns:

source_tag_names.

getStatus

Status getStatus()

Returns:

the most severe status of the Scenario's Steps.

isFailed

boolean isFailed()

Returns:

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

embed

@Deprecated
void embed(byte[] data,
                       String mimeType)

Deprecated. use embed(byte[], String, String) instead.

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?

embed

void embed(byte[] data,
           String mimeType,
           String name)

Like embed(byte[], String), but with name for the embedding.

Parameters:

data - what to embed, for example an image.

mimeType - what is the data?

name - embedding name

write

void write(String text)

Outputs some text into the report.

Parameters:

text - what to put in the report.

getName

String getName()

Returns:

the name of the Scenario

getId

String getId()

Returns:

the id of the Scenario.

getUri

URI getUri()

Returns:

the uri of the Scenario.

getLine

Integer getLine()

Returns:

the line in the feature file of the Scenario. If this is a Scenario from Scenario Outlines this will return the line of the example row in the Scenario Outline.