Package net.thucydides.core.steps

Class StepEventBus

java.lang.Object
net.thucydides.core.steps.StepEventBus
Direct Known Subclasses:
SilentEventBus
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 Details

  • Method Details

    • 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.

    • eventBusFor

      public static StepEventBus eventBusFor​(java.lang.Object key)
      Parameters:
      key -
      Returns:

    • setCurrentBusToEventBusFor

      public static void setCurrentBusToEventBusFor​(java.lang.Object key)

    • clearEventBusFor

      public static void clearEventBusFor​(java.lang.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​(java.lang.String testName)

    • testStarted

      public void testStarted​(java.lang.String testName, java.lang.String id)

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

    • getAllListeners

      protected java.util.List<StepListener> getAllListeners()

    • testSuiteStarted

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

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

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

    • reenableWebDriver

      public void reenableWebDriver()

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

    • suspendTest

      public void suspendTest​(TestResult result)

    • useScenarioOutline

      public void useScenarioOutline​(java.lang.String scenarioOutline)

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

    • updateCurrentStepTitleAsPrecondition

      public void updateCurrentStepTitleAsPrecondition​(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)

    • setRule

      public void setRule​(Rule rule)

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

    • exampleStarted

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

    • 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 java.util.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 java.util.Optional<TestResult> getForcedResult()

    • isDryRun

      public boolean isDryRun()

    • enableDryRun

      public void enableDryRun()

    • exceptionExpected

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

    • resultSoFar

      public java.util.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 java.lang.String getTestSource()

    • setTestSource

      public void setTestSource​(java.lang.String testSource)

    • cancelPreviousTest

      public void cancelPreviousTest()

    • lastTestPassedAfterRetries

      public void lastTestPassedAfterRetries​(int remainingTries, java.util.List<java.lang.String> failureMessages, TestFailureCause testFailureCause)

    • overrideEventBusWith

      public static void overrideEventBusWith​(StepEventBus stepEventBus)

    • castActor

      public void castActor​(java.lang.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​(java.lang.String stepName, Agent... agents)