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 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 DefaultRunnableSpec 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.provideManaged(testEnvironmentManaged)

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

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](before: ZIO[R0, E0, Any], after: ZIO[R0, Nothing, Any]): PerTest[Nothing, R0, E0, Any, Nothing, Any]

    Constructs an aspect that evaluates every test inside the context of a Managed.

  6. def aroundTest[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.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. 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.

  9. 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.

  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def dotty[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS](that: TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]): TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]

    An aspect that applies the specified aspect on Dotty.

  12. val dottyOnly: TestAspectPoly

    An aspect that only runs tests on Dotty.

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. val eventually: TestAspectPoly

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

  16. val exceptDotty: TestAspectPoly

    An aspect that runs tests on all versions except Dotty.

  17. val exceptJS: TestAspectPoly

    An aspect that runs tests on all platforms except ScalaJS.

  18. val exceptJVM: TestAspectPoly

    An aspect that runs tests on all platforms except the JVM.

  19. val exceptScala2: TestAspectPoly

    An aspect that runs tests on all versions except Scala2.

  20. def executionStrategy(exec: ExecutionStrategy): TestAspectPoly

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

  21. def failure[E0](p: Assertion[TestFailure[E0]]): PerTest[Nothing, Any, Nothing, E0, Unit, Unit]

    An aspect that makes a test that failed for the specified failure pass.

    An aspect that makes a test that failed for the specified failure pass. Note that the test will fail for other failures and also if it passes correctly.

  22. val failure: PerTest[Nothing, Any, Nothing, Any, Unit, Unit]

    An aspect that makes a test that failed for any reason pass.

    An aspect that makes a test that failed for any reason pass. Note that if the test passes this aspect will make it fail.

  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def flaky(n: Int): TestAspectPoly

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

  25. val flaky: TestAspectPoly

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

  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. val identity: TestAspectPoly

    An aspect that returns the tests unchanged

  29. def ifEnv(env: String, assertion: Assertion[String]): TestAspect[Nothing, Live[System], Nothing, Any, Nothing, Any]

    An aspect that only runs a test if the specified environment variable satisfies the specified assertion.

  30. def ifEnvSet(env: String): TestAspect[Nothing, Live[System], Nothing, Any, Nothing, Any]

    As aspect that only runs a test if the specified environment variable is set.

  31. def ifProp(prop: String, assertion: Assertion[String]): TestAspect[Nothing, Live[System], Nothing, Any, Nothing, Any]

    An aspect that only runs a test if the specified Java property satisfies the specified assertion.

  32. def ifPropSet(prop: String): TestAspect[Nothing, Live[System], Nothing, Any, Nothing, Any]

    As aspect that only runs a test if the specified Java property is set.

  33. val ignore: TestAspectPoly

    An aspect that marks tests as ignored.

  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def js[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS](that: TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]): TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]

    An aspect that applies the specified aspect on ScalaJS.

  36. val jsOnly: TestAspectPoly

    An aspect that only runs tests on ScalaJS.

  37. def jvm[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS](that: TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]): TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]

    An aspect that applies the specified aspect on the JVM.

  38. val jvmOnly: TestAspectPoly

    An aspect that only runs tests on the JVM.

  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def nonFlaky(n: 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.

  41. val nonFlaky: TestAspectPoly

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

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

  42. def nonFlakyPar(n: Int): TestAspectPoly

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

    An aspect that runs the test a specified number of times in parallel, ensuring it is stable ("non-flaky"). Stops at the first failure. This can be useful for testing effects during periods of high contention.

  43. val nonFlakyPar: TestAspectPoly

    An aspect that runs the test a default number of times in parallel, ensuring it is stable ("non-flaky").

    An aspect that runs the test a default number of times in parallel, ensuring it is stable ("non-flaky"). Stops at the first failure. This can be useful for testing effects during periods of high contention.

  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. val parallel: TestAspectPoly

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

  47. def parallelN(n: Int): TestAspectPoly

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

  48. def retry[R0, E0, S0](schedule: Schedule[R0, TestFailure[E0], S0]): TestAspect[Nothing, R0, Nothing, E0, Nothing, Any]

    An aspect that retries failed tests according to a schedule.

  49. def scala2[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS](that: TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]): TestAspect[LowerR, UpperR, LowerE, UpperE, LowerS, UpperS]

    An aspect that applies the specified aspect on Scala 2.

  50. val scala2Only: TestAspectPoly

    An aspect that only runs tests on Scala 2.

  51. val sequential: TestAspectPoly

    An aspect that executes the members of a suite sequentially.

  52. val success: TestAspectPoly

    An aspect that converts ignored tests into test failures.

  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. def timeout(duration: Duration, interruptDuration: Duration = 1.second): TestAspect[Nothing, Live[Clock], Nothing, Any, Nothing, Any]

    An aspect that times out tests using the specified duration.

    An aspect that times out tests using the specified duration.

    duration

    maximum test duration

    interruptDuration

    after test timeout will wait given duration for successful interruption

  55. 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
  56. def toString(): String
    Definition Classes
    AnyRef → Any
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from TimeoutVariants

Inherited from AnyRef

Inherited from Any

Ungrouped