Object/Class

org.scalatest

Outcome

Related Docs: class Outcome | package scalatest

Permalink

object Outcome

Companion object for trait Outcome that contains an implicit method that enables collections of Outcomes to be flattened into a collections of contained exceptions.

Source
Outcome.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Outcome
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. implicit def convertOutcomeToIterator(outcome: Outcome): Iterator[Throwable]

    Permalink

    Enables collections of Outcomes to be flattened into a collections of contained exceptions.

    Enables collections of Outcomes to be flattened into a collections of contained exceptions.

    Here's an example:

    scala> import org.scalatest._
    import org.scalatest._
    
    scala> import prop.TableDrivenPropertyChecks._
    import prop.TableDrivenPropertyChecks._
    
    scala> val squares = // (includes errors)
         |   Table(
         |     ("x", "square"),
         |     ( 0 ,     0   ),
         |     ( 1 ,     1   ),
         |     ( 2 ,     4   ),
         |     ( 3 ,     8   ),
         |     ( 4 ,    16   ),
         |     ( 5 ,    26   ),
         |     ( 6 ,    36   )
         |   )
    squares: org.scalatest.prop.TableFor2[Int,Int] =
      TableFor2((x,square), (0,0), (1,1), (2,4), (3,8), (4,16), (5,26), (6,36))
    

    Given the above table, which includes some errors, you can obtain an IndexedSeq of the Outcomes of executing an assertion on each row of the table with outcomeOf, like this:

    scala> import OutcomeOf._
    import OutcomeOf._
    
    scala> import Matchers._
    import Matchers._
    
    scala> val outcomes = for ((x, square) <- squares) yield outcomeOf { square shouldEqual x * x }
    outcomes: IndexedSeq[org.scalatest.Outcome] =
      Vector(Succeeded, Succeeded, Succeeded,
      Failed(org.scalatest.exceptions.TestFailedException: 8 did not equal 9), Succeeded,
      Failed(org.scalatest.exceptions.TestFailedException: 26 did not equal 25), Succeeded)
    

    Now you have a collection of all the outcomes, including successful ones. If you just want the Failed and Canceled outcomes, which contain exceptions, you can filter out anything that isn't "exceptional," like this:

    scala> outcomes.filter(_.isExceptional)
    res1: IndexedSeq[org.scalatest.Outcome] =
      Vector(Failed(org.scalatest.exceptions.TestFailedException: 8 did not equal 9),
      Failed(org.scalatest.exceptions.TestFailedException: 26 did not equal 25))
    

    But if you just wanted the contained exceptions, you can (thanks to this implicit method) invoke flatten on your collection:

    scala> outcomes.flatten
    res2: IndexedSeq[Throwable] =
      Vector(org.scalatest.exceptions.TestFailedException: 8 did not equal 9,
      org.scalatest.exceptions.TestFailedException: 26 did not equal 25)
    

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped