scalatestCoreDotty/org.scalatest.events/RunAborted

RunAborted

final 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

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

For example, object Runner reports RunAborted if the execute method of any of the run's starting Suites completes abruptly with a Throwable.

ScalaTest's Runner fires a RunAborted report with an empty summary, because the reporter is responsible for keeping track of the total number of tests reported as succeeded, failed, ignored, and pending. ScalaTest's internal reporter replaces the RunAborted with a new one that is identical except that is has a defined summary.

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

report(RunAborted(ordinal, message, Some(exception)))
Value parameters:
duration

an optional amount of time, in milliseconds, that was required by the run 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.

message

a localized message suitable for presenting to the user

ordinal

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

payload

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

summary

an optional Summary of the number of tests that were reported as succeeded, failed, ignored, and pending

threadName

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

throwable

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

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

class Event
trait Serializable
trait Product
trait Equals
trait Ordered[Event]
trait Comparable[Event]
class Object
trait Matchable
class Any

Value members

Inherited methods

def <(that: Event): Boolean
Inherited from:
Ordered
def <=(that: Event): Boolean
Inherited from:
Ordered
def >(that: Event): Boolean
Inherited from:
Ordered
def >=(that: Event): Boolean
Inherited from:
Ordered
def compare(that: Event): Int

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.

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.

Value parameters:
return

an integer indicating whether this event is less than, equal to, or greater than the passed event

that

the event to compare to this event

Inherited from:
Event
def compareTo(that: Event): Int
Inherited from:
Ordered
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product