Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arturdm/jacoco-android-gradle-plugin
Gradle plugin that creates JaCoCo test reports for Android unit tests
https://github.com/arturdm/jacoco-android-gradle-plugin
android gradle gradle-plugin hacktoberfest
Last synced: 2 days ago
JSON representation
Gradle plugin that creates JaCoCo test reports for Android unit tests
- Host: GitHub
- URL: https://github.com/arturdm/jacoco-android-gradle-plugin
- Owner: arturdm
- License: apache-2.0
- Created: 2015-08-31T21:15:54.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T21:00:46.000Z (almost 2 years ago)
- Last Synced: 2024-12-15T21:06:32.708Z (about 1 month ago)
- Topics: android, gradle, gradle-plugin, hacktoberfest
- Language: Groovy
- Homepage:
- Size: 337 KB
- Stars: 562
- Watchers: 25
- Forks: 111
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# jacoco-android-gradle-plugin
[](https://plugins.gradle.org/plugin/com.dicedmelon.gradle.jacoco-android)
[](https://travis-ci.org/arturdm/jacoco-android-gradle-plugin)
[](https://codecov.io/gh/arturdm/jacoco-android-gradle-plugin)
A Gradle plugin that adds fully configured `JacocoReport` tasks for unit tests of each Android application and library project variant.
## Why
In order to generate JaCoCo unit test coverage reports for Android projects you need to create `JacocoReport` tasks and configure them by providing paths to source code, execution data and compiled classes. It can be troublesome since Android projects can have different flavors and build types thus requiring additional paths to be set. This plugin provides those tasks already configured for you.
## Usage
```groovy
buildscript {
repositories {
...
maven { url 'https://plugins.gradle.org/m2/' }
}
dependencies {
...
classpath 'com.dicedmelon.gradle:jacoco-android:0.1.5'
}
}
apply plugin: 'com.android.application'
apply plugin: 'com.dicedmelon.gradle.jacoco-android'
jacoco {
toolVersion = "0.8.4"
}
tasks.withType(Test) {
jacoco.includeNoLocationClasses = true
}
android {
...
productFlavors {
free {}
paid {}
}
}
```
The above configuration creates a `JacocoReport` task for each variant and an additional `jacocoTestReport` task that runs all of them.
```
jacocoTestPaidDebugUnitTestReport
jacocoTestFreeDebugUnitTestReport
jacocoTestPaidReleaseUnitTestReport
jacocoTestFreeReleaseUnitTestReport
jacocoTestReport
```
The plugin excludes Android generated classes from report generation by default. You can use `jacocoAndroidUnitTestReport` extension to add other exclusion patterns if needed.
```groovy
jacocoAndroidUnitTestReport {
excludes += ['**/AutoValue_*.*',
'**/*JavascriptBridge.class']
}
```
You can also toggle report generation by type using the extension.
```groovy
jacocoAndroidUnitTestReport {
csv.enabled false
html.enabled true
xml.enabled true
}
```
By default your report will be in `[root_project]/[project_name]/build/jacoco/`
But you can change the local reporting directory :
```groovy
jacocoAndroidUnitTestReport {
destination "/path/to/the/new/local/directory/"
}
```
To generate all reports run:
```shell
$ ./gradlew jacocoTestReport
```
Reports for each variant are available at `$buildDir/reports/jacoco` in separate subdirectories, e.g. `build/reports/jacoco/jacocoTestPaidDebugUnitTestReport`.
## Examples
* [example](example)
* https://github.com/codecov/example-android
* https://github.com/devinciltd/lib
## Snapshot usage
Snapshots of the development version are available in [Sonatype Nexus `snapshots` repository][snapshots].
```
buildscript {
repositories {
...
maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots' }
}
dependencies {
...
classpath 'com.dicedmelon.gradle:jacoco-android:x.y.z-SNAPSHOT'
}
}
```
## License
```
Copyright 2015-2021 Artur Stępniewski
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
[snapshots]: https://s01.oss.sonatype.org/content/repositories/snapshots/com/dicedmelon/gradle/jacoco-android