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]
- Alphabetic
- By Inheritance
- Spec
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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.
-
final
def
annotated: Spec[R with Annotations, Annotated[E], Annotated[T]]
Returns a new spec with the annotation map at each node.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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.
- val caseValue: SpecCase[R, E, T, Spec[R, E, T]]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
countTests(f: (T) ⇒ Boolean): ZManaged[R, E, Int]
Returns the number of tests in the spec that satisfy the specified predicate.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
execute(defExec: ExecutionStrategy): ZManaged[R, Nothing, Spec[Any, E, T]]
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.
-
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.
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 orNone
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.
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 orNone
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.
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 orNone
otherwise. -
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
fold[Z](f: (SpecCase[R, E, T, Z]) ⇒ Z): Z
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.
-
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.
-
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.
-
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.
-
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.
-
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. -
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
mapError[E1](f: (E) ⇒ E1)(implicit ev: CanFail[E]): Spec[R, E1, T]
Returns a new spec with remapped errors.
-
final
def
mapLabel(f: (String) ⇒ String): Spec[R, E, T]
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.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
provide(r: R)(implicit ev: NeedsEnv[R]): Spec[Any, E, T]
Provides each test in this spec with its required environment
-
def
provideCustomLayer[E1 >: E, R1 <: Has[_]](layer: ZLayer[environment.TestEnvironment, E1, R1])(implicit ev: <:<[environment.TestEnvironment with R1, R], tagged: zio.Tag[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 theTestEnvironment
.Provides each test with the part of the environment that is not part of the
TestEnvironment
, leaving a spec that only depends on theTestEnvironment
.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[environment.TestEnvironment, E1, R1])(implicit ev: <:<[environment.TestEnvironment with R1, R], tagged: zio.Tag[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 theTestEnvironment
.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 theTestEnvironment
.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.
-
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.
-
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.
-
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.
Computes the size of the spec, i.e. the number of tests in the spec.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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.
-
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.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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.
-
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.