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 {
  suite("clock") {
    testM("time is non-zero") {
      assertM(nanoTime, isGreaterThan(0))
    }
  }
}
    Definition Classes
    zio
  • package mock

    The mock package contains testable versions of all the standard ZIO environment types through the MockClock, MockConsole, MockSystem, and MockRandom modules.

    The mock package contains testable versions of all the standard ZIO environment types through the MockClock, MockConsole, MockSystem, and MockRandom modules. See the documentation on the individual modules for more detail about using each of them.

    If you are using ZIO Test and extending DefaultRunnableSpec a MockEnvironment containing all of them will be automatically provided to each of your tests. Otherwise, the easiest way to use the mocking functionality in ZIO Test is by providing the MockEnvironment to your program.

    import zio.test.mock._

myProgram.provideManaged(mockEnvironmentManaged)

    Then all environmental effects, such as printing to the console or generating random numbers, will be implemented by the MockEnvironment and will be fully testable. When you do need to access the "live" environment, for example to print debugging information to the close, just use the live combinator along with the effect as your normally would.

    If you are only interested in one of the mocking modules for your application, you can also access them a la carte through the make method on each module. Each mock module requires some data on initialization. Default data is included for each as DefaultData.

    import zio.test.mock._

myProgram.provideM(MockConsole.make(MockConsole.DefaultData))

    Finally, you can create a Mock object that implements the mock interface directly using the makeMock method. This can be useful when you want to access some mocking functionality without using the environment type.

    import zio.test.mock._

for {
  mockRandom <- MockRandom.makeMock(MockRandom.DefaultData)
  n          <- mockRandom.nextInt
} yield n

    This can also be useful when you are creating a more complex environment to provide the implementation for mock services that you mix in.

    Definition Classes
    test
  • object MockSystem extends Serializable
    Definition Classes
    mock
  • Data
  • Mock
  • Service

case class Mock(systemState: Ref[Data]) extends Service[Any] with Product with Serializable

Linear Supertypes
Product, Equals, Service[Any], system.System.Service[Any], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Mock
  2. Product
  3. Equals
  4. Service
  5. Service
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Mock(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
    Mock → Service
  6. def clearProperty(prop: String): UIO[Unit]

    Clears the mapping of system properties.

    Clears the mapping of system properties.

    Definition Classes
    Mock → Service
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def env(variable: String): ZIO[Any, SecurityException, Option[String]]

    Returns the specified environment variable if it exists.

    Returns the specified environment variable if it exists.

    Definition Classes
    Mock → Service
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val lineSeparator: ZIO[Any, Nothing, String]

    Returns the system line separator.

    Returns the system line separator.

    Definition Classes
    Mock → Service
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. def property(prop: String): ZIO[Any, Throwable, Option[String]]

    Returns the specified system property if it exists.

    Returns the specified system property if it exists.

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

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

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

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

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

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

    Definition Classes
    Mock → Service
  21. def setLineSeparator(lineSep: String): UIO[Unit]

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

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

    Definition Classes
    Mock → Service
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. val systemState: Ref[Data]
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. 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[Any]

Inherited from system.System.Service[Any]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped