net.thucydides.core.steps

Class BaseStepListener

java.lang.Object

net.thucydides.core.steps.BaseStepListener

All Implemented Interfaces:

StepListener, StepPublisher

public class BaseStepListener
extends Object
implements 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
protected static class	BaseStepListener.ScreenshotType
class	BaseStepListener.StepMerger
class	BaseStepListener.StepMutator

Constructor Summary

Constructors

Constructor and Description
BaseStepListener(Class<? extends org.openqa.selenium.WebDriver> driverClass, File outputDirectory) Create a step listener with a given web driver type.
BaseStepListener(Class<? extends org.openqa.selenium.WebDriver> driverClass, File outputDirectory, Configuration configuration)
BaseStepListener(File outputDirectory)
BaseStepListener(File outputDirectory, com.google.inject.Injector injector)

Method Summary

Modifier and Type	Method and Description
void	addChildStepsFrom(List<TestStep> newSteps)
void	addIssuesToCurrentStory(List<String> issues)
void	addNewExamplesFrom(DataTable table)
void	addStepsFrom(List<TestStep> newSteps)
void	addTagsToCurrentStory(List<TestTag> tags)
void	assumptionViolated(String message)
boolean	aStepHasFailed() Should return true if a step failure has been logged.
boolean	aStepHasFailedInTheCurrentExample()
void	cancelPreviousTest()
BaseStepListener	childListenerFor(StepEventBus eventBus)
void	clearForcedResult()
void	clearTestOutcomes()
Optional<TestStep>	cloneCurrentStep()
int	currentStepDepth()
void	currentStepDone(TestResult result)
void	currentStepIsAPrecondition()
boolean	currentStoryHasTag(TestTag tag)
boolean	currentTestFailed()
void	exampleFinished()
void	exampleStarted(Map<String,String> data)
void	exampleStarted(Map<String,String> data, String exampleName)
void	exceptionExpected(Class<? extends Throwable> expected)
void	finishGroup()
Optional<TestStep>	firstFailingStep()
Map<String,org.openqa.selenium.WebDriver>	getActiveDrivers()
Optional<TestResult>	getAnnotatedResult()
protected SystemClock	getClock()
int	getCurrentLevel()
Optional<Method>	getCurrentStepMethod()
TestOutcome	getCurrentTestOutcome()
org.openqa.selenium.WebDriver	getDriver() The currently-used WebDriver instance for these tests.
StepEventBus	getEventBus()
Optional<TestResult>	getForcedResult()
File	getOutputDirectory()
Photographer	getPhotographer()
protected WebdriverProxyFactory	getProxyFactory()
int	getRunningStepCount()
int	getStepCount()
FailureCause	getTestFailureCause() If a test failed, what was the error.
List<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(StepFailure failure)
void	lastTestPassedAfterRetries(int attemptNum, List<String> failureMessages, TestFailureCause testfailureCause)
Optional<TestOutcome>	latestTestOutcome()
BaseStepListener.StepMerger	mergeLast(int maxStepsToMerge)
void	notifyScreenChange()
void	notifyUIError()
void	overrideResultTo(TestResult result)
boolean	previousScenarioWasASingleBrowserScenario()
void	recordManualTestResult(TestResult result)
void	recordManualTestResult(TestResult result, Optional<String> lastTestedVersion, Boolean isUpToDate, Optional<String> testEvidence)
void	recordRestQuery(RestQuery restQuery)
protected ScreenshotPermission	screenshots()
void	setAllStepsTo(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(ExecutedStepDescription description)
BaseStepListener	spawn(String outcomeName) Creates a new base step listener with
void	stepFailed(StepFailure failure)
void	stepFailedWithException(Throwable failure)
void	stepFinished()
void	stepFinished(List<ScreenshotAndHtmlSource> screenshotList)
void	stepIgnored()
void	stepPending()
void	stepPending(String message)
void	stepStarted(ExecutedStepDescription description) A step within a test is called.
void	takeScreenshot() Take a screenshot now.
void	takeScreenshots(List<ScreenshotAndHtmlSource> screenshots)
void	testAborted()
void	testFailed(TestOutcome testOutcome, Throwable cause)
void	testFinished(TestOutcome outcome)
void	testFinished(TestOutcome result, boolean isInDataDrivenTest)
void	testFinished(TestOutcome outcome, boolean isInDataDrivenTest, ZonedDateTime finishTime) A test has finished.
void	testIgnored()
void	testIsManual()
void	testPending()
void	testRetried()
void	testRunFinished()
void	testSkipped()
void	testStarted(String testMethod) An individual test starts.
void	testStarted(String testMethod, String id)
void	testStarted(String testMethod, String id, ZonedDateTime startTime)
void	testSuiteFinished()
boolean	testSuiteRunning()
void	testSuiteStarted(Class<?> startedTestSuite) A test suite (containing a series of tests) starts.
void	testSuiteStarted(Story story)
void	updateCurrentStepFailureCause(Throwable failure)
BaseStepListener.StepMutator	updateCurrentStepTitle(String updatedStepTitle)
void	updateExampleLineNumber(int lineNumber)
void	updateOverallResults()
void	useExamplesFrom(DataTable table) The current scenario is a data-driven scenario using test data from the specified table.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseStepListener

public BaseStepListener(File outputDirectory)

BaseStepListener

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

BaseStepListener

public BaseStepListener(Class<? extends org.openqa.selenium.WebDriver> driverClass,
                        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(Class<? extends org.openqa.selenium.WebDriver> driverClass,
                        File outputDirectory,
                        Configuration configuration)

Method Detail

setEventBus

public void setEventBus(StepEventBus eventBus)

getEventBus

public StepEventBus getEventBus()

getOutputDirectory

public File getOutputDirectory()

cloneCurrentStep

public Optional<TestStep> cloneCurrentStep()

getAnnotatedResult

public Optional<TestResult> getAnnotatedResult()

setAllStepsTo

public void setAllStepsTo(TestResult result)

overrideResultTo

public void overrideResultTo(TestResult result)

recordManualTestResult

public void recordManualTestResult(TestResult result,
                                   Optional<String> lastTestedVersion,
                                   Boolean isUpToDate,
                                   Optional<String> testEvidence)

recordManualTestResult

public void recordManualTestResult(TestResult result)

exceptionExpected

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

currentTestFailed

public boolean currentTestFailed()

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 attemptNum,
                                       List<String> failureMessages,
                                       TestFailureCause testfailureCause)

currentStepIsAPrecondition

public void currentStepIsAPrecondition()

updateExampleLineNumber

public void updateExampleLineNumber(int lineNumber)

addStepsFrom

public void addStepsFrom(List<TestStep> newSteps)

addChildStepsFrom

public void addChildStepsFrom(List<TestStep> newSteps)

currentStepDepth

public int currentStepDepth()

previousScenarioWasASingleBrowserScenario

public boolean previousScenarioWasASingleBrowserScenario()

currentStoryHasTag

public boolean currentStoryHasTag(TestTag tag)

childListenerFor

public BaseStepListener childListenerFor(StepEventBus eventBus)

spawn

public BaseStepListener spawn(String outcomeName)

Creates a new base step listener with

Parameters:

outcomeName -

Returns:

screenshots

protected ScreenshotPermission screenshots()

getProxyFactory

protected WebdriverProxyFactory getProxyFactory()

getCurrentTestOutcome

public TestOutcome getCurrentTestOutcome()

isAvailable

public boolean isAvailable()

latestTestOutcome

public Optional<TestOutcome> latestTestOutcome()

getClock

protected SystemClock getClock()

testSuiteStarted

public void testSuiteStarted(Class<?> startedTestSuite)

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

Specified by:

testSuiteStarted in interface StepListener

Parameters:

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

testSuiteStarted

public void testSuiteStarted(Story story)

Specified by:

testSuiteStarted in interface StepListener

testSuiteRunning

public boolean testSuiteRunning()

addIssuesToCurrentStory

public void addIssuesToCurrentStory(List<String> issues)

addTagsToCurrentStory

public void addTagsToCurrentStory(List<TestTag> tags)

testSuiteFinished

public void testSuiteFinished()

Specified by:

testSuiteFinished in interface StepListener

testStarted

public void testStarted(String testMethod)

An individual test starts.

Specified by:

testStarted in interface StepListener

Parameters:

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

testStarted

public void testStarted(String testMethod,
                        String id)

Specified by:

testStarted in interface StepListener

testStarted

public void testStarted(String testMethod,
                        String id,
                        ZonedDateTime startTime)

Specified by:

testStarted in interface StepListener

updateCurrentStepTitle

public BaseStepListener.StepMutator updateCurrentStepTitle(String updatedStepTitle)

updateCurrentStepFailureCause

public void updateCurrentStepFailureCause(Throwable failure)

testFinished

public void testFinished(TestOutcome outcome)

Specified by:

testFinished in interface StepListener

testFinished

public void testFinished(TestOutcome result,
                         boolean isInDataDrivenTest)

Specified by:

testFinished in interface StepListener

testFinished

public void testFinished(TestOutcome outcome,
                         boolean isInDataDrivenTest,
                         ZonedDateTime finishTime)

A test has finished.

Specified by:

testFinished in interface StepListener

testRetried

public void testRetried()

Specified by:

testRetried in interface StepListener

stepStarted

public void stepStarted(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 StepListener

Parameters:

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

skippedStepStarted

public void skippedStepStarted(ExecutedStepDescription description)

Specified by:

skippedStepStarted in interface StepListener

getCurrentStepMethod

public Optional<Method> getCurrentStepMethod()

stepFinished

public void stepFinished()

Specified by:

stepFinished in interface StepListener

stepFinished

public void stepFinished(List<ScreenshotAndHtmlSource> screenshotList)

Specified by:

stepFinished in interface StepListener

finishGroup

public void finishGroup()

stepFailed

public void stepFailed(StepFailure failure)

Specified by:

stepFailed in interface StepListener

stepFailedWithException

public void stepFailedWithException(Throwable failure)

lastStepFailed

public void lastStepFailed(StepFailure failure)

Specified by:

lastStepFailed in interface StepListener

stepIgnored

public void stepIgnored()

Specified by:

stepIgnored in interface StepListener

stepPending

public void stepPending()

Specified by:

stepPending in interface StepListener

stepPending

public void stepPending(String message)

Specified by:

stepPending in interface StepListener

assumptionViolated

public void assumptionViolated(String message)

Specified by:

assumptionViolated in interface StepListener

testRunFinished

public void testRunFinished()

Specified by:

testRunFinished in interface StepListener

takeScreenshots

public void takeScreenshots(List<ScreenshotAndHtmlSource> screenshots)

Specified by:

takeScreenshots in interface StepListener

currentStepDone

public void currentStepDone(TestResult result)

getCurrentLevel

public int getCurrentLevel()

getForcedResult

public Optional<TestResult> getForcedResult()

clearForcedResult

public void clearForcedResult()

getActiveDrivers

public Map<String,org.openqa.selenium.WebDriver> getActiveDrivers()

getTestOutcomes

public List<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

firstFailingStep

public Optional<TestStep> firstFailingStep()

Specified by:

firstFailingStep in interface StepPublisher

aStepHasFailedInTheCurrentExample

public boolean aStepHasFailedInTheCurrentExample()

getTestFailureCause

public 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(TestOutcome testOutcome,
                       Throwable cause)

Specified by:

testFailed in interface StepListener

testIgnored

public void testIgnored()

Specified by:

testIgnored in interface StepListener

testSkipped

public void testSkipped()

Specified by:

testSkipped in interface StepListener

testAborted

public void testAborted()

Specified by:

testAborted in interface StepListener

testPending

public void testPending()

Specified by:

testPending in interface StepListener

testIsManual

public void testIsManual()

Specified by:

testIsManual in interface StepListener

notifyScreenChange

public void notifyScreenChange()

Specified by:

notifyScreenChange in interface StepListener

notifyUIError

public void notifyUIError()

takeScreenshot

public void takeScreenshot()

Take a screenshot now.

useExamplesFrom

public void useExamplesFrom(DataTable table)

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

Specified by:

useExamplesFrom in interface StepListener

addNewExamplesFrom

public void addNewExamplesFrom(DataTable table)

Specified by:

addNewExamplesFrom in interface StepListener

exampleStarted

public void exampleStarted(Map<String,String> data)

Specified by:

exampleStarted in interface StepListener

exampleStarted

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

Specified by:

exampleStarted in interface StepListener

exampleFinished

public void exampleFinished()

Specified by:

exampleFinished in interface StepListener

recordRestQuery

public void recordRestQuery(RestQuery restQuery)

clearTestOutcomes

public void clearTestOutcomes()