Packages

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

A Spec[R, E, 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 require an environment of type R and may potentially fail with an error of type E.

Self Type
Spec[R, E, T]
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
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, T, Spec[R, E, T]])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def @@[R0 <: R1, R1 <: R, E0, E1, E2 >: E0 <: E1](aspect: TestAspect[R0, R1, E0, E1])(implicit ev1: <:<[E, TestFailure[E2]], ev2: <:<[T, TestSuccess]): ZSpec[R1, E2]

    Syntax for adding aspects.

    Syntax for adding aspects.

    test("foo") { assert(42, equalTo(42)) } @@ ignore
  5. final def annotate[V](key: TestAnnotation[V], value: V): Spec[R, E, T]

    Annotates each test in this spec with the specified test annotation.

  6. final def annotated: Spec[R with Annotations, Annotated[E], Annotated[T]]

    Returns a new spec with the annotation map at each node.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. final def bimap[E1, T1](f: (E) ⇒ E1, g: (T) ⇒ T1)(implicit ev: CanFail[E]): Spec[R, E1, T1]

    Returns a new spec with remapped errors and tests.

  9. val caseValue: SpecCase[R, E, T, Spec[R, E, T]]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. final def countTests(f: (T) ⇒ Boolean): ZIO[R, E, Int]

    Returns the number of tests in the spec that satisfy the specified predicate.

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def exists[R1 <: R, E1 >: E](f: (SpecCase[R, E, T, Any]) ⇒ ZIO[R1, E1, Boolean]): ZIO[R1, E1, Boolean]

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

  14. final def filterAnnotations[V](key: TestAnnotation[V])(f: (V) ⇒ Boolean): Option[Spec[R, E, T]]

    Returns a new spec with only those suites and tests with annotations satisfying the specified predicate.

    Returns a new spec with only those suites and tests with annotations satisfying the specified predicate. If no annotations satisfy the specified predicate then returns Some with an empty suite with the root label if this is a suite or None otherwise.

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

    Returns a new spec with only those suites and tests satisfying the specified predicate.

    Returns a new spec with only those suites and tests satisfying the specified predicate. If a suite label satisfies the predicate the entire suite will be included in the new spec. Otherwise only those specs in a suite that satisfy the specified predicate will be included in the new spec. If no labels satisfy the specified predicate then returns Some with an empty suite with the root label if this is a suite or None otherwise.

  16. final def filterTags(f: (String) ⇒ Boolean): Option[Spec[R, E, T]]

    Returns a new spec with only those suites and tests with tags satisfying the specified predicate.

    Returns a new spec with only those suites and tests with tags satisfying the specified predicate. If no tags satisfy the specified predicate then returns Some with an empty suite with the root label if this is a suite or None otherwise.

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

    Folds over all nodes to produce a final result.

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

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

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

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

  21. 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, A]]

    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.

  22. 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, A]]

    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.

  23. 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, A]]

    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.

  24. 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, A]]

    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.

  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def mapError[E1](f: (E) ⇒ E1)(implicit ev: CanFail[E]): Spec[R, E1, T]

    Returns a new spec with remapped errors.

  28. final def mapLabel(f: (String) ⇒ String): Spec[R, E, T]

    Returns a new spec with remapped labels.

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

    Returns a new spec with remapped tests.

  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def only(s: String)(implicit ev: <:<[T, TestSuccess]): Spec[R, E, TestSuccess]

    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.

  34. final def provide(r: R)(implicit ev: NeedsEnv[R]): Spec[Any, E, T]

    Provides each test in this spec with its required environment

  35. def provideCustomLayer[E1 >: E, R1 <: Has[_]](layer: ZLayer[environment.TestEnvironment, E1, R1])(implicit ev: <:<[environment.TestEnvironment with R1, R], tagged: Tagged[R1]): Spec[environment.TestEnvironment, E1, T]

    Provides each test with the part of the environment that is not part of the TestEnvironment, leaving a spec that only depends on the TestEnvironment.

    Provides each test with the part of the environment that is not part of the TestEnvironment, leaving a spec that only depends on the TestEnvironment.

    val loggingLayer: ZLayer[Any, Nothing, Logging] = ???

val spec: ZSpec[TestEnvironment with Logging, Nothing] = ???

val spec2 = spec.provideCustomLayer(loggingLayer)
  36. def provideCustomLayerShared[E1 >: E, R1 <: Has[_]](layer: ZLayer[environment.TestEnvironment, E1, R1])(implicit ev: <:<[environment.TestEnvironment with R1, R], tagged: Tagged[R1]): Spec[environment.TestEnvironment, E1, T]

    Provides all tests with a shared version of the part of the environment that is not part of the TestEnvironment, leaving a spec that only depends on the TestEnvironment.

    Provides all tests with a shared version of the part of the environment that is not part of the TestEnvironment, leaving a spec that only depends on the TestEnvironment.

    val loggingLayer: ZLayer[Any, Nothing, Logging] = ???

val spec: ZSpec[TestEnvironment with Logging, Nothing] = ???

val spec2 = spec.provideCustomLayerShared(loggingLayer)
  37. final def provideLayer[E1 >: E, R0, R1 <: Has[_]](layer: ZLayer[R0, E1, R1])(implicit ev1: <:<[R1, R], ev2: NeedsEnv[R]): Spec[R0, E1, T]

    Provides a layer to the spec, translating it up a level.

  38. final def provideLayerShared[E1 >: E, R0, R1 <: Has[_]](layer: ZLayer[R0, E1, R1])(implicit ev1: <:<[R1, R], ev2: NeedsEnv[R]): Spec[R0, E1, T]

    Provides a layer to the spec, sharing services between all tests.

  39. final def provideSome[R0](f: (R0) ⇒ R)(implicit ev: NeedsEnv[R]): Spec[R0, E, T]

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

  40. final def provideSomeLayer[R0 <: Has[_]]: ProvideSomeLayer[R0, R, E, T]

    Splits the environment into two parts, providing each test with one part using the specified layer and leaving the remainder R0.

    Splits the environment into two parts, providing each test with one part using the specified layer and leaving the remainder R0.

    val clockLayer: ZLayer[Any, Nothing, Clock] = ???

val spec: ZSpec[Clock with Random, Nothing] = ???

val spec2 = spec.provideSomeLayer[Random](clockLayer)
  41. final def provideSomeLayerShared[R0 <: Has[_]]: ProvideSomeLayerShared[R0, R, E, T]

    Splits the environment into two parts, providing all tests with a shared version of one part using the specified layer and leaving the remainder R0.

    Splits the environment into two parts, providing all tests with a shared version of one part using the specified layer and leaving the remainder R0.

    val clockLayer: ZLayer[Any, Nothing, Clock] = ???

val spec: ZSpec[Clock with Random, Nothing] = ???

val spec2 = spec.provideSomeLayerShared[Random](clockLayer)
  42. final def size: ZIO[R, E, Int]

    Computes the size of the spec, i.e.

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

  43. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  44. final def transform[R1, E1, T1](f: (SpecCase[R, E, T, Spec[R1, E1, T1]]) ⇒ SpecCase[R1, E1, T1, Spec[R1, E1, T1]]): Spec[R1, E1, T1]

    Transforms the spec one layer at a time.

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

    Transforms the spec statefully, one layer at a time.

  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  49. final def when(b: Boolean)(implicit ev: <:<[T, TestSuccess]): Spec[R with Annotations, E, TestSuccess]

    Runs the spec only if the specified predicate is satisfied.

  50. final def whenM[R1 <: R, E1 >: E](b: ZIO[R1, E1, Boolean])(implicit ev: <:<[T, TestSuccess]): Spec[R1 with Annotations, E1, TestSuccess]

    Runs the spec only if the specified effectual predicate is satisfied.

Deprecated Value Members

  1. final def provideM[E1 >: E](zio: ZIO[Any, E1, R])(implicit ev: NeedsEnv[R]): Spec[Any, E1, T]

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use provideLayer

  2. final def provideMShared[E1 >: E](zio: ZIO[Any, E1, R])(implicit ev: NeedsEnv[R]): Spec[Any, E1, T]

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use provideLayerShared

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

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use provideLayer

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

    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.

    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use provideLayerShared

  5. final def provideSomeM[R0, E1 >: E](zio: ZIO[R0, E1, R])(implicit ev: NeedsEnv[R]): Spec[R0, E1, T]

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use provideSomeLayer

  6. final def provideSomeMShared[R0, E1 >: E](zio: ZIO[R0, E1, R])(implicit ev: NeedsEnv[R]): Spec[R0, E1, T]

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use provideSomeLayerShared

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

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use provideSomeLayer

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

    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.

    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use provideSomeLayerShared

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped