Invoked to report an event that subclasses may wish to report in some way to the user
Invoked to report an event that subclasses may wish to report in some way to the user.
the event being reported
This method is used to compare the receiver object (this
)
with the argument object (arg0
) for equivalence
This method is used to compare the receiver object (this
)
with the argument object (arg0
) for equivalence.
The default implementations of this method is an equivalence relation:
x
of type Any
,
x.equals(x)
should return true
.x
and y
of type
Any
, x.equals(y)
should return true
if and only
if y.equals(x)
returns true
.x
, y
, and z
of type AnyRef
if x.equals(y)
returns true
and
y.equals(z)
returns
true
, then x.equals(z)
should return true
.
If you override this method, you should verify that
your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to
override hashCode
to ensure that objects that are
"equal" (o1.equals(o2)
returns true
)
hash to the same Int
(o1.hashCode.equals(o2.hashCode)
).
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
Returns a hash code value for the object
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash
codes (o1.hashCode.equals(o2.hashCode)
) yet not be
equal (o1.equals(o2)
returns false
). A
degenerate implementation could always return 0
.
However, it is required that if two objects are equal
(o1.equals(o2)
returns true
) that they
have identical hash codes
(o1.hashCode.equals(o2.hashCode)
). Therefore, when
overriding this method, be sure to verify that the behavior is
consistent with the equals
method.
Returns a string representation of the object
Returns a string representation of the object.
The default representation is platform dependent.
Trait whose instances collect the results of a running suite of tests and presents those results in some way to the user. Instances of this trait can be called "report functions" or "reporters."
Reporters receive test results via thirteen events. Each event is fired to pass a particular kind of information to the reporter. The events are:
RunStarting
TestStarting
TestSucceeded
TestFailed
TestIgnored
TestPending
SuiteStarting
SuiteCompleted
SuiteAborted
InfoProvided
RunStopped
RunAborted
RunCompleted
Reporters may be implemented such that they only present some of the reported events to the user. For example, you could define a reporter class that doesn nothing in response to
SuiteStarting
events. Such a class would always ignoreSuiteStarting
events.The term test as used in the
TestStarting
,TestSucceeded
, andTestFailed
event names is defined abstractly to enable a wide range of test implementations. TraitSuite
firesTestStarting
to indicate it is about to invoke one of its test methods,TestSucceeded
to indicate a test method returned normally, andTestFailed
to indicate a test method completed abruptly with an exception. Although the execution of aSuite
's test methods will likely be a common event reported via theTestStarting
,TestSucceeded
, andTestFailed
methods, because of the abstract definition of “test” used by the the event classes, these events are not limited to this use. Information about any conceptual test may be reported via theTestStarting
,TestSucceeded
, andTestFailed
events.Likewise, the term suite as used in the
SuiteStarting
,SuiteAborted
, andSuiteCompleted
event names is defined abstractly to enable a wide range of suite implementations. ObjectRunner
firesSuiteStarting
to indicate it is about to invokerun
on aSuite
,SuiteCompleted
to indicate aSuite
'srun
method returned normally, andSuiteAborted
to indicate aSuite
'srun
method completed abruptly with an exception. Similarly, classSuite
firesSuiteStarting
to indicate it is about to invokerun
on a nestedSuite
,SuiteCompleted
to indicate a nestedSuite
'srun
method returned normally, andSuiteAborted
to indicate a nestedSuite
'srun
method completed abruptly with an exception. Although the execution of aSuite
'srun
method will likely be a common event reported via theSuiteStarting
,SuiteAborted
, andSuiteCompleted
events, because of the abstract definition of "suite" used by the event classes, these events are not limited to this use. Information about any conceptual suite may be reported via theSuiteStarting
,SuiteAborted
, andSuiteCompleted
events.Extensibility
You can create classes that extend
ReportFunction
to report test results in custom ways, and to report custom information passed as an event "payload." For more information on the latter use case, see the Extensibility section of theEvent
documentation.Reporter classes can handle events in any manner, including doing nothing. For convenience, trait
ReporterFunction
includes a default implentation ofapply
that does nothing.