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 Assertion

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

Type Members

  1. sealed trait Render extends AnyRef

    Render captures both the name of an assertion as well as the parameters to the assertion combinator for pretty-printing.

  2. sealed trait RenderParam extends AnyRef

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 val anything: Assertion[Any]

    Makes a new assertion that always succeeds.

  5. final def approximatelyEquals[A](reference: A, tolerance: A)(implicit arg0: Numeric[A]): Assertion[A]

    Makes a new assertion that requires a given numeric value to match a value with some tolerance.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def assertion[A](name: String)(params: RenderParam*)(run: (⇒ A) ⇒ Boolean): Assertion[A]

    Makes a new Assertion from a pretty-printing and a function.

  8. final def assertionDirect[A](name: String)(params: RenderParam*)(run: (⇒ A) ⇒ AssertResult): Assertion[A]

    Makes a new Assertion from a pretty-printing and a function.

  9. final def assertionRec[A, B](name: String)(params: RenderParam*)(assertion: Assertion[B])(get: (⇒ A) ⇒ Option[B], orElse: (AssertionValue) ⇒ AssertResult = BoolAlgebra.failure): Assertion[A]

    Makes a new Assertion[A] from a pretty-printing, a function (=> A) => Option[B], and an Assertion[B].

    Makes a new Assertion[A] from a pretty-printing, a function (=> A) => Option[B], and an Assertion[B]. If the result of applying the function to a given value is Some[B], the Assertion[B] will be applied to the resulting value to determine if the assertion is satisfied. The result of the Assertion[B] and any assertions it is composed from will be recursively embedded in the assert result. If the result of the function is None the orElse parameter will be used to determine whether the assertion is satisfied.

  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. final def contains[A](element: A): Assertion[Iterable[A]]

    Makes a new assertion that requires an iterable contain the specified element.

  12. final def containsCause[E](cause: Cause[E]): Assertion[Cause[E]]

    Makes a new assertion that requires a Cause contain the specified cause.

  13. final def containsString(element: String): Assertion[String]

    Makes a new assertion that requires a substring to be present.

  14. final def dies(assertion: Assertion[Throwable]): Assertion[Exit[Any, Any]]

    Makes a new assertion that requires an exit value to die.

  15. final def endsWith(suffix: String): Assertion[String]

    Makes a new assertion that requires a given string to end with the specified suffix.

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def equalTo(expected: Any): Assertion[Any]

    Makes a new assertion that requires a value equal the specified value.

  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. final def equalsIgnoreCase(other: String): Assertion[String]

    Makes a new assertion that requires a given string to equal another ignoring case

  20. final def exists[A](assertion: Assertion[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an iterable contain one element satisfying the given assertion.

  21. final def fails[E](assertion: Assertion[E]): Assertion[Exit[E, Any]]

    Makes a new assertion that requires an exit value to fail.

  22. final def failsCause[E](assertion: Assertion[Cause[E]]): Assertion[Exit[E, Any]]

    Makes a new assertion that requires an exit value to fail with a cause that meets the specified assertion.

  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def forall[A](assertion: Assertion[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an iterable contain only elements satisfying the given assertion.

  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. final def hasAt[A](pos: Int)(assertion: Assertion[A]): Assertion[Seq[A]]

    Makes a new assertion that requires a sequence to contain an element satisfying the given assertion on the given position

  27. final def hasField[A, B](name: String, proj: (A) ⇒ B, assertion: Assertion[B]): Assertion[A]

    Makes a new assertion that focuses in on a field in a case class.

    Makes a new assertion that focuses in on a field in a case class.

    hasField("age", _.age, within(0, 10))
  28. final def hasFirst[A](assertion: Assertion[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an iterable to contain the first element satisfying the given assertion

  29. final def hasLast[A](assertion: Assertion[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an iterable to contain the last element satisfying the given assertion

  30. final def hasMessage(message: String): Assertion[Throwable]

    Makes a new assertion that requires an exception to have a certain message.

  31. final def hasSameElements[A](other: Iterable[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an Iterable to have the same elements as the specified Iterable, though not necessarily in the same order

  32. final def hasSize[A](assertion: Assertion[Int]): Assertion[Iterable[A]]

    Makes a new assertion that requires the size of an iterable be satisfied by the specified assertion.

  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. final def isCase[Sum, Proj](termName: String, term: (Sum) ⇒ Option[Proj], assertion: Assertion[Proj]): Assertion[Sum]

    Makes a new assertion that requires the sum type be a specified term.

    Makes a new assertion that requires the sum type be a specified term.

    isCase("Some", Some.unapply, anything)
  35. final val isEmpty: Assertion[Iterable[Any]]

    Makes a new assertion that requires an Iterable to be empty.

  36. final val isEmptyString: Assertion[String]

    Makes a new assertion that requires a given string to be empty.

  37. final def isFalse: Assertion[Boolean]

    Makes a new assertion that requires a value be true.

  38. final def isGreaterThan[A](reference: A)(implicit arg0: Numeric[A]): Assertion[A]

    Makes a new assertion that requires the numeric value be greater than the specified reference value.

  39. final def isGreaterThanEqualTo[A](reference: A)(implicit arg0: Numeric[A]): Assertion[A]

    Makes a new assertion that requires the numeric value be greater than or equal to the specified reference value.

  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. final def isInterrupted: Assertion[Exit[Any, Any]]

    Makes a new assertion that requires an exit value to be interrupted.

  42. final def isLeft[A](assertion: Assertion[A]): Assertion[Either[A, Any]]

    Makes a new assertion that requires a Left value satisfying a specified assertion.

  43. final def isLessThan[A](reference: A)(implicit arg0: Numeric[A]): Assertion[A]

    Makes a new assertion that requires the numeric value be less than the specified reference value.

  44. final def isLessThanEqualTo[A](reference: A)(implicit arg0: Numeric[A]): Assertion[A]

    Makes a new assertion that requires the numeric value be less than or equal to the specified reference value.

  45. final val isNonEmpty: Assertion[Iterable[Any]]

    Makes a new assertion that requires an Iterable to be non empty.

  46. final val isNonEmptyString: Assertion[String]

    Makes a new assertion that requires a given string to be non empty

  47. final val isNone: Assertion[Option[Any]]

    Makes a new assertion that requires a None value.

  48. final def isRight[A](assertion: Assertion[A]): Assertion[Either[Any, A]]

    Makes a new assertion that requires a Right value satisfying a specified assertion.

  49. final def isSome[A](assertion: Assertion[A]): Assertion[Option[A]]

    Makes a new assertion that requires a Some value satisfying the specified assertion.

  50. final def isSubtype[A](assertion: Assertion[A])(implicit C: ClassTag[A]): Assertion[Any]

    Makes an assertion that requires a value have the specified type.

    Makes an assertion that requires a value have the specified type.

    Example:

    assert(Duration.fromNanos(1), isSubtype[Duration.Finite](Assertion.anything))
  51. final def isTrue: Assertion[Boolean]

    Makes a new assertion that requires a value be true.

  52. final def isUnit: Assertion[Any]

    Makes a new assertion that requires the value be unit.

  53. final def isWithin[A](min: A, max: A)(implicit arg0: Numeric[A]): Assertion[A]

    Returns a new assertion that requires a numeric value to fall within a specified min and max (inclusive).

  54. final def matchesRegex(regex: String): Assertion[String]

    Makes a new assertion that requires a given string to match the specified regular expression.

  55. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  56. final def not[A](assertion: Assertion[A]): Assertion[A]

    Makes a new assertion that negates the specified assertion.

  57. final val nothing: Assertion[Any]

    Makes a new assertion that always fails.

  58. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. final def startsWith(prefix: String): Assertion[String]

    Makes a new assertion that requires a given string to start with a specified prefix

  61. final def succeeds[A](assertion: Assertion[A]): Assertion[Exit[Any, A]]

    Makes a new assertion that requires an exit value to succeed.

  62. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  63. final def throws[A](assertion: Assertion[Throwable]): Assertion[A]

    Returns a new assertion that requires the expression to throw.

  64. final def throwsA[E](implicit arg0: ClassTag[E]): Assertion[Any]

    Returns a new assertion that requires the expression to throw an instance of given type (or its subtype).

  65. def toString(): String
    Definition Classes
    AnyRef → Any
  66. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  69. object Render
  70. object RenderParam

Inherited from AnyRef

Inherited from Any

Ungrouped