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")(
    test("time is non-zero") {
      for {
        time <- Live.live(nanoTime)
      } yield assertTrue(time >= 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 2. Symmetry - a1 === a2 ==> a2 === a1 3. 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 mock

Definition Classes: test

package poly

Definition Classes: test

package render

Definition Classes: test

CheckConstructorLowPriority1

CheckConstructorLowPriority2

CheckConstructorLowPriority3

CheckConstructorLowPriority4

CheckConstructorLowPriority5

CheckConstructorLowPriority6

CheckConstructorLowPriority7

CheckVariants

CompileVariants

DefaultMutableRunnableSpec

Eql

Gen

PrettyPrintVersionSpecific

SourceLocationVariants

Spec

SpecLayerMacros

SuiteConstructor

SuiteConstructorLowPriority1

SuiteConstructorLowPriority2

SuiteConstructorLowPriority3

SuiteConstructorLowPriority4

TestAnnotationRenderer

TestConstructorLowPriority1

TestConstructorLowPriority2

TestConstructorLowPriority3

TestConstructorLowPriority4

TestConstructorLowPriority5

TestConstructorLowPriority6

TestConstructorLowPriority7

BoolAlgebra

Companion object BoolAlgebra

sealed abstract class BoolAlgebra[+A] extends Product with Serializable

A BoolAlgebra[A] is a description of logical operations on values of type A.

Self Type: BoolAlgebra[A]

Linear Supertypes

Serializable, Product, Equals, AnyRef, Any

Known Subclasses

And, Not, Or, Value

Ordering

Alphabetic
By Inheritance

Inherited

BoolAlgebra
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def canEqual(that: Any): Boolean
Definition Classes
Equals
abstract def productArity: Int
Definition Classes
Product
abstract def productElement(n: Int): Any
Definition Classes
Product

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def &&[A1 >: A](that: BoolAlgebra[A1]): BoolAlgebra[A1]
Returns a new result that is the logical conjunction of this result and the specified result.
final def <==>[A1 >: A](that: BoolAlgebra[A1]): BoolAlgebra[A1]
Returns a new result that is the logical double implication of this result and the specified result.
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ==>[A1 >: A](that: BoolAlgebra[A1]): BoolAlgebra[A1]
Returns a new result that is the logical implication of this result and the specified result.
final def as[B](b: B): BoolAlgebra[B]
Returns a new result, with all values mapped to the specified constant.
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def both[A1 >: A](that: BoolAlgebra[A1]): BoolAlgebra[A1]
A named alias for &&.
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def either[A1 >: A](that: BoolAlgebra[A1]): BoolAlgebra[A1]
A named alias for ||.
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def failures: Option[BoolAlgebra[A]]
If this result is a success returns None.
If this result is a success returns None. If it is a failure returns a new result containing all failures that are relevant to this result being a failure.
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def flatMap[B](f: (A) => BoolAlgebra[B]): BoolAlgebra[B]
Returns a new result, with all values mapped to new results using the specified function.
final def flatMapZIO[R, E, B](f: (A) => ZIO[R, E, BoolAlgebra[B]])(implicit trace: ZTraceElement): ZIO[R, E, BoolAlgebra[B]]
Returns a new result, with all values mapped to new results using the specified effectual function.
final def fold[B](caseValue: (A) => B)(caseAnd: (B, B) => B, caseOr: (B, B) => B, caseNot: (B) => B): B
Folds over the result bottom up, first converting values to B values, and then combining the B values, using the specified functions.
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
final def hashCode(): Int
Definition Classes
BoolAlgebra → AnyRef → Any
final def iff[A1 >: A](that: BoolAlgebra[A1]): BoolAlgebra[A1]
A named alias for "<==>".
final def implies[A1 >: A](that: BoolAlgebra[A1]): BoolAlgebra[A1]
A named alias for "==>".
final def isFailure: Boolean
Determines whether the result is a failure, where values represent success and are combined using logical conjunction, disjunction, and negation.
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isSuccess: Boolean
Determines whether the result is a success, where values represent success and are combined using logical conjunction, disjunction, and negation.
final def map[B](f: (A) => B): BoolAlgebra[B]
Returns a new result, with all values mapped by the specified function.
final def mapZIO[R, E, B](f: (A) => ZIO[R, E, B])(implicit trace: ZTraceElement): ZIO[R, E, BoolAlgebra[B]]
Returns a new result, with all values mapped by the specified effectual function.
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def negate: BoolAlgebra[A]
Negates this result, converting all successes into failures and failures into successes.
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def productElementName(n: Int): String
Definition Classes
Product
def productElementNames: Iterator[String]
Definition Classes
Product
def productIterator: Iterator[Any]
Definition Classes
Product
def productPrefix: String
Definition Classes
Product
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def unary_!: BoolAlgebra[A]
Returns a new result that is the logical negation of this result.
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()
final def ||[A1 >: A](that: BoolAlgebra[A1]): BoolAlgebra[A1]
Returns a new result that is the logical disjunction of this result and the specified result.

Deprecated Value Members

final def flatMapM[R, E, B](f: (A) => ZIO[R, E, BoolAlgebra[B]])(implicit trace: ZTraceElement): ZIO[R, E, BoolAlgebra[B]]
Returns a new result, with all values mapped to new results using the specified effectual function.
Returns a new result, with all values mapped to new results using the specified effectual function.
Annotations
@deprecated
Deprecated
(Since version 2.0.0) use flatMapZIO
final def mapM[R, E, B](f: (A) => ZIO[R, E, B])(implicit trace: ZTraceElement): ZIO[R, E, BoolAlgebra[B]]
Returns a new result, with all values mapped by the specified effectual function.
Returns a new result, with all values mapped by the specified effectual function.
Annotations
@deprecated
Deprecated
(Since version 2.0.0) use mapZIO

Packages

BoolAlgebra

Companion object BoolAlgebra

sealed abstract class BoolAlgebra[+A] extends Product with Serializable

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

BoolAlgebra

Companion object BoolAlgebra

sealed abstract class BoolAlgebra[+A] extends Product with Serializable

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

BoolAlgebra