Trait

org.scalatest

Status

Related Doc: package scalatest

Permalink

sealed trait Status extends AnyRef

The result status of running a test or a suite.

This trait is the return type of the "run" lifecycle methods of trait Suite: run, runNestedSuites, runTests, and runTest. It can be used to determine whether a test or suite has completed, and if completed, whether it succeeded or failed. The main use case for this trait in ScalaTest is to enable BeforeAndAfterAll's afterAll method to wait until all relevant tests and nested suites have completed before performing the "after all" code, even if those tests are nested suites are run in parallel.

Self Type
Status
Source
Status.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Status
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def isCompleted: Boolean

    Permalink

    Non-blocking call that indicates whether the all the tests or nested suites fired off by the run method that returned the Status have completed.

    Non-blocking call that indicates whether the all the tests or nested suites fired off by the run method that returned the Status have completed. Because this is non-blocking, you can use this to poll the completion status.

    returns

    true if the test or suite run is already completed, false otherwise.

  2. abstract def succeeds(): Boolean

    Permalink

    Blocking call that waits until completion, then returns returns true if no tests failed and no suites aborted, else returns false.

    Blocking call that waits until completion, then returns returns true if no tests failed and no suites aborted, else returns false.

    This only reports false if there was a failed test or aborted suite in the context of the "run" lifecycle method it was returned from. For example, if you call succeeds on the return Status of runTest, it returns (after that test has completed) true if the test whose name was passed to runTest succeeded, false if that test failed (or the suite aborts). If you call succeeds on the return value of runTests, by contrast, it returns (after the suite's tests have completed) true only if all tests in the suite succeeded. If any test in the suite fails (or the whole suite aborts), the succeeds call will return false. The Status returned from runNestedSuites will return true only if all tests in all nested suites (and their nested suites, etc.) fired off by that runNestedSuites call succeed and no suites abort. Simlarly, the Status returned from run will return true only if all tests in all nested suites (and their nested suites, etc.) fired off by that run call succeed and no suites abort.

    returns

    true if no tests failed and no suites aborted, false otherwise

  3. abstract def waitUntilCompleted(): Unit

    Permalink

    Blocking call that returns only after the underlying test or suite is completed.

  4. abstract def whenCompleted(f: (Try[Boolean]) ⇒ Unit): Unit

    Permalink

    Registers the passed function to be executed when this status completes.

    Registers the passed function to be executed when this status completes.

    You may register multiple functions, which on completion will be executed in an undefined order.

Concrete 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. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. final def thenRun(f: ⇒ Status): Status

    Permalink
  17. final def toFuture: Future[Boolean]

    Permalink
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. def unreportedException: Option[Throwable]

    Permalink
  20. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def withAfterEffect(f: ⇒ Option[Throwable]): Status

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped