CatsEffectSuite
Type members
Inherited classlikes
- Value Params
- name
The name of this fixture, used for displaying an error message if
beforeAll()
orafterAll()
fail.
- Inherited from
- Suite
Inherited types
Value members
Concrete methods
Inherited methods
Runs once after all test cases and after all suite-local fixtures have been tear down.
Runs once after all test cases and after all suite-local fixtures have been tear down.
- Inherited from
- Suite
Asserts that two elements are equal using ==
equality.
Asserts that two elements are equal using ==
equality.
The "expected" value (second argument) must have the same type or be a subtype of the "obtained" value (first argument). For example:
assertEquals(Option(1), Some(1)) // OK
assertEquals(Some(1), Option(1)) // Error: Option[Int] is not a subtype of Some[Int]
Use assertEquals[Any, Any](a, b)
as an escape hatch to compare two
values of different types. For example:
val a: Either[List[String], Int] = Right(42)
val b: Either[String, Int] = Right(42)
assertEquals[Any, Any](a, b) // OK
assertEquals(a, b) // Error: Either[String, Int] is not a subtype of Either[List[String], Int]
- Inherited from
- Assertions
Asserts that two doubles are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Double.NaN, Double.NaN, *) passes.
Asserts that two doubles are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Double.NaN, Double.NaN, *) passes.
- Inherited from
- Assertions
Asserts that two floats are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Float.NaN, Float.NaN, *) passes.
Asserts that two floats are equal to within a positive delta. If the expected value is infinity then the delta value is ignored. NaNs are considered equal: assertEquals(Float.NaN, Float.NaN, *) passes.
- Inherited from
- Assertions
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.
- Value Params
- clue
a value that will be printed in case the assertions fails
- obtained
the IO under testing
- returns
the expected value
- Inherited from
- CatsEffectAssertions
- Inherited from
- Assertions
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.
- Value Params
- clue
a value that will be printed in case the assertions fails
- obtained
the SyncIO under testing
- returns
the expected value
- Inherited from
- CatsEffectAssertions
Runs once before all test cases and before all suite-local fixtures are setup. An error in this method aborts the test suite.
Runs once before all test cases and before all suite-local fixtures are setup. An error in this method aborts the test suite.
- Inherited from
- Suite
Runs before each individual test case. An error in this method aborts the test case.
Runs before each individual test case. An error in this method aborts the test case.
- Inherited from
- Suite
- Inherited from
- Assertions
Intercepts a Throwable
being thrown inside the provided IO
.
Intercepts a Throwable
being thrown inside the provided IO
.
- Example
val io = IO.raiseError[Unit](MyException("BOOM!")) interceptIO[MyException](io)
or
interceptIO[MyException] { IO.raiseError[Unit](MyException("BOOM!")) }
- Inherited from
- CatsEffectAssertions
- Inherited from
- Assertions
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
.
- Example
val io = IO.raiseError[Unit](MyException("BOOM!")) interceptIO[MyException]("BOOM!")(io)
or
interceptIO[MyException] { IO.raiseError[Unit](MyException("BOOM!")) }
- Inherited from
- CatsEffectAssertions
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
.
- Example
val io = SyncIO.raiseError[Unit](MyException("BOOM!")) interceptSyncIO[MyException]("BOOM!")(io)
or
interceptSyncIO[MyException] { SyncIO.raiseError[Unit](MyException("BOOM!")) }
- Inherited from
- CatsEffectAssertions
Intercepts a Throwable
being thrown inside the provided SyncIO
.
Intercepts a Throwable
being thrown inside the provided SyncIO
.
- Example
val io = SyncIO.raiseError[Unit](MyException("BOOM!")) interceptSyncIO[MyException](io)
or
interceptSyncIO[MyException] { SyncIO.raiseError[Unit](MyException("BOOM!")) }
- Inherited from
- CatsEffectAssertions