net.thucydides.core.steps

Interface StepListener

All Known Implementing Classes:

ConsoleLoggingListener

public interface StepListener

Represents a class interested in knowing about test execution flow and results.

Method Summary

Modifier and Type	Method and Description
void	addNewExamplesFrom(DataTable table) If multiple tables are used, this method will add any new rows to the test data
void	assumptionViolated(String message)
void	exampleFinished() An example has finished.
void	exampleStarted(Map<String,String> data) A new example has just started.
default void	exampleStarted(Map<String,String> data, String exampleName)
void	lastStepFailed(StepFailure failure) Declare that a step has failed after it has finished.
void	notifyScreenChange()
void	skippedStepStarted(ExecutedStepDescription description) Called when a test step is about to be started, but this step is scheduled to be skipped.
void	stepFailed(StepFailure failure) Called when a test step fails.
void	stepFinished() Called when an test step has finished successfully
void	stepFinished(List<ScreenshotAndHtmlSource> screenshotList)
void	stepIgnored() Called when a step will not be run, generally because a test method is annotated with org.junit.Ignore.
void	stepPending() The step is marked as pending.
void	stepPending(String message) The step is marked as pending with a descriptive message.
void	stepStarted(ExecutedStepDescription description) Called when a test step is about to be started.
void	takeScreenshots(List<ScreenshotAndHtmlSource> screenshots)
default void	testAborted() The test as a whole was aborted.
void	testFailed(TestOutcome testOutcome, Throwable cause) The test failed, but not while executing a step.
void	testFinished(TestOutcome result) Called when a test finishes.
default void	testFinished(TestOutcome result, boolean isInDataDrivenTest)
void	testFinished(TestOutcome result, boolean isInDataDrivenTest, ZonedDateTime finishTime)
void	testIgnored() The test as a whole was ignored.
void	testIsManual()
void	testPending() The test as a whole should be marked as 'pending'.
void	testRetried() The last test run is about to be restarted
void	testRunFinished()
void	testSkipped() The test as a whole was skipped.
void	testStarted(String description) A test with a given name has started.
void	testStarted(String description, String id)
void	testStarted(String description, String id, ZonedDateTime startTime)
void	testSuiteFinished() End of a test case or story.
void	testSuiteStarted(Class<?> storyClass) Start a test run using a test case or a user story.
void	testSuiteStarted(Story story) Start a test run using a specific story, without a corresponding Java class.
void	useExamplesFrom(DataTable table) The current scenario is a data-driven scenario using test data from the specified table.

Method Detail

testSuiteStarted

void testSuiteStarted(Class<?> storyClass)

Start a test run using a test case or a user story. For JUnit tests, the test case should be provided. The test case should be annotated with the Story annotation to indicate what user story it tests. Otherwise, the test case itself will be treated as a user story. For easyb stories, the story class can be provided directly.

testSuiteStarted

void testSuiteStarted(Story story)

Start a test run using a specific story, without a corresponding Java class.

testSuiteFinished

void testSuiteFinished()

End of a test case or story.

testStarted

void testStarted(String description)

A test with a given name has started.

testStarted

void testStarted(String description,
                 String id)

testStarted

void testStarted(String description,
                 String id,
                 ZonedDateTime startTime)

testFinished

void testFinished(TestOutcome result)

Called when a test finishes.

testFinished

default void testFinished(TestOutcome result,
                          boolean isInDataDrivenTest)

testFinished

void testFinished(TestOutcome result,
                  boolean isInDataDrivenTest,
                  ZonedDateTime finishTime)

testRetried

void testRetried()

The last test run is about to be restarted

stepStarted

void stepStarted(ExecutedStepDescription description)

Called when a test step is about to be started.

Parameters:

description - the description of the test that is about to be run (generally a class and method name)

skippedStepStarted

void skippedStepStarted(ExecutedStepDescription description)

Called when a test step is about to be started, but this step is scheduled to be skipped.

Parameters:

description - the description of the test that is about to be run (generally a class and method name)

stepFailed

void stepFailed(StepFailure failure)

Called when a test step fails.

Parameters:

failure - describes the test that failed and the exception that was thrown

lastStepFailed

void lastStepFailed(StepFailure failure)

Declare that a step has failed after it has finished.

stepIgnored

void stepIgnored()

Called when a step will not be run, generally because a test method is annotated with org.junit.Ignore.

stepPending

void stepPending()

The step is marked as pending.

stepPending

void stepPending(String message)

The step is marked as pending with a descriptive message.

Parameters:

message -

stepFinished

void stepFinished()

Called when an test step has finished successfully

stepFinished

void stepFinished(List<ScreenshotAndHtmlSource> screenshotList)

testFailed

void testFailed(TestOutcome testOutcome,
                Throwable cause)

The test failed, but not while executing a step.

Parameters:

testOutcome - The test outcome structure for the failing test

cause - The exception that triggered the failure

testIgnored

void testIgnored()

The test as a whole was ignored.

testSkipped

void testSkipped()

The test as a whole was skipped.

testAborted

default void testAborted()

The test as a whole was aborted.

testPending

void testPending()

The test as a whole should be marked as 'pending'.

testIsManual

void testIsManual()

notifyScreenChange

void notifyScreenChange()

useExamplesFrom

void useExamplesFrom(DataTable table)

The current scenario is a data-driven scenario using test data from the specified table.

addNewExamplesFrom

void addNewExamplesFrom(DataTable table)

If multiple tables are used, this method will add any new rows to the test data

exampleStarted

void exampleStarted(Map<String,String> data)

A new example has just started.

exampleStarted

default void exampleStarted(Map<String,String> data,
                            String exampleName)

exampleFinished

void exampleFinished()

An example has finished.

assumptionViolated

void assumptionViolated(String message)

testRunFinished

void testRunFinished()

takeScreenshots

void takeScreenshots(List<ScreenshotAndHtmlSource> screenshots)