Spec

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

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.

Companion:
object
trait Product
trait Equals
class Object
trait Matchable
class Any
Spec[R, E]

Value members

Concrete methods

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

Combines this spec with the specified spec.

Combines this spec with the specified spec.

final def @@[R0 <: R1, R1 <: R, E0 >: E, E1 >: E0](aspect: TestAspect[R0, R1, E0, E1])(implicit trace: Trace): Spec[R1, E0]

Syntax for adding aspects.

Syntax for adding aspects.

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

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

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

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

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

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

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

Returns an effect that models execution of this spec.

Returns an effect that models execution of this spec.

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

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.

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.

final def filterLabels(f: String => Boolean)(implicit trace: Trace): Option[Spec[R, E]]

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.

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.

final def filterNotTags(f: String => Boolean)(implicit trace: Trace): Option[Spec[R, E]]

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.

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.

final def filterTags(f: String => Boolean)(implicit trace: Trace): Option[Spec[R, E]]

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.

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.

final def foldScoped[R1 <: R, E1, Z](defExec: ExecutionStrategy)(f: SpecCase[R, E, Z] => ZIO[R1 & Scope, E1, Z])(implicit trace: Trace): ZIO[R1 & Scope, E1, Z]

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.

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 & Scope, Nothing, Spec[R1, E1]]

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.

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.

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 & Scope, Nothing, Spec[R1, E1]]

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.

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.

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 & Scope, Nothing, Spec[R1, E1]]

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.

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.

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 & Scope, Nothing, Spec[R1, E1]]

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.

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.

final def mapError[E1](f: E => E1)(implicit ev: CanFail[E], trace: Trace): Spec[R, E1]

Returns a new spec with remapped errors.

Returns a new spec with remapped errors.

final def mapLabel(f: String => String)(implicit trace: Trace): Spec[R, E]

Returns a new spec with remapped labels.

Returns a new spec with remapped labels.

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

Provides each test in this spec with its required environment

Provides each test in this spec with its required environment

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

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

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

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

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

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

final def provideSomeEnvironment[R0](f: ZEnvironment[R0] => ZEnvironment[R])(implicit trace: Trace): Spec[R0, E]

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

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

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

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)

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)
final def transform[R1, E1](f: SpecCase[R, E, Spec[R1, E1]] => SpecCase[R1, E1, Spec[R1, E1]])(implicit trace: Trace): Spec[R1, E1]

Transforms the spec one layer at a time.

Transforms the spec one layer at a time.

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

Updates a service in the environment of this effect.

Updates a service in the environment of this effect.

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

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

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

final def when(b: => Boolean)(implicit trace: Trace): Spec[R, E]

Runs the spec only if the specified predicate is satisfied.

Runs the spec only if the specified predicate is satisfied.

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

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

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

Deprecated methods

def provideCustomLayer[E1 >: E, R1](layer: ZLayer[TestEnvironment, E1, R1])(implicit ev: TestEnvironment & R1 <:< R, tagged: Tag[R1], trace: Trace): Spec[TestEnvironment, E1]

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)
Deprecated
def provideCustomLayerShared[E1 >: E, R1](layer: ZLayer[TestEnvironment, E1, R1])(implicit ev: TestEnvironment & R1 <:< R, tagged: Tag[R1], trace: Trace): Spec[TestEnvironment, E1]

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)
Deprecated

Inherited methods

def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
inline def provide[E1 >: E](inline layer: ZLayer[_, E1, _]*): Spec[Any, E1]

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

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

Inherited from:
SpecVersionSpecific
inline def provideShared[E1 >: E](inline layer: ZLayer[_, E1, _]*): Spec[Any, E1]

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

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

Inherited from:
SpecVersionSpecific

Deprecated and Inherited methods

inline def provideCustom[E1 >: E](inline layer: ZLayer[_, E1, _]*): Spec[TestEnvironment, E1]

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.

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 zio: ZIO[OldLady with Console, Nothing, Unit] = ???
val oldLadyLayer: ZLayer[Fly, Nothing, OldLady] = ???
val flyLayer: ZLayer[Blocking, Nothing, Fly] = ???

// The TestEnvironment you use later will provide both Blocking to flyLayer and
// Console to zio
val zio2 : ZIO[TestEnvironment, Nothing, Unit] =
 zio.provideCustom(oldLadyLayer, flyLayer)
Deprecated
Inherited from:
SpecVersionSpecific
inline def provideCustomShared[E1 >: E](inline layer: ZLayer[_, E1, _]*): Spec[TestEnvironment, E1]

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 zio: ZIO[OldLady with Console, Nothing, Unit] = ???
val oldLadyLayer: ZLayer[Fly, Nothing, OldLady] = ???
val flyLayer: ZLayer[Blocking, Nothing, Fly] = ???

// The TestEnvironment you use later will provide both Blocking to flyLayer and
// Console to zio
val zio2 : ZIO[TestEnvironment, Nothing, Unit] =
 zio.provideCustom(oldLadyLayer, flyLayer)
Deprecated
Inherited from:
SpecVersionSpecific