Class/Object

zio.test

Spec

Related Docs: object Spec | package test

Permalink

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

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

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

    Permalink

Type Members

  1. type ZSpec[-R, +E, +T] = Spec[R, E]

    Permalink
    Definition Classes
    SpecVersionSpecific

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](that: Spec[R1, E1]): Spec[R1, E1]

    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 >: E, E1 >: E0](aspect: TestAspect[R0, R1, E0, E1])(implicit trace: Trace): Spec[R1, E0]

    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)(implicit trace: Trace): Spec[R, E]

    Permalink

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

  7. final def annotated(implicit trace: Trace): Spec[R, E]

    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, Spec[R, E]]

    Permalink

  10. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  12. final def execute(defExec: ExecutionStrategy)(implicit trace: Trace): ZIO[R with Scope, Nothing, Spec[Any, E]]

    Permalink

    Returns an effect that models execution of this spec.

  13. final def filterAnnotations[V](key: TestAnnotation[V])(f: (V) ⇒ Boolean)(implicit trace: Trace): Option[Spec[R, E]]

    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.

  14. final def filterLabels(f: (String) ⇒ Boolean)(implicit trace: Trace): Option[Spec[R, E]]

    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.

  15. final def filterNotTags(f: (String) ⇒ Boolean)(implicit trace: Trace): Option[Spec[R, E]]

    Permalink

    Returns a new spec with only those suites and tests except for the ones with tags satisfying the predicate.

    Returns a new spec with only those suites and tests except for the ones with tags satisfying the predicate. If all tests or suites have tags that 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)(implicit trace: Trace): Option[Spec[R, E]]

    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.

  17. def finalize(): Unit

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

  18. final def foldScoped[R1 <: R, E1, Z](defExec: ExecutionStrategy)(f: (SpecCase[R, E, Z]) ⇒ ZIO[R1 with Scope, E1, Z])(implicit trace: Trace): ZIO[R1 with Scope, E1, Z]

    Permalink

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

  19. final def foreach[R1 <: R, E1](failure: (Cause[TestFailure[E]]) ⇒ ZIO[R1, TestFailure[E1], TestSuccess], success: (TestSuccess) ⇒ ZIO[R1, E1, TestSuccess])(implicit trace: Trace): ZIO[R1 with Scope, Nothing, Spec[R1, E1]]

    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.

  20. final def foreachExec[R1 <: R, E1](defExec: ExecutionStrategy)(failure: (Cause[TestFailure[E]]) ⇒ ZIO[R1, TestFailure[E1], TestSuccess], success: (TestSuccess) ⇒ ZIO[R1, E1, TestSuccess])(implicit trace: Trace): ZIO[R1 with Scope, Nothing, Spec[R1, E1]]

    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.

  21. final def foreachPar[R1 <: R, E1](failure: (Cause[TestFailure[E]]) ⇒ ZIO[R1, TestFailure[E1], TestSuccess], success: (TestSuccess) ⇒ ZIO[R1, E1, TestSuccess])(implicit trace: Trace): ZIO[R1 with Scope, Nothing, Spec[R1, E1]]

    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.

  22. final def foreachParN[R1 <: R, E1](n: Int)(failure: (Cause[TestFailure[E]]) ⇒ ZIO[R1, TestFailure[E1], TestSuccess], success: (TestSuccess) ⇒ ZIO[R1, E1, TestSuccess])(implicit trace: Trace): ZIO[R1 with Scope, Nothing, Spec[R1, E1]]

    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.

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

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  25. final def mapError[E1](f: (E) ⇒ E1)(implicit ev: CanFail[E], trace: Trace): Spec[R, E1]

    Permalink

    Returns a new spec with remapped errors.

  26. final def mapLabel(f: (String) ⇒ String)(implicit trace: Trace): Spec[R, E]

    Permalink

    Returns a new spec with remapped labels.

  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. macro def provide[E1 >: E](layer: ZLayer[_, E1, _]*): ZSpec[Any, E1, TestSuccess]

    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

  31. final def provideEnvironment(r: ZEnvironment[R])(implicit trace: Trace): Spec[Any, E]

    Permalink

    Provides each test in this spec with its required environment

  32. final def provideLayer[E1 >: E, R0](layer: ZLayer[R0, E1, R])(implicit trace: Trace): Spec[R0, E1]

    Permalink

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

  33. final def provideLayerShared[E1 >: E, R0](layer: ZLayer[R0, E1, R])(implicit trace: Trace): Spec[R0, E1]

    Permalink

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

  34. macro def provideShared[E1 >: E](layer: ZLayer[_, E1, _]*): Spec[Any, E1]

    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

  35. def provideSome[R0]: ProvideSomePartiallyApplied[R0, R, E]

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

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

  36. final def provideSomeEnvironment[R0](f: (ZEnvironment[R0]) ⇒ ZEnvironment[R])(implicit trace: Trace): Spec[R0, E]

    Permalink

    Transforms the environment being provided to each test in this spec with the specified function.

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

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

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

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

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

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

  39. final def provideSomeShared[R0]: ProvideSomeSharedPartiallyApplied[R0, R, E]

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

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

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

    Permalink
    Definition Classes
    AnyRef

  41. final def transform[R1, E1](f: (SpecCase[R, E, Spec[R1, E1]]) ⇒ SpecCase[R1, E1, Spec[R1, E1]])(implicit trace: Trace): Spec[R1, E1]

    Permalink

    Transforms the spec one layer at a time.

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

    Permalink

    Updates a service in the environment of this effect.

  43. final def updateServiceAt[Service]: UpdateServiceAt[R, E, Service]

    Permalink

    Updates a service at the specified key in the environment of this effect.

  44. final def wait(): Unit

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

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

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

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

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

  47. final def when(b: ⇒ Boolean)(implicit trace: Trace): Spec[R, E]

    Permalink

    Runs the spec only if the specified predicate is satisfied.

  48. final def whenZIO[R1 <: R, E1 >: E](b: ZIO[R1, E1, Boolean])(implicit trace: Trace): Spec[R1, E1]

    Permalink

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

Deprecated Value Members

  1. macro def provideCustom[E1 >: E](layer: ZLayer[_, E1, _]*): ZSpec[TestEnvironment, E1, TestSuccess]

    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[UserRepo with Console, Nothing, Unit] = ???
val userRepoLayer: ZLayer[Database, Nothing, UserRepo = ???
val databaseLayer: ZLayer[Clock, Nothing, Database] = ???

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

    (Since version 2.0.2) use provide

  2. def provideCustomLayer[E1 >: E, R1](layer: ZLayer[TestEnvironment, E1, R1])(implicit ev: <:<[TestEnvironment with R1, R], tagged: zio.EnvironmentTag[R1], trace: Trace): Spec[TestEnvironment, E1]

    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: Spec[TestEnvironment with Logging, Nothing] = ???

val spec2 = spec.provideCustomLayer(loggingLayer)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.2) use provideLayer

  3. def provideCustomLayerShared[E1 >: E, R1](layer: ZLayer[TestEnvironment, E1, R1])(implicit ev: <:<[TestEnvironment with R1, R], tagged: zio.EnvironmentTag[R1], trace: Trace): Spec[TestEnvironment, E1]

    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: Spec[TestEnvironment with Logging, Nothing] = ???

val spec2 = spec.provideCustomLayerShared(loggingLayer)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.2) use provideLayerShared

  4. macro def provideCustomShared[E1 >: E](layer: ZLayer[_, E1, _]*): Spec[TestEnvironment, E1]

    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[UserRepo with Console, Nothing, Unit] = ???
val userRepoLayer: ZLayer[Database, Nothing, UserRepo = ???
val databaseLayer: ZLayer[Clock, Nothing, Database] = ???

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

    (Since version 2.0.2) use provideShared

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SpecVersionSpecific[R, E]

Inherited from AnyRef

Inherited from Any

Ungrouped