SuiteAborted
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.
Value parameters
- duration
-
an optional amount of time, in milliseconds, that was required to execute the suite that has aborted
- formatter
-
an optional
Formatterthat provides extra information that can be used by reporters in determining how to present this event to the user - location
-
an optional
Locationthat provides information indicating where in the source code an event originated. - message
-
a localized message suitable for presenting to the user
- ordinal
-
an
Ordinalthat 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 - payload
-
an optional object that can be used to pass custom information to the reporter about the
SuiteAbortedevent - rerunner
-
an optional
Stringgiving the fully qualified name of the class that can be used to rerun the suite that has aborted. (IfNoneis passed, the suite cannot be rerun.) - suiteClassName
-
an optional fully qualifed
Suiteclass name containing the suite that has aborted - suiteId
-
a string ID for the suite that has aborted, intended to be unique across all suites in a run
- suiteName
-
a localized name identifying the suite that has aborted, suitable for presenting to the user
- threadName
-
a name for the
Threadabout whose activity this event was reported - throwable
-
an optional
Throwablethat, if aSome, indicates why the suite has aborted, or aThrowablecreated to capture stack trace information about the problem. - timeStamp
-
a
Longindicating 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
Attributes
- Graph
-
- Supertypes
-
trait ExceptionalEventclass Eventtrait Serializabletrait Producttrait Equalstrait Ordered[Event]trait Comparable[Event]class Objecttrait Matchableclass Any