zio-test/zio.test/Spec

Spec

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

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.

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

Value members

Concrete methods

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

Combines this spec with the specified spec.

Combines this spec with the specified spec.

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
final def annotate[V](key: TestAnnotation[V], value: V): Spec[R, E, T]

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: Spec[R & Annotations, (E), (T)]

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

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

final def countTests(f: T => Boolean): ZManaged[R, E, Int]

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

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

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

Returns an effect that models execution of this spec.

Returns an effect that models execution of this spec.

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

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

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

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

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): Option[Spec[R, E, T]]

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 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. 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 fold[Z](f: SpecCase[R, E, T, Z] => Z): Z

Folds over all nodes to produce a final result.

Folds over all nodes to produce a final result.

final def foldM[R1 <: R, E1, Z](defExec: ExecutionStrategy)(f: SpecCase[R, E, T, Z] => ZManaged[R1, E1, Z]): ZManaged[R1, 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 forall[R1 <: R, E1 >: E](f: SpecCase[R, E, T, Any] => ZIO[R1, E1, Boolean]): ZManaged[R1, E1, Boolean]

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

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

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

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, A](defExec: ExecutionStrategy)(failure: Cause[E] => ZIO[R1, E1, A], success: T => ZIO[R1, E1, A]): ZManaged[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.

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, A](failure: Cause[E] => ZIO[R1, E1, A], success: T => ZIO[R1, E1, A]): ZManaged[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.

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, A](n: Int)(failure: Cause[E] => ZIO[R1, E1, A], success: T => ZIO[R1, E1, A]): ZManaged[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.

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 mapBoth[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.

Returns a new spec with remapped errors and tests.

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

Returns a new spec with remapped errors.

Returns a new spec with remapped errors.

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

Returns a new spec with remapped labels.

Returns a new spec with remapped labels.

final def mapTest[T1](f: T => T1): Spec[R, E, T1]

Returns a new spec with remapped tests.

Returns a new spec with remapped tests.

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

Provides each test in this spec with its required environment

Provides each test in this spec with its required environment

def provideCustomLayer[E1 >: E, R1 <: Has[_]](layer: ZLayer[TestEnvironment, E1, R1])(implicit ev: TestEnvironment & R1 <:< R, tagged: Tag[R1]): Spec[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)
def provideCustomLayerShared[E1 >: E, R1 <: Has[_]](layer: ZLayer[TestEnvironment, E1, R1])(implicit ev: TestEnvironment & R1 <:< R, tagged: Tag[R1]): Spec[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)
final def provideLayer[E1 >: E, R0, R1](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.

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

final def provideLayerShared[E1 >: E, R0, R1](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.

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

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.

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

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)
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)
final def size: ZManaged[R, E, Int]

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

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

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.

Transforms the spec one layer at a time.

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

Transforms the spec statefully, one layer at a time.

Transforms the spec statefully, one layer at a time.

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

Updates a service in the environment of this effect.

Updates a service in the environment of this effect.

final def when(b: => Boolean)(implicit ev: T <:< TestSuccess): Spec[R & Annotations, E, TestSuccess]

Runs the spec only if the specified predicate is satisfied.

Runs the spec only if the specified predicate is satisfied.

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

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

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

Deprecated methods

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.

Returns a new spec with remapped errors and tests.

Deprecated

Inherited methods

def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product