Class

org.scalatest.events

TestFailed

Related Doc: package events

Permalink

final case class TestFailed(ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], throwable: Option[Throwable] = None, duration: Option[Long] = None, formatter: Option[Formatter] = None, location: Option[Location] = None, rerunner: Option[String] = None, payload: Option[Any] = None, threadName: String = Thread.currentThread.getName, timeStamp: Long = new Date).getTime) extends Event with ExceptionalEvent with Product with Serializable

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

For example, trait Suite uses TestFailed to report that a test method of a Suite completed abruptly with an Exception.

To create instances of this class you may use the factory method. For example, given a report function named report, you could fire a TestFailed event like this:

report(TestFailed(ordinal, userFriendlyName, message, suiteName, Some(thisSuite.getClass.getName), testName))

The suite class name parameter is optional, because suites in ScalaTest are an abstraction that need not necessarily correspond to one class. Nevertheless, in most cases each suite will correspond to a class, and when it does, the fully qualified name of that class should be reported by passing a Some for suiteClassName. One use for this bit of information is JUnit integration, because the "name" provided to a JUnit org.junit.runner.Description appears to usually include a fully qualified class name by convention.

ordinal

an Ordinal that can be used to place this event in order in the context of other events reported during the same run

message

a localized message suitable for presenting to the user

suiteName

a localized name identifying the suite containing the test that has failed, suitable for presenting to the user

suiteId

a string ID for the suite containing the test that has failed, intended to be unique across all suites in a run

suiteClassName

an optional fully qualifed Suite class name containing the test that has failed

testName

the name of the test that has failed

testText

the text of the test that has failed (may be the test name, or a suffix of the test name)

recordedEvents

recorded events in the test.

throwable

an optional Throwable that, if a Some, indicates why the test has failed, or a Throwable created to capture stack trace information about the problem.

duration

an optional amount of time, in milliseconds, that was required to run the test that has failed

formatter

an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

location

An optional Location that provides information indicating where in the source code an event originated.

rerunner

an optional String giving the fully qualified name of the class that can be used to rerun the test that has failed. (If None is passed, the test cannot be rerun.)

payload

an optional object that can be used to pass custom information to the reporter about the TestFailed event

threadName

a name for the Thread about whose activity this event was reported

timeStamp

a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

Source
Event.scala
Linear Supertypes
ExceptionalEvent, Event, Serializable, Serializable, Product, Equals, Ordered[Event], Comparable[Event], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestFailed
  2. ExceptionalEvent
  3. Event
  4. Serializable
  5. Serializable
  6. Product
  7. Equals
  8. Ordered
  9. Comparable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TestFailed(ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], testName: String, testText: String, recordedEvents: IndexedSeq[RecordableEvent], throwable: Option[Throwable] = None, duration: Option[Long] = None, formatter: Option[Formatter] = None, location: Option[Location] = None, rerunner: Option[String] = None, payload: Option[Any] = None, threadName: String = Thread.currentThread.getName, timeStamp: Long = new Date).getTime)

    Permalink

    ordinal

    an Ordinal that can be used to place this event in order in the context of other events reported during the same run

    message

    a localized message suitable for presenting to the user

    suiteName

    a localized name identifying the suite containing the test that has failed, suitable for presenting to the user

    suiteId

    a string ID for the suite containing the test that has failed, intended to be unique across all suites in a run

    suiteClassName

    an optional fully qualifed Suite class name containing the test that has failed

    testName

    the name of the test that has failed

    testText

    the text of the test that has failed (may be the test name, or a suffix of the test name)

    recordedEvents

    recorded events in the test.

    throwable

    an optional Throwable that, if a Some, indicates why the test has failed, or a Throwable created to capture stack trace information about the problem.

    duration

    an optional amount of time, in milliseconds, that was required to run the test that has failed

    formatter

    an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

    location

    An optional Location that provides information indicating where in the source code an event originated.

    rerunner

    an optional String giving the fully qualified name of the class that can be used to rerun the test that has failed. (If None is passed, the test cannot be rerun.)

    payload

    an optional object that can be used to pass custom information to the reporter about the TestFailed event

    threadName

    a name for the Thread about whose activity this event was reported

    timeStamp

    a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def <(that: Event): Boolean

    Permalink
    Definition Classes
    Ordered
  4. def <=(that: Event): Boolean

    Permalink
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def >(that: Event): Boolean

    Permalink
    Definition Classes
    Ordered
  7. def >=(that: Event): Boolean

    Permalink
    Definition Classes
    Ordered
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def compare(that: Event): Int

    Permalink

    Comparing this event with the event passed as that.

    Comparing this event with the event passed as that. Returns x, where x < 0 iff this < that, x == 0 iff this == that, x > 0 iff this > that.

    that

    the event to compare to this event

    Definition Classes
    Event → Ordered
  11. def compareTo(that: Event): Int

    Permalink
    Definition Classes
    Ordered → Comparable
  12. val duration: Option[Long]

    Permalink

    an optional amount of time, in milliseconds, that was required to run the test that has failed

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. val formatter: Option[Formatter]

    Permalink

    an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

    an optional Formatter that provides extra information that can be used by reporters in determining how to present this event to the user

    Definition Classes
    TestFailedEvent
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. val location: Option[Location]

    Permalink

    An optional Location that provides information indicating where in the source code an event originated.

    An optional Location that provides information indicating where in the source code an event originated.

    Definition Classes
    TestFailedEvent
  19. val message: String

    Permalink

    a localized message suitable for presenting to the user

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. val ordinal: Ordinal

    Permalink

    an Ordinal that can be used to place this event in order in the context of other events reported during the same run

    an Ordinal that can be used to place this event in order in the context of other events reported during the same run

    Definition Classes
    TestFailedEvent
  24. val payload: Option[Any]

    Permalink

    an optional object that can be used to pass custom information to the reporter about the TestFailed event

    an optional object that can be used to pass custom information to the reporter about the TestFailed event

    Definition Classes
    TestFailedEvent
  25. val recordedEvents: IndexedSeq[RecordableEvent]

    Permalink

    recorded events in the test.

  26. val rerunner: Option[String]

    Permalink

    an optional String giving the fully qualified name of the class that can be used to rerun the test that has failed.

    an optional String giving the fully qualified name of the class that can be used to rerun the test that has failed. (If None is passed, the test cannot be rerun.)

  27. val suiteClassName: Option[String]

    Permalink

    an optional fully qualifed Suite class name containing the test that has failed

    an optional fully qualifed Suite class name containing the test that has failed

  28. val suiteId: String

    Permalink

    a string ID for the suite containing the test that has failed, intended to be unique across all suites in a run

  29. val suiteName: String

    Permalink

    a localized name identifying the suite containing the test that has failed, suitable for presenting to the user

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. val testName: String

    Permalink

    the name of the test that has failed

  32. val testText: String

    Permalink

    the text of the test that has failed (may be the test name, or a suffix of the test name)

  33. val threadName: String

    Permalink

    a name for the Thread about whose activity this event was reported

    a name for the Thread about whose activity this event was reported

    Definition Classes
    TestFailedEvent
  34. val throwable: Option[Throwable]

    Permalink

    an optional Throwable that, if a Some, indicates why the test has failed, or a Throwable created to capture stack trace information about the problem.

    an optional Throwable that, if a Some, indicates why the test has failed, or a Throwable created to capture stack trace information about the problem.

  35. val timeStamp: Long

    Permalink

    a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

    a Long indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT

    Definition Classes
    TestFailedEvent
  36. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExceptionalEvent

Inherited from Event

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped