Class

munit

FunSuite

Related Doc: package munit

Permalink

abstract class FunSuite extends Suite with Assertions with FunFixtures with TestOptionsConversions with TestTransforms with SuiteTransforms with ValueTransforms

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

Instance Constructors

  1. new FunSuite()

    Permalink

Type Members

  1. final type AfterEach = GenericAfterEach[TestValue]

    Permalink
    Definition Classes
    Suite
  2. final type BeforeEach = GenericBeforeEach[TestValue]

    Permalink
    Definition Classes
    Suite
  3. abstract class Fixture[T] extends AnyRef

    Permalink

    Definition Classes
    Suite
  4. class FunFixture[T] extends AnyRef

    Permalink
    Definition Classes
    FunFixtures
  5. final class SuiteTransform extends (List[FunSuite.Test]) ⇒ List[FunSuite.Test]

    Permalink
    Definition Classes
    SuiteTransforms
  6. final type Test = GenericTest[TestValue]

    Permalink
    Definition Classes
    Suite
  7. final class TestTransform extends (FunSuite.Test) ⇒ FunSuite.Test

    Permalink
    Definition Classes
    TestTransforms
  8. final type TestValue = Future[Any]

    Permalink

    The value produced by test bodies.

    The value produced by test bodies.

    Definition Classes
    FunSuiteSuite
  9. final class ValueTransform extends (Any) ⇒ Option[Future[Any]]

    Permalink
    Definition Classes
    ValueTransforms

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object FunFixture

    Permalink
    Definition Classes
    FunFixtures
  5. def afterAll(): Unit

    Permalink

    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.

    Definition Classes
    Suite
  6. def afterEach(context: AfterEach): Unit

    Permalink

    Runs after each individual test case.

    Runs after each individual test case.

    Definition Classes
    Suite
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def assert(cond: ⇒ Boolean, clue: ⇒ Any = "assertion failed")(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assertions
  9. def assertEquals[A, B](obtained: A, expected: B, clue: ⇒ Any = "values are not the same")(implicit loc: Location, ev: <:<[B, A]): Unit

    Permalink

    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]
    Definition Classes
    Assertions
  10. def assertEqualsDouble(obtained: Double, expected: Double, delta: Double, clue: ⇒ Any = "values are not the same")(implicit loc: Location): Unit

    Permalink

    Asserts that two doubles are equal to within a positive delta.

    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.

    Definition Classes
    Assertions
  11. def assertEqualsFloat(obtained: Float, expected: Float, delta: Float, clue: ⇒ Any = "values are not the same")(implicit loc: Location): Unit

    Permalink

    Asserts that two floats are equal to within a positive delta.

    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.

    Definition Classes
    Assertions
  12. def assertNoDiff(obtained: String, expected: String, clue: ⇒ Any = "diff assertion failed")(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assertions
  13. def assertNotEquals[A, B](obtained: A, expected: B, clue: ⇒ Any = "values are the same")(implicit loc: Location, ev: =:=[A, B]): Unit

    Permalink
    Definition Classes
    Assertions
  14. def assume(cond: Boolean, clue: ⇒ Any = "assumption failed")(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assertions
  15. def beforeAll(): Unit

    Permalink

    Runs once before all test cases and before all suite-local fixtures are setup.

    Runs once before all test cases and before all suite-local fixtures are setup. An error in this method aborts the test suite.

    Definition Classes
    Suite
  16. def beforeEach(context: BeforeEach): Unit

    Permalink

    Runs before each individual test case.

    Runs before each individual test case. An error in this method aborts the test case.

    Definition Classes
    Suite
  17. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def clue[T](c: Clue[T]): T

    Permalink
    Definition Classes
    Assertions
  19. def clues(clue: Clue[_]*): Clues

    Permalink
    Definition Classes
    Assertions
  20. macro def compileErrors(code: String): String

    Permalink
    Definition Classes
    CompileErrorMacro
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  23. def fail(message: String, clues: Clues = new Clues(Nil))(implicit loc: Location): Nothing

    Permalink
    Definition Classes
    Assertions
  24. def fail(message: String, cause: Throwable)(implicit loc: Location): Nothing

    Permalink
    Definition Classes
    Assertions
  25. def failComparison(message: String, obtained: Any, expected: Any, clues: Clues = new Clues(Nil))(implicit loc: Location): Nothing

    Permalink
    Definition Classes
    Assertions
  26. def failSuite(message: String, clues: Clues = new Clues(Nil))(implicit loc: Location): Nothing

    Permalink
    Definition Classes
    Assertions
  27. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. def intercept[T <: Throwable](body: ⇒ Any)(implicit T: ClassTag[T], loc: Location): T

    Permalink
    Definition Classes
    Assertions
  31. def interceptMessage[T <: Throwable](expectedExceptionMessage: String)(body: ⇒ Any)(implicit T: ClassTag[T], loc: Location): T

    Permalink
    Definition Classes
    Assertions
  32. def isCI: Boolean

    Permalink
    Definition Classes
    SuiteTransforms
  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  34. def munitAnsiColors: Boolean

    Permalink
    Definition Classes
    Assertions
  35. def munitCaptureClues[T](thunk: ⇒ T): (T, Clues)

    Permalink
    Definition Classes
    Assertions
  36. def munitExecutionContext: ExecutionContext

    Permalink
    Definition Classes
    Suite
  37. final def munitFailTransform: TestTransform

    Permalink
    Definition Classes
    TestTransforms
  38. def munitFixtures: Seq[Fixture[_]]

    Permalink

    Functinonal fixtures that can be reused for individual test cases or entire suites.

    Functinonal fixtures that can be reused for individual test cases or entire suites.

    Definition Classes
    Suite
  39. def munitFlakyOK: Boolean

    Permalink
    Definition Classes
    TestTransforms
  40. final def munitFlakyTransform: TestTransform

    Permalink
    Definition Classes
    TestTransforms
  41. final def munitFutureTransform: ValueTransform

    Permalink
    Definition Classes
    ValueTransforms
  42. def munitIgnore: Boolean

    Permalink
    Definition Classes
    SuiteTransforms
  43. final def munitIgnoreSuiteTransform: SuiteTransform

    Permalink
    Definition Classes
    SuiteTransforms
  44. val munitLines: Lines

    Permalink
    Definition Classes
    Assertions
  45. final def munitOnlySuiteTransform: SuiteTransform

    Permalink
    Definition Classes
    SuiteTransforms
  46. def munitPrint(clue: ⇒ Any): String

    Permalink
    Definition Classes
    Assertions
  47. final def munitSuiteTransform(tests: List[Test]): List[Test]

    Permalink
    Definition Classes
    SuiteTransforms
  48. def munitSuiteTransforms: List[SuiteTransform]

    Permalink
    Definition Classes
    SuiteTransforms
  49. final def munitTestTransform(test: Test): Test

    Permalink
    Definition Classes
    TestTransforms
  50. def munitTestTransforms: List[TestTransform]

    Permalink
    Definition Classes
    TestTransforms
  51. def munitTests(): Seq[Test]

    Permalink

    The base class for all test suites

    The base class for all test suites

    Definition Classes
    FunSuiteSuite
  52. final val munitTestsBuffer: ListBuffer[Test]

    Permalink
  53. def munitTimeout: Duration

    Permalink
  54. final def munitValueTransform(testValue: ⇒ Any): Future[Any]

    Permalink
    Definition Classes
    ValueTransforms
  55. def munitValueTransforms: List[ValueTransform]

    Permalink
    Definition Classes
    ValueTransforms
  56. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  57. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  58. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  59. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  60. def test(options: TestOptions)(body: ⇒ Any)(implicit loc: Location): Unit

    Permalink
  61. def test(name: String)(body: ⇒ Any)(implicit loc: Location): Unit

    Permalink
  62. implicit def testOptionsFromString(name: String)(implicit loc: Location): TestOptions

    Permalink

    Implicitly create a TestOptions given a test name.

    Implicitly create a TestOptions given a test name. This allows writing test("name") { ... } even if test accepts a TestOptions

    Definition Classes
    TestOptionsConversions
  63. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  64. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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