TestCanceled
Event that indicates a test was canceled, i.e., it couldn't run because some precondition was not met.
To create instances of this class you may
use the factory methods. For example, given a report function named report, you could fire a TestCanceled event like this:
report(TestCanceled(ordinal, userFriendlyName, suiteName, Some(thisSuite.getClass.getName), testName))
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 run the test that was canceled
- 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- payload
an optional object that can be used to pass custom information to the reporter about the
TestCanceledevent- recordedEvents
recorded events in the test.
- rerunner
an optional
Stringgiving the fully qualified name of the class that can be used to rerun the test that has canceled. (IfNoneis passed, the test cannot be rerun.)- suiteClassName
an optional fully qualifed
Suiteclass name containing the test that was canceled- suiteId
a string ID for the suite containing the test that was canceled, intended to be unique across all suites in a run
- suiteName
a localized name identifying the suite containing the test that was canceled, suitable for presenting to the user
- testName
the name of the test that was canceled
- testText
the text of the test that was canceled (may be the test name, or a suffix of the test name)
- threadName
a name for the
Threadabout whose activity this event was reported- throwable
an optional
Throwablethat, if aSome, indicates why the test was canceled, 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
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