Packages

c

munit

ZSuite

abstract class ZSuite extends FunSuite with ZAssertions with ZFixtures with ZFixtureSyntax with ZRuntime

Linear Supertypes
ZRuntime, ZFixtureSyntax, ZFixtures, ZAssertions, FunSuite, ValueTransforms, SuiteTransforms, TestTransforms, TestOptionsConversions, FunFixtures, Assertions, CompileErrorMacro, Suite, PlatformSuite, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZSuite
  2. ZRuntime
  3. ZFixtureSyntax
  4. ZFixtures
  5. ZAssertions
  6. FunSuite
  7. ValueTransforms
  8. SuiteTransforms
  9. TestTransforms
  10. TestOptionsConversions
  11. FunFixtures
  12. Assertions
  13. CompileErrorMacro
  14. Suite
  15. PlatformSuite
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ZSuite()

Type Members

  1. implicit class InterceptSyntax[R, E <: Throwable] extends AnyRef
    Definition Classes
    ZAssertions
  2. implicit class FixtureSyntax[T] extends AnyRef
    Definition Classes
    ZFixtureSyntax
  3. implicit class LayerFixtureSyntax[R] extends AnyRef
    Definition Classes
    ZFixtureSyntax
  4. final type AfterEach = GenericAfterEach[TestValue]
    Definition Classes
    Suite
  5. final type BeforeEach = GenericBeforeEach[TestValue]
    Definition Classes
    Suite
  6. abstract class Fixture[T] extends AnyRef
    Definition Classes
    Suite
  7. class FunFixture[T] extends AnyRef
    Definition Classes
    FunFixtures
  8. final class SuiteTransform extends (List[FunSuite.Test]) => List[FunSuite.Test]
    Definition Classes
    SuiteTransforms
  9. final type Test = GenericTest[TestValue]
    Definition Classes
    Suite
  10. final class TestTransform extends (FunSuite.Test) => FunSuite.Test
    Definition Classes
    TestTransforms
  11. final type TestValue = Future[Any]
    Definition Classes
    FunSuite → Suite
  12. final class ValueTransform extends (Any) => Option[Future[Any]]
    Definition Classes
    ValueTransforms
  13. class WrongTestMethodError extends Exception

Value Members

  1. object ZSuiteLocalFixture

    Suite local fixture from ZManaged.

    Suite local fixture from ZManaged.

    var state   = 0
val fixture = ZSuiteLocalFixture(
  "sample",
  ZManaged.make(ZIO.effectTotal { state += 1; state })(_ => ZIO.effectTotal { state -= 1 })
)

override val munitFixtures = Seq(fixture)

test("suite local fixture works") {
  assertEquals(fixture(), 1)
}
    Definition Classes
    ZFixtures
  2. object ZTestLocalFixture

    Test-local fixture.

    Test-local fixture.

    Can be created from raw setup/teardown effects or from ZManaged.

    val rawZIOFunFixture = ZTestLocalFixture(options => ZIO.succeed(s"acquired ${options.name}")) { str =>
  putStrLn(s"cleanup [$str]").provideLayer(Console.live)
}

val ZManagedFunFixture = ZTestLocalFixture { options =>
  ZManaged.make(ZIO.succeed(s"acquired ${options.name} with ZManaged")) { str =>
    putStrLn(s"cleanup [$str] with ZManaged").provideLayer(Console.live).orDie
  }
}

rawZIOFunFixture.test("allocate resource with ZIO FunFixture") { str =>
  assertNoDiff(str, "acquired allocate resource with ZIO FunFixture")
}

ZManagedFunFixture.test("allocate resource with ZManaged FunFixture") { str =>
  assertNoDiff(str, "acquired allocate resource with ZManaged FunFixture with ZManaged")
}
    Definition Classes
    ZFixtures
  3. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def afterAll(): Unit
    Definition Classes
    Suite
  7. def afterEach(context: AfterEach): Unit
    Definition Classes
    Suite
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def assert(cond: => Boolean, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  10. def assertEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, ev: <:<[B, A]): Unit
    Definition Classes
    Assertions
  11. def assertEqualsDouble(obtained: Double, expected: Double, delta: Double, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  12. def assertEqualsFloat(obtained: Float, expected: Float, delta: Float, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  13. final def assertEqualsZ[R, E, A, B](obtained: ZIO[R, E, A], expected: B, clue: => Any = "values are not the same")(implicit loc: Location, ev: <:<[B, A]): ZIO[R, E, Unit]

    Asserts that ZIO[R, E, A] returns the same result as expected

    Asserts that ZIO[R, E, A] returns the same result as expected

    testZ("strings are the same") {
  val effect = ZIO.succeed("string")
  assertEqualsZ(effect, "string", "different strings")
}
    obtained

    the effect to be tested

    expected

    expected result

    clue

    a value that will be printed in case the assertions fail

    Definition Classes
    ZAssertions
  14. def assertNoDiff(obtained: String, expected: String, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  15. final def assertNoDiffZ[R, E](obtained: ZIO[R, E, String], expected: String, clue: => Any = "diff assertion failed")(implicit loc: Location): ZIO[R, E, Unit]

    Asserts that ZIO[R, E, String] has no difference with expected string.

    Asserts that ZIO[R, E, String] has no difference with expected string. Pretty prints diff unlike just assertEqualsZ.

    testZ("strings are the same") {
  val effect = ZIO.succeed("string")
  assertNoDiffZ(effect, "string", "different strings")
}
    obtained

    the string effect to be tested

    expected

    expected string

    clue

    a value that will be printed in case the assertions fail

    Definition Classes
    ZAssertions
  16. def assertNotEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, ev: =:=[A, B]): Unit
    Definition Classes
    Assertions
  17. final def assertNotEqualsZ[R, E, A, B](obtained: ZIO[R, E, A], expected: B, clue: => Any = "values are not the same")(implicit loc: Location, ev: =:=[A, B]): ZIO[R, E, Unit]

    Asserts that ZIO[R, E, A] returns NOT the same result as expected

    Asserts that ZIO[R, E, A] returns NOT the same result as expected

    testZ("strings are the same") {
  val effect = ZIO.succeed("string")
  assertNotEqualsZ(effect, "another string", "same strings")
}
    obtained

    the effect to be tested

    expected

    expected result

    clue

    a value that will be printed in case the assertions fail

    Definition Classes
    ZAssertions
  18. final def assertZ[R, E](cond: ZIO[R, E, Boolean], clue: => Any = "assertion failed")(implicit loc: Location): ZIO[R, E, Unit]

    Asserts that ZIO[R, E, Boolean] returns true.

    Asserts that ZIO[R, E, Boolean] returns true.

    testZ("false OR true should be true") {
  val effect = ZIO.succeed(false || true)
  assertZ(effect, "boolean algebra check failed")
}
    cond

    the boolean effect to be tested

    clue

    a value that will be printed in case the assertions fail

    Definition Classes
    ZAssertions
  19. def assume(cond: Boolean, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  20. def beforeAll(): Unit
    Definition Classes
    Suite
  21. def beforeEach(context: BeforeEach): Unit
    Definition Classes
    Suite
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  23. def clue[T](c: Clue[T]): T
    Definition Classes
    Assertions
  24. def clues(clue: Clue[_]*): Clues
    Definition Classes
    Assertions
  25. macro def compileErrors(code: String): String
    Definition Classes
    CompileErrorMacro
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  28. def fail(message: String, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  29. def fail(message: String, cause: Throwable)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  30. def failComparison(message: String, obtained: Any, expected: Any, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  31. def failSuite(message: String, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  32. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. def intercept[T <: Throwable](body: => Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  36. def interceptMessage[T <: Throwable](expectedExceptionMessage: String)(body: => Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  37. def isCI: Boolean
    Definition Classes
    SuiteTransforms
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. def munitAnsiColors: Boolean
    Definition Classes
    Assertions
  40. def munitCaptureClues[T](thunk: => T): (T, Clues)
    Definition Classes
    Assertions
  41. def munitExecutionContext: ExecutionContext
    Definition Classes
    Suite
  42. final def munitFailTransform: TestTransform
    Definition Classes
    TestTransforms
  43. def munitFixtures: Seq[Fixture[_]]
    Definition Classes
    Suite
  44. def munitFlakyOK: Boolean
    Definition Classes
    TestTransforms
  45. final def munitFlakyTransform: TestTransform
    Definition Classes
    TestTransforms
  46. final def munitFutureTransform: ValueTransform
    Definition Classes
    ValueTransforms
  47. def munitIgnore: Boolean
    Definition Classes
    SuiteTransforms
  48. final def munitIgnoreSuiteTransform: SuiteTransform
    Definition Classes
    SuiteTransforms
  49. val munitLines: Lines
    Definition Classes
    Assertions
  50. final def munitOnlySuiteTransform: SuiteTransform
    Definition Classes
    SuiteTransforms
  51. def munitPrint(clue: => Any): String
    Definition Classes
    Assertions
  52. final def munitSuiteTransform(tests: List[Test]): List[Test]
    Definition Classes
    SuiteTransforms
  53. def munitSuiteTransforms: List[SuiteTransform]
    Definition Classes
    SuiteTransforms
  54. final def munitTestTransform(test: Test): Test
    Definition Classes
    TestTransforms
  55. def munitTestTransforms: List[TestTransform]
    Definition Classes
    TestTransforms
  56. def munitTests(): Seq[Test]
    Definition Classes
    FunSuite → Suite
  57. final val munitTestsBuffer: ListBuffer[Test]
    Definition Classes
    FunSuite
  58. def munitTimeout: Duration
    Definition Classes
    FunSuite
  59. final def munitValueTransform(testValue: => Any): Future[Any]
    Definition Classes
    ValueTransforms
  60. def munitValueTransforms: List[ValueTransform]
    Definition Classes
    ZSuite → ValueTransforms
  61. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  63. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  64. val runtime: Runtime[Any]
    Attributes
    protected
    Definition Classes
    ZRuntime
  65. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  66. def test(options: TestOptions)(body: => Any)(implicit loc: Location): Unit
    Definition Classes
    FunSuite
  67. def test(name: String)(body: => Any)(implicit loc: Location): Unit
    Definition Classes
    FunSuite
  68. implicit def testOptionsFromString(name: String)(implicit loc: Location): TestOptions
    Definition Classes
    TestOptionsConversions
  69. def testZ[E](options: TestOptions)(body: IO[E, Any])(implicit loc: Location): Unit
  70. def testZ[E](name: String)(body: IO[E, Any])(implicit loc: Location): Unit

    Runs test returning ZIO[Any, E, Any]

    Runs test returning ZIO[Any, E, Any]

    testZ("simple effect test") {
  val effect = for
    a <- ZIO(1)
    b <- ZIO(2)
  yield a + b

  assertEqualsZ(effect, 3)
}
    name

    test name

    body

    test body

  71. def toString(): String
    Definition Classes
    AnyRef → Any
  72. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  75. object FunFixture
    Definition Classes
    FunFixtures

Inherited from ZRuntime

Inherited from ZFixtureSyntax

Inherited from ZFixtures

Inherited from ZAssertions

Inherited from FunSuite

Inherited from ValueTransforms

Inherited from SuiteTransforms

Inherited from TestTransforms

Inherited from TestOptionsConversions

Inherited from FunFixtures

Inherited from Assertions

Inherited from CompileErrorMacro

Inherited from Suite

Inherited from PlatformSuite

Inherited from AnyRef

Inherited from Any

Ungrouped