Packages

Definition Classes: root

Definition Classes: root

_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

object MyTest extends ZIOSpecDefault {
  def spec = suite("clock")(
    test("time is non-zero") {
      for {
        time <- Live.live(nanoTime)
      } yield assertTrue(time >= 0L)
    }
  )
}

Definition Classes: zio

package diff

Definition Classes: test

package internal

Definition Classes: test

package laws

The laws package provides functionality for describing laws as values.

The laws package provides functionality for describing laws as values. The fundamental abstraction is a set of ZLaws[Caps, R]. These laws model the laws that instances having a capability of type Caps are expected to satisfy. A capability Caps[_] is an abstraction describing some functionality that is common across different data types and obeys certain laws. For example, we can model the capability of two values of a type being compared for equality as follows:

trait Equal[-A] {
  def equal(a1: A, a2: A): Boolean
}

Definitions of equality are expected to obey certain laws:

Reflexivity - a1 === a1
Symmetry - a1 === a2 ==> a2 === a1
Transitivity - (a1 === a2) && (a2 === a3) ==> (a1 === a3)

These laws define what the capabilities mean and ensure that it is safe to abstract across different instances with the same capability.

Using ZIO Test, we can represent these laws as values. To do so, we define each law using one of the ZLaws constructors. For example:

val transitivityLaw = ZLaws.Laws3[Equal]("transitivityLaw") {
  def apply[A: Equal](a1: A, a2: A, a3: A): TestResult =
    ???
}

We can then combine laws using the + operator:

val reflexivityLaw: = ???
val symmetryLaw:    = ???

val equalLaws = reflexivityLaw + symmetryLaw + transitivityLaw

Laws have a run method that takes a generator of values of type A and checks that those values satisfy the laws. In addition, objects can extend ZLawful to provide an even more convenient syntax for users to check that instances satisfy certain laws.

object Equal extends Lawful[Equal]

object Hash extends Lawful[Hash]

object Ord extends Lawful[Ord]

checkAllLaws(Equal + Hash + Ord)(Gen.int)

Note that capabilities compose seamlessly because of contravariance. We can combine laws describing different capabilities to construct a set of laws requiring that instances having all of the capabilities satisfy each of the laws.

Definition Classes: test

package magnolia

Definition Classes: test

package poly

Definition Classes: test

package refined

Definition Classes: test

package render

Definition Classes: test

package results

Definition Classes: test

package scalacheck

This package provides helpers to integrate *some* ScalaCheck primitives to their ZIO equivalents.

This package provides helpers to integrate *some* ScalaCheck primitives to their ZIO equivalents. Currently available helpers:

Converting ScalaCheck Generators to ZIO Generators
Asserting a ScalaCheck Prop with ZIO
Asserting a ScalaCheck Properties with ZIO

**Generators**

This functionality converts legacy ScalaCheck generators to ZIO Test generators to support upgrading to ZIO Test without having to reimplement existing generators. To use it import this module and then call toGenZIO on any existing ScalaCheck generator. For example:

import org.scalacheck.Arbitrary

import zio._
import zio.test._
import zio.test.scalacheck._

val anyInt: Gen[Any, Int] =
  Arbitrary.arbitrary[Int].toGenZIO

**Asserting ScalaCheck Prop and Properties**

This functionality generates ZIO Assertions from either ScalaCheck Prop or Properties. This helps with integrating other libraries that provide ScalaCheck properties as helpers, i.e. cats-laws.

Prop example:

import org.scalacheck.Prop
import org.scalacheck.Test.{ Parameters => ScalaCheckParameters }

import zio._
import zio.test._
import zio.test.scalacheck._

val prop: Prop = Prop.forAll { (n: Int, m: Int) =>
  n + m == m + n
}
val resultDefault: TestResult = prop.assertZIO()

val resultWithCustomizations: TestResult =
  prop.assertZIO("My Prop Name", ScalaCheckParameters.default.withMaxSize(10))

Properties example:

import org.scalacheck.{ Prop, Properties }
import org.scalacheck.Test.{ Parameters => ScalaCheckParameters }

import zio._
import zio.test._
import zio.test.scalacheck._

object MyProperties extends Properties("MyProperties") {
  property("myProp") = Prop.forAll { (n: Int, m: Int) =>
    n + m == m + n
  }
}

* val resultDefault: TestResult = MyProperties.assertZIO()

// Beware that we can't provide a custom name here, it will be
// taken from the `Properties` name parameter
val resultWithCustomizations: TestResult =
  MyProperties.assertZIO(ScalaCheckParameters.default.withMaxSize(10))

Definition Classes: test

CheckConstructorLowPriority1

CheckConstructorLowPriority2

CheckConstructorLowPriority3

Eql

Gen

PrettyPrintVersionSpecific

ProvideSomePartiallyApplied

ProvideSomeSharedPartiallyApplied

ReporterEventRenderer

SuiteConstructorLowPriority1

SuiteConstructorLowPriority2

SuiteConstructorLowPriority3

SuiteConstructorLowPriority4

TestAnnotationRenderer

TestClockPlatformSpecific

TestConfig

TestConsole

TestConstructor

TestConstructorLowPriority1

TestConstructorLowPriority2

TestConstructorLowPriority3

ZIOSpecAbstractVersionSpecific

ZIOSpecDefault

ZIOSpecVersionSpecific

TestClock

Companion trait TestClock

object TestClock extends Serializable

Linear Supertypes

Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

TestClock
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

final case class Data(instant: Instant, sleeps: List[(Instant, Promise[Nothing, Unit])], timeZone: ZoneId) extends Product with Serializable
Data represents the state of the TestClock, including the clock time and time zone.
final case class Sleep(duration: zio.Duration, promise: Promise[Nothing, Unit], fiberId: FiberId) extends Product with Serializable
Sleep represents the state of a scheduled effect, including the time the effect is scheduled to run, a promise that can be completed to resume execution of the effect, and the fiber executing the effect.
sealed abstract class SuspendedWarningData extends AnyRef
final case class Test(clockState: Atomic[Data], live: Live, annotations: Annotations, warningState: Synchronized[WarningData], suspendedWarningState: Synchronized[SuspendedWarningData]) extends TestClock with TestClockPlatformSpecific with Product with Serializable
sealed abstract class WarningData extends AnyRef
WarningData describes the state of the warning message that is displayed if a test is using time by is not advancing the TestClock.
WarningData describes the state of the warning message that is displayed if a test is using time by is not advancing the TestClock. The possible states are Start if a test has not used time, Pending if a test has used time but has not adjusted the TestClock, and Done if a test has adjusted the TestClock or the warning message has already been displayed.

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
def adjust(duration: => zio.Duration)(implicit trace: Trace): UIO[Unit]
Accesses a TestClock instance in the environment and increments the time by the specified duration, running any actions scheduled for on or before the new time in order.
def adjustWith[R, E, A](duration: => zio.Duration)(zio: ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]
val any: ZLayer[TestClock, Nothing, TestClock]
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
val default: ZLayer[Live with Annotations, Nothing, TestClock]
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def live(data: Data)(implicit trace: Trace): ZLayer[Annotations with Live, Nothing, TestClock]
Constructs a new Test object that implements the TestClock interface.
Constructs a new Test object that implements the TestClock interface. This can be useful for mixing in with implementations of other interfaces.
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()
def save(implicit trace: Trace): UIO[UIO[Unit]]
Accesses a TestClock instance in the environment and saves the clock state in an effect which, when run, will restore the TestClock to the saved state.
def setTime(instant: => Instant)(implicit trace: Trace): UIO[Unit]
Accesses a TestClock instance in the environment and sets the clock time to the specified Instant, running any actions scheduled for on or before the new time in order.
def setTimeZone(zone: => ZoneId)(implicit trace: Trace): UIO[Unit]
Accesses a TestClock instance in the environment, setting the time zone to the specified time zone.
Accesses a TestClock 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.
def sleeps(implicit trace: Trace): UIO[List[Instant]]
Accesses a TestClock instance in the environment and returns a list of times that effects are scheduled to run.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def timeZone(implicit trace: Trace): UIO[ZoneId]
Accesses a TestClock instance in the environment and returns the current time zone.
def toString(): String
Definition Classes
AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
object SuspendedWarningData
object WarningData

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Packages

TestClock

Companion trait TestClock

object TestClock extends Serializable

Type Members

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

TestClock

Companion trait TestClock

object TestClock extends Serializable

Type Members

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

TestClock