StepEventBus (Serenity Core 3.7.1 API)

java.lang.Object
- net.thucydides.core.steps.StepEventBus

Direct Known Subclasses:

SilentEventBus
```
public class StepEventBus
extends Object
```
An event bus for Step-related notifications. Use this to integrate Thucydides listeners with testing tools. You create a listener (e.g. an instance of BaseStepListener, or your own), register it using 'registerListener', and then implement the various methods (testStarted(), stepStarted()). Thucydides will call these events on your listener as they occur. You can register a new Thucydides listener by implementing the StepListener interface and placing your class in the classpath. Thucydides will automatically detect the listener and add it to the registered listeners. It will load custom listeners automatically when a test starts for the first time.

Field Summary

Fields
Modifier and Type Field and Description

static String JUNIT_JUPITER_EXECUTION_PARALLEL_ENABLED

Fields
Modifier and Type	Field and Description
`static String`	`JUNIT_JUPITER_EXECUTION_PARALLEL_ENABLED`

Constructor Summary

Constructors
Constructor and Description

StepEventBus(EnvironmentVariables environmentVariables, Configuration configuration)

Constructors
Constructor and Description
`StepEventBus(EnvironmentVariables environmentVariables, Configuration configuration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDescriptionToCurrentTest(String description)`
`void`	`addIssuesToCurrentStory(List<String> issues)`
`void`	`addIssuesToCurrentTest(List<String> issues)`
`void`	`addNewExamplesFrom(DataTable newTable)`
`void`	`addTagsToCurrentStory(List<TestTag> tags)`
`void`	`addTagsToCurrentTest(List<TestTag> tags)`
`boolean`	`areStepsRunning()`
`boolean`	`assumptionViolated()`
`void`	`assumptionViolated(String message)`
`boolean`	`aStepInTheCurrentTestHasFailed()`
`void`	`cancelPreviousTest()`
`void`	`castActor(String name)`
`void`	`clear()`
`static void`	`clearEventBusFor(Object key)`
`void`	`clearStepFailures()`
`boolean`	`currentTestHasTag(TestTag tag)`
`boolean`	`currentTestIsSuspended()`
`boolean`	`currentTestOutcomeIsDataDriven()`
`void`	`disableSoftAsserts()`
`void`	`dropAgent(Agent agent)`
`void`	`dropAgents(Agent... agents)`
`void`	`dropAllListeners()`
`void`	`dropListener(StepListener stepListener)`
`void`	`enableDryRun()`
`void`	`enableSoftAsserts()`
`static StepEventBus`	`eventBusFor(Object key)`
`void`	`exampleFinished()`
`void`	`exampleStarted(Map<String,String> data)`
`void`	`exampleStarted(Map<String,String> data, String exampleName)`
`void`	`exceptionExpected(Class<? extends Throwable> expected)`
`void`	`finishTestRun()`
`static void`	`forceClearEventBusFor(Object key)`
`protected List<StepListener>`	`getAllListeners()`
`String`	`getAssumptionViolatedMessage()`
`BaseStepListener`	`getBaseStepListener()`
`Optional<TestStep>`	`getCurrentStep()`
`EnvironmentVariables`	`getEnvironmentVariables()`
`static StepEventBus`	`getEventBus()` The event bus used to inform listening classes about when tests and test steps start and finish.
`Optional<TestResult>`	`getForcedResult()`
`static StepEventBus`	`getParallelEventBus()` If called from a Cucumber parallel Test session will return the corresponding StepEventBus, otherwise will redirect to getEventBus()
`String`	`getTestSource()`
`boolean`	`inFixtureMethod()`
`void`	`initialiseSession()`
`boolean`	`isASingleBrowserScenario()`
`boolean`	`isBaseStepListenerRegistered()`
`boolean`	`isCurrentTestDataDriven()`
`boolean`	`isDryRun()`
`boolean`	`isNewSingleBrowserScenario()`
`boolean`	`isUniqueSession()`
`void`	`lastStepFailed(StepFailure failure)`
`void`	`lastTestPassedAfterRetries(int remainingTries, List<String> failureMessages, TestFailureCause testFailureCause)`
`void`	`mergeActivitiesToDefaultStepListener(Agent... agents)`
`void`	`mergeActivitiesToDefaultStepListener(String stepName, Agent... agents)`
`void`	`mergePreviousStep()`
`void`	`notifyFailure()`
`void`	`notifyScreenChange()`
`static void`	`overrideEventBusWith(StepEventBus stepEventBus)`
`void`	`reenableWebDriver()`
`void`	`reenableWebdriverCalls()`
`void`	`registerAgent(Agent agent)`
`void`	`registerAgents(Agent... agents)`
`StepEventBus`	`registerListener(StepListener listener)` Register a listener to receive notification at different points during a test's execution.
`void`	`reset()`
`Optional<TestResult>`	`resultSoFar()`
`void`	`setAllStepsTo(TestResult result)` Set all steps in the current test outcome to a given result.
`void`	`setBackgroundDescription(String description)`
`void`	`setBackgroundTitle(String title)`
`static void`	`setCurrentBusToEventBusFor(Object key)`
`static void`	`setNoCleanupForStickyBuses(boolean noCleanup)`
`void`	`setRule(Rule rule)`
`void`	`setTestSource(String testSource)`
`void`	`setUniqueSession(boolean uniqueSession)`
`void`	`skippedStepStarted(ExecutedStepDescription executedStepDescription)` Record a step that is not scheduled to be executed (e.g.
`boolean`	`softAssertsActive()`
`void`	`stepFailed(StepFailure failure)`
`void`	`stepFinished()`
`void`	`stepFinished(List<ScreenshotAndHtmlSource> screenshots)` Called from serial replay - StepFinishedEvent
`void`	`stepIgnored()`
`void`	`stepPending()`
`void`	`stepPending(String message)`
`void`	`stepStarted(ExecutedStepDescription stepDescription)` Start the execution of a test step.
`void`	`stepStarted(ExecutedStepDescription stepDescription, boolean isPrecondition)` Start the execution of a test step.
`void`	`suspendTest()`
`void`	`suspendTest(TestResult result)`
`void`	`takeScreenshot()` Forces Thucydides to take a screenshot now.
`List<ScreenshotAndHtmlSource>`	`takeScreenshots()`
`void`	`temporarilySuspendWebdriverCalls()`
`void`	`testAborted()`
`void`	`testFailed(Throwable cause)` The test failed, but not during the execution of a step.
`void`	`testFinished()`
`void`	`testFinished(boolean inDataDrivenTest)`
`void`	`testFinished(boolean inDataDrivenTest, ZonedDateTime finishTime)`
`void`	`testFinished(TestOutcome result)`
`void`	`testIgnored()`
`void`	`testIsManual()` Mark the current test method as pending.
`void`	`testPending()` Mark the current test method as pending.
`void`	`testRetried()`
`void`	`testRunFinished()`
`void`	`testSkipped()`
`void`	`testStarted(String testName)`
`void`	`testStarted(String newTestName, Class<?> testClass)`
`void`	`testStarted(String newTestName, Story story)`
`void`	`testStarted(String testName, String id)`
`void`	`testStarted(String testName, String id, ZonedDateTime startTime)`
`void`	`testSuiteFinished()`
`boolean`	`testSuiteHasStarted()`
`void`	`testSuiteStarted(Class<?> testClass)`
`void`	`testSuiteStarted(Story story)`
`void`	`unsuspend()` Removes a test suspension
`void`	`updateCurrentStepTitle(String stepTitle)`
`void`	`updateCurrentStepTitleAsPrecondition(String stepTitle)`
`void`	`updateExampleLineNumber(int lineNumber)`
`void`	`updateOverallResults()`
`void`	`useExamplesFrom(DataTable table)`
`void`	`useScenarioOutline(String scenarioOutline)`
`boolean`	`webdriverCallsAreSuspended()`
`void`	`wrapUpCurrentCucumberStep()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- JUNIT_JUPITER_EXECUTION_PARALLEL_ENABLED
```
public static final String JUNIT_JUPITER_EXECUTION_PARALLEL_ENABLED
```
  See Also:
  
  Constant Field Values

Constructor Detail

StepEventBus

@Inject
public StepEventBus(EnvironmentVariables environmentVariables,
                            Configuration configuration)

Method Detail

getEventBus
```
public static StepEventBus getEventBus()
```
The event bus used to inform listening classes about when tests and test steps start and finish. There is a separate event bus for each thread.

getParallelEventBus
```
public static StepEventBus getParallelEventBus()
```
If called from a Cucumber parallel Test session will return the corresponding StepEventBus, otherwise will redirect to getEventBus()

eventBusFor

public static StepEventBus eventBusFor(Object key)

Parameters:: key -
Returns:

setCurrentBusToEventBusFor

public static void setCurrentBusToEventBusFor(Object key)

clearEventBusFor

public static void clearEventBusFor(Object key)

forceClearEventBusFor

public static void forceClearEventBusFor(Object key)

getEnvironmentVariables

public EnvironmentVariables getEnvironmentVariables()

registerListener
```
public StepEventBus registerListener(StepListener listener)
```
Register a listener to receive notification at different points during a test's execution. If you are writing your own listener, you shouldn't need to call this method - just set up your listener implementation as a service (see http://download.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html), place the listener class on the classpath and it will be detected automatically.

isBaseStepListenerRegistered

public boolean isBaseStepListenerRegistered()

getBaseStepListener

public BaseStepListener getBaseStepListener()

testStarted

public void testStarted(String testName)

testStarted

public void testStarted(String testName,
                        String id)

testStarted

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

isUniqueSession
```
public boolean isUniqueSession()
```

setUniqueSession

public void setUniqueSession(boolean uniqueSession)

testStarted

public void testStarted(String newTestName,
                        Story story)

testStarted

public void testStarted(String newTestName,
                        Class<?> testClass)

getAllListeners

protected List<StepListener> getAllListeners()

testSuiteStarted

public void testSuiteStarted(Class<?> testClass)

updateExampleLineNumber

public void updateExampleLineNumber(int lineNumber)

testSuiteStarted

public void testSuiteStarted(Story story)

clear
```
public void clear()
```

unsuspend
```
public void unsuspend()
```
Removes a test suspension

testFinished

public void testFinished(boolean inDataDrivenTest,
                         ZonedDateTime finishTime)

testFinished

public void testFinished(boolean inDataDrivenTest)

finishTestRun
```
public void finishTestRun()
```

testFinished
```
public void testFinished()
```

testFinished

public void testFinished(TestOutcome result)

testRetried
```
public void testRetried()
```

clearStepFailures
```
public void clearStepFailures()
```

aStepInTheCurrentTestHasFailed

public boolean aStepInTheCurrentTestHasFailed()

isCurrentTestDataDriven

public boolean isCurrentTestDataDriven()

stepStarted

public void stepStarted(ExecutedStepDescription stepDescription)

Start the execution of a test step.

stepStarted

public void stepStarted(ExecutedStepDescription stepDescription,
                        boolean isPrecondition)

Start the execution of a test step.

skippedStepStarted
```
public void skippedStepStarted(ExecutedStepDescription executedStepDescription)
```
Record a step that is not scheduled to be executed (e.g. a skipped or ignored step).

stepFinished
```
public void stepFinished()
```

stepFinished
```
public void stepFinished(List<ScreenshotAndHtmlSource> screenshots)
```
Called from serial replay - StepFinishedEvent

Parameters:

screenshots - - screenshots that were recorded when the step was finished

stepFailed

public void stepFailed(StepFailure failure)

lastStepFailed

public void lastStepFailed(StepFailure failure)

stepIgnored
```
public void stepIgnored()
```

stepPending
```
public void stepPending()
```

stepPending

public void stepPending(String message)

assumptionViolated

public void assumptionViolated(String message)

dropListener

public void dropListener(StepListener stepListener)

dropAllListeners
```
public void dropAllListeners()
```

reenableWebDriver
```
public void reenableWebDriver()
```

inFixtureMethod
```
public boolean inFixtureMethod()
```

webdriverCallsAreSuspended

public boolean webdriverCallsAreSuspended()

reenableWebdriverCalls
```
public void reenableWebdriverCalls()
```

temporarilySuspendWebdriverCalls

public void temporarilySuspendWebdriverCalls()

testFailed
```
public void testFailed(Throwable cause)
```
The test failed, but not during the execution of a step.

Parameters:

cause - the underlying cause of the failure.

testPending
```
public void testPending()
```
Mark the current test method as pending. The test will stil be executed to record the steps, but any webdriver calls will be skipped.

testIsManual
```
public void testIsManual()
```
Mark the current test method as pending. The test will stil be executed to record the steps, but any webdriver calls will be skipped.

suspendTest
```
public void suspendTest()
```

suspendTest

public void suspendTest(TestResult result)

useScenarioOutline

public void useScenarioOutline(String scenarioOutline)

currentTestIsSuspended

public boolean currentTestIsSuspended()

assumptionViolated
```
public boolean assumptionViolated()
```

testIgnored
```
public void testIgnored()
```

testSkipped
```
public void testSkipped()
```

testAborted
```
public void testAborted()
```

areStepsRunning
```
public boolean areStepsRunning()
```

notifyScreenChange
```
public void notifyScreenChange()
```

testSuiteFinished
```
public void testSuiteFinished()
```

testRunFinished
```
public void testRunFinished()
```

updateCurrentStepTitle

public void updateCurrentStepTitle(String stepTitle)

updateCurrentStepTitleAsPrecondition

public void updateCurrentStepTitleAsPrecondition(String stepTitle)

addIssuesToCurrentStory

public void addIssuesToCurrentStory(List<String> issues)

addIssuesToCurrentTest

public void addIssuesToCurrentTest(List<String> issues)

addTagsToCurrentTest

public void addTagsToCurrentTest(List<TestTag> tags)

addTagsToCurrentStory

public void addTagsToCurrentStory(List<TestTag> tags)

addDescriptionToCurrentTest

public void addDescriptionToCurrentTest(String description)

setBackgroundTitle

public void setBackgroundTitle(String title)

setBackgroundDescription

public void setBackgroundDescription(String description)

setRule
```
public void setRule(Rule rule)
```

useExamplesFrom

public void useExamplesFrom(DataTable table)

addNewExamplesFrom

public void addNewExamplesFrom(DataTable newTable)

exampleStarted

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

exampleStarted

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

exampleFinished
```
public void exampleFinished()
```

currentTestOutcomeIsDataDriven

public boolean currentTestOutcomeIsDataDriven()

takeScreenshot
```
public void takeScreenshot()
```
Forces Thucydides to take a screenshot now.

notifyFailure
```
public void notifyFailure()
```

testSuiteHasStarted
```
public boolean testSuiteHasStarted()
```

getAssumptionViolatedMessage

public String getAssumptionViolatedMessage()

getCurrentStep

public Optional<TestStep> getCurrentStep()

setAllStepsTo
```
public void setAllStepsTo(TestResult result)
```
Set all steps in the current test outcome to a given result. Used to set all steps to PENDING or SKIPPED, for example.

Parameters:

result -

getForcedResult

public Optional<TestResult> getForcedResult()

isDryRun
```
public boolean isDryRun()
```

enableDryRun
```
public void enableDryRun()
```

exceptionExpected

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

resultSoFar

public Optional<TestResult> resultSoFar()

mergePreviousStep
```
public void mergePreviousStep()
```

updateOverallResults
```
public void updateOverallResults()
```

reset
```
public void reset()
```

disableSoftAsserts
```
public void disableSoftAsserts()
```

enableSoftAsserts
```
public void enableSoftAsserts()
```

softAssertsActive
```
public boolean softAssertsActive()
```

getTestSource
```
public String getTestSource()
```

setTestSource

public void setTestSource(String testSource)

cancelPreviousTest
```
public void cancelPreviousTest()
```

lastTestPassedAfterRetries

public void lastTestPassedAfterRetries(int remainingTries,
                                       List<String> failureMessages,
                                       TestFailureCause testFailureCause)

overrideEventBusWith

public static void overrideEventBusWith(StepEventBus stepEventBus)

castActor
```
public void castActor(String name)
```

initialiseSession
```
public void initialiseSession()
```

registerAgent

public void registerAgent(Agent agent)

registerAgents

public void registerAgents(Agent... agents)

dropAgents

public void dropAgents(Agent... agents)

dropAgent
```
public void dropAgent(Agent agent)
```

mergeActivitiesToDefaultStepListener

public void mergeActivitiesToDefaultStepListener(Agent... agents)

mergeActivitiesToDefaultStepListener

public void mergeActivitiesToDefaultStepListener(String stepName,
                                                 Agent... agents)

wrapUpCurrentCucumberStep

public void wrapUpCurrentCucumberStep()

currentTestHasTag

public boolean currentTestHasTag(TestTag tag)

isASingleBrowserScenario

public boolean isASingleBrowserScenario()

isNewSingleBrowserScenario

public boolean isNewSingleBrowserScenario()

setNoCleanupForStickyBuses

public static void setNoCleanupForStickyBuses(boolean noCleanup)

takeScreenshots

public List<ScreenshotAndHtmlSource> takeScreenshots()

Class StepEventBus

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JUNIT_JUPITER_EXECUTION_PARALLEL_ENABLED

Constructor Detail

StepEventBus

Method Detail

getEventBus

getParallelEventBus

eventBusFor

setCurrentBusToEventBusFor

clearEventBusFor

forceClearEventBusFor

getEnvironmentVariables

registerListener

isBaseStepListenerRegistered

getBaseStepListener

testStarted

testStarted

testStarted

isUniqueSession

setUniqueSession

testStarted

testStarted

getAllListeners

testSuiteStarted

updateExampleLineNumber

testSuiteStarted

clear

unsuspend

testFinished

testFinished

finishTestRun

testFinished

testFinished

testRetried

clearStepFailures

aStepInTheCurrentTestHasFailed

isCurrentTestDataDriven

stepStarted

stepStarted

skippedStepStarted

stepFinished

stepFinished

stepFailed

lastStepFailed

stepIgnored

stepPending

stepPending

assumptionViolated

dropListener

dropAllListeners

reenableWebDriver

inFixtureMethod

webdriverCallsAreSuspended

reenableWebdriverCalls

temporarilySuspendWebdriverCalls

testFailed

testPending

testIsManual

suspendTest

suspendTest

useScenarioOutline

currentTestIsSuspended

assumptionViolated

testIgnored

testSkipped

testAborted

areStepsRunning

notifyScreenChange

testSuiteFinished

testRunFinished

updateCurrentStepTitle

updateCurrentStepTitleAsPrecondition

addIssuesToCurrentStory

addIssuesToCurrentTest

addTagsToCurrentTest