Class/Object

zio.test

Spec

Related Docs: object Spec | package test

Permalink

final case class Spec[-R, +E, +L, +T](caseValue: SpecCase[R, E, L, T, Spec[R, E, L, T]]) extends Product with Serializable

A Spec[R, E, L, T] is the backbone of _ZIO Test_. Every spec is either a suite, which contains other specs, or a test of type T. All specs are annotated with labels of type L, require an environment of type R and may potentially fail with an error of type E.

Self Type
Spec[R, E, L, T]
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Spec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Spec(caseValue: SpecCase[R, E, L, T, Spec[R, E, L, T]])

    Permalink

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 @@[R0 <: R1, R1 <: R, E0, E1, E2 >: E0 <: E1, S0, S1, S >: S0 <: S1](aspect: TestAspect[R0, R1, E0, E1, S0, S1])(implicit ev1: <:<[E, TestFailure[E2]], ev2: <:<[T, TestSuccess[S]]): ZSpec[R1, E2, L, S]

    Permalink

    Syntax for adding aspects.

    Syntax for adding aspects.

    test("foo") { assert(42, equalTo(42)) } @@ ignore
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. final def bimap[E1, T1](f: (E) ⇒ E1, g: (T) ⇒ T1)(implicit ev: CanFail[E]): Spec[R, E1, L, T1]

    Permalink

    Returns a new spec with remapped errors and tests.

  7. val caseValue: SpecCase[R, E, L, T, Spec[R, E, L, T]]

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def distinguish: Spec[R, E, Either[L, L], T]

    Permalink

    Returns a new spec with the suite labels distinguished by Left, and the test labels distinguished by Right.

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

    Permalink
    Definition Classes
    AnyRef
  11. final def exists[R1 <: R, E1 >: E](f: (SpecCase[R, E, L, T, Any]) ⇒ ZIO[R1, E1, Boolean]): ZIO[R1, E1, Boolean]

    Permalink

    Determines if any node in the spec is satisfied by the given predicate.

  12. final def filterLabels(f: (L) ⇒ Boolean): Option[Spec[R, E, L, T]]

    Permalink

    Returns a new Spec containing only tests/suites with labels satisfying the specified predicate.

  13. final def filterTestLabels(f: (L) ⇒ Boolean): Option[Spec[R, E, L, T]]

    Permalink

    Returns a new Spec containing only tests with labels satisfying the specified predicate.

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def fold[Z](f: (SpecCase[R, E, L, T, Z]) ⇒ Z): Z

    Permalink

    Folds over all nodes to produce a final result.

  16. final def foldM[R1 <: R, E1, Z](defExec: ExecutionStrategy)(f: (SpecCase[R, E, L, T, Z]) ⇒ ZIO[R1, E1, Z]): ZIO[R1, E1, Z]

    Permalink

    Effectfully folds over all nodes according to the execution strategy of suites, utilizing the specified default for other cases.

  17. final def forall[R1 <: R, E1 >: E](f: (SpecCase[R, E, L, T, Any]) ⇒ ZIO[R1, E1, Boolean]): ZIO[R1, E1, Boolean]

    Permalink

    Determines if all node in the spec are satisfied by the given predicate.

  18. final def foreach[R1 <: R, E1, A](failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZIO[R1, Nothing, Spec[R1, E1, L, A]]

    Permalink

    Iterates over the spec with the sequential strategy as the default, and effectfully transforming every test with the provided function, finally reconstructing the spec with the same structure.

  19. final def foreachExec[R1 <: R, E1, A](defExec: ExecutionStrategy)(failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZIO[R1, Nothing, Spec[R1, E1, L, A]]

    Permalink

    Iterates over the spec with the specified default execution strategy, and effectfully transforming every test with the provided function, finally reconstructing the spec with the same structure.

  20. final def foreachPar[R1 <: R, E1, A](failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZIO[R1, Nothing, Spec[R1, E1, L, A]]

    Permalink

    Iterates over the spec with the parallel strategy as the default, and effectfully transforming every test with the provided function, finally reconstructing the spec with the same structure.

  21. final def foreachParN[R1 <: R, E1, A](n: Int)(failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZIO[R1, Nothing, Spec[R1, E1, L, A]]

    Permalink

    Iterates over the spec with the parallel (n) strategy as the default, and effectfully transforming every test with the provided function, finally reconstructing the spec with the same structure.

  22. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  24. final def mapError[E1](f: (E) ⇒ E1)(implicit ev: CanFail[E]): Spec[R, E1, L, T]

    Permalink

    Returns a new spec with remapped errors.

  25. final def mapLabel[L1](f: (L) ⇒ L1): Spec[R, E, L1, T]

    Permalink

    Returns a new spec with remapped labels.

  26. final def mapTest[T1](f: (T) ⇒ T1): Spec[R, E, L, T1]

    Permalink

    Returns a new spec with remapped tests.

  27. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  30. final def only[S, E1](s: String)(implicit ev1: <:<[L, String], ev2: <:<[E, TestFailure[E1]], ev3: <:<[T, TestSuccess[S]]): ZSpec[R, E1, String, S]

    Permalink

    Runs only tests whose labels (which must be strings) contain the given substring.

    Runs only tests whose labels (which must be strings) contain the given substring. If a suite label contains the specified string all specs in that suite will be included in the resulting spec.

  31. final def provideManaged[E1 >: E](managed: Managed[E1, R])(implicit ev: NeedsEnv[R]): Spec[Any, E1, L, T]

    Permalink

    Uses the specified Managed to provide each test in this spec with its required environment.

  32. final def provideManagedShared[E1 >: E](managed: Managed[E1, R])(implicit ev: NeedsEnv[R]): Spec[Any, E1, L, T]

    Permalink

    Uses the specified Managed once to provide all tests in this spec with a shared version of their required environment.

    Uses the specified Managed once to provide all tests in this spec with a shared version of their required environment. This is useful when the act of creating the environment is expensive and should only be performed once.

  33. final def provideSomeManaged[R0, E1 >: E](managed: ZManaged[R0, E1, R])(implicit ev: NeedsEnv[R]): Spec[R0, E1, L, T]

    Permalink

    Uses the specified ZManaged to provide each test in this spec with part of its required environment.

  34. final def provideSomeManagedShared[R0, E1 >: E](managed: ZManaged[R0, E1, R])(implicit ev: NeedsEnv[R]): Spec[R0, E1, L, T]

    Permalink

    Uses the specified ZManaged once to provide all tests in this spec with a shared version of part of their required environment.

    Uses the specified ZManaged once to provide all tests in this spec with a shared version of part of their required environment. This is useful when the act of creating the environment is expensive and should only be performed once.

  35. final def size: ZIO[R, E, Int]

    Permalink

    Computes the size of the spec, i.e.

    Computes the size of the spec, i.e. the number of tests in the spec.

  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. final def transform[R1, E1, L1, T1](f: (SpecCase[R, E, L, T, Spec[R1, E1, L1, T1]]) ⇒ SpecCase[R1, E1, L1, T1, Spec[R1, E1, L1, T1]]): Spec[R1, E1, L1, T1]

    Permalink

    Transforms the spec one layer at a time.

  38. final def transformAccum[R1, E1, L1, T1, Z](z0: Z)(f: (Z, SpecCase[R, E, L, T, Spec[R1, E1, L1, T1]]) ⇒ (Z, SpecCase[R1, E1, L1, T1, Spec[R1, E1, L1, T1]])): ZIO[R, E, (Z, Spec[R1, E1, L1, T1])]

    Permalink

    Transforms the spec statefully, one layer at a time.

  39. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped