Packages

c

munit

CatsEffectSuite

abstract class CatsEffectSuite extends FunSuite with CatsEffectAssertions

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

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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def afterAll(): Unit
    Definition Classes
    Suite
  5. def afterEach(context: AfterEach): Unit
    Definition Classes
    Suite
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def assert(cond: ⇒ Boolean, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  8. def assertEquals[A, B](obtained: A, expected: B, clue: ⇒ Any)(implicit loc: Location, ev: <:<[B, A]): Unit
    Definition Classes
    Assertions
  9. def assertEqualsDouble(obtained: Double, expected: Double, delta: Double, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  10. def assertEqualsFloat(obtained: Float, expected: Float, delta: Float, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  11. 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
  12. def assertNoDiff(obtained: String, expected: String, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  13. def assertNotEquals[A, B](obtained: A, expected: B, clue: ⇒ Any)(implicit loc: Location, ev: =:=[A, B]): Unit
    Definition Classes
    Assertions
  14. 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
  15. def assume(cond: Boolean, clue: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    Assertions
  16. def beforeAll(): Unit
    Definition Classes
    Suite
  17. def beforeEach(context: BeforeEach): Unit
    Definition Classes
    Suite
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. def clue[T](c: Clue[T]): T
    Definition Classes
    Assertions
  20. def clues(clue: Clue[_]*): Clues
    Definition Classes
    Assertions
  21. macro def compileErrors(code: String): String
    Definition Classes
    CompileErrorMacro
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  24. def fail(message: String, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  25. def fail(message: String, cause: Throwable)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  26. def failSuite(message: String, clues: Clues)(implicit loc: Location): Nothing
    Definition Classes
    Assertions
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def intercept[T <: Throwable](body: ⇒ Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  31. 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!"))
      }
  32. def interceptMessage[T <: Throwable](expectedExceptionMessage: String)(body: ⇒ Any)(implicit T: ClassTag[T], loc: Location): T
    Definition Classes
    Assertions
  33. 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!"))
      }
  34. 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!"))
      }
  35. 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!"))
      }
  36. implicit val ioRuntime: IORuntime
  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
    CatsEffectSuite → 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. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  65. def test(options: TestOptions)(body: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    FunSuite
  66. def test(name: String)(body: ⇒ Any)(implicit loc: Location): Unit
    Definition Classes
    FunSuite
  67. implicit def testOptionsFromString(name: String)(implicit loc: Location): TestOptions
    Definition Classes
    TestOptionsConversions
  68. def toString(): String
    Definition Classes
    AnyRef → Any
  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  72. object FunFixture
    Definition Classes
    FunFixtures

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