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
  • package reflect
    Definition Classes
    test
  • AbstractRunnableSpec
  • Assertion
  • AssertionValue
  • BoolAlgebra
  • CheckVariants
  • DefaultRunnableSpec
  • DefaultTestReporter
  • DefaultTestRunner
  • ExecutionStrategy
  • FailureDetails
  • Gen
  • GenFailureDetails
  • GenZIO
  • RenderedResult
  • RunnableSpec
  • Sample
  • Sized
  • Spec
  • TestAnnotation
  • TestAnnotationMap
  • TestAspect
  • TestExecutor
  • TestFailure
  • TestLogger
  • TestPlatform
  • TestReporter
  • TestRunner
  • TestSuccess
  • TestTimeoutException
  • TimeoutVariants
  • ZSpecSyntax

object TestAspect extends TimeoutVariants

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

Type Members

  1. trait PerTest[+LowerR, -UpperR, +LowerE, -UpperE, +LowerS, -UpperS] extends TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]

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. def after[R0, E0](effect: ZIO[R0, E0, Any]): TestAspect[Nothing, R0, E0, Any, Nothing, Any]

    Constructs an aspect that runs the specified effect after every test.

  5. def around[R0, E0, S0](managed: ZManaged[R0, TestFailure[E0], (TestSuccess[S0]) => ZIO[R0, TestFailure[E0], TestSuccess[S0]]]): PerTest[Nothing, R0, E0, Any, S0, S0]

    Constructs an aspect that evaluates every test inside the context of the managed function.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def aspect[R0, E0, S0](f: (ZIO[R0, TestFailure[E0], TestSuccess[S0]]) => ZIO[R0, TestFailure[E0], TestSuccess[S0]]): TestAspect[R0, R0, E0, E0, S0, S0]

    Constucts a simple monomorphic aspect that only works with the specified environment and error type.

  8. def before[R0, E0, S0](effect: ZIO[R0, Nothing, Any]): TestAspect[Nothing, R0, E0, Any, S0, Any]

    Constructs an aspect that runs the specified effect before every test.

  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. val eventually: TestAspectPoly

    An aspect that retries a test until success, without limit.

  13. def executionStrategy(exec: ExecutionStrategy): TestAspectPoly

    An aspect that sets suites to the specified execution strategy, but only if their current strategy is inherited (undefined).

  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. val flaky: TestAspectPoly

    An aspect that retries a test until success, without limit, for use with flaky tests.

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. val identity: TestAspectPoly

    An aspect that returns the tests unchanged

  19. val ignore: TestAspectPoly

    An aspect that marks tests as ignored.

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def js[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS](that: TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]): TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]
  22. val jsOnly: TestAspectPoly

    An aspect that only runs tests on ScalaJS.

  23. def jvm[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS](that: TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]): TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]
  24. val jvmOnly: TestAspectPoly

    An aspect that only runs tests on the JVM.

  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def nonFlaky(n0: Int): TestAspectPoly

    An aspect that repeats the test a specified number of times, ensuring it is stable ("non-flaky").

    An aspect that repeats the test a specified number of times, ensuring it is stable ("non-flaky"). Stops at the first failure.

  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. val parallel: TestAspectPoly

    An aspect that executes the members of a suite in parallel.

  30. def parallelN(n: Int): TestAspectPoly

    An aspect that executes the members of a suite in parallel, up to the specified number of concurent fibers.

  31. def retry[R0, E0, S0](schedule: ZSchedule[R0, TestFailure[E0], S0]): TestAspect[Nothing, R0 with Live[Clock], Nothing, E0, Nothing, S0]

    An aspect that retries failed tests according to a schedule.

  32. val sequential: TestAspectPoly

    An aspect that executes the members of a suite sequentially.

  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def timeout(duration: Duration): TestAspect[Nothing, Live[Clock], Nothing, Any, Nothing, Any]

    An aspect that times out tests using the specified duration.

  35. def timeoutWarning(duration: Duration): TestAspect[Nothing, Live[Clock] with Live[Console], Nothing, Any, Nothing, Any]

    A test aspect that prints a warning to the console when a test takes longer than the specified duration.

    A test aspect that prints a warning to the console when a test takes longer than the specified duration.

    Definition Classes
    TimeoutVariants
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from TimeoutVariants

Inherited from AnyRef

Inherited from Any

Ungrouped