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 mock

    The mock package contains testable versions of all the standard ZIO environment types through the MockClock, MockConsole, MockSystem, and MockRandom modules.

    The mock package contains testable versions of all the standard ZIO environment types through the MockClock, MockConsole, MockSystem, and MockRandom 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 MockEnvironment containing all of them will be automatically provided to each of your tests. Otherwise, the easiest way to use the mocking functionality in ZIO Test is by providing the MockEnvironment to your program.

    import zio.test.mock._

myProgram.provideManaged(mockEnvironmentManaged)

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

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

    import zio.test.mock._

myProgram.provideM(MockConsole.make(MockConsole.DefaultData))

    Finally, you can create a Mock object that implements the mock interface directly using the makeMock method. This can be useful when you want to access some mocking functionality without using the environment type.

    import zio.test.mock._

for {
  mockRandom <- MockRandom.makeMock(MockRandom.DefaultData)
  n          <- mockRandom.nextInt
} yield n

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

    Definition Classes
    test
  • Live
  • MockClock
  • MockConsole
  • MockEnvironment
  • MockRandom
  • MockSystem

object MockClock extends Serializable

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MockClock
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Data(nanoTime: Long, currentTimeMillis: Long, sleeps: List[(Duration, Promise[Nothing, Unit])], timeZone: ZoneId) extends Product with Serializable

    The state of the MockClock.

  2. case class FiberData(nanoTime: Long) extends Product with Serializable
  3. case class Mock(clockState: Ref[Data], fiberState: FiberRef[FiberData]) extends Service[Any] with Product with Serializable
  4. trait Service[R] extends clock.Clock.Service[R] with scheduler.Scheduler.Service[R]

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. val DefaultData: Data

    The default initial state of the MockClock with the clock time set to 0 and no effects scheduled to run.

  5. def adjust(duration: Duration): ZIO[MockClock, Nothing, Unit]

    Accesses a MockClock instance in the environment and increments the time by the specified duration, running any actions scheduled for on or before the new time.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def make(data: Data): UIO[MockClock]

    Constructs a new MockClock with the specified initial state.

    Constructs a new MockClock with the specified initial state. This can be useful for providing the required environment to an effect that requires a Clock, such as with ZIO!.provide.

  15. def makeMock(data: Data): UIO[Mock]

    Constructs a new Mock object that implements the MockClock interface.

    Constructs a new Mock object that implements the MockClock interface. This can be useful for mixing in with implementations of other interfaces.

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def setTime(duration: Duration): ZIO[MockClock, Nothing, Unit]

    Accesses a MockClock instance in the environment and sets the clock time to the specified time, running any actions scheduled for on or before the new time.

  20. def setTimeZone(zone: ZoneId): ZIO[MockClock, Nothing, Unit]

    Accesses a MockClock instance in the environment, setting the time zone to the specified time zone.

    Accesses a MockClock instance in the environment, setting the time zone to the specified time zone. The clock time in terms of nanoseconds since the epoch will not be altered and no scheduled actions will be run as a result of this effect.

  21. val sleeps: ZIO[MockClock, Nothing, List[Duration]]

    Accesses a MockClock instance in the environment and returns a list of times that effects are scheduled to run.

  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. val timeZone: ZIO[MockClock, Nothing, ZoneId]

    Accesses a MockClock instance in the environemtn and returns the current time zone.

  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped