org.scalatest

events

package events

Visibility
  1. Public
  2. All

Type Members

  1. class Event extends Ordered[Event] with Serializable

    A base class for the events that can be passed to the report function passed to the execute method of a Suite.

  2. class Formatter extends AnyRef

    Abstract class for the optional formatter objects that must be passed to the Events reported during a ScalaTest run.

  3. case class IndentedText (formattedText: String, rawText: String, indentationLevel: Int) extends Formatter with Product with Serializable

    A Formatter providing information that enables reporters to create more stylized output.

  4. case class InfoProvided (ordinal: Ordinal, message: String, nameInfo: Option[NameInfo], throwable: Option[Throwable], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with RecordableEvent with Product with Serializable

    Event used to provide information that is not appropriate to report via any other Event.

  5. case class LineInFile (lineNumber: Int, fileName: String) extends Location with Product with Serializable

    An arbitrary line number in a named source file.

  6. class Location extends AnyRef

    Location in source code about which an event concerns.

  7. case class MarkupProvided (ordinal: Ordinal, text: String, nameInfo: Option[NameInfo], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with RecordableEvent with Product with Serializable

    Event used to provide markup text for document-style reports.

  8. case class NameInfo (suiteName: String, suiteID: String, suiteClassName: Option[String], testName: Option[String]) extends Product with Serializable

    Class that holds information about names for the information events InfoProvided, MarkupProvided, ScopeOpened, and ScopeClosed.

  9. class Ordinal extends Ordered[Ordinal] with Serializable

    Class used to specify a sequential order for events reported during a test run, so they can be arranged in that order in a report even if the events were fired in some other order during concurrent or distributed execution.

  10. trait RecordableEvent extends Event

    Marker trait for test completed event's recordedEvents.

  11. case class RunAborted (ordinal: Ordinal, message: String, throwable: Option[Throwable], duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a runner encountered an error while attempting to run a suite of tests.

  12. case class RunCompleted (ordinal: Ordinal, duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a runner has completed running a suite of tests.

  13. case class RunStarting (ordinal: Ordinal, testCount: Int, configMap: Map[String, Any], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a runner is about run a suite of tests.

  14. case class RunStopped (ordinal: Ordinal, duration: Option[Long], summary: Option[Summary], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a runner has stopped running a suite of tests prior to completion, likely because of a stop request.

  15. case class ScopeClosed (ordinal: Ordinal, message: String, nameInfo: NameInfo, formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a scope has been closed.

  16. case class ScopeOpened (ordinal: Ordinal, message: String, nameInfo: NameInfo, formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a new scope has been opened.

  17. case class SuiteAborted (ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], throwable: Option[Throwable], duration: Option[Long], formatter: Option[Formatter], location: Option[Location], rerunner: Option[String], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates the execution of a suite of tests has aborted, likely because of an error, prior to completion.

  18. case class SuiteCompleted (ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], duration: Option[Long], formatter: Option[Formatter], location: Option[Location], rerunner: Option[String], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a suite of tests has completed executing.

  19. case class SuiteStarting (ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], formatter: Option[Formatter], location: Option[Location], rerunner: Option[String], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a suite of tests is about to start executing.

  20. case class Summary (testsSucceededCount: Int, testsFailedCount: Int, testsIgnoredCount: Int, testsPendingCount: Int, testsCanceledCount: Int, suitesCompletedCount: Int, suitesAbortedCount: Int) extends Product with Serializable

    Class each of whose instances hold summary information about one ScalaTest run.

  21. case class TestCanceled (ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], throwable: Option[Throwable], duration: Option[Long], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a test was canceled, i.e., it couldn't run because some precondition was not met.

  22. case class TestFailed (ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], throwable: Option[Throwable], duration: Option[Long], formatter: Option[Formatter], location: Option[Location], rerunner: Option[String], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a suite (or other entity) has completed running a test that failed.

  23. case class TestIgnored (ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a suite (or other entity) has ignored a test.

  24. case class TestPending (ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], duration: Option[Long], formatter: Option[Formatter], location: Option[Location], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a test is pending, i.e., it hasn't yet been implemented.

  25. case class TestStarting (ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, formatter: Option[Formatter], location: Option[Location], rerunner: Option[String], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a suite (or other entity) is about to start running a test.

  26. case class TestSucceeded (ordinal: Ordinal, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], duration: Option[Long], formatter: Option[Formatter], location: Option[Location], rerunner: Option[String], payload: Option[Any], threadName: String, timeStamp: Long) extends Event with Product with Serializable

    Event that indicates a suite (or other entity) has completed running a test that succeeded.

  27. case class TopOfClass (className: String) extends Location with Product with Serializable

    The location in a source file where the class whose by the fully qualified name is passed as className is declared.

  28. case class TopOfMethod (className: String, methodId: String) extends Location with Product with Serializable

    The location in a source file where the method identified by the passed methodId in the class whose fully qualified name is pased as className is declared.

Value Members

  1. object DeprecatedNameInfo extends AnyRef

    Singleton object containing an extractor that was in the NameInfo companion object prior to ScalaTest 2.

  2. object MotionToSuppress extends Formatter with Product with Serializable

    A Formatter that indicates reporters may wish to suppress reporting of an Event.

  3. object NameInfo extends Serializable

    Companion object for case class NameInfo.

  4. object SeeStackDepthException extends Location with Product with Serializable

    Indicates the location should be taken from the stack depth exception, included elsewhere in the event that contained this location.

  5. object Summary extends Serializable

    Companion object for case class Summary.

  6. object ToDoLocation extends Location with Product with Serializable

    Interim one that I can quickly put in to get the compile going, and later I can go back carefully and do them correctly.

  7. object DeprecatedInfoProvided extends AnyRef

    Deprecated singleton object for the InfoProvided event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on InfoProvided objects.

  8. object DeprecatedRunAborted extends AnyRef

    Deprecated singleton object for the RunAborted event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on RunAborted objects.

  9. object DeprecatedRunCompleted extends AnyRef

    Deprecated singleton object for the RunCompleted event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on RunCompleted objects.

  10. object DeprecatedRunStarting extends AnyRef

    Deprecated singleton object for the RunStarting event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on RunStarting objects.

  11. object DeprecatedRunStopped extends AnyRef

    Deprecated singleton object for the RunStopped event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on RunStopped objects.

  12. object DeprecatedSuiteAborted extends AnyRef

    Deprecated singleton object for the SuiteAborted event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on SuiteAborted objects.

  13. object DeprecatedSuiteCompleted extends AnyRef

    Deprecated singleton object for the SuiteCompleted event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on SuiteCompleted objects.

  14. object DeprecatedSuiteStarting extends AnyRef

    Deprecated singleton object for the SuiteStarting event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on SuiteStarting objects.

  15. object DeprecatedTestFailed extends AnyRef

    Deprecated singleton object for the TestFailed event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestFailed objects.

  16. object DeprecatedTestIgnored extends AnyRef

    Deprecated singleton object for the TestIgnored event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestIgnored objects.

  17. object DeprecatedTestPending extends AnyRef

    Deprecated singleton object for the TestPending event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestPending objects.

  18. object DeprecatedTestStarting extends AnyRef

    Deprecated singleton object for the TestStarting event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestStarting objects.

  19. object DeprecatedTestSucceeded extends AnyRef

    Deprecated singleton object for the TestSucceeded event, which contains overloaded factory methods and an extractor method to facilitate pattern matching on TestSucceeded objects.