SuiteStarting
Event that indicates a suite of tests is about to start executing.
For example, trait Suite
and object Runner
use SuiteStarting
to report
that the execute
method of a Suite
is about to be invoked.
To create instances of this class you may use the factory method. For example, given a
report function named report
, you could fire a SuiteStarting
event like this:
report(SuiteStarting(ordinal, userFriendlyName, 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:
- 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.- 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
SuiteStarting
event- rerunner
an optional
String
giving the fully qualified name of the class that can be used to rerun the suite that is starting. (IfNone
is passed, the suite cannot be rerun.)- suiteClassName
an optional fully qualifed
Suite
class name of the suite that is starting- suiteId
a string ID for the suite that is starting, intended to be unique across all suites in a run XXX
- suiteName
a localized name identifying the suite that is starting, suitable for presenting to the user
- 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
Inherited methods
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