blob: c3e4efad834ff3232d7e744a55da67791b7aa9be [file] [log] [blame] [view] [edit]
# Module kotlin-test
## kotlin.test
The `kotlin.test` library provides [annotations](kotlin.test/index.html#annotations) to mark test functions and a set of [utility functions](kotlin.test/index.html#functions) for performing assertions in tests,
independently of the test framework being used.
The test framework is abstracted through the [Asserter][kotlin.test.Asserter] class.
A basic `Asserter` implementation is provided out of the box.
Note that the class is not intended to be used directly from tests,
use instead the top-level assertion functions which delegate to the `Asserter`.
The library consists of the modules:
- `kotlin-test-common` assertions for use in common code;
- `kotlin-test-annotations-common` test annotations for use in common code;
- `kotlin-test` a JVM implementation of assertions from `kotlin-test-common`;
- `kotlin-test-junit` provides an implementation of [Asserter] on top of JUnit
and maps the test annotations from `kotlin-test-annotations-common` to JUnit test annotations;
- `kotlin-test-junit5` provides an implementation of [Asserter] on top of JUnit 5
and maps the test annotations from `kotlin-test-annotations-common` to JUnit 5 test annotations;
- `kotlin-test-testng` provides an implementation of [Asserter] on top of TestNG
and maps the test annotations from `kotlin-test-annotations-common` to TestNG test annotations;
- `kotlin-test-js` a JS implementation of common test assertions and annotations
with the out-of-the-box support for [Jasmine](https://jasmine.github.io/), [Mocha](https://mochajs.org/),
and [Jest](https://facebook.github.io/jest/) testing frameworks, and an experimental way to plug in
a custom unit testing framework.
# Package kotlin.test
Annotations to mark test functions and top-level functions for performing assertions in tests.