net.thucydides.core.steps

Class StepEventBus

java.lang.Object

net.thucydides.core.steps.StepEventBus

public class StepEventBus
extends java.lang.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.

Constructor Summary

Constructors

Constructor and Description
StepEventBus(ScreenshotProcessor screenshotProcessor, EnvironmentVariables environmentVariables)

Method Summary

Modifier and Type	Method and Description
void	addDescriptionToCurrentTest(java.lang.String description)
void	addIssuesToCurrentStory(java.util.List<java.lang.String> issues)
void	addIssuesToCurrentTest(java.util.List<java.lang.String> issues)
void	addNewExamplesFrom(DataTable newTable)
void	addTagsToCurrentStory(java.util.List<TestTag> tags)
void	addTagsToCurrentTest(java.util.List<TestTag> tags)
boolean	areStepsRunning()
boolean	assumptionViolated()
void	assumptionViolated(java.lang.String message)
boolean	aStepInTheCurrentTestHasFailed()
void	clear()
void	clearStepFailures()
boolean	currentTestIsSuspended()
boolean	currentTestOutcomeIsDataDriven()
void	dropAllListeners()
void	dropListener(StepListener stepListener)
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.lang.String	getAssumptionViolatedMessage()
BaseStepListener	getBaseStepListener()
com.google.common.base.Optional<TestStep>	getCurrentStep()
static StepEventBus	getEventBus() The event bus used to inform listening classes about when tests and test steps start and finish.
com.google.common.base.Optional<TestResult>	getForcedResult()
boolean	isCurrentTestDataDriven()
boolean	isDryRun()
boolean	isUniqueSession()
void	lastStepFailed(StepFailure failure)
void	notifyScreenChange()
void	reenableWebdriverCalls()
StepEventBus	registerListener(StepListener listener) Register a listener to receive notification at different points during a test's execution.
void	setAllStepsTo(TestResult result) Set all steps in the current test outcome to a given result.
void	setBackgroundDescription(java.lang.String description)
void	setBackgroundTitle(java.lang.String title)
void	setUniqueSession(boolean uniqueSession)
void	skippedStepStarted(ExecutedStepDescription executedStepDescription) Record a step that is not scheduled to be executed (e.g.
void	stepFailed(StepFailure failure)
void	stepFinished()
void	stepIgnored()
void	stepPending()
void	stepPending(java.lang.String message)
void	stepStarted(ExecutedStepDescription stepDescription) Start the execution of a test step.
void	suspendTest()
void	takeScreenshot() Forces Thucydides to take a screenshot now.
void	temporarilySuspendWebdriverCalls()
void	testFailed(java.lang.Throwable cause) The test failed, but not during the execution of a step.
void	testFinished()
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(java.lang.String testName)
void	testStarted(java.lang.String newTestName, java.lang.Class<?> testClass)
void	testStarted(java.lang.String newTestName, Story story)
void	testSuiteFinished()
boolean	testSuiteHasStarted()
void	testSuiteStarted(java.lang.Class<?> testClass)
void	testSuiteStarted(Story story)
void	updateCurrentStepTitle(java.lang.String stepTitle)
void	useExamplesFrom(DataTable table)
boolean	webdriverCallsAreSuspended()

Methods inherited from class java.lang.Object

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

Constructor Detail

StepEventBus

@Inject
public StepEventBus(ScreenshotProcessor screenshotProcessor,
                            EnvironmentVariables environmentVariables)

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.

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.

getBaseStepListener

public BaseStepListener getBaseStepListener()

testStarted

public void testStarted(java.lang.String testName)

isUniqueSession

public boolean isUniqueSession()

setUniqueSession

public void setUniqueSession(boolean uniqueSession)

testStarted

public void testStarted(java.lang.String newTestName,
                        Story story)

testStarted

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

testSuiteStarted

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

testSuiteStarted

public void testSuiteStarted(Story story)

clear

public void clear()

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.

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

stepFailed

public void stepFailed(StepFailure failure)

lastStepFailed

public void lastStepFailed(StepFailure failure)

stepIgnored

public void stepIgnored()

stepPending

public void stepPending()

stepPending

public void stepPending(java.lang.String message)

assumptionViolated

public void assumptionViolated(java.lang.String message)

dropListener

public void dropListener(StepListener stepListener)

dropAllListeners

public void dropAllListeners()

webdriverCallsAreSuspended

public boolean webdriverCallsAreSuspended()

reenableWebdriverCalls

public void reenableWebdriverCalls()

temporarilySuspendWebdriverCalls

public void temporarilySuspendWebdriverCalls()

testFailed

public void testFailed(java.lang.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()

currentTestIsSuspended

public boolean currentTestIsSuspended()

assumptionViolated

public boolean assumptionViolated()

testIgnored

public void testIgnored()

testSkipped

public void testSkipped()

areStepsRunning

public boolean areStepsRunning()

notifyScreenChange

public void notifyScreenChange()

testSuiteFinished

public void testSuiteFinished()

testRunFinished

public void testRunFinished()

updateCurrentStepTitle

public void updateCurrentStepTitle(java.lang.String stepTitle)

addIssuesToCurrentStory

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

addIssuesToCurrentTest

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

addTagsToCurrentTest

public void addTagsToCurrentTest(java.util.List<TestTag> tags)

addTagsToCurrentStory

public void addTagsToCurrentStory(java.util.List<TestTag> tags)

addDescriptionToCurrentTest

public void addDescriptionToCurrentTest(java.lang.String description)

setBackgroundTitle

public void setBackgroundTitle(java.lang.String title)

setBackgroundDescription

public void setBackgroundDescription(java.lang.String description)

useExamplesFrom

public void useExamplesFrom(DataTable table)

addNewExamplesFrom

public void addNewExamplesFrom(DataTable newTable)

exampleStarted

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

exampleFinished

public void exampleFinished()

currentTestOutcomeIsDataDriven

public boolean currentTestOutcomeIsDataDriven()

takeScreenshot

public void takeScreenshot()

Forces Thucydides to take a screenshot now.

testSuiteHasStarted

public boolean testSuiteHasStarted()

getAssumptionViolatedMessage

public java.lang.String getAssumptionViolatedMessage()

getCurrentStep

public com.google.common.base.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 com.google.common.base.Optional<TestResult> getForcedResult()

isDryRun

public boolean isDryRun()

exceptionExpected

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