Packages

package root

Definition Classes: root

package zio

Definition Classes: root

package test

_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
import Assertion.isGreaterThan

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

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 poly

Definition Classes: test

package render

Definition Classes: test

AbstractRunnableSpec

Annotations

Assert

Assertion

AssertionData

AssertionM

AssertionMData

AssertionResult

AssertionValue

AssertionVariants

BoolAlgebra

BoolAlgebraM

CheckConstructor

CheckConstructorLowPriority1

CheckConstructorLowPriority2

CheckConstructorLowPriority3

CheckConstructorLowPriority4

CheckConstructorLowPriority5

CheckVariants

CompileVariants

CustomAssertion

DefaultMutableRunnableSpec

DefaultRunnableSpec

DefaultTestReporter

Eql

ErrorMessage

ExecutedSpec

FailureCase

FailureDetails

FunctionVariants

Gen

GenFailureDetails

GenZIO

Live

MutableRunnableSpec

PrettyPrintVersionSpecific

Restorable

Result

RunnableSpec

Sample

Sized

SmartAssertMacros

SmartAssertionOps

Spec

SpecLayerMacros

SuiteConstructor

SuiteConstructorLowPriority1

SuiteConstructorLowPriority2

SuiteConstructorLowPriority3

SuiteConstructorLowPriority4

Summary

SummaryBuilder

TestAnnotation

TestAnnotationMap

TestAnnotationRenderer

TestArgs

TestArrow

TestAspect

TestClock

TestClockPlatformSpecific

TestConfig

TestConsole

TestConstructor

TestConstructorLowPriority1

TestConstructorLowPriority2

TestConstructorLowPriority3

TestConstructorLowPriority4

TestConstructorLowPriority5

TestDuration

TestEnvironment

TestExecutor

TestFailure

TestLens

TestLensAnyOps

TestLensCauseOps

TestLensEitherOps

TestLensExitOps

TestLensOptionOps

TestLogger

TestPlatform

TestRandom

TestReporter

TestResult

TestRunner

TestSuccess

TestSystem

TestTimeoutException

TestVersion

TimeVariants

TimeoutVariants

Trace

ZIOSpec

ZIOSpecAbstract

ZIOSpecDefault

ZTest

ZTestLogger

zio.test

TestRunner

final case class TestRunner[R, E](executor: TestExecutor[R, E], runtimeConfig: RuntimeConfig = RuntimeConfig.makeDefault(), reporter: TestReporter[E] = ..., bootstrap: Layer[Nothing, TestLogger with Clock] = ...) extends Product with Serializable

A TestRunner[R, E] encapsulates all the logic necessary to run specs that require an environment R and may fail with an error E. Test runners require a test executor, a runtime configuration, and a reporter.

Self Type: TestRunner[R, E]

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

TestRunner
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new TestRunner(executor: TestExecutor[R, E], runtimeConfig: RuntimeConfig = RuntimeConfig.makeDefault(), reporter: TestReporter[E] = ..., bootstrap: Layer[Nothing, TestLogger with Clock] = ...)

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
val bootstrap: Layer[Nothing, TestLogger with Clock]
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val executor: TestExecutor[R, E]
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()
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()
val reporter: TestReporter[E]
def run(spec: ZSpec[R, E])(implicit trace: ZTraceElement): URIO[TestLogger with Clock, ExecutedSpec[E]]
Runs the spec, producing the execution results.
lazy val runtime: Runtime[Any]
val runtimeConfig: RuntimeConfig
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def unsafeRun(spec: ZSpec[R, E])(implicit trace: ZTraceElement): ExecutedSpec[E]
An unsafe, synchronous run of the specified spec.
def unsafeRunAsync(spec: ZSpec[R, E])(k: (ExecutedSpec[E]) ⇒ Unit)(implicit trace: ZTraceElement): Unit
An unsafe, asynchronous run of the specified spec.
def unsafeRunSync(spec: ZSpec[R, E])(implicit trace: ZTraceElement): Exit[Nothing, ExecutedSpec[E]]
An unsafe, synchronous run of the specified spec.
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()
def withReporter[E1 >: E](reporter: TestReporter[E1]): TestRunner[R, E]
Creates a copy of this runner replacing the reporter.
def withRuntimeConfig(f: (RuntimeConfig) ⇒ RuntimeConfig): TestRunner[R, E]
Creates a copy of this runner replacing the runtime configuration.

Deprecated Value Members

def withPlatform(f: (Platform) ⇒ Platform): TestRunner[R, E]
Creates a copy of this runner replacing the platform
Creates a copy of this runner replacing the platform

Annotations
@deprecated
Deprecated
(Since version 2.0.0) use withRuntimeConfig

Packages

TestRunner

final case class TestRunner[R, E](executor: TestExecutor[R, E], runtimeConfig: RuntimeConfig = RuntimeConfig.makeDefault(), reporter: TestReporter[E] = ..., bootstrap: Layer[Nothing, TestLogger with Clock] = ...) extends Product with Serializable

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

TestRunner 

final case class TestRunner[R, E](executor: TestExecutor[R, E], runtimeConfig: RuntimeConfig = RuntimeConfig.makeDefault(), reporter: TestReporter[E] = ..., bootstrap: Layer[Nothing, TestLogger with Clock] = ...) extends Product with Serializable

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

TestRunner