p

munit

package munit

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. munit
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package internal

Type Members

  1. class AfterEach extends Serializable
  2. abstract class AnyFixture[T] extends AnyRef

    AnyFixture allows you to acquire resources during setup and clean up resources after the tests finish running.

    AnyFixture allows you to acquire resources during setup and clean up resources after the tests finish running.

    Fixtures can be local to a single test case by overriding beforeEach and afterEach, or they can be re-used for an entire test suite by extending beforeAll and afterAll.

    It's preferable to use a sub-class like munit.Fixture or munit.FutureFixture instead of this class. Extend this class if you're writing an integration a third-party type like Cats Resource.

    See also

    https://scalameta.org/munit/docs/fixtures.html

  3. trait Assertions extends CompileErrorMacro
  4. trait BaseFunSuite extends Suite with Assertions with FunFixtures with TestOptionsConversions with TestTransforms with SuiteTransforms with ValueTransforms
  5. class BeforeEach extends Serializable
  6. class Clue[+T] extends Serializable
  7. class Clues extends AnyRef
  8. trait Compare[A, B] extends AnyRef

    A type-class that is used to compare values in MUnit assertions.

    A type-class that is used to compare values in MUnit assertions.

    By default, uses == and allows comparison between any two types as long they have a supertype/subtype relationship. For example:

    - Compare[T, T] OK - Compare[Some[Int], Option[Int]] OK, subtype - Compare[Option[Int], Some[Int]] OK, supertype - Compare[List[Int], collection.Seq[Int]] OK, subtype - Compare[List[Int], Vector[Int]] Error, requires upcast to Seq[Int]

    Annotations
    @implicitNotFound()
  9. trait ComparePriority1 extends ComparePriority2

    Allows comparison between A and B when A is a subtype of B

  10. trait ComparePriority2 extends AnyRef

    Allows comparison between A and B when B is a subtype of A.

    Allows comparison between A and B when B is a subtype of A.

    This implicit is defined separately from ComparePriority1 in order to avoid diverging implicit search when comparing equal types.

  11. class ComparisonFailException extends ComparisonFailure with FailExceptionLike[ComparisonFailException]

    The base exception for all comparison failures.

    The base exception for all comparison failures.

    This class exists so that it can extend org.junit.ComparisonFailure, which is recognised by IntelliJ so that users can optionally compare the obtained/expected values in a GUI diff explorer.

  12. class FailException extends AssertionError with FailExceptionLike[FailException]
  13. trait FailExceptionLike[T <: AssertionError] extends Serializable

    The base class for all MUnit FailExceptions.

    The base class for all MUnit FailExceptions.

    Implementation note: this class exists so that we could fix the issue https://youtrack.jetbrains.com/issue/SCL-18255 In order to support the JUnit comparison GUI in IntelliJ we need to extend org.junit.ComparisonFailure, which is a class and not an interface. We can't make munit.FailException extend org.junit.ComparisonFailure since not all "fail exceptions" are "comparison failures". Instead, we introduced munit.ComparisionFailException, which extends org.junit.ComparisonFailure and this base trait. Internally, MUnit should match against FailExceptionLike[_] instead of munit.FailException directly.

  14. class FailSuiteException extends FailException
  15. abstract class Fixture[T] extends AnyFixture[T]

    Fixture allows you to acquire resources during setup and clean up resources after the tests finish running.

    Fixture allows you to acquire resources during setup and clean up resources after the tests finish running.

    Fixtures can be local to a single test case by overriding beforeEach and afterEach, or they can be re-used for an entire test suite by extending beforeAll and afterAll.

    There is no functional difference between extending Fixture[T] or AnyFixture[T]. The only difference is that an IDE will auto-complete Unit in the result type instead of Any.

    See also

    https://scalameta.org/munit/docs/fixtures.html

  16. class Framework extends JUnitFramework
  17. trait FunFixtures extends AnyRef
  18. abstract class FunSuite extends Suite with BaseFunSuite
  19. abstract class FutureFixture[T] extends AnyFixture[T]

    FutureFixture allows you to acquire resources during setup and clean up resources after the tests finish running.

    FutureFixture allows you to acquire resources during setup and clean up resources after the tests finish running.

    Fixtures can be local to a single test case by overriding beforeEach and afterEach, or they can be re-used for an entire test suite by extending beforeAll and afterAll.

    There is no functional difference between extending FutureFixture[T] or AnyFixture[T]. The only difference is that an IDE will auto-complete Future[Unit] in the result type instead of Any.

    See also

    https://scalameta.org/munit/docs/fixtures.html

  20. class IgnoreSuite extends Annotation
  21. final class Location extends Annotation with Serializable
  22. class MUnitRunner extends Runner with Filterable with Configurable
  23. trait PlatformSuite extends AnyRef
    Annotations
    @EnableReflectiveInstantiation()
  24. trait Printable extends AnyRef

    Override this class to customize the default pretty-printer.

  25. trait Printer extends AnyRef

    Implement this trait to customize the default printer

  26. abstract class Suite extends PlatformSuite

    The base class for all test suites.

    The base class for all test suites. Extend this class if you don't need the functionality in FunSuite.

    Annotations
    @RunWith(cls = classOf[MUnitRunner])
  27. trait SuiteTransforms extends AnyRef
  28. class Tag extends munit.internal.junitinterface.Tag with Annotation with Serializable
  29. final class Test extends Serializable

    Metadata about a single test case.

  30. final class TestOptions extends Serializable

    Options used when running a test.

    Options used when running a test. It can be built implicitly from a String (@see munit.TestOptionsConversions)

  31. trait TestOptionsConversions extends AnyRef
  32. trait TestTransforms extends AnyRef
  33. trait ValueTransforms extends AnyRef

Deprecated Type Members

  1. type GenericAfterEach[T] = AfterEach
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use AfterEach instead

  2. type GenericBeforeEach[T] = BeforeEach
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use BeforeEach instead

  3. type GenericTest[T] = Test
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) use Test instead

Value Members

  1. val Fail: Tag
  2. val Flaky: Tag
  3. val Ignore: Tag
  4. val Only: Tag
  5. val Slow: Tag
  6. object Assertions extends Assertions
  7. object Clue extends ClueMacro with Serializable
  8. object Clues
  9. object Compare extends ComparePriority1
  10. object EmptyPrinter extends Printer

    Default printer that does not customize the pretty-printer

  11. object Exceptions
  12. object Location extends LocationMacro with Serializable
  13. object MUnitRunner
  14. object TestOptions extends TestOptionsConversions with Serializable
  15. object TestValues

    Values that have special treatment when evaluating values produced by tests.

Inherited from AnyRef

Inherited from Any

Ungrouped