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

TestSystem

Companion trait TestSystem

object TestSystem extends Serializable

Linear Supertypes

Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

TestSystem
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

final case class Data(properties: Map[String, String] = Map.empty, envs: Map[String, String] = Map.empty, lineSeparator: String = "\n") extends Product with Serializable
The state of the TestSystem.
final case class Test(systemState: Atomic[Data]) extends TestSystem with Product with Serializable

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
val DefaultData: Data
The default initial state of the TestSystem with no environment variable or system property mappings and the system line separator set to the new line character.
val any: ZLayer[TestSystem, Nothing, TestSystem]
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clearEnv(variable: => String)(implicit trace: Trace): UIO[Unit]
Accesses a TestSystem instance in the environment and clears the mapping of environment variables.
def clearProperty(prop: => String)(implicit trace: Trace): UIO[Unit]
Accesses a TestSystem instance in the environment and clears the mapping of system properties.
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
val default: Layer[Nothing, TestSystem]
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): Layer[Nothing, TestSystem]
Constructs a new TestSystem with the specified initial state.
Constructs a new TestSystem with the specified initial state. This can be useful for providing the required environment to an effect that requires a Console, such as with ZIO#provide.
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 putEnv(name: => String, value: => String)(implicit trace: Trace): UIO[Unit]
Accesses a TestSystem instance in the environment and adds the specified name and value to the mapping of environment variables.
def putProperty(name: => String, value: => String)(implicit trace: Trace): UIO[Unit]
Accesses a TestSystem instance in the environment and adds the specified name and value to the mapping of system properties.
def save(implicit trace: Trace): UIO[UIO[Unit]]
Accesses a TestSystem instance in the environment and saves the system state in an effect which, when run, will restore the TestSystem to the saved state
def setLineSeparator(lineSep: => String)(implicit trace: Trace): UIO[Unit]
Accesses a TestSystem instance in the environment and sets the line separator to the specified value.
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()

Deprecated Value Members

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

Packages

TestSystem

Companion trait TestSystem

object TestSystem extends Serializable

Type Members

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

TestSystem

Companion trait TestSystem

object TestSystem extends Serializable

Type Members

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

TestSystem