azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve cover documentation page of kotlin.test library

Browse Source
This commit is contained in:
Ilya Gorbunov
2017-11-27 06:39:35 +03:00
parent cf076f3d25
commit 5e85f71e48
1 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/kotlin.test/Module.md
+22 -5
View File
@@ -2,9 +2,26 @@
## kotlin.test
kotlin.test provides a set of utility functions for performing assertions in tests, independently of the test framework
being used. The functions are defined as [top-level functions in the package](kotlin.test/index.html#functions).
`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] class. A basic [Asserter] implementation is provided out of the
box. The `kotlin-test-junit` module provides an implementation of [Asserter] on top of JUnit. Note that the class is not intended
to be used directly from tests.
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-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.