sealed abstract class Outcome extends Product with Serializable
Superclass for the possible outcomes of running a test.
Outcome
is the result type of the withFixture
methods of traits
Suite
and fixture.Suite
, as well as their
NoArgTest
and OneArgTest
function types.
The four possible outcomes are:
Succeeded
- indicates a test succeededFailed
- indicates a test failed and contains an exception describing the failureCanceled
- indicates a test was canceled and contains an exception describing the cancelationPending
- indicates a test was pending
Note that "ignored" does not appear as a type of Outcome
, because tests are
marked as ignored on the outside and skipped over as the suite executes. So an ignored test never runs, and therefore
never has an outcome. By contrast, a test is determined to be pending by running the test
and observing the actual outcome. If the test body completes abruptly with a TestPendingException
,
then the outcome was that the test was pending.
- Source
- Outcome.scala
- Alphabetic
- By Inheritance
- Outcome
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
canEqual(that: Any): Boolean
- Definition Classes
- Equals
-
abstract
def
productArity: Int
- Definition Classes
- Product
-
abstract
def
productElement(n: Int): Any
- Definition Classes
- Product
-
abstract
def
toSucceeded: Succeeded.type
Converts this
Outcome
to aSucceeded
.Converts this
Outcome
to aSucceeded
.When this
Outcome
instance is not Succeeded, it behaves as followed:- Failed(ex) - throws ex
- Canceled(tce) - throws tce
- Pending - throws TestPendingException
- returns
Succeeded if this
Outcome
instance is a Succeeded.
Concrete Value Members
-
val
isCanceled: Boolean
Indicates whether this
Outcome
represents a test that was canceled.Indicates whether this
Outcome
represents a test that was canceled.This class's implementation of this method always returns
false
.- returns
true if this
Outcome
is an instance ofCanceled
.
-
val
isExceptional: Boolean
Indicates whether this
Outcome
represents a test that either failed or was canceled, in which case thisOutcome
will contain an exception.Indicates whether this
Outcome
represents a test that either failed or was canceled, in which case thisOutcome
will contain an exception.- returns
true if this
Outcome
is an instance of eitherFailed
orCanceled
.
-
val
isFailed: Boolean
Indicates whether this
Outcome
represents a test that failed.Indicates whether this
Outcome
represents a test that failed.This class's implementation of this method always returns
false
.- returns
true if this
Outcome
is an instance ofFailed
.
-
val
isPending: Boolean
Indicates whether this
Outcome
represents a test that was pending.Indicates whether this
Outcome
represents a test that was pending.This class's implementation of this method always returns
false
.- returns
true if this
Outcome
is an instance ofPending
.
-
val
isSucceeded: Boolean
Indicates whether this
Outcome
represents a test that succeeded.Indicates whether this
Outcome
represents a test that succeeded.This class's implementation of this method always returns
false
.- returns
true if this
Outcome
is an instance ofSucceeded
.
-
def
productIterator: Iterator[Any]
- Definition Classes
- Product
-
def
productPrefix: String
- Definition Classes
- Product
-
def
toOption: Option[Throwable]
Converts this
Outcome
to anOption[Throwable]
.Converts this
Outcome
to anOption[Throwable]
.This class's implementation of this method always returns
None
.- returns
a
Some
wrapping the contained exception if thisOutcome
is an instance of eitherFailed
orCanceled
.