Class/Object

zio.test

Spec

Related Docs: object Spec | package test

Permalink

final case class Spec[-R, +E, +T](caseValue: SpecCase[R, E, T, Spec[R, E, T]]) extends SpecVersionSpecific[R, E, T] with 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, SpecVersionSpecific[R, E, T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Spec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SpecVersionSpecific
  7. AnyRef
  8. 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]])

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +[R1 <: R, E1 >: E, T1 >: T](that: Spec[R1, E1, T1]): Spec[R1, E1, T1]

    Permalink

    Combines this spec with the specified spec.

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  5. 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]

    Permalink

    Syntax for adding aspects.

    Syntax for adding aspects.

    test("foo") { assert(42, equalTo(42)) } @@ ignore

  6. final def annotate[V](key: TestAnnotation[V], value: V): Spec[R, E, T]

    Permalink

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

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

    Permalink

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

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

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

    Permalink

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. final def countTests(f: (T) ⇒ Boolean): ZManaged[R, E, Int]

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef

  13. final def execute(defExec: ExecutionStrategy): ZManaged[R, Nothing, Spec[Any, E, T]]

    Permalink

    Returns an effect that models execution of this spec.

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

    Permalink

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

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

    Permalink

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

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

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

    Permalink

    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 if this is a suite or None otherwise.

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

    Permalink

    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.

  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. final def fold[Z](f: (SpecCase[R, E, T, Z]) ⇒ Z): Z

    Permalink

    Folds over all nodes to produce a final result.

  20. final def foldManaged[R1 <: R, E1, Z](defExec: ExecutionStrategy)(f: (SpecCase[R, E, T, Z]) ⇒ ZManaged[R1, E1, Z]): ZManaged[R1, E1, Z]

    Permalink

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

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

    Permalink

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

  22. final def foreach[R1 <: R, E1, A](failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZManaged[R1, Nothing, Spec[R1, E1, 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.

  23. final def foreachExec[R1 <: R, E1, A](defExec: ExecutionStrategy)(failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZManaged[R1, Nothing, Spec[R1, E1, 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.

  24. final def foreachPar[R1 <: R, E1, A](failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZManaged[R1, Nothing, Spec[R1, E1, 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.

  25. final def foreachParN[R1 <: R, E1, A](n: Int)(failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZManaged[R1, Nothing, Spec[R1, E1, 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.

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

    Permalink
    Definition Classes
    AnyRef → Any

  27. macro def inject[E1 >: E](layers: ZLayer[_, E1, _]*): Spec[Any, E1, T]

    Permalink

    Automatically assembles a layer for the spec, translating it up a level.

    Automatically assembles a layer for the spec, translating it up a level.

    Definition Classes
    SpecVersionSpecific

  28. macro def injectCustom[E1 >: E](layers: ZLayer[_, E1, _]*): Spec[environment.TestEnvironment, E1, T]

    Permalink

    Automatically constructs the part of the environment that is not part of the TestEnvironment, leaving an effect that only depends on the TestEnvironment.

    Automatically constructs the part of the environment that is not part of the TestEnvironment, leaving an effect that only depends on the TestEnvironment. This will also satisfy transitive TestEnvironment requirements with TestEnvironment.any, allowing them to be provided later.

    val spec: ZIO[Has[UserRepo] with Has[Console], Nothing, Unit] = ???
val userRepoLayer: ZLayer[Has[Database], Nothing, Has[UserRepo] = ???
val databaseLayer: ZLayer[Has[Clock], Nothing, Has[Database]] = ???

// The TestEnvironment you use later will provide Clock to
// `databaseLayer` and Console to `spec`
val spec2 : ZIO[TestEnvironment, Nothing, Unit] =
  spec.injectCustom(userRepoLayer, databaseLayer)
    Definition Classes
    SpecVersionSpecific

  29. macro def injectCustomShared[E1 >: E](layers: ZLayer[_, E1, _]*): Spec[environment.TestEnvironment, E1, T]

    Permalink

    Automatically constructs the part of the environment that is not part of the TestEnvironment, leaving an effect that only depends on the TestEnvironment, sharing services between all tests.

    Automatically constructs the part of the environment that is not part of the TestEnvironment, leaving an effect that only depends on the TestEnvironment, sharing services between all tests.

    This will also satisfy transitive TestEnvironment requirements with TestEnvironment.any, allowing them to be provided later.

    val spec: ZIO[Has[UserRepo] with Has[Console], Nothing, Unit] = ???
val userRepoLayer: ZLayer[Has[Database], Nothing, Has[UserRepo] = ???
val databaseLayer: ZLayer[Has[Clock], Nothing, Has[Database]] = ???

// The TestEnvironment you use later will provide Clock to
// `databaseLayer` and Console to `spec`
val spec2 : ZIO[TestEnvironment, Nothing, Unit] =
  spec.injectCustomShared(userRepoLayer, databaseLayer)
    Definition Classes
    SpecVersionSpecific

  30. macro def injectShared[E1 >: E](layers: ZLayer[_, E1, _]*): Spec[Any, E1, T]

    Permalink

    Automatically assembles a layer for the spec, sharing services between all tests.

    Automatically assembles a layer for the spec, sharing services between all tests.

    Definition Classes
    SpecVersionSpecific

  31. def injectSome[R0 <: Has[_]]: InjectSomePartiallyApplied[R0, R, E, T]

    Permalink

    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 spec: ZSpec[Has[Clock] with Has[Random], Nothing] = ???
val clockLayer: ZLayer[Any, Nothing, Has[Clock]] = ???

val spec2: ZSpec[Has[Random], Nothing] = spec.injectSome[Has[Random]](clockLayer)
    Definition Classes
    SpecVersionSpecific

  32. final def injectSomeShared[R0 <: Has[_]]: InjectSomeSharedPartiallyApplied[R0, R, E, T]

    Permalink

    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 spec: ZSpec[Has[Int] with Has[Random], Nothing] = ???
val intLayer: ZLayer[Any, Nothing, Has[Int]] = ???

val spec2 = spec.injectSomeShared[Has[Random]](intLayer)
    Definition Classes
    SpecVersionSpecific

  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  34. final def mapBoth[E1, T1](f: (E) ⇒ E1, g: (T) ⇒ T1)(implicit ev: CanFail[E]): Spec[R, E1, T1]

    Permalink

    Returns a new spec with remapped errors and tests.

  35. final def mapError[E1](f: (E) ⇒ E1)(implicit ev: CanFail[E]): Spec[R, E1, T]

    Permalink

    Returns a new spec with remapped errors.

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

    Permalink

    Returns a new spec with remapped labels.

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

    Permalink

    Returns a new spec with remapped tests.

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

    Permalink
    Definition Classes
    AnyRef

  39. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  40. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

    Provides each test in this spec with its required environment

  42. def provideCustomLayer[E1 >: E, R1](layer: ZLayer[environment.TestEnvironment, E1, R1])(implicit ev1: <:<[environment.TestEnvironment with R1, R], ev2: Union[environment.TestEnvironment, R1], tagged: zio.Tag[R1]): Spec[environment.TestEnvironment, E1, T]

    Permalink

    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)

  43. def provideCustomLayerShared[E1 >: E, R1](layer: ZLayer[environment.TestEnvironment, E1, R1])(implicit ev1: <:<[environment.TestEnvironment with R1, R], ev2: Union[environment.TestEnvironment, R1], tagged: zio.Tag[R1]): Spec[environment.TestEnvironment, E1, T]

    Permalink

    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)

  44. final def provideLayer[E1 >: E, R0, R1](layer: ZLayer[R0, E1, R1])(implicit ev: <:<[R1, R]): Spec[R0, E1, T]

    Permalink

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

  45. final def provideLayerShared[E1 >: E, R0, R1](layer: ZLayer[R0, E1, R1])(implicit ev: <:<[R1, R]): Spec[R0, E1, T]

    Permalink

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

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

    Permalink

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

  47. final def provideSomeLayer[R0]: ProvideSomeLayer[R0, R, E, T]

    Permalink

    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[Has[Clock] with Has[Random], Nothing] = ???

val spec2 = spec.provideSomeLayer[Has[Random]](clockLayer)

  48. final def provideSomeLayerShared[R0]: ProvideSomeLayerShared[R0, R, E, T]

    Permalink

    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[Has[Clock] with Has[Random], Nothing] = ???

val spec2 = spec.provideSomeLayerShared[Has[Random]](clockLayer)

  49. final def size: ZManaged[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.

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

    Permalink
    Definition Classes
    AnyRef

  51. 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]

    Permalink

    Transforms the spec one layer at a time.

  52. 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]])): ZManaged[R, E, (Z, Spec[R1, E1, T1])]

    Permalink

    Transforms the spec statefully, one layer at a time.

  53. final def updateService[M]: UpdateService[R, E, T, M]

    Permalink

    Updates a service in the environment of this effect.

  54. final def wait(): Unit

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

  55. final def wait(arg0: Long, arg1: Int): Unit

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

  56. final def wait(arg0: Long): Unit

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

  57. final def when(b: ⇒ Boolean)(implicit ev: <:<[T, TestSuccess]): Spec[R with Has[Annotations], E, TestSuccess]

    Permalink

    Runs the spec only if the specified predicate is satisfied.

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

    Permalink

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

Deprecated Value Members

  1. final def bimap[E1, T1](f: (E) ⇒ E1, g: (T) ⇒ T1)(implicit ev: CanFail[E]): Spec[R, E1, T1]

    Permalink

    Returns a new spec with remapped errors and tests.

    Returns a new spec with remapped errors and tests.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use mapBoth

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

    Permalink

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use foldManaged

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

    Permalink

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use whenZIO

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SpecVersionSpecific[R, E, T]

Inherited from AnyRef

Inherited from Any

Ungrouped