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 {
  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 DefaultRunnableSpec 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.provideManaged(testEnvironmentManaged)

    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 mock
    Definition Classes
    test
  • package reflect
    Definition Classes
    test
  • AbstractRunnableSpec
  • Assertion
  • AssertionValue
  • BoolAlgebra
  • CheckVariants
  • CompileVariants
  • DefaultRunnableSpec
  • DefaultTestReporter
  • DefaultTestRunner
  • ExecutionStrategy
  • FailureDetails
  • FunctionVariants
  • Gen
  • GenFailureDetails
  • GenZIO
  • RenderedResult
  • RunnableSpec
  • Sample
  • Sized
  • Spec
  • SummaryBuilder
  • TestAnnotation
  • TestAnnotationMap
  • TestArgs
  • TestAspect
  • TestExecutor
  • TestFailure
  • TestLogger
  • TestPlatform
  • TestReporter
  • TestRunner
  • TestSuccess
  • TestTimeoutException
  • TestVersion
  • TimeVariants
  • TimeoutVariants

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

A Spec[R, E, L, 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 are annotated with labels of type L, require an environment of type R and may potentially fail with an error of type E.

Self Type
Spec[R, E, L, T]
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Spec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Spec(caseValue: SpecCase[R, E, L, T, Spec[R, E, L, 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, S0, S1, S >: S0 <: S1](aspect: TestAspect[R0, R1, E0, E1, S0, S1])(implicit ev1: <:<[E, TestFailure[E2]], ev2: <:<[T, TestSuccess[S]]): ZSpec[R1, E2, L, S]

    Syntax for adding aspects.

    Syntax for adding aspects.

    test("foo") { assert(42, equalTo(42)) } @@ ignore
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def bimap[E1, T1](f: (E) ⇒ E1, g: (T) ⇒ T1)(implicit ev: CanFail[E]): Spec[R, E1, L, T1]

    Returns a new spec with remapped errors and tests.

  7. val caseValue: SpecCase[R, E, L, T, Spec[R, E, L, T]]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. final def distinguish: Spec[R, E, Either[L, L], T]

    Returns a new spec with the suite labels distinguished by Left, and the test labels distinguished by Right.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def exists[R1 <: R, E1 >: E](f: (SpecCase[R, E, L, T, Any]) ⇒ ZIO[R1, E1, Boolean]): ZIO[R1, E1, Boolean]

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

  12. final def filterLabels(f: (L) ⇒ Boolean): Option[Spec[R, E, L, T]]

    Returns a new Spec containing only tests/suites with labels satisfying the specified predicate.

  13. final def filterTestLabels(f: (L) ⇒ Boolean): Option[Spec[R, E, L, T]]

    Returns a new Spec containing only tests with labels satisfying the specified predicate.

  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def fold[Z](f: (SpecCase[R, E, L, T, Z]) ⇒ Z): Z

    Folds over all nodes to produce a final result.

  16. final def foldM[R1 <: R, E1, Z](defExec: ExecutionStrategy)(f: (SpecCase[R, E, L, T, Z]) ⇒ ZIO[R1, E1, Z]): ZIO[R1, E1, Z]

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

  17. final def forall[R1 <: R, E1 >: E](f: (SpecCase[R, E, L, T, Any]) ⇒ ZIO[R1, E1, Boolean]): ZIO[R1, E1, Boolean]

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

  18. final def foreach[R1 <: R, E1, A](failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZIO[R1, Nothing, Spec[R1, E1, L, 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.

  19. final def foreachExec[R1 <: R, E1, A](defExec: ExecutionStrategy)(failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZIO[R1, Nothing, Spec[R1, E1, L, 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.

  20. final def foreachPar[R1 <: R, E1, A](failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZIO[R1, Nothing, Spec[R1, E1, L, 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.

  21. final def foreachParN[R1 <: R, E1, A](n: Int)(failure: (Cause[E]) ⇒ ZIO[R1, E1, A], success: (T) ⇒ ZIO[R1, E1, A]): ZIO[R1, Nothing, Spec[R1, E1, L, 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.

  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def mapError[E1](f: (E) ⇒ E1)(implicit ev: CanFail[E]): Spec[R, E1, L, T]

    Returns a new spec with remapped errors.

  25. final def mapLabel[L1](f: (L) ⇒ L1): Spec[R, E, L1, T]

    Returns a new spec with remapped labels.

  26. final def mapTest[T1](f: (T) ⇒ T1): Spec[R, E, L, T1]

    Returns a new spec with remapped tests.

  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def only[S, E1](s: String)(implicit ev1: <:<[L, String], ev2: <:<[E, TestFailure[E1]], ev3: <:<[T, TestSuccess[S]]): ZSpec[R, E1, String, S]

    Runs only tests whose labels (which must be strings) contain the given substring.

    Runs only tests whose labels (which must be strings) contain the given substring. If a suite label contains the specified string all specs in that suite will be included in the resulting spec.

  31. final def provideManaged[E1 >: E](managed: Managed[E1, R])(implicit ev: NeedsEnv[R]): Spec[Any, E1, L, T]

    Uses the specified Managed to provide each test in this spec with its required environment.

  32. final def provideManagedShared[E1 >: E](managed: Managed[E1, R])(implicit ev: NeedsEnv[R]): Spec[Any, E1, L, T]

    Uses the specified Managed once to provide all tests in this spec with a shared version of their required environment.

    Uses the specified Managed once to provide all tests in this spec with a shared version of their required environment. This is useful when the act of creating the environment is expensive and should only be performed once.

  33. final def provideSomeManaged[R0, E1 >: E](managed: ZManaged[R0, E1, R])(implicit ev: NeedsEnv[R]): Spec[R0, E1, L, T]

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

  34. final def provideSomeManagedShared[R0, E1 >: E](managed: ZManaged[R0, E1, R])(implicit ev: NeedsEnv[R]): Spec[R0, E1, L, T]

    Uses the specified ZManaged once to provide all tests in this spec with a shared version of part of their required environment.

    Uses the specified ZManaged once to provide all tests in this spec with a shared version of part of their required environment. This is useful when the act of creating the environment is expensive and should only be performed once.

  35. final def size: ZIO[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.

  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. final def transform[R1, E1, L1, T1](f: (SpecCase[R, E, L, T, Spec[R1, E1, L1, T1]]) ⇒ SpecCase[R1, E1, L1, T1, Spec[R1, E1, L1, T1]]): Spec[R1, E1, L1, T1]

    Transforms the spec one layer at a time.

  38. final def transformAccum[R1, E1, L1, T1, Z](z0: Z)(f: (Z, SpecCase[R, E, L, T, Spec[R1, E1, L1, T1]]) ⇒ (Z, SpecCase[R1, E1, L1, T1, Spec[R1, E1, L1, T1]])): ZIO[R, E, (Z, Spec[R1, E1, L1, T1])]

    Transforms the spec statefully, one layer at a time.

  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped