Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kotlin/kotlinx-kover
https://github.com/Kotlin/kotlinx-kover
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Kotlin/kotlinx-kover
- Owner: Kotlin
- License: apache-2.0
- Created: 2021-08-10T08:10:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T10:33:30.000Z (4 months ago)
- Last Synced: 2024-10-29T15:40:13.627Z (4 months ago)
- Language: Kotlin
- Size: 2.01 MB
- Stars: 1,360
- Watchers: 21
- Forks: 53
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.TXT
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-github-repos - Kotlin/kotlinx-kover - (Kotlin)
README
# Kover
[](https://kotlinlang.org/docs/components-stability.html)
[](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
[](https://www.apache.org/licenses/LICENSE-2.0)
Kover is a set of solutions for collecting test coverage of Kotlin code compiled for JVM and Android platforms.
Kover Toolset:
- [Kover Gradle Plugin](#kover-gradle-plugin)
- [Kover Maven Plugin](#kover-maven-plugin)
- [Kover CLI](#kover-cli)
- [Kover offline instrumentation](#kover-offline-instrumentation)
- [Kover JVM agent](#kover-jvm-agent)
- [Kover features artifact](#kover-features-artifact)
## Kover Gradle Plugin
For full information about latest stable release of Kover Gradle Plugin, please refer to the [documentation](https://kotlin.github.io/kotlinx-kover/gradle-plugin).
### Features
* Collection of code coverage through `JVM` tests (JS and native targets are not supported yet).
* Generating `HTML` and `XML` reports.
* Support for `Kotlin JVM`, `Kotlin Multiplatform` projects.
* Support for `Kotlin Android` projects with build variants (instrumentation tests executing on the Android device are not supported yet).
* Support mixed `Kotlin` and `Java` sources
* Verification rules with bounds in the Gradle plugin to keep track of coverage.
* Using JaCoCo library in Gradle plugin as an alternative for coverage measuring and report generation.
The recommended way of applying Kover is with the
[plugins DSL](https://docs.gradle.org/current/userguide/plugins.html#sec:plugins_block).
Minimum supported version of `Gradle` is `6.8`.
Add the following to your top-level build file:
Kotlin
```kotlin
plugins {
id("org.jetbrains.kotlinx.kover") version "0.9.0-RC"
}
```
Groovy
```groovy
plugins {
id 'org.jetbrains.kotlinx.kover' version '0.9.0-RC'
}
```
After you applied Kover Gradle plugin, Kover tasks will be created for generating reports and verification.
E.g. to generate HTML report run `./gradlew koverHtmlReport` - this will automatically start code compilation, execution of instrumented tests, and an HTML report will be generated with measurement results in the build folder.
It is also important that after applying Kover Gradle plugin, during the running tests, the classes are modified (instrumented) when loaded into the JVM which may lead to some performance degradation, or affect concurrent tests.
### Legacy Plugin Application
[Legacy method](https://docs.gradle.org/current/userguide/plugins.html#sec:old_plugin_application) of applying plugins
can be used if you cannot use the plugins DSL for some reason.
Kotlin
```kotlin
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.9.0-RC")
}
}
apply(plugin = "org.jetbrains.kotlinx.kover")
```
Groovy
```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.jetbrains.kotlinx:kover-gradle-plugin:0.9.0-RC'
}
}
apply plugin: 'org.jetbrains.kotlinx.kover'
```
### To create report combining coverage info from different Gradle projects
You have to add dependency on the project, in which the report task will be run
```groovy
dependencies {
kover(project(":another:project"))
}
```
in this case report will be generated for current project joined with `:another:project` project.
**More examples of Gradle plugin applying can be found in [example folder](kover-gradle-plugin/examples)**
## Kover Aggregated Plugin
Kover Aggregated Plugin as a prototype of Gradle Settings plugin, created to simplify the setup of multi-project builds.
It is in its infancy, it is recommended to use it only for test or pet projects.
Refer to the [documentation](https://kotlin.github.io/kotlinx-kover/gradle-plugin/aggregated.html) for details.
## Kover Maven Plugin
The Kover Maven Plugin can be applied by specifying build plugin
```xml
org.jetbrains.kotlinx
kover-maven-plugin
0.9.0-RC
```
The list of Kover goals is specified in [this document section](https://kotlin.github.io/kotlinx-kover/maven-plugin#goals).
For full information about latest stable release of Kover Maven Plugin, please refer to the [documentation](https://kotlin.github.io/kotlinx-kover/maven-plugin).
## Kover CLI
Standalone JVM application used for offline instrumentation and generation of human-readable reports.
[Documentation of the Kover CLI](https://kotlin.github.io/kotlinx-kover/cli).
## Kover offline instrumentation
Offline instrumentation is the modification of class-files stored on disk to measure their coverage.
The ways of offline instrumentation and running of the instrumented applications are described in the [documentation](https://kotlin.github.io/kotlinx-kover/offline-instrumentation).
## Kover JVM agent
JVM agent is a jar file that modifies the bytecode of loaded into the JVM classes in order to measure coverage.
[Documentations](https://kotlin.github.io/kotlinx-kover/jvm-agent).
## Kover features artifact
A JVM dependency that allows to programmatically instrument class-files on a disk.
[Documentation of Kover features artifact](https://kotlin.github.io/kotlinx-kover/offline-instrumentation/#instrumentation-by-kover-features)
## Building locally and Contributing
See [Contributing Guidelines](https://github.com/Kotlin/kotlinx-kover/tree/main/CONTRIBUTING.md).