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 {
      def spec = 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 RunnableSpec 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.provideLayer(testEnvironment)

    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 laws

    The laws package provides functionality for describing laws as values.

    The laws package provides functionality for describing laws as values. The fundamental abstraction is a set of ZLaws[Caps, R]. These laws model the laws that instances having a capability of type Caps are expected to satisfy. A capability Caps[_] is an abstraction describing some functionality that is common across different data types and obeys certain laws. For example, we can model the capability of two values of a type being compared for equality as follows:

    trait Equal[-A] {
      def equal(a1: A, a2: A): Boolean
    }

    Definitions of equality are expected to obey certain laws:

    1. Reflexivity - a1 === a1 2. Symmetry - a1 === a2 ==> a2 === a1 3. Transitivity - (a1 === a2) && (a2 === a3) ==> (a1 === a3)

    These laws define what the capabilities mean and ensure that it is safe to abstract across different instances with the same capability.

    Using ZIO Test, we can represent these laws as values. To do so, we define each law using one of the ZLaws constructors. For example:

    val transitivityLaw = ZLaws.Laws3[Equal]("transitivityLaw") {
      def apply[A: Equal](a1: A, a2: A, a3: A): TestResult =
        ???
    }

    We can then combine laws using the + operator:

    val reflexivityLaw: = ???
    val symmetryLaw:    = ???
    
    val equalLaws = reflexivityLaw + symmetryLaw + transitivityLaw

    Laws have a run method that takes a generator of values of type A and checks that those values satisfy the laws. In addition, objects can extend ZLawful to provide an even more convenient syntax for users to check that instances satisfy certain laws.

    object Equal extends Lawful[Equal]
    
    object Hash extends Lawful[Hash]
    
    object Ord extends Lawful[Ord]
    
    checkAllLaws(Equal + Hash + Ord)(Gen.anyInt)

    Note that capabilities compose seamlessly because of contravariance. We can combine laws describing different capabilities to construct a set of laws requiring that instances having all of the capabilities satisfy each of the laws.

    Definition Classes
    test
  • package mock
    Definition Classes
    test
  • package poly
    Definition Classes
    test
  • package reflect
    Definition Classes
    test
  • AbstractRunnableSpec
  • Annotations
  • Assertion
  • AssertionData
  • AssertionM
  • AssertionMData
  • AssertionValue
  • AssertionVariants
  • BoolAlgebra
  • BoolAlgebraM
  • CheckVariants
  • CompileVariants
  • DefaultRunnableSpec
  • DefaultTestReporter
  • Eql
  • ExecutedSpec
  • FailureDetails
  • FailureRenderer
  • FunctionVariants
  • Gen
  • GenFailureDetails
  • GenZIO
  • RenderedResult
  • RunnableSpec
  • Sample
  • Sized
  • Spec
  • Summary
  • SummaryBuilder
  • TestAnnotation
  • TestAnnotationMap
  • TestAnnotationRenderer
  • TestArgs
  • TestAspect
  • TestConfig
  • TestExecutor
  • TestFailure
  • TestLogger
  • TestPlatform
  • TestReporter
  • TestRunner
  • TestSuccess
  • TestTimeoutException
  • TestVersion
  • TimeVariants
  • TimeoutVariants
  • ZTest

object Assertion extends AssertionVariants

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

Type Members

  1. type Render = AssertionM.Render

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. val Render: AssertionM.Render.type
  5. val anything: Assertion[Any]

    Makes a new assertion that always succeeds.

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

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

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

  9. def assertionDirect[A](name: String)(params: RenderParam*)(run: (=> A) => AssertResult): Assertion[A]

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

  10. def assertionRec[A, B](name: String)(params: RenderParam*)(assertion: Assertion[B])(get: (=> A) => Option[B], orElse: (AssertionData) => AssertResult = _.asFailure): 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.

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

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

    Makes a new assertion that requires an Iterable contain the specified element. See Assertion.exists if you want to require an Iterable to contain an element satisfying an assertion.

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

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

  14. def containsString(element: String): Assertion[String]

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

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

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

  16. def endsWith[A](suffix: Seq[A]): Assertion[Seq[A]]

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

  17. def endsWithString(suffix: String): Assertion[String]

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

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def equalTo[A, B](expected: A)(implicit eql: Eql[A, B]): Assertion[B]

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

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

    Definition Classes
    AssertionVariants
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. def equalsIgnoreCase(other: String): Assertion[String]

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

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

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

    Makes a new assertion that requires an Iterable contain an element satisfying the given assertion. See Assertion.contains if you only need an Iterable to contain a given element.

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

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

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

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

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

  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. 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

  29. def hasAtLeastOneOf[A](other: Iterable[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an Iterable contain at least one of the specified elements.

  30. def hasAtMostOneOf[A](other: Iterable[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an Iterable contain at most one of the specified elements.

  31. 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))
  32. 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

  33. def hasIntersection[A](other: Iterable[A])(assertion: Assertion[Iterable[A]]): Assertion[Iterable[A]]

    Makes a new assertion that requires the intersection of two Iterables satisfy the given assertion

  34. def hasKey[K, V](key: K): Assertion[Map[K, V]]

    Makes a new assertion that requires a Map to have the specified key.

  35. def hasKey[K, V](key: K, assertion: Assertion[V]): Assertion[Map[K, V]]

    Makes a new assertion that requires a Map to have the specified key with value satisfying the specified assertion.

  36. def hasKeys[K, V](assertion: Assertion[Iterable[K]]): Assertion[Map[K, V]]

    Makes a new assertion that requires a Map have keys satisfying the specified assertion.

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

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

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

  39. def hasNoneOf[A](other: Iterable[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an Iterable contain none of the specified elements.

  40. def hasOneOf[A](other: Iterable[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an Iterable contain exactly one of the specified elements.

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

  42. def hasSameElementsDistinct[A](other: Iterable[A]): Assertion[Iterable[A]]

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

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

  44. def hasSizeString(assertion: Assertion[Int]): Assertion[String]

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

  45. def hasSubset[A](other: Iterable[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires the specified Iterable to be a subset of the other Iterable

  46. def hasThrowableCause(cause: Assertion[Throwable]): Assertion[Throwable]

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

  47. def hasValues[K, V](assertion: Assertion[Iterable[V]]): Assertion[Map[K, V]]

    Makes a new assertion that requires a Map have values satisfying the specified assertion.

  48. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  49. 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)
  50. val isDistinct: Assertion[Iterable[Any]]

    Makes a new assertion that requires an Iterable is distinct.

  51. val isEmpty: Assertion[Iterable[Any]]

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

  52. val isEmptyString: Assertion[String]

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

  53. def isFailure(assertion: Assertion[Throwable]): Assertion[Try[Any]]

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

  54. val isFailure: Assertion[Try[Any]]

    Makes a new assertion that requires a Try value is Failure.

  55. def isFalse: Assertion[Boolean]

    Makes a new assertion that requires a value be true.

  56. def isGreaterThan[A](reference: A)(implicit ord: Ordering[A]): Assertion[A]

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

  57. def isGreaterThanEqualTo[A](reference: A)(implicit ord: Ordering[A]): Assertion[A]

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

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

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

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

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

  61. val isLeft: Assertion[Either[Any, Any]]

    Makes a new assertion that requires an Either is Left.

  62. def isLessThan[A](reference: A)(implicit ord: Ordering[A]): Assertion[A]

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

  63. def isLessThanEqualTo[A](reference: A)(implicit ord: Ordering[A]): Assertion[A]

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

  64. def isNegative[A](implicit num: Numeric[A]): Assertion[A]

    Makes a new assertion that requires a numeric value is negative.

  65. val isNonEmpty: Assertion[Iterable[Any]]

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

  66. val isNonEmptyString: Assertion[String]

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

  67. val isNone: Assertion[Option[Any]]

    Makes a new assertion that requires a None value.

  68. val isNull: Assertion[Any]

    Makes a new assertion that requires a null value.

  69. def isOneOf[A](values: Iterable[A]): Assertion[A]

    Makes a new assertion that requires a value to be equal to one of the specified values.

  70. def isPositive[A](implicit num: Numeric[A]): Assertion[A]

    Makes a new assertion that requires a numeric value is positive.

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

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

  72. val isRight: Assertion[Either[Any, Any]]

    Makes a new assertion that requires an Either is Right.

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

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

  74. val isSome: Assertion[Option[Any]]

    Makes a new assertion that requires an Option is Some.

  75. def isSorted[A](implicit ord: Ordering[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an Iterable is sorted.

  76. def isSortedReverse[A](implicit ord: Ordering[A]): Assertion[Iterable[A]]

    Makes a new assertion that requires an Iterable is sorted in reverse order.

  77. 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))
  78. def isSuccess[A](assertion: Assertion[A]): Assertion[Try[A]]

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

  79. val isSuccess: Assertion[Try[Any]]

    Makes a new assertion that requires a Try value is Success.

  80. def isTrue: Assertion[Boolean]

    Makes a new assertion that requires a value be true.

  81. val isUnit: Assertion[Unit]

    Makes a new assertion that requires the value be unit.

  82. def isWithin[A](min: A, max: A)(implicit ord: Ordering[A]): Assertion[A]

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

  83. def isZero[A](implicit num: Numeric[A]): Assertion[A]

    Makes a new assertion that requires a numeric value is zero.

  84. def matchesRegex(regex: String): Assertion[String]

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

  85. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  86. def nonNegative[A](implicit num: Numeric[A]): Assertion[A]

    Makes a new assertion that requires a numeric value is non negative.

  87. def nonPositive[A](implicit num: Numeric[A]): Assertion[A]

    Makes a new assertion that requires a numeric value is non positive.

  88. def not[A](assertion: Assertion[A]): Assertion[A]

    Makes a new assertion that negates the specified assertion.

  89. val nothing: Assertion[Any]

    Makes a new assertion that always fails.

  90. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  91. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  92. def startsWith[A](prefix: Seq[A]): Assertion[Seq[A]]

    Makes a new assertion that requires a given sequence to start with the specified prefix.

  93. def startsWithString(prefix: String): Assertion[String]

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

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

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

  95. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  96. def throws[A](assertion: Assertion[Throwable]): Assertion[A]

    Returns a new assertion that requires the expression to throw.

  97. 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).

  98. def toString(): String
    Definition Classes
    AnyRef → Any
  99. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  100. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  101. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AssertionVariants

Inherited from AnyRef

Inherited from Any

Ungrouped