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.test.environment.Live
import zio.clock.nanoTime
import Assertion.isGreaterThan

object MyTest extends DefaultRunnableSpec {
  def spec = suite("clock")(
    testM("time is non-zero") {
      assertM(Live.live(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 TestSystem extends Serializable

    TestSystem supports deterministic testing of effects involving system properties.

    TestSystem supports deterministic testing of effects involving system properties. Internally, TestSystem maintains mappings of environment variables and system properties that can be set and accessed. No actual environment variables or system properties will be accessed or set as a result of these actions.

    import zio.system
import zio.test.environment.TestSystem

for {
  _      <- TestSystem.putProperty("java.vm.name", "VM")
  result <- system.property("java.vm.name")
} yield result == Some("VM")
    Definition Classes
    environment
  • Data
  • Service
  • Test

final case class Test(systemState: Ref[Data]) extends system.System.Service with Service with Product with Serializable

Linear Supertypes
Product, Equals, Service, Restorable, system.System.Service, Serializable, 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. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Test(systemState: Ref[Data])

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. def clearEnv(variable: String): UIO[Unit]

    Clears the mapping of environment variables.

    Clears the mapping of environment variables.

    Definition Classes
    Test → Service
  6. def clearProperty(prop: String): UIO[Unit]

    Clears the mapping of system properties.

    Clears the mapping of system properties.

    Definition Classes
    Test → Service
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def env(variable: String): IO[SecurityException, Option[String]]

    Returns the specified environment variable if it exists.

    Returns the specified environment variable if it exists.

    Definition Classes
    Test → Service
  9. def envOrElse(variable: String, alt: ⇒ String): IO[SecurityException, String]

    Returns the specified environment variable if it exists or else the specified fallback value.

    Returns the specified environment variable if it exists or else the specified fallback value.

    Definition Classes
    Test → Service
  10. def envOrOption(variable: String, alt: ⇒ Option[String]): IO[SecurityException, Option[String]]

    Returns the specified environment variable if it exists or else the specified optional fallback value.

    Returns the specified environment variable if it exists or else the specified optional fallback value.

    Definition Classes
    Test → Service
  11. val envs: ZIO[Any, SecurityException, Map[String, String]]
    Definition Classes
    Test → Service
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val lineSeparator: UIO[String]

    Returns the system line separator.

    Returns the system line separator.

    Definition Classes
    Test → Service
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. val properties: ZIO[Any, Throwable, Map[String, String]]
    Definition Classes
    Test → Service
  21. def property(prop: String): IO[Throwable, Option[String]]

    Returns the specified system property if it exists.

    Returns the specified system property if it exists.

    Definition Classes
    Test → Service
  22. def propertyOrElse(prop: String, alt: ⇒ String): IO[Throwable, String]

    Returns the specified system property if it exists or else the specified fallback value.

    Returns the specified system property if it exists or else the specified fallback value.

    Definition Classes
    Test → Service
  23. def propertyOrOption(prop: String, alt: ⇒ Option[String]): IO[Throwable, Option[String]]

    Returns the specified system property if it exists or else the specified optional fallback value.

    Returns the specified system property if it exists or else the specified optional fallback value.

    Definition Classes
    Test → Service
  24. def putEnv(name: String, value: String): UIO[Unit]

    Adds the specified name and value to the mapping of environment variables maintained by this TestSystem.

    Adds the specified name and value to the mapping of environment variables maintained by this TestSystem.

    Definition Classes
    Test → Service
  25. def putProperty(name: String, value: String): UIO[Unit]

    Adds the specified name and value to the mapping of system properties maintained by this TestSystem.

    Adds the specified name and value to the mapping of system properties maintained by this TestSystem.

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

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

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

    Definition Classes
    Test → Restorable
  27. def setLineSeparator(lineSep: String): UIO[Unit]

    Sets the system line separator maintained by this TestSystem to the specified value.

    Sets the system line separator maintained by this TestSystem to the specified value.

    Definition Classes
    Test → Service
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. val systemState: Ref[Data]
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Product

Inherited from Equals

Inherited from Service

Inherited from Restorable

Inherited from system.System.Service

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped