abstract class CatsEffectSuite extends FunSuite with CatsEffectSuitePlatform with CatsEffectAssertions with CatsEffectFixtures with CatsEffectFunFixtures

Source
CatsEffectSuite.scala
Linear Supertypes
CatsEffectFunFixtures, CatsEffectFixtures, CatsEffectFixturesPlatform, CatsEffectAssertions, CatsEffectSuitePlatform, FunSuite, 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. CatsEffectFixturesPlatform
  5. CatsEffectAssertions
  6. CatsEffectSuitePlatform
  7. FunSuite
  8. ValueTransforms
  9. SuiteTransforms
  10. TestTransforms
  11. TestOptionsConversions
  12. FunFixtures
  13. Assertions
  14. CompileErrorMacro
  15. Suite
  16. PlatformSuite
  17. AnyRef
  18. 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 = GenericAfterEach[TestValue]
    Definition Classes
    Suite
  8. final type BeforeEach = GenericBeforeEach[TestValue]
    Definition Classes
    Suite
  9. abstract class Fixture[T] extends AnyRef
    Definition Classes
    Suite
  10. class FunFixture[T] extends AnyRef
    Definition Classes
    FunFixtures
  11. final class SuiteTransform extends (List[FunSuite.Test]) ⇒ List[FunSuite.Test]
    Definition Classes
    SuiteTransforms
  12. final type Test = GenericTest[TestValue]
    Definition Classes
    Suite
  13. final class TestTransform extends (FunSuite.Test) ⇒ FunSuite.Test
    Definition Classes
    TestTransforms
  14. final type TestValue = Future[Any]
    Definition Classes
    FunSuite → Suite
  15. final class ValueTransform extends (Any) ⇒ Option[Future[Any]]
    Definition Classes
    ValueTransforms

Value Members

  1. object UnsafeResourceSuiteLocalDeferredFixture

    Similar to ResourceSuiteLocalFixture, but supported on both JVM and JS via several caveats.

    Similar to ResourceSuiteLocalFixture, but supported on both JVM and JS via several caveats. Instead of directly providing T provides a (memoized) IO[T] that is backed by a Deferred[T]. It is unsafe because on JS the resource is closed concurrently without backpressure, i.e. the suite will complete even while the resource has not closed yet. On JVM it is semantically equivalent to ResourceSuiteLocalFixture. Note also that constructing this fixture is impure because it unsafely allocates a Deferred.

    Definition Classes
    CatsEffectFixtures
  2. object ResourceSuiteLocalFixture
    Definition Classes
    CatsEffectFixturesPlatform
  3. object ResourceFixture
    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, ev: <:<[B, A]): 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, ev: =:=[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() @HotSpotIntrinsicCandidate()
  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. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. def intercept[T <: Throwable](body: ⇒ Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  37. 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!"))
}
  38. def interceptMessage[T <: Throwable](expectedExceptionMessage: String)(body: ⇒ Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  39. 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!"))
}
  40. 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!"))
}
  41. 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!"))
}
  42. def isCI: Boolean
    Definition Classes
    SuiteTransforms
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. def munitAnsiColors: Boolean
    Definition Classes
    Assertions
  45. def munitCaptureClues[T](thunk: ⇒ T): (T, Clues)
    Definition Classes
    Assertions
  46. implicit def munitContextShift: ContextShift[IO]
  47. def munitExecutionContext: ExecutionContext
    Definition Classes
    Suite
  48. final def munitFailTransform: TestTransform
    Definition Classes
    TestTransforms
  49. def munitFixtures: Seq[Fixture[_]]
    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. def munitIgnore: Boolean
    Definition Classes
    SuiteTransforms
  54. final def munitIgnoreSuiteTransform: SuiteTransform
    Definition Classes
    SuiteTransforms
  55. val munitLines: Lines
    Definition Classes
    Assertions
  56. final def munitOnlySuiteTransform: SuiteTransform
    Definition Classes
    SuiteTransforms
  57. def munitPrint(clue: ⇒ Any): String
    Definition Classes
    Assertions
  58. final def munitSuiteTransform(tests: List[Test]): List[Test]
    Definition Classes
    SuiteTransforms
  59. def munitSuiteTransforms: List[SuiteTransform]
    Definition Classes
    SuiteTransforms
  60. final def munitTestTransform(test: Test): Test
    Definition Classes
    TestTransforms
  61. def munitTestTransforms: List[TestTransform]
    Definition Classes
    TestTransforms
  62. def munitTests(): Seq[Test]
    Definition Classes
    FunSuite → Suite
  63. final val munitTestsBuffer: ListBuffer[Test]
    Definition Classes
    FunSuite
  64. def munitTimeout: Duration
    Definition Classes
    FunSuite
  65. implicit def munitTimer: Timer[IO]
  66. final def munitValueTransform(testValue: ⇒ Any): Future[Any]
    Definition Classes
    ValueTransforms
  67. def munitValueTransforms: List[ValueTransform]
    Definition Classes
    CatsEffectSuite → ValueTransforms
  68. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  69. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  70. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  71. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  72. def test(options: TestOptions)(body: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    FunSuite
  73. def test(name: String)(body: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    FunSuite
  74. implicit def testOptionsFromString(name: String)(implicit loc: Location): TestOptions
    Definition Classes
    TestOptionsConversions
  75. def toString(): String
    Definition Classes
    AnyRef → Any
  76. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  78. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  79. object FunFixture
    Definition Classes
    FunFixtures

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from CatsEffectFunFixtures

Inherited from CatsEffectFixtures

Inherited from CatsEffectFixturesPlatform

Inherited from CatsEffectAssertions

Inherited from CatsEffectSuitePlatform

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