SuiteAborted

final case class SuiteAborted(ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], 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 the execution of a suite of tests has aborted, likely because of an error, prior to completion.

For example, trait Suite and object Runner use SuiteAborted to report that the execute method of a Suite has completed abruptly with a RuntimeException.

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

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

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 suite name, suitable for presenting to the user
message: a localized message suitable for presenting to the user
suiteName: a localized name identifying the suite that has aborted, suitable for presenting to the user
suiteId: a string ID for the suite that has aborted, intended to be unique across all suites in a run
suiteClassName: an optional fully qualifed Suite class name containing the suite that has aborted
throwable: an optional Throwable that, if a Some, indicates why the suite has aborted, or a Throwable created to capture stack trace information about the problem.
duration: an optional amount of time, in milliseconds, that was required to execute the suite that has aborted
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 suite that has aborted. (If None is passed, the suite cannot be rerun.)
payload: an optional object that can be used to pass custom information to the reporter about the SuiteAborted 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, Product, Equals, Ordered[Event], Comparable[Event], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

SuiteAborted
ExceptionalEvent
Event
Serializable
Product
Equals
Ordered
Comparable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new SuiteAborted(ordinal: Ordinal, message: String, suiteName: String, suiteId: String, suiteClassName: Option[String], 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)
ordinal
an Ordinal that can be used to place this event in order in the context of other events reported during the same run suite name, suitable for presenting to the user
message
a localized message suitable for presenting to the user
suiteName
a localized name identifying the suite that has aborted, suitable for presenting to the user
suiteId
a string ID for the suite that has aborted, intended to be unique across all suites in a run
suiteClassName
an optional fully qualifed Suite class name containing the suite that has aborted
throwable
an optional Throwable that, if a Some, indicates why the suite has aborted, or a Throwable created to capture stack trace information about the problem.
duration
an optional amount of time, in milliseconds, that was required to execute the suite that has aborted
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 suite that has aborted. (If None is passed, the suite cannot be rerun.)
payload
an optional object that can be used to pass custom information to the reporter about the SuiteAborted 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

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
def <(that: Event): Boolean
Definition Classes
Ordered
def <=(that: Event): Boolean
Definition Classes
Ordered
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def >(that: Event): Boolean
Definition Classes
Ordered
def >=(that: Event): Boolean
Definition Classes
Ordered
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def compare(that: Event): Int
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
def compareTo(that: Event): Int
Definition Classes
Ordered → Comparable
val duration: Option[Long]
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
val formatter: Option[Formatter]
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
SuiteAborted → Event
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
val location: Option[Location]
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. IDEs can use this information, for example, to allow the user to hop from an event report to the relevant line of source code.
Definition Classes
SuiteAborted → Event
val message: String
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
val ordinal: Ordinal
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
SuiteAborted → Event
val payload: Option[Any]
An optional object that can be used to pass custom information to the reporter about this event.
An optional object that can be used to pass custom information to the reporter about this event.
Definition Classes
SuiteAborted → Event
def productElementNames: Iterator[String]
Definition Classes
Product
val rerunner: Option[String]
val suiteClassName: Option[String]
val suiteId: String
val suiteName: String
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
val threadName: String
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
SuiteAborted → Event
val throwable: Option[Throwable]
val timeStamp: Long
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
SuiteAborted → Event
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

SuiteAborted

Instance Constructors

Value Members

Inherited from ExceptionalEvent

Inherited from Event

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

SuiteAborted

Instance Constructors

Value Members

Inherited from ExceptionalEvent

Inherited from Event

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[Event]

Inherited from Comparable[Event]

Inherited from AnyRef

Inherited from Any

Ungrouped

SuiteAborted