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
  • object TestClock extends Serializable
    Definition Classes
    environment
  • Data
  • FiberData
  • Service
  • Test
  • WarningData

case class Test(clockState: Ref[Data], fiberState: FiberRef[FiberData], live: Live.Service[Clock with Console], warningState: RefM[WarningData]) extends Service[Any] with Product with Serializable

Linear Supertypes
Product, Equals, Service[Any], scheduler.Scheduler.Service[Any], clock.Clock.Service[Any], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Test
  2. Product
  3. Equals
  4. Service
  5. Service
  6. Service
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Test(clockState: Ref[Data], fiberState: FiberRef[FiberData], live: Live.Service[Clock with Console], warningState: RefM[WarningData])

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 adjust(duration: Duration): UIO[Unit]

    Increments the current clock time by the specified duration.

    Increments the current clock time by the specified duration. Any effects that were scheduled to occur on or before the new time will immediately be run.

    Definition Classes
    Test → Service
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val clockState: Ref[Data]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def currentDateTime: UIO[OffsetDateTime]

    Returns the current clock time as an OffsetDateTime.

    Returns the current clock time as an OffsetDateTime.

    Definition Classes
    Test → Service
  9. final def currentTime(unit: TimeUnit): UIO[Long]

    Returns the current clock time in the specified time unit.

    Returns the current clock time in the specified time unit.

    Definition Classes
    Test → Service
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. val fiberState: FiberRef[FiberData]
  12. final val fiberTime: UIO[Duration]

    Returns the current fiber time for this fiber.

    Returns the current fiber time for this fiber. The fiber time is backed by a FiberRef and is incremented for the duration each fiber is sleeping. When a fiber is joined the fiber time will be set to the maximum of the fiber time of the parent and child fibers. Thus, the fiber time reflects the duration of sleeping that has occurred for this fiber to reach its current state, properly reflecting forks and joins.

    for {
  _      <- TestClock.set(Duration.Infinity)
  _      <- ZIO.sleep(2.millis).zipPar(ZIO.sleep(1.millis))
  result <- TestClock.fiberTime
} yield result.toNanos == 2000000L
    Definition Classes
    Test → Service
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val live: Live.Service[Clock with Console]
  17. final val nanoTime: UIO[Long]

    Returns the current clock time in nanoseconds.

    Returns the current clock time in nanoseconds.

    Definition Classes
    Test → Service
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val scheduler: ZIO[Any, Nothing, Scheduler]

    Returns an effect that creates a new Scheduler backed by this TestClock.

    Returns an effect that creates a new Scheduler backed by this TestClock.

    Definition Classes
    Test → Service
  23. final def setDateTime(dateTime: OffsetDateTime): UIO[Unit]

    Sets the current clock time to the specified OffsetDateTime.

    Sets the current clock time to the specified OffsetDateTime. Any effets that were scheduled to occur on or before the new time will immediately be run.

    Definition Classes
    Test → Service
  24. final def setTime(duration: Duration): UIO[Unit]

    Sets the current clock time to the specified time in terms of duration since the epoch.

    Sets the current clock time to the specified time in terms of duration since the epoch. Any effects that were scheduled to occur on or before the new time will immediately be run.

    Definition Classes
    Test → Service
  25. final def setTimeZone(zone: ZoneId): UIO[Unit]

    Sets the time zone to the specified time zone.

    Sets the time zone to the specified time zone. The clock time in terms of nanoseconds since the epoch will not be adjusted and no scheduled effects will be run as a result of this method.

    Definition Classes
    Test → Service
  26. final def sleep(duration: Duration): UIO[Unit]

    Semantically blocks the current fiber until the clock time is equal to or greater than the specified duration.

    Semantically blocks the current fiber until the clock time is equal to or greater than the specified duration. Once the clock time is adjusted to on or after the duration, the fiber will automatically be resumed.

    Definition Classes
    Test → Service
  27. val sleeps: UIO[List[Duration]]

    Returns a list of the times at which all queued effects are scheduled to resume.

    Returns a list of the times at which all queued effects are scheduled to resume.

    Definition Classes
    Test → Service
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. val timeZone: UIO[ZoneId]

    Returns the time zone.

    Returns the time zone.

    Definition Classes
    Test → Service
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. val warningState: RefM[WarningData]

Inherited from Product

Inherited from Equals

Inherited from Service[Any]

Inherited from scheduler.Scheduler.Service[Any]

Inherited from clock.Clock.Service[Any]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped