Packages

c

munit

CatsEffectSuite

abstract class CatsEffectSuite extends FunSuite with CatsEffectAssertions with CatsEffectFixtures with CatsEffectFunFixtures

Source
CatsEffectSuite.scala
Linear Supertypes
CatsEffectFunFixtures, CatsEffectFixtures, CatsEffectAssertions, FunSuite, BaseFunSuite, ValueTransforms, SuiteTransforms, TestTransforms, TestOptionsConversions, FunFixtures, Assertions, CompileErrorMacro, Suite, PlatformSuite, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CatsEffectSuite
  2. CatsEffectFunFixtures
  3. CatsEffectFixtures
  4. CatsEffectAssertions
  5. FunSuite
  6. BaseFunSuite
  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. All

Instance Constructors

  1. new CatsEffectSuite()

Type Members

  1. implicit class MUnitCatsAssertionsForIOBooleanOps extends AnyRef
    Definition Classes
    CatsEffectAssertions
  2. implicit class MUnitCatsAssertionsForIOOps[A] extends AnyRef
    Definition Classes
    CatsEffectAssertions
  3. implicit class MUnitCatsAssertionsForIOUnitOps extends AnyRef
    Definition Classes
    CatsEffectAssertions
  4. implicit class MUnitCatsAssertionsForSyncIOOps[A] extends AnyRef
    Definition Classes
    CatsEffectAssertions
  5. implicit class MUnitCatsAssertionsForSyncIOUnitOps extends AnyRef
    Definition Classes
    CatsEffectAssertions
  6. implicit class SyncIOFunFixtureOps[T] extends AnyRef
    Definition Classes
    CatsEffectFunFixtures
  7. final type AfterEach = munit.AfterEach
    Definition Classes
    Suite
  8. final type BeforeEach = munit.BeforeEach
    Definition Classes
    Suite
  9. final type Fixture[T] = munit.Fixture[T]
    Definition Classes
    Suite
  10. class FunFixture[T] extends AnyRef
    Definition Classes
    FunFixtures
  11. final class SuiteTransform extends (List[BaseFunSuite.Test]) ⇒ List[BaseFunSuite.Test]
    Definition Classes
    SuiteTransforms
  12. final type Test = munit.Test
    Definition Classes
    Suite
  13. final class TestTransform extends (BaseFunSuite.Test) ⇒ BaseFunSuite.Test
    Definition Classes
    TestTransforms
  14. final type TestValue = Future[Any]
    Definition Classes
    Suite
  15. final class ValueTransform extends (Any) ⇒ Option[Future[Any]]
    Definition Classes
    ValueTransforms

Value Members

  1. object ResourceSuiteLocalFixture
    Definition Classes
    CatsEffectFixtures
  2. object ResourceTestLocalFixture
    Definition Classes
    CatsEffectFixtures
  3. object ResourceFunFixture
    Definition Classes
    CatsEffectFunFixtures
  4. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def ##(): Int
    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def afterAll(): Unit
    Definition Classes
    Suite
  8. def afterEach(context: AfterEach): Unit
    Definition Classes
    Suite
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def assert(cond: ⇒ Boolean, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  11. def assertEquals[A, B](obtained: A, expected: B, clue: ⇒ Any)(implicit loc: Location, compare: Compare[A, B]): Unit
    Definition Classes
    Assertions
  12. def assertEqualsDouble(obtained: Double, expected: Double, delta: Double, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  13. def assertEqualsFloat(obtained: Float, expected: Float, delta: Float, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  14. def assertIO[A, B](obtained: IO[A], returns: B, clue: ⇒ Any = "values are not the same")(implicit loc: Location, ev: <:<[B, A]): IO[Unit]

    Asserts that an IO returns an expected value.

    Asserts that an IO returns an expected value.

    The "returns" value (second argument) must have the same type or be a subtype of the one "contained" inside the IO (first argument). For example:

    assertIO(IO(Option(1)), returns = Some(1)) // OK
assertIO(IO(Some(1)), returns = Option(1)) // Error: Option[Int] is not a subtype of Some[Int]

    The "clue" value can be used to give extra information about the failure in case the assertion fails.

    obtained

    the IO under testing

    returns

    the expected value

    clue

    a value that will be printed in case the assertions fails

    Definition Classes
    CatsEffectAssertions
  15. def assertIOBoolean(obtained: IO[Boolean], clue: ⇒ Any = "values are not the same")(implicit loc: Location): IO[Unit]

    Asserts that an IO[Boolean] returns true.

    Asserts that an IO[Boolean] returns true.

    For example:

    assertIOBoolean(IO(true))

    The "clue" value can be used to give extra information about the failure in case the assertion fails.

    obtained

    the IO[Boolean] under testing

    clue

    a value that will be printed in case the assertions fails

    Attributes
    protected
    Definition Classes
    CatsEffectAssertions
  16. def assertIO_(obtained: IO[Unit], clue: ⇒ Any = "value is not ()")(implicit loc: Location): IO[Unit]

    Asserts that an IO[Unit] returns the Unit value.

    Asserts that an IO[Unit] returns the Unit value.

    For example:

    assertIO_(IO.unit)

    The "clue" value can be used to give extra information about the failure in case the assertion fails.

    obtained

    the IO under testing

    clue

    a value that will be printed in case the assertions fails

    Attributes
    protected
    Definition Classes
    CatsEffectAssertions
  17. def assertNoDiff(obtained: String, expected: String, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  18. def assertNotEquals[A, B](obtained: A, expected: B, clue: ⇒ Any)(implicit loc: Location, compare: Compare[A, B]): Unit
    Definition Classes
    Assertions
  19. def assertSyncIO[A, B](obtained: SyncIO[A], returns: B, clue: ⇒ Any = "values are not the same")(implicit loc: Location, ev: <:<[B, A]): SyncIO[Unit]

    Asserts that a SyncIO returns an expected value.

    Asserts that a SyncIO returns an expected value.

    The "returns" value (second argument) must have the same type or be a subtype of the one "contained" inside the SyncIO (first argument). For example:

    assertSyncIO(SyncIO(Option(1)), returns = Some(1)) // OK
assertSyncIO(SyncIO(Some(1)), returns = Option(1)) // Error: Option[Int] is not a subtype of Some[Int]

    The "clue" value can be used to give extra information about the failure in case the assertion fails.

    obtained

    the SyncIO under testing

    returns

    the expected value

    clue

    a value that will be printed in case the assertions fails

    Definition Classes
    CatsEffectAssertions
  20. def assertSyncIO_(obtained: SyncIO[Unit], clue: ⇒ Any = "value is not ()")(implicit loc: Location): SyncIO[Unit]

    Asserts that a SyncIO[Unit] returns the Unit value.

    Asserts that a SyncIO[Unit] returns the Unit value.

    For example:

    assertSyncIO_(SyncIO.unit) // OK

    The "clue" value can be used to give extra information about the failure in case the assertion fails.

    obtained

    the SyncIO under testing

    clue

    a value that will be printed in case the assertions fails

    Attributes
    protected
    Definition Classes
    CatsEffectAssertions
  21. def assume(cond: Boolean, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  22. def beforeAll(): Unit
    Definition Classes
    Suite
  23. def beforeEach(context: BeforeEach): Unit
    Definition Classes
    Suite
  24. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. def clue[T](c: Clue[T]): T
    Definition Classes
    Assertions
  26. def clues(clue: Clue[_]*): Clues
    Definition Classes
    Assertions
  27. macro def compileErrors(code: String): String
    Definition Classes
    CompileErrorMacro
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  30. def fail(message: String, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  31. def fail(message: String, cause: Throwable)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  32. def failComparison(message: String, obtained: Any, expected: Any, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  33. def failSuite(message: String, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  34. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. def intercept[T <: Throwable](body: ⇒ Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  38. def interceptIO[T <: Throwable](io: IO[Any])(implicit T: ClassTag[T], loc: Location): IO[T]

    Intercepts a Throwable being thrown inside the provided IO.

    Intercepts a Throwable being thrown inside the provided IO.

    Definition Classes
    CatsEffectAssertions
    Example: 

    1. val io = IO.raiseError[Unit](MyException("BOOM!"))

interceptIO[MyException](io)

      or

      interceptIO[MyException] {
    IO.raiseError[Unit](MyException("BOOM!"))
}
  39. def interceptMessage[T <: Throwable](expectedExceptionMessage: String)(body: ⇒ Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  40. def interceptMessageIO[T <: Throwable](expectedExceptionMessage: String)(io: IO[Any])(implicit T: ClassTag[T], loc: Location): IO[T]

    Intercepts a Throwable with a certain message being thrown inside the provided IO.

    Intercepts a Throwable with a certain message being thrown inside the provided IO.

    Definition Classes
    CatsEffectAssertions
    Example: 

    1. val io = IO.raiseError[Unit](MyException("BOOM!"))

interceptIO[MyException]("BOOM!")(io)

      or

      interceptIO[MyException] {
    IO.raiseError[Unit](MyException("BOOM!"))
}
  41. def interceptMessageSyncIO[T <: Throwable](expectedExceptionMessage: String)(io: SyncIO[Any])(implicit T: ClassTag[T], loc: Location): SyncIO[T]

    Intercepts a Throwable with a certain message being thrown inside the provided SyncIO.

    Intercepts a Throwable with a certain message being thrown inside the provided SyncIO.

    Definition Classes
    CatsEffectAssertions
    Example: 

    1. val io = SyncIO.raiseError[Unit](MyException("BOOM!"))

interceptSyncIO[MyException]("BOOM!")(io)

      or

      interceptSyncIO[MyException] {
    SyncIO.raiseError[Unit](MyException("BOOM!"))
}
  42. def interceptSyncIO[T <: Throwable](io: SyncIO[Any])(implicit T: ClassTag[T], loc: Location): SyncIO[T]

    Intercepts a Throwable being thrown inside the provided SyncIO.

    Intercepts a Throwable being thrown inside the provided SyncIO.

    Definition Classes
    CatsEffectAssertions
    Example: 

    1. val io = SyncIO.raiseError[Unit](MyException("BOOM!"))

interceptSyncIO[MyException](io)

      or

      interceptSyncIO[MyException] {
    SyncIO.raiseError[Unit](MyException("BOOM!"))
}
  43. def isCI: Boolean
    Definition Classes
    SuiteTransforms
  44. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  45. def munitAnsiColors: Boolean
    Definition Classes
    Assertions
  46. def munitCaptureClues[T](thunk: ⇒ T): (T, Clues)
    Definition Classes
    Assertions
  47. implicit def munitExecutionContext: ExecutionContext
    Definition Classes
    CatsEffectSuite → Suite
  48. final def munitFailTransform: TestTransform
    Definition Classes
    TestTransforms
  49. def munitFixtures: Seq[AnyFixture[_]]
    Definition Classes
    Suite
  50. def munitFlakyOK: Boolean
    Definition Classes
    TestTransforms
  51. final def munitFlakyTransform: TestTransform
    Definition Classes
    TestTransforms
  52. final def munitFutureTransform: ValueTransform
    Definition Classes
    ValueTransforms
  53. implicit def munitIORuntime: IORuntime
  54. def munitIOTimeout: Duration

    The timeout for IO-based tests.

    The timeout for IO-based tests. When it expires it will gracefully cancel the fiber running the test and invoke any finalizers before ultimately failing the test.

    Note that the fiber may still hang while running finalizers or even be uncancelable. In this case the munitTimeout will take effect, with the caveat that the hanging fiber will be leaked.

  55. def munitIgnore: Boolean
    Definition Classes
    SuiteTransforms
  56. final def munitIgnoreSuiteTransform: SuiteTransform
    Definition Classes
    SuiteTransforms
  57. val munitLines: Lines
    Definition Classes
    Assertions
  58. final def munitOnlySuiteTransform: SuiteTransform
    Definition Classes
    SuiteTransforms
  59. def munitPrint(clue: ⇒ Any): String
    Definition Classes
    Assertions
  60. final def munitSuiteTransform(tests: List[Test]): List[Test]
    Definition Classes
    SuiteTransforms
  61. def munitSuiteTransforms: List[SuiteTransform]
    Definition Classes
    SuiteTransforms
  62. final def munitTestTransform(test: Test): Test
    Definition Classes
    TestTransforms
  63. def munitTestTransforms: List[TestTransform]
    Definition Classes
    TestTransforms
  64. def munitTests(): Seq[Test]
    Definition Classes
    BaseFunSuite → Suite
  65. final val munitTestsBuffer: ListBuffer[Test]
    Definition Classes
    BaseFunSuite
  66. def munitTimeout: Duration

    The overall timeout applicable to all tests in the suite, including those written in terms of Future or synchronous code.

    The overall timeout applicable to all tests in the suite, including those written in terms of Future or synchronous code. This is implemented by the MUnit framework itself.

    When this timeout expires, the suite will immediately fail the test and proceed without waiting for its cancelation or even attempting to cancel it. For that reason it is recommended to set this to a greater value than munitIOTimeout, which performs graceful cancelation of IO-based tests. The default grace period for cancelation is 1 second.

    Definition Classes
    CatsEffectSuite → BaseFunSuite
  67. final def munitValueTransform(testValue: ⇒ Any): Future[Any]
    Definition Classes
    ValueTransforms
  68. def munitValueTransforms: List[ValueTransform]
    Definition Classes
    CatsEffectSuite → ValueTransforms
  69. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  71. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  72. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  73. def test(options: TestOptions)(body: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    BaseFunSuite
  74. def test(name: String)(body: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    BaseFunSuite
  75. implicit def testOptionsFromString(name: String)(implicit loc: Location): TestOptions
    Definition Classes
    TestOptionsConversions
  76. def toString(): String
    Definition Classes
    AnyRef → Any
  77. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  78. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  79. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  80. object FunFixture
    Definition Classes
    FunFixtures

Deprecated Value Members

  1. object UnsafeResourceSuiteLocalDeferredFixture
    Definition Classes
    CatsEffectFixtures
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use ResourceSuiteLocalFixture

  2. object ResourceFixture
    Definition Classes
    CatsEffectFunFixtures
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use ResourceFunFixture

  3. def munitIoRuntime: IORuntime
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use munitIORuntime

Inherited from CatsEffectFunFixtures

Inherited from CatsEffectFixtures

Inherited from CatsEffectAssertions

Inherited from FunSuite

Inherited from BaseFunSuite

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