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

ZIOSpecAbstract

abstract class ZIOSpecAbstract extends ZIOApp with ZIOSpecAbstractVersionSpecific

Self Type: ZIOSpecAbstract
Annotations: @EnableReflectiveInstantiation()

Linear Supertypes

ZIOSpecAbstractVersionSpecific, ZIOApp, ZIOAppVersionSpecific, ZIOAppPlatformSpecific, AnyRef, Any

Known Subclasses

ZIOSpec, ZIOSpecDefault

Ordering

Alphabetic
By Inheritance

Inherited

ZIOSpecAbstract
ZIOSpecAbstractVersionSpecific
ZIOApp
ZIOAppVersionSpecific
ZIOAppPlatformSpecific
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new ZIOSpecAbstract()

Type Members

abstract type Environment
Definition Classes
ZIOApp

Abstract Value Members

abstract def bootstrap: ZLayer[Any, Any, Environment]
A layer that manages the acquisition and release of services necessary for the application to run.
A layer that manages the acquisition and release of services necessary for the application to run.
Definition Classes
ZIOSpecAbstract → ZIOApp
implicit abstract def environmentTag: zio.EnvironmentTag[Environment]
Definition Classes
ZIOApp
abstract def spec: Spec[Environment with TestEnvironment with Scope, Any]

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def <>(that: ZIOSpecAbstract)(implicit trace: Trace): ZIOSpecAbstract
final def <>(that: ZIOApp)(implicit trace: Trace): ZIOApp
Composes this ZIOApp with another ZIOApp, to yield an application that executes the logic of both applications.
Composes this ZIOApp with another ZIOApp, to yield an application that executes the logic of both applications.
Definition Classes
ZIOApp
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def aspects: Chunk[TestAspectAtLeastR[Environment with TestEnvironment]]
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
final def exit(code: ExitCode)(implicit trace: Trace): UIO[Unit]
A helper function to exit the application with the specified exit code.
A helper function to exit the application with the specified exit code.
Definition Classes
ZIOApp
final def getArgs(implicit trace: Trace): ZIO[ZIOAppArgs, Nothing, Chunk[String]]
A helper function to obtain access to the command-line arguments of the application.
A helper function to obtain access to the command-line arguments of the application. You may use this helper function inside your run function.
Definition Classes
ZIOApp
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
def installSignalHandlers(runtime: Runtime[Any])(implicit trace: Trace): UIO[Any]
Attributes
protected
Definition Classes
ZIOApp
final def invoke(args: Chunk[String])(implicit trace: Trace): ZIO[Any, Any, Any]
Invokes the main app.
Invokes the main app. Designed primarily for testing.
Definition Classes
ZIOApp
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def main(args0: Array[String]): Unit
The Scala main function, intended to be called only by the Scala runtime.
The Scala main function, intended to be called only by the Scala runtime.
Definition Classes
ZIOAppPlatformSpecific
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 run: ZIO[Environment with ZIOAppArgs with Scope, Any, Summary]
The main function of the application, which can access the command-line arguments through the args helper method of this class.
The main function of the application, which can access the command-line arguments through the args helper method of this class. If the provided effect fails for any reason, the cause will be logged, and the exit code of the application will be non-zero. Otherwise, the exit code of the application will be zero.
Definition Classes
ZIOSpecAbstract → ZIOApp
final def runSpec(implicit trace: Trace): ZIO[Environment with TestEnvironment with ZIOAppArgs with Scope, Throwable, Summary]
Attributes
protected
def runtime: Runtime[Any]
Definition Classes
ZIOApp
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
implicit macro def validateEnv[R1, R, E](spec: Spec[R, E]): Spec[R1, E]
This implicit conversion macro will ensure that the provided ZIO effect does not require more than the provided environment.
This implicit conversion macro will ensure that the provided ZIO effect does not require more than the provided environment.
If it is missing requirements, it will report a descriptive error message. Otherwise, the effect will be returned unmodified.
Definition Classes
ZIOSpecAbstractVersionSpecific
implicit macro def validateEnv[R1, R, E, A](zio: ZIO[R, E, A]): ZIO[R1, E, A]
This implicit conversion macro will ensure that the provided ZIO effect does not require more than the provided environment.
This implicit conversion macro will ensure that the provided ZIO effect does not require more than the provided environment.
If it is missing requirements, it will report a descriptive error message. Otherwise, the effect will be returned unmodified.
Definition Classes
ZIOAppVersionSpecific
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

ZIOSpecAbstract

abstract class ZIOSpecAbstract extends ZIOApp with ZIOSpecAbstractVersionSpecific

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ZIOSpecAbstractVersionSpecific

Inherited from ZIOApp

Inherited from ZIOAppVersionSpecific

Inherited from ZIOAppPlatformSpecific

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

ZIOSpecAbstract

abstract class ZIOSpecAbstract extends ZIOApp with ZIOSpecAbstractVersionSpecific

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ZIOSpecAbstractVersionSpecific

Inherited from ZIOApp

Inherited from ZIOAppVersionSpecific

Inherited from ZIOAppPlatformSpecific

Inherited from AnyRef

Inherited from Any

Ungrouped

ZIOSpecAbstract