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
  • object TestRandom extends Serializable

    TestRandom allows for deterministically testing effects involving randomness.

    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.

    Definition Classes
    environment
  • Buffer
  • Data
  • Service
  • Test

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)

Linear Supertypes
Product, Equals, Service, Restorable, random.Random.Service, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Test
  2. Product
  3. Equals
  4. Service
  5. Restorable
  6. Service
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Test(randomState: Ref[Data], bufferState: Ref[Buffer])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val bufferState: Ref[Buffer]
  6. val clearBooleans: UIO[Unit]

    Clears the buffer of booleans.

    Clears the buffer of booleans.

    Definition Classes
    Test → Service
  7. val clearBytes: UIO[Unit]

    Clears the buffer of bytes.

    Clears the buffer of bytes.

    Definition Classes
    Test → Service
  8. val clearChars: UIO[Unit]

    Clears the buffer of characters.

    Clears the buffer of characters.

    Definition Classes
    Test → Service
  9. val clearDoubles: UIO[Unit]

    Clears the buffer of doubles.

    Clears the buffer of doubles.

    Definition Classes
    Test → Service
  10. val clearFloats: UIO[Unit]

    Clears the buffer of floats.

    Clears the buffer of floats.

    Definition Classes
    Test → Service
  11. val clearInts: UIO[Unit]

    Clears the buffer of integers.

    Clears the buffer of integers.

    Definition Classes
    Test → Service
  12. val clearLongs: UIO[Unit]

    Clears the buffer of longs.

    Clears the buffer of longs.

    Definition Classes
    Test → Service
  13. val clearStrings: UIO[Unit]

    Clears the buffer of strings.

    Clears the buffer of strings.

    Definition Classes
    Test → Service
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def feedBooleans(booleans: Boolean*): UIO[Unit]

    Feeds the buffer with specified sequence of booleans.

    Feeds the buffer with specified sequence of booleans. The first value in the sequence will be the first to be taken. These values will be taken before any values that were previously in the buffer.

    Definition Classes
    Test → Service
  17. def feedBytes(bytes: Chunk[Byte]*): UIO[Unit]

    Feeds the buffer with specified sequence of chunks of bytes.

    Feeds the buffer with specified sequence of chunks of bytes. The first value in the sequence will be the first to be taken. These values will be taken before any values that were previously in the buffer.

    Definition Classes
    Test → Service
  18. def feedChars(chars: Char*): UIO[Unit]

    Feeds the buffer with specified sequence of characters.

    Feeds the buffer with specified sequence of characters. The first value in the sequence will be the first to be taken. These values will be taken before any values that were previously in the buffer.

    Definition Classes
    Test → Service
  19. def feedDoubles(doubles: Double*): UIO[Unit]

    Feeds the buffer with specified sequence of doubles.

    Feeds the buffer with specified sequence of doubles. The first value in the sequence will be the first to be taken. These values will be taken before any values that were previously in the buffer.

    Definition Classes
    Test → Service
  20. def feedFloats(floats: Float*): UIO[Unit]

    Feeds the buffer with specified sequence of floats.

    Feeds the buffer with specified sequence of floats. The first value in the sequence will be the first to be taken. These values will be taken before any values that were previously in the buffer.

    Definition Classes
    Test → Service
  21. def feedInts(ints: Int*): UIO[Unit]

    Feeds the buffer with specified sequence of integers.

    Feeds the buffer with specified sequence of integers. The first value in the sequence will be the first to be taken. These values will be taken before any values that were previously in the buffer.

    Definition Classes
    Test → Service
  22. def feedLongs(longs: Long*): UIO[Unit]

    Feeds the buffer with specified sequence of longs.

    Feeds the buffer with specified sequence of longs. The first value in the sequence will be the first to be taken. These values will be taken before any values that were previously in the buffer.

    Definition Classes
    Test → Service
  23. def feedStrings(strings: String*): UIO[Unit]

    Feeds the buffer with specified sequence of strings.

    Feeds the buffer with specified sequence of strings. The first value in the sequence will be the first to be taken. These values will be taken before any values that were previously in the buffer.

    Definition Classes
    Test → Service
  24. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. val getSeed: UIO[Long]

    Gets the seed of this TestRandom.

    Gets the seed of this TestRandom.

    Definition Classes
    Test → Service
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. lazy val nextBoolean: UIO[Boolean]

    Takes a boolean from the buffer if one exists or else generates a pseudo-random boolean.

    Takes a boolean from the buffer if one exists or else generates a pseudo-random boolean.

    Definition Classes
    Test → Service
  30. def nextBytes(length: Int): UIO[Chunk[Byte]]

    Takes a chunk of bytes from the buffer if one exists or else generates a pseudo-random chunk of bytes of the specified length.

    Takes a chunk of bytes from the buffer if one exists or else generates a pseudo-random chunk of bytes of the specified length.

    Definition Classes
    Test → Service
  31. lazy val nextDouble: UIO[Double]

    Takes a double from the buffer if one exists or else generates a pseudo-random, uniformly distributed double between 0.0 and 1.0.

    Takes a double from the buffer if one exists or else generates a pseudo-random, uniformly distributed double between 0.0 and 1.0.

    Definition Classes
    Test → Service
  32. def nextDoubleBetween(minInclusive: Double, maxExclusive: Double): UIO[Double]

    Takes a double from the buffer if one exists or else generates a pseudo-random double in the specified range.

    Takes a double from the buffer if one exists or else generates a pseudo-random double in the specified range.

    Definition Classes
    Test → Service
  33. lazy val nextFloat: UIO[Float]

    Takes a float from the buffer if one exists or else generates a pseudo-random, uniformly distributed float between 0.0 and 1.0.

    Takes a float from the buffer if one exists or else generates a pseudo-random, uniformly distributed float between 0.0 and 1.0.

    Definition Classes
    Test → Service
  34. def nextFloatBetween(minInclusive: Float, maxExclusive: Float): UIO[Float]

    Takes a float from the buffer if one exists or else generates a pseudo-random float in the specified range.

    Takes a float from the buffer if one exists or else generates a pseudo-random float in the specified range.

    Definition Classes
    Test → Service
  35. lazy val nextGaussian: UIO[Double]

    Takes a double from the buffer if one exists or else generates a pseudo-random double from a normal distribution with mean 0.0 and standard deviation 1.0.

    Takes a double from the buffer if one exists or else generates a pseudo-random double from a normal distribution with mean 0.0 and standard deviation 1.0.

    Definition Classes
    Test → Service
  36. lazy val nextInt: UIO[Int]

    Takes an integer from the buffer if one exists or else generates a pseudo-random integer.

    Takes an integer from the buffer if one exists or else generates a pseudo-random integer.

    Definition Classes
    Test → Service
  37. def nextIntBetween(minInclusive: Int, maxExclusive: Int): UIO[Int]

    Takes an integer from the buffer if one exists or else generates a pseudo-random integer in the specified range.

    Takes an integer from the buffer if one exists or else generates a pseudo-random integer in the specified range.

    Definition Classes
    Test → Service
  38. def nextIntBounded(n: Int): UIO[Int]

    Takes an integer from the buffer if one exists or else generates a pseudo-random integer between 0 (inclusive) and the specified value (exclusive).

    Takes an integer from the buffer if one exists or else generates a pseudo-random integer between 0 (inclusive) and the specified value (exclusive).

    Definition Classes
    Test → Service
  39. lazy val nextLong: UIO[Long]

    Takes a long from the buffer if one exists or else generates a pseudo-random long.

    Takes a long from the buffer if one exists or else generates a pseudo-random long.

    Definition Classes
    Test → Service
  40. def nextLongBetween(minInclusive: Long, maxExclusive: Long): UIO[Long]

    Takes a long from the buffer if one exists or else generates a pseudo-random long in the specified range.

    Takes a long from the buffer if one exists or else generates a pseudo-random long in the specified range.

    Definition Classes
    Test → Service
  41. def nextLongBounded(n: Long): UIO[Long]

    Takes a long from the buffer if one exists or else generates a pseudo-random long between 0 (inclusive) and the specified value (exclusive).

    Takes a long from the buffer if one exists or else generates a pseudo-random long between 0 (inclusive) and the specified value (exclusive).

    Definition Classes
    Test → Service
  42. lazy val nextPrintableChar: UIO[Char]

    Takes a character from the buffer if one exists or else generates a pseudo-random character from the ASCII range 33-126.

    Takes a character from the buffer if one exists or else generates a pseudo-random character from the ASCII range 33-126.

    Definition Classes
    Test → Service
  43. def nextString(length: Int): UIO[String]

    Takes a string from the buffer if one exists or else generates a pseudo-random string of the specified length.

    Takes a string from the buffer if one exists or else generates a pseudo-random string of the specified length.

    Definition Classes
    Test → Service
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. def productElementNames: Iterator[String]
    Definition Classes
    Product
  47. val randomState: Ref[Data]
  48. val save: UIO[UIO[Unit]]

    Saves the TestRandom's current state in an effect which, when run, will restore the TestRandom state to the saved state.

    Saves the TestRandom's current state in an effect which, when run, will restore the TestRandom state to the saved state.

    Definition Classes
    Test → Restorable
  49. def setSeed(seed: Long): UIO[Unit]

    Sets the seed of this TestRandom to the specified value.

    Sets the seed of this TestRandom to the specified value.

    Definition Classes
    Test → Service → Service
  50. def shuffle[A, Collection[+Element] <: Iterable[Element]](list: Collection[A])(implicit bf: zio.BuildFrom[Collection[A], A, Collection[A]]): UIO[Collection[A]]

    Randomly shuffles the specified list.

    Randomly shuffles the specified list.

    Definition Classes
    Test → Service
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Product

Inherited from Equals

Inherited from Service

Inherited from Restorable

Inherited from random.Random.Service

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped