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

object MyTest extends DefaultRunnableSpec {
  def spec = suite("clock")(
    testM("time is non-zero") {
      assertM(Live.live(nanoTime))(isGreaterThan(0))
    }
  )
}

Definition Classes: zio

package diff

Definition Classes: test

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

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.anyInt)

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 mock

Definition Classes: test

package poly

Definition Classes: test

DefaultMutableRunnableSpec

Eql

Gen

PrettyPrintVersionSpecific

SourceLocationVariants

TestAnnotationRenderer

TimeVariants

trait TimeVariants extends AnyRef

Linear Supertypes

AnyRef, Any

Known Subclasses

Gen

Ordering

Alphabetic
By Inheritance

Inherited

TimeVariants
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

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 anyDayOfWeek: Gen[Random, DayOfWeek]
A generator of java.time.DayOfWeek values.
A generator of java.time.DayOfWeek values. Shrinks toward DayOfWeek.MONDAY.
final def anyFiniteDuration: Gen[Random, Duration]
A generator of finite zio.duration.Duration values.
A generator of finite zio.duration.Duration values. Shrinks toward Duration.Zero.
final def anyInstant: Gen[Random, Instant]
A generator of java.time.Instant values.
A generator of java.time.Instant values. Shrinks toward Instant.MIN.
final def anyLocalDate: Gen[Random, LocalDate]
A generator of java.time.LocalDate values.
A generator of java.time.LocalDate values. Shrinks toward LocalDate.MIN.
final def anyLocalDateTime: Gen[Random, LocalDateTime]
A generator of java.time.LocalDateTime values.
A generator of java.time.LocalDateTime values. Shrinks toward LocalDateTime.MIN.
final def anyLocalTime: Gen[Random, LocalTime]
A generator of java.time.LocalTime values.
A generator of java.time.LocalTime values. Shrinks toward LocalTime.MIN.
final def anyMonth: Gen[Random, Month]
A generator of java.time.Month values.
A generator of java.time.Month values. Shrinks toward Month.JANUARY.
final def anyMonthDay: Gen[Random, MonthDay]
A generator of java.time.MonthDay values.
A generator of java.time.MonthDay values. Shrinks toward MonthDay.of(Month.JANUARY, 1).
final def anyOffsetDateTime: Gen[Random, OffsetDateTime]
A generator of java.time.OffsetDateTime values.
A generator of java.time.OffsetDateTime values. Shrinks toward OffsetDateTime.MIN.
final def anyOffsetTime: Gen[Random, OffsetTime]
A generator of java.time.OffsetTime values.
A generator of java.time.OffsetTime values. Shrinks torward OffsetTime.MIN.
final def anyPeriod: Gen[Random, Period]
A generator of java.time.Period values.
A generator of java.time.Period values. Shrinks toward Period.ZERO.
final def anyYear: Gen[Random, Year]
A generator of java.time.Year values.
A generator of java.time.Year values. Shrinks toward Year.of(Year.MIN_VALUE).
final def anyYearMonth: Gen[Random, YearMonth]
A generator of java.time.YearMonth values.
A generator of java.time.YearMonth values. Shrinks toward YearMonth.of(Year.MIN_VALUE, Month.JANUARY).
final def anyZoneId: Gen[Random, ZoneId]
A generator of java.time.ZoneId values.
A generator of java.time.ZoneId values. Doesn't have any shrinking.
Annotations
@silent("JavaConverters")
final def anyZoneOffset: Gen[Random, ZoneOffset]
A generator of java.time.ZoneOffset values.
A generator of java.time.ZoneOffset values. Shrinks toward ZoneOffset.MIN.
final def anyZonedDateTime: Gen[Random, ZonedDateTime]
A generator of java.time.ZonedDateTime values.
A generator of java.time.ZonedDateTime values. Shrinks toward ZoneDateTime.of(LocalDateTime.MIN, zoneId).
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def finiteDuration(min: Duration, max: Duration): Gen[Random, Duration]
A generator of finite zio.duration.Duration values inside the specified range: [min, max].
A generator of finite zio.duration.Duration values inside the specified range: [min, max]. Shrinks toward min.
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def instant(min: Instant, max: Instant): Gen[Random, Instant]
A generator of java.time.Instant values inside the specified range: [min, max].
A generator of java.time.Instant values inside the specified range: [min, max]. Shrinks toward min.
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def localDateTime(min: LocalDateTime, max: LocalDateTime): Gen[Random, LocalDateTime]
A generator of java.time.LocalDateTime values inside the specified range: [min, max].
A generator of java.time.LocalDateTime values inside the specified range: [min, max]. Shrinks toward min.
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 offsetDateTime(min: OffsetDateTime, max: OffsetDateTime): Gen[Random, OffsetDateTime]
A generator of java.time.OffsetDateTime values inside the specified range: [min, max].
A generator of java.time.OffsetDateTime values inside the specified range: [min, max]. Shrinks toward min.
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(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()

Packages

TimeVariants

trait TimeVariants extends AnyRef

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

TimeVariants

trait TimeVariants extends AnyRef

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

TimeVariants