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.test.environment.Live
import zio.Clock.nanoTime
import Assertion.isGreaterThan

object MyTest extends DefaultRunnableSpec {
  def spec = suite("clock")(
    test("time is non-zero") {
      assertM(Live.live(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
  • object TestClock extends Serializable
    Definition Classes
    environment
  • Data
  • Sleep
  • SuspendedWarningData
  • Test
  • WarningData

final case class Test(clockState: Ref[Data], live: Live, annotations: Annotations, warningState: Synchronized[WarningData], suspendedWarningState: Synchronized[SuspendedWarningData]) extends Clock with TestClock with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Test
  2. Product
  3. Equals
  4. TestClock
  5. Restorable
  6. Clock
  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], live: Live, annotations: Annotations, warningState: Synchronized[WarningData], suspendedWarningState: Synchronized[SuspendedWarningData])

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. def adjust(duration: zio.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 be run in order.

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

    Returns the current clock time as an OffsetDateTime.

    Returns the current clock time as an OffsetDateTime.

    Definition Classes
    Test → Clock
  10. 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 → Clock
  11. final def driver[Env, In, Out](schedule: Schedule[Env, In, Out]): UIO[Driver[State, Env, In, Out]]
    Definition Classes
    Clock
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  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. val instant: UIO[Instant]

    Returns the current clock time as an Instant.

    Returns the current clock time as an Instant.

    Definition Classes
    Test → Clock
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val live: Live
  18. val localDateTime: UIO[LocalDateTime]

    Returns the current clock time as a LocalDateTime.

    Returns the current clock time as a LocalDateTime.

    Definition Classes
    Test → Clock
  19. val nanoTime: UIO[Long]

    Returns the current clock time in nanoseconds.

    Returns the current clock time in nanoseconds.

    Definition Classes
    Test → Clock
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. final def repeat[R, R1 <: R, E, A, B](zio: ZIO[R, E, A])(schedule: Schedule[R1, A, B]): ZIO[R1, E, B]
    Definition Classes
    Clock
  25. final def repeatOrElse[R, R1 <: R, E, E2, A, B](zio: ZIO[R, E, A])(schedule: Schedule[R1, A, B], orElse: (E, Option[B]) => ZIO[R1, E2, B]): ZIO[R1, E2, B]
    Definition Classes
    Clock
  26. final def repeatOrElseEither[R, R1 <: R, E, E2, A, B, C](zio: ZIO[R, E, A])(schedule: Schedule[R1, A, B], orElse: (E, Option[B]) => ZIO[R1, E2, C]): ZIO[R1, E2, Either[C, B]]
    Definition Classes
    Clock
  27. final def retry[R, R1 <: R, E, A, S](zio: ZIO[R, E, A])(policy: Schedule[R1, E, S])(implicit ev: CanFail[E]): ZIO[R1, E, A]
    Definition Classes
    Clock
  28. final def retryOrElse[R, R1 <: R, E, E1, A, A1 >: A, S](zio: ZIO[R, E, A])(policy: Schedule[R1, E, S], orElse: (E, S) => ZIO[R1, E1, A1])(implicit ev: CanFail[E]): ZIO[R1, E1, A1]
    Definition Classes
    Clock
  29. final def retryOrElseEither[R, R1 <: R, E, E1, A, B, Out](zio: ZIO[R, E, A])(schedule: Schedule[R1, E, Out], orElse: (E, Out) => ZIO[R1, E1, B])(implicit ev: CanFail[E]): ZIO[R1, E1, Either[B, A]]
    Definition Classes
    Clock
  30. val save: UIO[UIO[Unit]]

    Saves the TestClock's current state in an effect which, when run, will restore the TestClock state to the saved state

    Saves the TestClock's current state in an effect which, when run, will restore the TestClock state to the saved state

    Definition Classes
    Test → Restorable
  31. final def schedule[R, R1 <: R, E, A, B](zio: ZIO[R, E, A])(schedule: Schedule[R1, Any, B]): ZIO[R1, E, B]
    Definition Classes
    Clock
  32. final def scheduleFrom[R, R1 <: R, E, A, A1 >: A, B](zio: ZIO[R, E, A])(a: A1)(schedule: Schedule[R1, A1, B]): ZIO[R1, E, B]
    Definition Classes
    Clock
  33. 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 effects that were scheduled to occur on or before the new time will be run in order.

    Definition Classes
    Test → TestClock
  34. def setTime(duration: zio.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 in order.

    Definition Classes
    Test → TestClock
  35. 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 → TestClock
  36. def sleep(duration: zio.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 → Clock
  37. lazy val sleeps: UIO[List[zio.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 → TestClock
  38. def supervisedFibers: UIO[SortedSet[Fiber.Runtime[Any, Any]]]

    Returns a set of all fibers in this test.

  39. val suspendedWarningState: Synchronized[SuspendedWarningData]
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. lazy val timeZone: UIO[ZoneId]

    Returns the time zone.

    Returns the time zone.

    Definition Classes
    Test → TestClock
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. val warningState: Synchronized[WarningData]

Inherited from Product

Inherited from Equals

Inherited from TestClock

Inherited from Restorable

Inherited from Clock

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped