Object/Class

zio.test

TestAspect

Related Docs: class TestAspect | package test

Permalink

object TestAspect extends TimeoutVariants

Linear Supertypes
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. abstract class PerTest[+LowerR, -UpperR, +LowerE, -UpperE] extends TestAspect[LowerR, UpperR, LowerE, UpperE]

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object PerTest

    Permalink
  5. def after[R0, E0](effect: ZIO[R0, E0, Any]): TestAspect[Nothing, R0, E0, Any]

    Permalink

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

  6. def afterAll[R0](effect: ZIO[R0, Nothing, Any]): TestAspect[Nothing, R0, Nothing, Any]

    Permalink

    Constructs an aspect that runs the specified effect after all tests.

  7. def annotate[V](key: TestAnnotation[V], value: V): TestAspectPoly

    Permalink

    Annotates tests with the specified test annotation.

  8. def around[R0, E0, A0](before: ZIO[R0, E0, A0])(after: (A0) ⇒ ZIO[R0, Nothing, Any]): TestAspect[Nothing, R0, E0, Any]

    Permalink

    Constructs an aspect that evaluates every test between two effects, before and after, where the result of before can be used in after.

  9. def aroundAll[R0, E0, A0](before: ZIO[R0, E0, A0])(after: (A0) ⇒ ZIO[R0, Nothing, Any]): TestAspect[Nothing, R0, E0, Any]

    Permalink

    Constructs an aspect that evaluates all tests between two effects, before and after, where the result of before can be used in after.

  10. def aroundAll_[R0, E0](before: ZIO[R0, E0, Any], after: ZIO[R0, Nothing, Any]): TestAspect[Nothing, R0, E0, Any]

    Permalink

    A less powerful variant of aroundAll where the result of before is not required by after.

  11. def aroundTest[R0, E0](managed: ZManaged[R0, TestFailure[E0], (TestSuccess) ⇒ ZIO[R0, TestFailure[E0], TestSuccess]]): TestAspect[Nothing, R0, E0, Any]

    Permalink

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

  12. def around_[R0, E0](before: ZIO[R0, E0, Any], after: ZIO[R0, Nothing, Any]): TestAspect[Nothing, R0, E0, Any]

    Permalink

    A less powerful variant of around where the result of before is not required by after.

  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def aspect[R0, E0](f: (ZIO[R0, TestFailure[E0], TestSuccess]) ⇒ ZIO[R0, TestFailure[E0], TestSuccess]): TestAspect[R0, R0, E0, E0]

    Permalink

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

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

    Permalink

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

  16. def beforeAll[R0, E0](effect: ZIO[R0, E0, Any]): TestAspect[Nothing, R0, E0, Any]

    Permalink

    Constructs an aspect that runs the specified effect a single time before all tests.

  17. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. val debug: TestAspectAtLeastR[TestConsole]

    Permalink

    An aspect that runs each test with the TestConsole instance in the environment set to debug mode so that console output is rendered to standard output in addition to being written to the output buffer.

  19. def diagnose(duration: Duration): TestAspectAtLeastR[Live with Annotations]

    Permalink

    An aspect that runs each test on a separate fiber and prints a fiber dump if the test fails or has not terminated within the specified duration.

  20. def dotty[LowerR, UpperR, LowerE, UpperE](that: TestAspect[LowerR, UpperR, LowerE, UpperE]): TestAspect[LowerR, UpperR, LowerE, UpperE]

    Permalink

    An aspect that applies the specified aspect on Dotty.

  21. val dottyOnly: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that only runs tests on Dotty.

  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  24. val eventually: TestAspectAtLeastR[ZTestEnv]

    Permalink

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

  25. val exceptDotty: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that runs tests on all versions except Dotty.

  26. val exceptJS: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that runs tests on all platforms except ScalaJS.

  27. val exceptJVM: TestAspectAtLeastR[Annotations]

    Permalink

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

  28. val exceptNative: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that runs tests on all platforms except ScalaNative.

  29. val exceptScala2: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that runs tests on all versions except Scala 2.

  30. val exceptScala211: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that runs tests on all versions except Scala 2.11.

  31. val exceptScala212: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that runs tests on all versions except Scala 2.12.

  32. val exceptScala213: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that runs tests on all versions except Scala 2.13.

  33. def executionStrategy(exec: ExecutionStrategy): TestAspectPoly

    Permalink

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

  34. def failing[E0](assertion: Assertion[TestFailure[E0]]): TestAspect[Nothing, Any, Nothing, E0]

    Permalink

    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.

  35. val failing: TestAspectPoly

    Permalink

    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.

  36. lazy val fibers: TestAspect[Nothing, Annotations, Nothing, Any]

    Permalink

    An aspect that records the state of fibers spawned by the current test in TestAnnotation.fibers.

    An aspect that records the state of fibers spawned by the current test in TestAnnotation.fibers. Applied by default in DefaultRunnableSpec and MutableRunnableSpec but not in RunnableSpec. This aspect is required for the proper functioning of TestClock.adjust.

  37. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def flaky(n: Int): TestAspectAtLeastR[ZTestEnv with Annotations]

    Permalink

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

  39. val flaky: TestAspectAtLeastR[Annotations with TestConfig with ZTestEnv]

    Permalink

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

  40. val forked: TestAspectPoly

    Permalink

    An aspect that runs each test on its own separate fiber.

  41. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  42. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  43. val identity: TestAspectPoly

    Permalink

    An aspect that returns the tests unchanged

  44. def ifEnv(env: String, assertion: Assertion[String]): TestAspectAtLeastR[Live with Annotations]

    Permalink

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

  45. def ifEnvSet(env: String): TestAspectAtLeastR[Live with Annotations]

    Permalink

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

  46. def ifProp(prop: String, assertion: Assertion[String]): TestAspectAtLeastR[Live with Annotations]

    Permalink

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

  47. def ifPropSet(prop: String): TestAspectAtLeastR[Live with Annotations]

    Permalink

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

  48. val ignore: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that marks tests as ignored.

  49. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  50. def js[LowerR, UpperR, LowerE, UpperE](that: TestAspect[LowerR, UpperR, LowerE, UpperE]): TestAspect[LowerR, UpperR, LowerE, UpperE]

    Permalink

    An aspect that applies the specified aspect on ScalaJS.

  51. val jsOnly: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that only runs tests on ScalaJS.

  52. def jvm[LowerR, UpperR, LowerE, UpperE](that: TestAspect[LowerR, UpperR, LowerE, UpperE]): TestAspect[LowerR, UpperR, LowerE, UpperE]

    Permalink

    An aspect that applies the specified aspect on the JVM.

  53. val jvmOnly: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that only runs tests on the JVM.

  54. def native[LowerR, UpperR, LowerE, UpperE](that: TestAspect[LowerR, UpperR, LowerE, UpperE]): TestAspect[LowerR, UpperR, LowerE, UpperE]

    Permalink

    An aspect that applies the specified aspect on ScalaNative.

  55. val nativeOnly: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that only runs tests on ScalaNative.

  56. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  57. def nonFlaky(n: Int): TestAspectAtLeastR[ZTestEnv with Annotations]

    Permalink

    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.

  58. val nonFlaky: TestAspectAtLeastR[ZTestEnv with Annotations with TestConfig]

    Permalink

    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.

  59. def nonTermination(duration: Duration): TestAspectAtLeastR[Live]

    Permalink

    Constructs an aspect that requires a test to not terminate within the specified time.

  60. val nondeterministic: TestAspectAtLeastR[Live with TestRandom]

    Permalink

    Sets the seed of the TestRandom instance in the environment to a random value before each test.

  61. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  62. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  63. val parallel: TestAspectPoly

    Permalink

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

  64. def parallelN(n: Int): TestAspectPoly

    Permalink

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

  65. def repeat[R0 <: ZTestEnv with Annotations with Live](schedule: Schedule[R0, TestSuccess, Any]): TestAspectAtLeastR[R0]

    Permalink

    An aspect that repeats successful tests according to a schedule.

  66. def repeats(n: Int): TestAspectAtLeastR[TestConfig]

    Permalink

    An aspect that runs each test with the number of times to repeat tests to ensure they are stable set to the specified value.

  67. def restore[R0](service: (R0) ⇒ Restorable): TestAspectAtLeastR[R0]

    Permalink

    An aspect that restores a given Restorable's state to its starting state after the test is run.

    An aspect that restores a given Restorable's state to its starting state after the test is run. Note that this is only useful when repeating tests.

  68. def restoreTestClock: TestAspectAtLeastR[TestClock]

    Permalink

    An aspect that restores the TestClock's state to its starting state after the test is run.

    An aspect that restores the TestClock's state to its starting state after the test is run. Note that this is only useful when repeating tests.

  69. def restoreTestConsole: TestAspectAtLeastR[TestConsole]

    Permalink

    An aspect that restores the TestConsole's state to its starting state after the test is run.

    An aspect that restores the TestConsole's state to its starting state after the test is run. Note that this is only useful when repeating tests.

  70. def restoreTestEnvironment: TestAspectAtLeastR[ZTestEnv]

    Permalink

    An aspect that restores all state in the standard provided test environments (TestClock, TestConsole, TestRandom and TestSystem) to their starting state after the test is run.

    An aspect that restores all state in the standard provided test environments (TestClock, TestConsole, TestRandom and TestSystem) to their starting state after the test is run. Note that this is only useful when repeating tests.

  71. def restoreTestRandom: TestAspectAtLeastR[TestRandom]

    Permalink

    An aspect that restores the TestRandom's state to its starting state after the test is run.

    An aspect that restores the TestRandom's state to its starting state after the test is run. Note that this is only useful when repeating tests.

  72. def restoreTestSystem: TestAspectAtLeastR[ZTestEnv]

    Permalink

    An aspect that restores the TestSystem's state to its starting state after the test is run.

    An aspect that restores the TestSystem's state to its starting state after the test is run. Note that this is only useful when repeating tests.

  73. def retries(n: Int): TestAspectAtLeastR[TestConfig]

    Permalink

    An aspect that runs each test with the number of times to retry flaky tests set to the specified value.

  74. def retry[R0 <: ZTestEnv with Annotations with Live, E0](schedule: Schedule[R0, TestFailure[E0], Any]): TestAspect[Nothing, R0, Nothing, E0]

    Permalink

    An aspect that retries failed tests according to a schedule.

  75. def samples(n: Int): TestAspectAtLeastR[TestConfig]

    Permalink

    An aspect that runs each test with the number of sufficient samples to check for a random variable set to the specified value.

  76. def scala2[LowerR, UpperR, LowerE, UpperE](that: TestAspect[LowerR, UpperR, LowerE, UpperE]): TestAspect[LowerR, UpperR, LowerE, UpperE]

    Permalink

    An aspect that applies the specified aspect on Scala 2.

  77. def scala211[LowerR, UpperR, LowerE, UpperE](that: TestAspect[LowerR, UpperR, LowerE, UpperE]): TestAspect[LowerR, UpperR, LowerE, UpperE]

    Permalink

    An aspect that applies the specified aspect on Scala 2.11.

  78. val scala211Only: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that only runs tests on Scala 2.11.

  79. def scala212[LowerR, UpperR, LowerE, UpperE](that: TestAspect[LowerR, UpperR, LowerE, UpperE]): TestAspect[LowerR, UpperR, LowerE, UpperE]

    Permalink

    An aspect that applies the specified aspect on Scala 2.12.

  80. val scala212Only: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that only runs tests on Scala 2.12.

  81. def scala213[LowerR, UpperR, LowerE, UpperE](that: TestAspect[LowerR, UpperR, LowerE, UpperE]): TestAspect[LowerR, UpperR, LowerE, UpperE]

    Permalink

    An aspect that applies the specified aspect on Scala 2.13.

  82. val scala213Only: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that only runs tests on Scala 2.13.

  83. val scala2Only: TestAspectAtLeastR[Annotations]

    Permalink

    An aspect that only runs tests on Scala 2.

  84. val sequential: TestAspectPoly

    Permalink

    An aspect that executes the members of a suite sequentially.

  85. def setSeed(seed: ⇒ Long): TestAspectAtLeastR[TestRandom]

    Permalink

    Sets the seed of the TestRandom instance in the environment to the specified value before each test.

  86. def shrinks(n: Int): TestAspectAtLeastR[TestConfig]

    Permalink

    An aspect that runs each test with the maximum number of shrinkings to minimize large failures set to the specified value.

  87. val silent: TestAspectAtLeastR[TestConsole]

    Permalink

    An aspect that runs each test with the TestConsole instance in the environment set to silent mode so that console output is only written to the output buffer and not rendered to standard output.

  88. def sized(n: Int): TestAspectAtLeastR[Sized]

    Permalink

    An aspect that runs each test with the size set to the specified value.

  89. val success: TestAspectPoly

    Permalink

    An aspect that converts ignored tests into test failures.

  90. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  91. def tag(tag: String, tags: String*): TestAspectPoly

    Permalink

    Annotates tests with string tags.

  92. val timed: TestAspectAtLeastR[Live with Annotations]

    Permalink

    Annotates tests with their execution times.

  93. def timeout(duration: Duration): TestAspectAtLeastR[Live]

    Permalink

    An aspect that times out tests using the specified duration.

    An aspect that times out tests using the specified duration.

    duration

    maximum test duration

  94. def timeoutWarning(duration: Duration): TestAspect[Nothing, Live, Nothing, Any]

    Permalink

    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
  95. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  96. val untraced: TestAspectPoly

    Permalink
  97. def verify[R0, E0](condition: ⇒ ZIO[R0, E0, TestResult]): TestAspect[Nothing, R0, E0, Any]

    Permalink

    Verifies the specified post-condition after each test is run.

  98. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  99. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  100. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TimeoutVariants

Inherited from AnyRef

Inherited from Any

Ungrouped