RunCompleted
Event that indicates a runner has completed running a suite of tests.
Suite
's execute
method takes a Stopper
, whose stopRequested
method indicates a stop was requested. If true
is returned by
stopRequested
while a suite of tests is running, the
execute
method should promptly
return even if that suite hasn't finished running all of its tests.
If a stop was requested via the Stopper
.
Runner
will report RunStopped
when the execute
method of the run's starting Suite
returns.
If a stop is not requested, Runner
will report RunCompleted
when the last execute
method of the run's starting Suite
s returns.
ScalaTest's Runner
fires a RunCompleted
report with an empty summary
, because
the reporter is responsible for keeping track of the total number of tests reported as succeeded, failed, ignored, pending
and canceled. ScalaTest's internal reporter replaces the RunCompleted
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 RunCompleted
event like this:
report(RunCompleted(ordinal))
- Value parameters:
- duration
an optional amount of time, in milliseconds, that was required by the run that has completed
- 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
RunCompleted
event- summary
an optional
Summary
of the number of tests that were reported as succeeded, failed, ignored, pending and canceled- 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