TestIgnored
Event that indicates a suite (or other entity) has ignored a test.
For example, trait Suite
uses TestIgnored
to report that a test method of a Suite
was ignored because it was annotated with @Ignore
. Ignored tests will not be run, but will usually be reported as reminder to fix the broken test.
To create instances of this class you may use the factory method. For example, given a report function named report
, you could fire a TestIgnored
event like this:
report(TestIgnored(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
- 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
TestIgnored
event - suiteClassName
-
an optional fully qualifed
Suite
class name containing the test that was ignored - suiteId
-
a string ID for the suite containing the test that was ignored, intended to be unique across all suites in a run
- suiteName
-
a localized name identifying the suite containing the test that was ignored, suitable for presenting to the user
- testName
-
the name of the test that was ignored
- testText
-
the text of the test that was ignored (may be the test name, or a suffix of the test name)
- 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
Attributes
- Graph
-
- Supertypes