Packages

  • package root
    Definition Classes
    root
  • package zio
    Definition Classes
    root
  • package test

    _ZIO Test_ is a featherweight testing library for effectful programs.

    _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")(
    testM("time is non-zero") {
      assertM(nanoTime)(isGreaterThan(0))
    }
  )
}
    Definition Classes
    zio
  • 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
  • Live
  • Restorable
  • TestClock
  • TestConsole
  • TestEnvironment
  • TestRandom
  • TestSystem

object TestRandom extends Serializable

TestRandom allows for deterministically testing effects involving randomness.

TestRandom operates in two modes. In the first mode, TestRandom is a purely functional pseudo-random number generator. It will generate pseudo-random values just like scala.util.Random except that no internal state is mutated. Instead, methods like nextInt describe state transitions from one random state to another that are automatically composed together through methods like flatMap. The random seed can be set using setSeed and TestRandom is guaranteed to return the same sequence of values for any given seed. This is useful for deterministically generating a sequence of pseudo-random values and powers the property based testing functionality in ZIO Test.

In the second mode, TestRandom maintains an internal buffer of values that can be "fed" with methods such as feedInts and then when random values of that type are generated they will first be taken from the buffer. This is useful for verifying that functions produce the expected output for a given sequence of "random" inputs.

import zio.random._
import zio.test.environment.TestRandom

for {
  _ <- TestRandom.feedInts(4, 5, 2)
  x <- random.nextIntBounded(6)
  y <- random.nextIntBounded(6)
  z <- random.nextIntBounded(6)
} yield x + y + z == 11

TestRandom will automatically take values from the buffer if a value of the appropriate type is available and otherwise generate a pseudo-random value, so there is nothing you need to do to switch between the two modes. Just generate random values as you normally would to get pseudo-random values, or feed in values of your own to get those values back. You can also use methods like clearInts to clear the buffer of values of a given type so you can fill the buffer with new values or go back to pseudo-random number generation.

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestRandom
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Buffer(booleans: List[Boolean] = List.empty, bytes: List[Chunk[Byte]] = List.empty, chars: List[Char] = List.empty, doubles: List[Double] = List.empty, floats: List[Float] = List.empty, integers: List[Int] = List.empty, longs: List[Long] = List.empty, strings: List[String] = List.empty) extends Product with Serializable

    The buffer of the TestRandom.

  2. final case class Data(seed1: Int, seed2: Int, nextNextGaussians: scala.collection.immutable.Queue[Double] = Queue.empty) extends Product with Serializable

    The seed of the TestRandom.

  3. trait Service extends Restorable
  4. final case class Test(randomState: Ref[Data], bufferState: Ref[Buffer]) extends random.Random.Service with Service with Product with Serializable

    Adapted from @gzmo work in Scala.js (https://github.com/scala-js/scala-js/pull/780)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val DefaultData: Data

    An arbitrary initial seed for the TestRandom.

  5. val any: ZLayer[Random with TestRandom, Nothing, Random with TestRandom]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val clearBooleans: URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and clears the buffer of booleans.

  8. val clearBytes: URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and clears the buffer of bytes.

  9. val clearChars: URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and clears the buffer of characters.

  10. val clearDoubles: URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and clears the buffer of doubles.

  11. val clearFloats: URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and clears the buffer of floats.

  12. val clearInts: URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and clears the buffer of integers.

  13. val clearLongs: URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and clears the buffer of longs.

  14. val clearStrings: URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and clears the buffer of strings.

  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. val deterministic: Layer[Nothing, Random with TestRandom]
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. def feedBooleans(booleans: Boolean*): URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and feeds the buffer with the specified sequence of booleans.

  20. def feedBytes(bytes: Chunk[Byte]*): URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and feeds the buffer with the specified sequence of chunks of bytes.

  21. def feedChars(chars: Char*): URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and feeds the buffer with the specified sequence of characters.

  22. def feedDoubles(doubles: Double*): URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and feeds the buffer with the specified sequence of doubles.

  23. def feedFloats(floats: Float*): URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and feeds the buffer with the specified sequence of floats.

  24. def feedInts(ints: Int*): URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and feeds the buffer with the specified sequence of integers.

  25. def feedLongs(longs: Long*): URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and feeds the buffer with the specified sequence of longs.

  26. def feedStrings(strings: String*): URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and feeds the buffer with the specified sequence of strings.

  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. val getSeed: URIO[TestRandom, Long]

    Accesses a TestRandom instance in the environment and gets the seed.

  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def make(data: Data): Layer[Nothing, Random with TestRandom]

    Constructs a new TestRandom with the specified initial state.

    Constructs a new TestRandom with the specified initial state. This can be useful for providing the required environment to an effect that requires a Random, such as with ZIO#provide.

  33. def makeTest(data: Data): UIO[Test]

    Constructs a new Test object that implements the TestRandom interface.

    Constructs a new Test object that implements the TestRandom interface. This can be useful for mixing in with implementations of other interfaces.

  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. val random: ZLayer[Clock, Nothing, Random with TestRandom]
  38. val save: ZIO[TestRandom, Nothing, UIO[Unit]]

    Accesses a TestRandom instance in the environment and saves the random state in an effect which, when run, will restore the TestRandom to the saved state.

  39. def setSeed(seed: => Long): URIO[TestRandom, Unit]

    Accesses a TestRandom instance in the environment and sets the seed to the specified value.

  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped