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
  • Live
  • TestClock
  • TestConsole
  • TestEnvironment
  • TestRandom
  • TestSystem

case class TestEnvironment(blocking: Service[Any], clock: Test, console: Test, live: Service[zio.ZEnv], random: Test, sized: Service[Any], system: Test) extends Blocking with Live[zio.ZEnv] with TestClock with TestConsole with TestRandom with TestSystem with Scheduler with Sized with Product with Serializable

Linear Supertypes
Product, Equals, Sized, TestSystem, System, TestRandom, Random, TestConsole, Console, TestClock, Scheduler, Clock, Live[zio.ZEnv], Blocking, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestEnvironment
  2. Product
  3. Equals
  4. Sized
  5. TestSystem
  6. System
  7. TestRandom
  8. Random
  9. TestConsole
  10. Console
  11. TestClock
  12. Scheduler
  13. Clock
  14. Live
  15. Blocking
  16. Serializable
  17. Serializable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TestEnvironment(blocking: Service[Any], clock: Test, console: Test, live: Service[zio.ZEnv], random: Test, sized: Service[Any], system: Test)

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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val blocking: Service[Any]
    Definition Classes
    TestEnvironment → Blocking
  6. val clock: Test
    Definition Classes
    TestEnvironment → TestClock → Clock
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. val console: Test
    Definition Classes
    TestEnvironment → TestConsole → Console
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val live: Service[zio.ZEnv]
    Definition Classes
    TestEnvironment → Live
  14. final def mapAll(mapTestClock: (Test) ⇒ Test = identity, mapTestConsole: (Test) ⇒ Test = identity, mapTestRandom: (Test) ⇒ Test = identity, mapTestSystem: (Test) ⇒ Test = identity): TestEnvironment

    Maps all test implementations in the test environment individually.

  15. final def mapTestClock(f: (Test) ⇒ Test): TestEnvironment

    Maps the TestClock implementation in the test environment, leaving all other test implementations the same.

  16. final def mapTestConsole(f: (Test) ⇒ Test): TestEnvironment

    Maps the TestConsole implementation in the test environment, leaving all other test implementations the same.

  17. final def mapTestRandom(f: (Test) ⇒ Test): TestEnvironment

    Maps the TestRandom implementation in the test environment, leaving all other test implementations the same.

  18. final def mapTestSystem(f: (Test) ⇒ Test): TestEnvironment

    Maps the TestSystem implementation in the test environment, leaving all other test implementations the same.

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val random: Test
    Definition Classes
    TestEnvironment → TestRandom → Random
  23. val scheduler: Test
    Definition Classes
    TestEnvironment → TestClock → Scheduler
  24. val sized: Service[Any]
    Definition Classes
    TestEnvironment → Sized
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. val system: Test
    Definition Classes
    TestEnvironment → TestSystem → System
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Product

Inherited from Equals

Inherited from Sized

Inherited from TestSystem

Inherited from System

Inherited from TestRandom

Inherited from Random

Inherited from TestConsole

Inherited from Console

Inherited from TestClock

Inherited from Scheduler

Inherited from Clock

Inherited from Live[zio.ZEnv]

Inherited from Blocking

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped