Packages

  • package root
    Definition Classes
    root
  • package zio
    Definition Classes
    root
  • package test

    _ZIO Test_ is a featherweight testing library for effectful programs.

    _ZIO Test_ is a featherweight testing library for effectful programs.

    The library imagines every spec as an ordinary immutable value, providing tremendous potential for composition. Thanks to tight integration with ZIO, specs can use resources (including those requiring disposal), have well- defined linear and parallel semantics, and can benefit from a host of ZIO combinators.

    import zio.test._
import zio.clock.nanoTime
import Assertion.isGreaterThan

object MyTest extends DefaultRunnableSpec {
  def spec = suite("clock")(
    testM("time is non-zero") {
      assertM(nanoTime)(isGreaterThan(0))
    }
  )
}
    Definition Classes
    zio
  • package environment

    The environment package contains testable versions of all the standard ZIO environment types through the TestClock, TestConsole, TestSystem, and TestRandom modules.

    The environment package contains testable versions of all the standard ZIO environment types through the TestClock, TestConsole, TestSystem, and TestRandom modules. See the documentation on the individual modules for more detail about using each of them.

    If you are using ZIO Test and extending RunnableSpec a TestEnvironment containing all of them will be automatically provided to each of your tests. Otherwise, the easiest way to use the test implementations in ZIO Test is by providing the TestEnvironment to your program.

    import zio.test.environment._

myProgram.provideLayer(testEnvironment)

    Then all environmental effects, such as printing to the console or generating random numbers, will be implemented by the TestEnvironment and will be fully testable. When you do need to access the "live" environment, for example to print debugging information to the console, just use the live combinator along with the effect as your normally would.

    If you are only interested in one of the test implementations for your application, you can also access them a la carte through the make method on each module. Each test module requires some data on initialization. Default data is included for each as DefaultData.

    import zio.test.environment._

myProgram.provideM(TestConsole.make(TestConsole.DefaultData))

    Finally, you can create a Test object that implements the test interface directly using the makeTest method. This can be useful when you want to access some testing functionality without using the environment type.

    import zio.test.environment._

for {
  testRandom <- TestRandom.makeTest(TestRandom.DefaultData)
  n          <- testRandom.nextInt
} yield n

    This can also be useful when you are creating a more complex environment to provide the implementation for test services that you mix in.

    Definition Classes
    test
  • package laws

    The laws package provides functionality for describing laws as values.

    The laws package provides functionality for describing laws as values. The fundamental abstraction is a set of ZLaws[Caps, R]. These laws model the laws that instances having a capability of type Caps are expected to satisfy. A capability Caps[_] is an abstraction describing some functionality that is common across different data types and obeys certain laws. For example, we can model the capability of two values of a type being compared for equality as follows:

    trait Equal[-A] {
  def equal(a1: A, a2: A): Boolean
}

    Definitions of equality are expected to obey certain laws:

    1. Reflexivity - a1 === a1 2. Symmetry - a1 === a2 ==> a2 === a1 3. Transitivity - (a1 === a2) && (a2 === a3) ==> (a1 === a3)

    These laws define what the capabilities mean and ensure that it is safe to abstract across different instances with the same capability.

    Using ZIO Test, we can represent these laws as values. To do so, we define each law using one of the ZLaws constructors. For example:

    val transitivityLaw = ZLaws.Laws3[Equal]("transitivityLaw") {
  def apply[A: Equal](a1: A, a2: A, a3: A): TestResult =
    ???
}

    We can then combine laws using the + operator:

    val reflexivityLaw: = ???
val symmetryLaw:    = ???

val equalLaws = reflexivityLaw + symmetryLaw + transitivityLaw

    Laws have a run method that takes a generator of values of type A and checks that those values satisfy the laws. In addition, objects can extend ZLawful to provide an even more convenient syntax for users to check that instances satisfy certain laws.

    object Equal extends Lawful[Equal]

object Hash extends Lawful[Hash]

object Ord extends Lawful[Ord]

checkAllLaws(Equal + Hash + Ord)(Gen.anyInt)

    Note that capabilities compose seamlessly because of contravariance. We can combine laws describing different capabilities to construct a set of laws requiring that instances having all of the capabilities satisfy each of the laws.

    Definition Classes
    test
  • package mock
    Definition Classes
    test
  • package poly
    Definition Classes
    test
  • package reflect
    Definition Classes
    test
  • AbstractRunnableSpec
  • Annotations
  • Assertion
  • AssertionData
  • AssertionM
  • AssertionMData
  • AssertionValue
  • AssertionVariants
  • BoolAlgebra
  • BoolAlgebraM
  • CheckVariants
  • CompileVariants
  • DefaultRunnableSpec
  • DefaultTestReporter
  • Eql
  • ExecutedSpec
  • FailureDetails
  • FailureRenderer
  • FunctionVariants
  • Gen
  • GenFailureDetails
  • GenZIO
  • RenderedResult
  • RunnableSpec
  • Sample
  • Sized
  • Spec
  • Summary
  • SummaryBuilder
  • TestAnnotation
  • TestAnnotationMap
  • TestAnnotationRenderer
  • TestArgs
  • TestAspect
  • TestConfig
  • TestExecutor
  • TestFailure
  • TestLogger
  • TestPlatform
  • TestReporter
  • TestRunner
  • TestSuccess
  • TestTimeoutException
  • TestVersion
  • TimeVariants
  • TimeoutVariants
  • ZTest

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]
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Spec
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Spec(caseValue: SpecCase[R, E, T, Spec[R, E, T]])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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
  5. final def annotate[V](key: TestAnnotation[V], value: V): Spec[R, E, T]

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

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

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

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. 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.

  9. val caseValue: SpecCase[R, E, T, Spec[R, E, T]]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. final def countTests(f: (T) => Boolean): ZManaged[R, E, Int]

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

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def execute(defExec: ExecutionStrategy): ZManaged[R, Nothing, Spec[Any, E, T]]

    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]

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

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

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

    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
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. final def fold[Z](f: (SpecCase[R, E, T, Z]) => Z): Z

    Folds over all nodes to produce a final result.

  20. 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.

  21. 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.

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

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

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

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

    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[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def mapError[E1](f: (E) => E1)(implicit ev: CanFail[E]): Spec[R, E1, T]

    Returns a new spec with remapped errors.

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

    Returns a new spec with remapped labels.

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

    Returns a new spec with remapped tests.

  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def productElementNames: Iterator[String]
    Definition Classes
    Product
  35. final def provide(r: R)(implicit ev: NeedsEnv[R]): Spec[Any, E, T]

    Provides each test in this spec with its required environment

  36. 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 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)
  37. 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 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)
  38. 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.

  39. 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.

  40. 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.

  41. 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)
  42. 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)
  43. 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.

  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. 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.

  46. 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.

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

    Updates a service in the environment of this effect.

  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. 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.

  52. 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.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped