net.thucydides.core.steps

Class BaseStepListener

java.lang.Object

net.thucydides.core.steps.BaseStepListener

All Implemented Interfaces:

net.thucydides.core.steps.StepListener, StepPublisher

Direct Known Subclasses:

ConsoleStepListener

public class BaseStepListener
extends java.lang.Object
implements net.thucydides.core.steps.StepListener, StepPublisher

Observes the test run and stores test run details for later reporting. Observations are recorded in an TestOutcome object. This includes recording the names and results of each test, and taking and storing screenshots at strategic points during the tests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseStepListener.StepMerger
class	BaseStepListener.StepMutator

Constructor Summary

Constructors

Constructor and Description
BaseStepListener(java.lang.Class<? extends org.openqa.selenium.WebDriver> driverClass, java.io.File outputDirectory) Create a step listener with a given web driver type.
BaseStepListener(java.lang.Class<? extends org.openqa.selenium.WebDriver> driverClass, java.io.File outputDirectory, net.thucydides.core.webdriver.Configuration configuration)
BaseStepListener(java.io.File outputDirectory)
BaseStepListener(java.io.File outputDirectory, com.google.inject.Injector injector)
BaseStepListener(java.io.File outputDirectory, Pages pages) Create a step listener using the driver from a given page factory.
BaseStepListener(java.io.File outputDirectory, WebdriverManager webdriverManager)

Method Summary

Modifier and Type	Method and Description
void	addIssuesToCurrentStory(java.util.List<java.lang.String> issues)
void	addNewExamplesFrom(net.thucydides.core.model.DataTable table)
void	addTagsToCurrentStory(java.util.List<net.thucydides.core.model.TestTag> tags)
void	assumptionViolated(java.lang.String message)
boolean	aStepHasFailed() Should return true if a step failure has been logged.
boolean	aStepHasFailedInTheCurrentExample()
void	cancelPreviousTest()
void	clearForcedResult()
java.util.Optional<net.thucydides.core.model.TestStep>	cloneCurrentStep()
void	currentStepIsAPrecondition()
void	exampleFinished()
void	exampleStarted(java.util.Map<java.lang.String,java.lang.String> data)
void	exceptionExpected(java.lang.Class<? extends java.lang.Throwable> expected)
java.util.Optional<net.thucydides.core.model.TestResult>	getAnnotatedResult()
java.util.Optional<java.lang.reflect.Method>	getCurrentStepMethod()
org.openqa.selenium.WebDriver	getDriver() The currently-used WebDriver instance for these tests.
StepEventBus	getEventBus()
java.util.Optional<net.thucydides.core.model.TestResult>	getForcedResult()
Photographer	getPhotographer()
int	getRunningStepCount()
int	getStepCount()
net.thucydides.core.model.stacktrace.FailureCause	getTestFailureCause() If a test failed, what was the error.
java.util.List<net.thucydides.core.model.TestOutcome>	getTestOutcomes() A step listener should be able to return a set of test results at the end of the test run.
boolean	isAvailable()
void	lastStepFailed(net.thucydides.core.steps.StepFailure failure)
void	lastTestPassedAfterRetries(int remainingTries, java.util.List<java.lang.String> failureMessages, net.thucydides.core.steps.TestFailureCause testfailureCause)
java.util.Optional<net.thucydides.core.model.TestOutcome>	latestTestOutcome()
BaseStepListener.StepMerger	mergeLast(int maxStepsToMerge)
void	notifyScreenChange()
void	overrideResultTo(net.thucydides.core.model.TestResult result)
void	recordRestQuery(net.serenitybdd.core.rest.RestQuery restQuery)
void	setAllStepsTo(net.thucydides.core.model.TestResult result)
void	setDriver(org.openqa.selenium.WebDriver driver) Used to update the webdriver driver for screenshots if a listener is reused between scenarios.
void	setEventBus(StepEventBus eventBus)
void	skippedStepStarted(net.thucydides.core.steps.ExecutedStepDescription description)
void	stepFailed(net.thucydides.core.steps.StepFailure failure)
void	stepFinished()
void	stepIgnored()
void	stepPending()
void	stepPending(java.lang.String message)
void	stepStarted(net.thucydides.core.steps.ExecutedStepDescription description) A step within a test is called.
void	takeScreenshot() Take a screenshot now.
void	testFailed(net.thucydides.core.model.TestOutcome testOutcome, java.lang.Throwable cause)
void	testFinished(net.thucydides.core.model.TestOutcome outcome) A test has finished.
void	testIgnored()
void	testIsManual()
void	testPending()
void	testRetried()
void	testRunFinished()
void	testSkipped()
void	testStarted(java.lang.String testMethod) An individual test starts.
void	testStarted(java.lang.String testMethod, java.lang.String id)
void	testSuiteFinished()
boolean	testSuiteRunning()
void	testSuiteStarted(java.lang.Class<?> startedTestSuite) A test suite (containing a series of tests) starts.
void	testSuiteStarted(net.thucydides.core.model.Story story)
BaseStepListener.StepMutator	updateCurrentStepTitle(java.lang.String updatedStepTitle)
void	updateOverallResults()
void	useExamplesFrom(net.thucydides.core.model.DataTable table) The current scenario is a data-driven scenario using test data from the specified table.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseStepListener

public BaseStepListener(java.io.File outputDirectory)

BaseStepListener

public BaseStepListener(java.io.File outputDirectory,
                        com.google.inject.Injector injector)

BaseStepListener

public BaseStepListener(java.lang.Class<? extends org.openqa.selenium.WebDriver> driverClass,
                        java.io.File outputDirectory)

Create a step listener with a given web driver type.

Parameters:

driverClass - a driver of this type will be used

outputDirectory - reports and screenshots are generated here

BaseStepListener

public BaseStepListener(java.lang.Class<? extends org.openqa.selenium.WebDriver> driverClass,
                        java.io.File outputDirectory,
                        net.thucydides.core.webdriver.Configuration configuration)

BaseStepListener

public BaseStepListener(java.io.File outputDirectory,
                        WebdriverManager webdriverManager)

BaseStepListener

public BaseStepListener(java.io.File outputDirectory,
                        Pages pages)

Create a step listener using the driver from a given page factory. If the pages factory is null, a new driver will be created based on the default system values.

Parameters:

outputDirectory - reports and screenshots are generated here

pages - a pages factory.

Method Detail

setEventBus

public void setEventBus(StepEventBus eventBus)

getEventBus

public StepEventBus getEventBus()

cloneCurrentStep

public java.util.Optional<net.thucydides.core.model.TestStep> cloneCurrentStep()

getAnnotatedResult

public java.util.Optional<net.thucydides.core.model.TestResult> getAnnotatedResult()

setAllStepsTo

public void setAllStepsTo(net.thucydides.core.model.TestResult result)

overrideResultTo

public void overrideResultTo(net.thucydides.core.model.TestResult result)

exceptionExpected

public void exceptionExpected(java.lang.Class<? extends java.lang.Throwable> expected)

mergeLast

public BaseStepListener.StepMerger mergeLast(int maxStepsToMerge)

getStepCount

public int getStepCount()

getRunningStepCount

public int getRunningStepCount()

updateOverallResults

public void updateOverallResults()

getPhotographer

public Photographer getPhotographer()

cancelPreviousTest

public void cancelPreviousTest()

lastTestPassedAfterRetries

public void lastTestPassedAfterRetries(int remainingTries,
                                       java.util.List<java.lang.String> failureMessages,
                                       net.thucydides.core.steps.TestFailureCause testfailureCause)

currentStepIsAPrecondition

public void currentStepIsAPrecondition()

isAvailable

public boolean isAvailable()

latestTestOutcome

public java.util.Optional<net.thucydides.core.model.TestOutcome> latestTestOutcome()

testSuiteStarted

public void testSuiteStarted(java.lang.Class<?> startedTestSuite)

A test suite (containing a series of tests) starts.

Specified by:

testSuiteStarted in interface net.thucydides.core.steps.StepListener

Parameters:

startedTestSuite - the class implementing the test suite (e.g. a JUnit test case)

testSuiteStarted

public void testSuiteStarted(net.thucydides.core.model.Story story)

Specified by:

testSuiteStarted in interface net.thucydides.core.steps.StepListener

testSuiteRunning

public boolean testSuiteRunning()

addIssuesToCurrentStory

public void addIssuesToCurrentStory(java.util.List<java.lang.String> issues)

addTagsToCurrentStory

public void addTagsToCurrentStory(java.util.List<net.thucydides.core.model.TestTag> tags)

testSuiteFinished

public void testSuiteFinished()

Specified by:

testSuiteFinished in interface net.thucydides.core.steps.StepListener

testStarted

public void testStarted(java.lang.String testMethod)

An individual test starts.

Specified by:

testStarted in interface net.thucydides.core.steps.StepListener

Parameters:

testMethod - the name of the test method in the test suite class.

testStarted

public void testStarted(java.lang.String testMethod,
                        java.lang.String id)

Specified by:

testStarted in interface net.thucydides.core.steps.StepListener

updateCurrentStepTitle

public BaseStepListener.StepMutator updateCurrentStepTitle(java.lang.String updatedStepTitle)

testFinished

public void testFinished(net.thucydides.core.model.TestOutcome outcome)

A test has finished.

Specified by:

testFinished in interface net.thucydides.core.steps.StepListener

Parameters:

outcome - the result of the test that just finished.

testRetried

public void testRetried()

Specified by:

testRetried in interface net.thucydides.core.steps.StepListener

stepStarted

public void stepStarted(net.thucydides.core.steps.ExecutedStepDescription description)

A step within a test is called. This step might be nested in another step, in which case the original step becomes a group of steps.

Specified by:

stepStarted in interface net.thucydides.core.steps.StepListener

Parameters:

description - the description of the test that is about to be run

skippedStepStarted

public void skippedStepStarted(net.thucydides.core.steps.ExecutedStepDescription description)

Specified by:

skippedStepStarted in interface net.thucydides.core.steps.StepListener

getCurrentStepMethod

public java.util.Optional<java.lang.reflect.Method> getCurrentStepMethod()

stepFinished

public void stepFinished()

Specified by:

stepFinished in interface net.thucydides.core.steps.StepListener

stepFailed

public void stepFailed(net.thucydides.core.steps.StepFailure failure)

Specified by:

stepFailed in interface net.thucydides.core.steps.StepListener

lastStepFailed

public void lastStepFailed(net.thucydides.core.steps.StepFailure failure)

Specified by:

lastStepFailed in interface net.thucydides.core.steps.StepListener

stepIgnored

public void stepIgnored()

Specified by:

stepIgnored in interface net.thucydides.core.steps.StepListener

stepPending

public void stepPending()

Specified by:

stepPending in interface net.thucydides.core.steps.StepListener

stepPending

public void stepPending(java.lang.String message)

Specified by:

stepPending in interface net.thucydides.core.steps.StepListener

assumptionViolated

public void assumptionViolated(java.lang.String message)

Specified by:

assumptionViolated in interface net.thucydides.core.steps.StepListener

testRunFinished

public void testRunFinished()

Specified by:

testRunFinished in interface net.thucydides.core.steps.StepListener

getForcedResult

public java.util.Optional<net.thucydides.core.model.TestResult> getForcedResult()

clearForcedResult

public void clearForcedResult()

getTestOutcomes

public java.util.List<net.thucydides.core.model.TestOutcome> getTestOutcomes()

Description copied from interface: StepPublisher

A step listener should be able to return a set of test results at the end of the test run.

Specified by:

getTestOutcomes in interface StepPublisher

setDriver

public void setDriver(org.openqa.selenium.WebDriver driver)

Description copied from interface: StepPublisher

Used to update the webdriver driver for screenshots if a listener is reused between scenarios.

Specified by:

setDriver in interface StepPublisher

getDriver

public org.openqa.selenium.WebDriver getDriver()

Description copied from interface: StepPublisher

The currently-used WebDriver instance for these tests.

Specified by:

getDriver in interface StepPublisher

aStepHasFailed

public boolean aStepHasFailed()

Description copied from interface: StepPublisher

Should return true if a step failure has been logged. We need to share this information if multiple step libraries are used.

Specified by:

aStepHasFailed in interface StepPublisher

aStepHasFailedInTheCurrentExample

public boolean aStepHasFailedInTheCurrentExample()

getTestFailureCause

public net.thucydides.core.model.stacktrace.FailureCause getTestFailureCause()

Description copied from interface: StepPublisher

If a test failed, what was the error.

Specified by:

getTestFailureCause in interface StepPublisher

testFailed

public void testFailed(net.thucydides.core.model.TestOutcome testOutcome,
                       java.lang.Throwable cause)

Specified by:

testFailed in interface net.thucydides.core.steps.StepListener

testIgnored

public void testIgnored()

Specified by:

testIgnored in interface net.thucydides.core.steps.StepListener

testSkipped

public void testSkipped()

Specified by:

testSkipped in interface net.thucydides.core.steps.StepListener

testPending

public void testPending()

Specified by:

testPending in interface net.thucydides.core.steps.StepListener

testIsManual

public void testIsManual()

Specified by:

testIsManual in interface net.thucydides.core.steps.StepListener

notifyScreenChange

public void notifyScreenChange()

Specified by:

notifyScreenChange in interface net.thucydides.core.steps.StepListener

takeScreenshot

public void takeScreenshot()

Take a screenshot now.

useExamplesFrom

public void useExamplesFrom(net.thucydides.core.model.DataTable table)

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

Specified by:

useExamplesFrom in interface net.thucydides.core.steps.StepListener

addNewExamplesFrom

public void addNewExamplesFrom(net.thucydides.core.model.DataTable table)

Specified by:

addNewExamplesFrom in interface net.thucydides.core.steps.StepListener

exampleStarted

public void exampleStarted(java.util.Map<java.lang.String,java.lang.String> data)

Specified by:

exampleStarted in interface net.thucydides.core.steps.StepListener

exampleFinished

public void exampleFinished()

Specified by:

exampleFinished in interface net.thucydides.core.steps.StepListener

recordRestQuery

public void recordRestQuery(net.serenitybdd.core.rest.RestQuery restQuery)