Packages

c

munit

CatsEffectSuite

abstract class CatsEffectSuite extends FunSuite with CatsEffectAssertions with CatsEffectFunFixtures

Source
CatsEffectSuite.scala
Linear Supertypes
CatsEffectFunFixtures, CatsEffectAssertions, FunSuite, ValueTransforms, SuiteTransforms, TestTransforms, TestOptionsConversions, FunFixtures, Assertions, CompileErrorMacro, Suite, PlatformSuite, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CatsEffectSuite
  2. CatsEffectFunFixtures
  3. CatsEffectAssertions
  4. FunSuite
  5. ValueTransforms
  6. SuiteTransforms
  7. TestTransforms
  8. TestOptionsConversions
  9. FunFixtures
  10. Assertions
  11. CompileErrorMacro
  12. Suite
  13. PlatformSuite
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CatsEffectSuite()

Type Members

  1. implicit class MUnitCatsAssertionsForIOOps[A] extends AnyRef
    Definition Classes
    CatsEffectAssertions
  2. implicit class MUnitCatsAssertionsForSyncIOOps[A] extends AnyRef
    Definition Classes
    CatsEffectAssertions
  3. final type AfterEach = GenericAfterEach[TestValue]
    Definition Classes
    Suite
  4. final type BeforeEach = GenericBeforeEach[TestValue]
    Definition Classes
    Suite
  5. abstract class Fixture[T] extends AnyRef
    Definition Classes
    Suite
  6. class FunFixture[T] extends AnyRef
    Definition Classes
    FunFixtures
  7. final class SuiteTransform extends (List[FunSuite.Test]) => List[FunSuite.Test]
    Definition Classes
    SuiteTransforms
  8. final type Test = GenericTest[TestValue]
    Definition Classes
    Suite
  9. final class TestTransform extends (FunSuite.Test) => FunSuite.Test
    Definition Classes
    TestTransforms
  10. final type TestValue = Future[Any]
    Definition Classes
    FunSuite → Suite
  11. final class ValueTransform extends (Any) => Option[Future[Any]]
    Definition Classes
    ValueTransforms

Value Members

  1. object ResourceFixture
    Definition Classes
    CatsEffectFunFixtures
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def afterAll(): Unit
    Definition Classes
    Suite
  6. def afterEach(context: AfterEach): Unit
    Definition Classes
    Suite
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def assert(cond: => Boolean, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  9. def assertEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, ev: <:<[B, A]): Unit
    Definition Classes
    Assertions
  10. def assertEqualsDouble(obtained: Double, expected: Double, delta: Double, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  11. def assertEqualsFloat(obtained: Float, expected: Float, delta: Float, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  12. 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
  13. def assertNoDiff(obtained: String, expected: String, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  14. def assertNotEquals[A, B](obtained: A, expected: B, clue: => Any)(implicit loc: Location, ev: =:=[A, B]): Unit
    Definition Classes
    Assertions
  15. 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
  16. def assume(cond: Boolean, clue: => Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  17. def beforeAll(): Unit
    Definition Classes
    Suite
  18. def beforeEach(context: BeforeEach): Unit
    Definition Classes
    Suite
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  20. def clue[T](c: Clue[T]): T
    Definition Classes
    Assertions
  21. def clues(clue: Clue[_]*): Clues
    Definition Classes
    Assertions
  22. macro def compileErrors(code: String): String
    Definition Classes
    CompileErrorMacro
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. def fail(message: String, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  26. def fail(message: String, cause: Throwable)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  27. def failComparison(message: String, obtained: Any, expected: Any, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  28. def failSuite(message: String, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  29. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  30. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. def intercept[T <: Throwable](body: => Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  33. 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!"))
}
  34. def interceptMessage[T <: Throwable](expectedExceptionMessage: String)(body: => Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  35. 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!"))
}
  36. 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!"))
}
  37. 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!"))
}
  38. implicit val ioRuntime: IORuntime
  39. def isCI: Boolean
    Definition Classes
    SuiteTransforms
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def munitAnsiColors: Boolean
    Definition Classes
    Assertions
  42. def munitCaptureClues[T](thunk: => T): (T, Clues)
    Definition Classes
    Assertions
  43. def munitExecutionContext: ExecutionContext
    Definition Classes
    Suite
  44. final def munitFailTransform: TestTransform
    Definition Classes
    TestTransforms
  45. def munitFixtures: Seq[Fixture[_]]
    Definition Classes
    Suite
  46. def munitFlakyOK: Boolean
    Definition Classes
    TestTransforms
  47. final def munitFlakyTransform: TestTransform
    Definition Classes
    TestTransforms
  48. final def munitFutureTransform: ValueTransform
    Definition Classes
    ValueTransforms
  49. def munitIgnore: Boolean
    Definition Classes
    SuiteTransforms
  50. final def munitIgnoreSuiteTransform: SuiteTransform
    Definition Classes
    SuiteTransforms
  51. val munitLines: Lines
    Definition Classes
    Assertions
  52. final def munitOnlySuiteTransform: SuiteTransform
    Definition Classes
    SuiteTransforms
  53. def munitPrint(clue: => Any): String
    Definition Classes
    Assertions
  54. final def munitSuiteTransform(tests: List[Test]): List[Test]
    Definition Classes
    SuiteTransforms
  55. def munitSuiteTransforms: List[SuiteTransform]
    Definition Classes
    SuiteTransforms
  56. final def munitTestTransform(test: Test): Test
    Definition Classes
    TestTransforms
  57. def munitTestTransforms: List[TestTransform]
    Definition Classes
    TestTransforms
  58. def munitTests(): Seq[Test]
    Definition Classes
    FunSuite → Suite
  59. final val munitTestsBuffer: ListBuffer[Test]
    Definition Classes
    FunSuite
  60. def munitTimeout: Duration
    Definition Classes
    FunSuite
  61. final def munitValueTransform(testValue: => Any): Future[Any]
    Definition Classes
    ValueTransforms
  62. def munitValueTransforms: List[ValueTransform]
    Definition Classes
    CatsEffectSuite → ValueTransforms
  63. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  64. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  65. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  66. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  67. def test(options: TestOptions)(body: => Any)(implicit loc: Location): Unit
    Definition Classes
    FunSuite
  68. def test(name: String)(body: => Any)(implicit loc: Location): Unit
    Definition Classes
    FunSuite
  69. implicit def testOptionsFromString(name: String)(implicit loc: Location): TestOptions
    Definition Classes
    TestOptionsConversions
  70. def toString(): String
    Definition Classes
    AnyRef → Any
  71. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  72. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  73. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  74. object FunFixture
    Definition Classes
    FunFixtures

Inherited from CatsEffectFunFixtures

Inherited from CatsEffectAssertions

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