Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koral--/jacoco-gradle-testkit-plugin
Gradle plugin for JaCoCo code coverage in tests using Gradle TestKit
https://github.com/koral--/jacoco-gradle-testkit-plugin
coverage gradle-plugin gradle-testkit hacktoberfest jacoco jacoco-plugin testkit
Last synced: 17 days ago
JSON representation
Gradle plugin for JaCoCo code coverage in tests using Gradle TestKit
- Host: GitHub
- URL: https://github.com/koral--/jacoco-gradle-testkit-plugin
- Owner: koral--
- License: mit
- Created: 2017-03-24T02:28:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-04T10:54:20.000Z (over 1 year ago)
- Last Synced: 2024-10-14T15:04:39.716Z (about 1 month ago)
- Topics: coverage, gradle-plugin, gradle-testkit, hacktoberfest, jacoco, jacoco-plugin, testkit
- Language: Kotlin
- Homepage: https://www.thedroidsonroids.com/blog/how-to-create-gradle-plugin-in-kotlin/
- Size: 295 KB
- Stars: 43
- Watchers: 2
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://ci.appveyor.com/project/koral--/jacoco-gradle-testkit-plugin/branch/master)
[](https://codecov.io/gh/koral--/jacoco-gradle-testkit-plugin)
[](https://app.bitrise.io/app/8be2125eb039c87e)
# jacoco-gradle-testkit-plugin
Gradle plugin for [JaCoCo](http://www.eclemma.org/jacoco/) code coverage
in tests using [Gradle TestKit](https://docs.gradle.org/current/userguide/test_kit.html).
## Motivation
There is no built-it support for code coverage in TestKit. Those tests run
in separate JVM and configuration of [JaCoCo plugin](https://docs.gradle.org/current/userguide/jacoco_plugin.html)
is not taken into account. See [Gradle forum post](https://discuss.gradle.org/t/gradle-plugins-integration-tests-code-coverage-with-jacoco-plugin/12403)
for more details.
## Usage
- Apply plugin in `build.gradle`:
```groovy
plugins {
id "pl.droidsonroids.jacoco.testkit" version "1.0.12"
}
```
This will add `testkit-gradle.properties` system resource.
- Create `gradle.properties` file used by `GradleRunner` and populate it
with content from mentioned resource.
Sample kotlin code:
```kotlin
class AwesomeTest {
fun InputStream.toFile(file: File) {
use { input ->
file.outputStream().use { input.copyTo(it) }
}
}
fun GradleRunner.withJaCoCo(): GradleRunner {
javaClass.classLoader.getResourceAsStream("testkit-gradle.properties").toFile(File(projectDir, "gradle.properties"))
return this
}
@get:Rule
val temporaryFolder = TemporaryProjectFolder()
@Test
fun `empty project builds successfuly`() {
val result = GradleRunner.create()
.withProjectDir(temporaryFolder.root)
.withTestKitDir(temporaryFolder.newFolder())
.withPluginClasspath()
.withJaCoCo()
.build()
}
}
```
### Adding coverage for another task (ex. integrationTest)
By default the plugin configures the `test` task for any project with Java plugin applied.
To configure the coverage for another task just add something like this:
```groovy
jacocoTestKit {
applyTo("intTestRuntimeOnly", tasks.named("integrationTest"))
}
```
### Custom JaCoCo destination file
JaCoCo destination file path reads it from the `JacocoTaskExtension` so you can change it like this:
```groovy
tasks.named("test").configure {
jacoco {
destinationFile = file('integration.exec')
}
}
```
### Requirements
Minimum supported versions:
- Gradle: **7.6**
- Java: **1.8**
### Backwards compatibility
#### Migrating from 1.0.9 or older
Starting from version 1.0.10 the legacy plugin coordinates have changed. For example:
```
classpath("gradle.plugin.pl.droidsonroids.gradle.jacoco:jacoco-gradle-testkit-plugin:1.0.9")
```
became:
```
classpath("pl.droidsonroids.gradle.jacoco:pl.droidsonroids.gradle.jacoco:1.0.10")
```
Note the `gradle.plugin` prefix has gone. This change does NOT affect the plugins DSL:
```
plugins {
id("pl.droidsonroids.jacoco.testkit") version "1.0.10"
}
```