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 TestConsole extends Serializable

    TestConsole provides a testable interface for programs interacting with the console by modeling input and output as reading from and writing to input and output buffers maintained by TestConsole and backed by a Ref.

    TestConsole provides a testable interface for programs interacting with the console by modeling input and output as reading from and writing to input and output buffers maintained by TestConsole and backed by a Ref.

    All calls to putStr and putStrLn using the TestConsole will write the string to the output buffer and all calls to getStrLn will take a string from the input buffer. To facilitate debugging, by default output will also be rendered to standard output. You can enable or disable this for a scope using debug, silent, or the corresponding test aspects.

    TestConsole has several methods to access and manipulate the content of these buffers including feedLines to feed strings to the input buffer that will then be returned by calls to getStrLn, output to get the content of the output buffer from calls to putStr and putStrLn, and clearInput and clearOutput to clear the respective buffers.

    Together, these functions make it easy to test programs interacting with the console.

    import zio.console._
import zio.test.environment.TestConsole
import zio.ZIO

val sayHello = for {
  name <- getStrLn
  _    <- putStrLn("Hello, " + name + "!")
} yield ()

for {
  _ <- TestConsole.feedLines("John", "Jane", "Sally")
  _ <- ZIO.collectAll(List.fill(3)(sayHello))
  result <- TestConsole.output
} yield result == Vector("Hello, John!\n", "Hello, Jane!\n", "Hello, Sally!\n")
    Definition Classes
    environment
  • Data
  • Service
  • Test

case class Test(consoleState: Ref[Data], live: Live.Service, debugState: FiberRef[Boolean]) extends console.Console.Service with Service with Product with Serializable

Linear Supertypes
Product, Equals, Service, Restorable, console.Console.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(consoleState: Ref[Data], live: Live.Service, debugState: FiberRef[Boolean])

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 clearInput: UIO[Unit]

    Clears the contents of the input buffer.

    Clears the contents of the input buffer.

    Definition Classes
    Test → Service
  6. val clearOutput: UIO[Unit]

    Clears the contents of the output buffer.

    Clears the contents of the output buffer.

    Definition Classes
    Test → Service
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val consoleState: Ref[Data]
  9. def debug[R, E, A](zio: ZIO[R, E, A]): ZIO[R, E, A]

    Runs the specified effect with the TestConsole set to debug mode, so that console output is rendered to standard output in addition to being written to the output buffer.

    Runs the specified effect with the TestConsole set to debug mode, so that console output is rendered to standard output in addition to being written to the output buffer.

    Definition Classes
    Test → Service
  10. val debugState: FiberRef[Boolean]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def feedLines(lines: String*): UIO[Unit]

    Writes the specified sequence of strings to the input buffer.

    Writes the specified sequence of strings to the input buffer. The first string in the sequence will be the first to be taken. These strings will be taken before any strings that were previously in the input buffer.

    Definition Classes
    Test → Service
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. val getStrLn: IO[IOException, String]

    Takes the first value from the input buffer, if one exists, or else fails with an EOFException.

    Takes the first value from the input buffer, if one exists, or else fails with an EOFException.

    Definition Classes
    Test → Service
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val live: Live.Service
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. val output: UIO[Vector[String]]

    Returns the contents of the output buffer.

    Returns the contents of the output buffer. The first value written to the output buffer will be the first in the sequence.

    Definition Classes
    Test → Service
  22. val outputErr: UIO[Vector[String]]

    Returns the contents of the error output buffer.

    Returns the contents of the error output buffer. The first value written to the error output buffer will be the first in the sequence.

    Definition Classes
    Test → Service
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. def putStr(line: String): UIO[Unit]

    Writes the specified string to the output buffer.

    Writes the specified string to the output buffer.

    Definition Classes
    Test → Service
  25. def putStrErr(line: String): UIO[Unit]

    Writes the specified string to the error buffer.

    Writes the specified string to the error buffer.

    Definition Classes
    Test → Service
  26. def putStrLn(line: String): UIO[Unit]

    Writes the specified string to the output buffer followed by a newline character.

    Writes the specified string to the output buffer followed by a newline character.

    Definition Classes
    Test → Service
  27. def putStrLnErr(line: String): UIO[Unit]

    Writes the specified string to the error buffer followed by a newline character.

    Writes the specified string to the error buffer followed by a newline character.

    Definition Classes
    Test → Service
  28. val save: UIO[UIO[Unit]]

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

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

    Definition Classes
    Test → Restorable
  29. def silent[R, E, A](zio: ZIO[R, E, A]): ZIO[R, E, A]

    Runs the specified effect with the TestConsole set to silent mode, so that console output is only written to the output buffer and not rendered to standard output.

    Runs the specified effect with the TestConsole set to silent mode, so that console output is only written to the output buffer and not rendered to standard output.

    Definition Classes
    Test → Service
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. 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 console.Console.Service

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped