trait TestClock extends Clock with Restorable
TestClock
makes it easy to deterministically and efficiently test effects
involving the passage of time.
Instead of waiting for actual time to pass, sleep
and methods implemented
in terms of it schedule effects to take place at a given clock time. Users
can adjust the clock time using the adjust
and setTime
methods, and all
effects scheduled to take place on or before that time will automatically be
run in order.
For example, here is how we can test ZIO#timeout
using TestClock
:
import zio.ZIO import zio.test.TestClock for { fiber <- ZIO.sleep(5.minutes).timeout(1.minute).fork _ <- TestClock.adjust(1.minute) result <- fiber.join } yield result == None
Note how we forked the fiber that sleep
was invoked on. Calls to sleep
and methods derived from it will semantically block until the time is set to
on or after the time they are scheduled to run. If we didn't fork the fiber
on which we called sleep we would never get to set the time on the line
below. Thus, a useful pattern when using TestClock
is to fork the effect
being tested, then adjust the clock time, and finally verify that the
expected effects have been performed.
For example, here is how we can test an effect that recurs with a fixed delay:
import zio.Queue import zio.test.TestClock for { q <- Queue.unbounded[Unit] _ <- q.offer(()).delay(60.minutes).forever.fork a <- q.poll.map(_.isEmpty) _ <- TestClock.adjust(60.minutes) b <- q.take.as(true) c <- q.poll.map(_.isEmpty) _ <- TestClock.adjust(60.minutes) d <- q.take.as(true) e <- q.poll.map(_.isEmpty) } yield a && b && c && d && e
Here we verify that no effect is performed before the recurrence period, that an effect is performed after the recurrence period, and that the effect is performed exactly once. The key thing to note here is that after each recurrence the next recurrence is scheduled to occur at the appropriate time in the future, so when we adjust the clock by 60 minutes exactly one value is placed in the queue, and when we adjust the clock by another 60 minutes exactly one more value is placed in the queue.
- Alphabetic
- By Inheritance
- TestClock
- Restorable
- Clock
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
- abstract def adjust(duration: zio.Duration)(implicit trace: ZTraceElement): UIO[Unit]
- abstract def adjustWith[R, E, A](duration: zio.Duration)(zio: ZIO[R, E, A])(implicit trace: ZTraceElement): ZIO[R, E, A]
-
abstract
def
currentDateTime(implicit trace: ZTraceElement): UIO[OffsetDateTime]
- Definition Classes
- Clock
-
abstract
def
currentTime(unit: ⇒ TimeUnit)(implicit trace: ZTraceElement): UIO[Long]
- Definition Classes
- Clock
-
abstract
def
instant(implicit trace: ZTraceElement): UIO[Instant]
- Definition Classes
- Clock
-
abstract
def
localDateTime(implicit trace: ZTraceElement): UIO[LocalDateTime]
- Definition Classes
- Clock
-
abstract
def
nanoTime(implicit trace: ZTraceElement): UIO[Long]
- Definition Classes
- Clock
-
abstract
def
save(implicit trace: ZTraceElement): UIO[UIO[Unit]]
- Definition Classes
- Restorable
-
abstract
def
scheduler(implicit trace: ZTraceElement): UIO[Scheduler]
- Definition Classes
- Clock
- abstract def setDateTime(dateTime: OffsetDateTime)(implicit trace: ZTraceElement): UIO[Unit]
- abstract def setTime(duration: zio.Duration)(implicit trace: ZTraceElement): UIO[Unit]
- abstract def setTimeZone(zone: ZoneId)(implicit trace: ZTraceElement): UIO[Unit]
-
abstract
def
sleep(duration: ⇒ zio.Duration)(implicit trace: ZTraceElement): UIO[Unit]
- Definition Classes
- Clock
- abstract def sleeps(implicit trace: ZTraceElement): UIO[List[zio.Duration]]
- abstract def timeZone(implicit trace: ZTraceElement): UIO[ZoneId]
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
driver[Env, In, Out](schedule: Schedule[Env, In, Out])(implicit trace: ZTraceElement): UIO[Driver[State, Env, In, Out]]
- Definition Classes
- Clock
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
repeat[R, R1 <: R, E, A, B](zio: ⇒ ZIO[R, E, A])(schedule: ⇒ Schedule[R1, A, B])(implicit trace: ZTraceElement): ZIO[R1, E, B]
- Definition Classes
- Clock
-
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])(implicit trace: ZTraceElement): ZIO[R1, E2, B]
- Definition Classes
- Clock
-
final
def
repeatOrElseEither[R, R1 <: R, E, E2, A, B, C](zio0: ⇒ ZIO[R, E, A])(schedule0: ⇒ Schedule[R1, A, B], orElse: (E, Option[B]) ⇒ ZIO[R1, E2, C])(implicit trace: ZTraceElement): ZIO[R1, E2, Either[C, B]]
- Definition Classes
- Clock
-
final
def
retry[R, R1 <: R, E, A, S](zio: ⇒ ZIO[R, E, A])(policy: Schedule[R1, E, S])(implicit ev: CanFail[E], trace: ZTraceElement): ZIO[R1, E, A]
- Definition Classes
- Clock
-
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], trace: ZTraceElement): ZIO[R1, E1, A1]
- Definition Classes
- Clock
-
final
def
retryOrElseEither[R, R1 <: R, E, E1, A, B, Out](zio0: ⇒ ZIO[R, E, A])(schedule0: ⇒ Schedule[R1, E, Out], orElse: (E, Out) ⇒ ZIO[R1, E1, B])(implicit ev: CanFail[E], trace: ZTraceElement): ZIO[R1, E1, Either[B, A]]
- Definition Classes
- Clock
-
final
def
schedule[R, R1 <: R, E, A, B](zio: ⇒ ZIO[R, E, A])(schedule: ⇒ Schedule[R1, Any, B])(implicit trace: ZTraceElement): ZIO[R1, E, B]
- Definition Classes
- Clock
-
final
def
scheduleFrom[R, R1 <: R, E, A, A1 >: A, B](zio0: ⇒ ZIO[R, E, A])(a: ⇒ A1)(schedule0: ⇒ Schedule[R1, A1, B])(implicit trace: ZTraceElement): ZIO[R1, E, B]
- Definition Classes
- Clock
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()