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
    
    object MyTest extends ZIOSpecDefault {
      def spec = suite("clock")(
        test("time is non-zero") {
          for {
            time <- Live.live(nanoTime)
          } yield assertTrue(time >= 0L)
        }
      )
    }
    Definition Classes
    zio
  • package scalacheck

    This package provides helpers to integrate *some* ScalaCheck primitives to their ZIO equivalents.

    This package provides helpers to integrate *some* ScalaCheck primitives to their ZIO equivalents. Currently available helpers:

    • Converting ScalaCheck Generators to ZIO Generators
    • Asserting a ScalaCheck Prop with ZIO
    • Asserting a ScalaCheck Properties with ZIO

    **Generators**

    This functionality converts legacy ScalaCheck generators to ZIO Test generators to support upgrading to ZIO Test without having to reimplement existing generators. To use it import this module and then call toGenZIO on any existing ScalaCheck generator. For example:

    import org.scalacheck.Arbitrary
    
    import zio._
    import zio.test._
    import zio.test.scalacheck._
    
    val anyInt: Gen[Any, Int] =
      Arbitrary.arbitrary[Int].toGenZIO

    **Asserting ScalaCheck Prop and Properties**

    This functionality generates ZIO Assertions from either ScalaCheck Prop or Properties. This helps with integrating other libraries that provide ScalaCheck properties as helpers, i.e. cats-laws.

    Prop example:

    import org.scalacheck.Prop
    import org.scalacheck.Test.{ Parameters => ScalaCheckParameters }
    
    import zio._
    import zio.test._
    import zio.test.scalacheck._
    
    val prop: Prop = Prop.forAll { (n: Int, m: Int) =>
      n + m == m + n
    }
    val resultDefault: TestResult = prop.assertZIO()
    
    val resultWithCustomizations: TestResult =
      prop.assertZIO("My Prop Name", ScalaCheckParameters.default.withMaxSize(10))

    Properties example:

    import org.scalacheck.{ Prop, Properties }
    import org.scalacheck.Test.{ Parameters => ScalaCheckParameters }
    
    import zio._
    import zio.test._
    import zio.test.scalacheck._
    
    object MyProperties extends Properties("MyProperties") {
      property("myProp") = Prop.forAll { (n: Int, m: Int) =>
        n + m == m + n
      }
    }
    
    * val resultDefault: TestResult = MyProperties.assertZIO()
    
    // Beware that we can't provide a custom name here, it will be
    // taken from the `Properties` name parameter
    val resultWithCustomizations: TestResult =
      MyProperties.assertZIO(ScalaCheckParameters.default.withMaxSize(10))
    Definition Classes
    test
  • ScalaCheckGenSyntax
  • ScalaCheckPropSyntax
  • ScalaCheckPropertiesSyntax
c

zio.test.scalacheck

ScalaCheckPropSyntax

implicit final class ScalaCheckPropSyntax extends AnyVal

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaCheckPropSyntax
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ScalaCheckPropSyntax(self: Prop)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def assertZIO(name: String = "ScalaCheck Prop Assertion", testParams: Parameters = CheckTest.Parameters.default): TestResult

    Asserts a ScalaCheck Prop and provides a ZIO TestResult.

  6. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  7. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  8. def toString(): String
    Definition Classes
    Any

Inherited from AnyVal

Inherited from Any

Ungrouped