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

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 poly

Definition Classes: test

package render

Definition Classes: test

package results

Definition Classes: test

Annotations

Assertion

AssertionVariants

CheckConstructor

CheckConstructorLowPriority1

CheckConstructorLowPriority2

CheckConstructorLowPriority3

CheckVariants

CompileVariants

CustomAssertion

Eql

ErrorMessage

ExecutionEvent

ExecutionEventSink

FailureCase

FunctionVariants

Gen

GenFailureDetails

GenZIO

Live

PrettyPrintVersionSpecific

ProvideSomePartiallyApplied

ProvideSomeSharedPartiallyApplied

ReporterEventRenderer

Restorable

Result

Sample

Sized

SmartAssertMacros

SmartAssertionOps

SmartSpecMacros

Spec

SpecLayerMacros

SuiteConstructor

SuiteConstructorLowPriority1

SuiteConstructorLowPriority2

SuiteConstructorLowPriority3

SuiteConstructorLowPriority4

SuiteId

Summary

SummaryBuilder

TestAnnotation

TestAnnotationMap

TestAnnotationRenderer

TestArrow

TestAspect

TestClock

TestClockPlatformSpecific

TestConfig

TestConsole

TestConstructor

TestConstructorLowPriority1

TestConstructorLowPriority2

TestConstructorLowPriority3

TestDuration

TestEnvironment

TestExecutor

TestFailure

TestLens

TestLensAnyOps

TestLensCauseOps

TestLensEitherOps

TestLensExitOps

TestLensOptionOps

TestLogger

TestPlatform

TestRandom

TestReporters

TestResult

TestResultZIOOps

TestRunner

TestServices

TestSuccess

TestSystem

TestTimeoutException

TestTrace

TestVersion

TimeVariants

TimeoutVariants

ZIOSpec

ZIOSpecAbstract

ZIOSpecAbstractVersionSpecific

ZIOSpecDefault

ZIOSpecVersionSpecific

ZTest

ZTestEventHandler

ZTestLogger

zio.test

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
All

Instance Constructors

new ZIOSpecAbstract()

Type Members

abstract type Environment

Definition Classes
ZIOApp

Abstract Value Members

abstract def bootstrap: ZLayer[Any, Any, Environment]

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

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( ... ) @native()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def exit(code: ExitCode)(implicit trace: Trace): UIO[Unit]

Definition Classes
ZIOApp
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getArgs(implicit trace: Trace): ZIO[ZIOAppArgs, Nothing, Chunk[String]]

Definition Classes
ZIOApp
final def getClass(): Class[_]

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]

Definition Classes
ZIOApp
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def main(args0: Array[String]): Unit

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]

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]

Definition Classes
ZIOAppVersionSpecific
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()

Packages

ZIOSpecAbstract

abstract class ZIOSpecAbstract extends ZIOApp with ZIOSpecAbstractVersionSpecific

Instance Constructors

Type Members

Abstract Value Members

Concrete 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

Inherited from ZIOSpecAbstractVersionSpecific

Inherited from ZIOApp

Inherited from ZIOAppVersionSpecific

Inherited from ZIOAppPlatformSpecific

Inherited from AnyRef

Inherited from Any

Ungrouped

ZIOSpecAbstract