{"id":20843464,"url":"https://github.com/arturdm/jacoco-android-gradle-plugin","last_synced_at":"2025-04-04T15:10:01.853Z","repository":{"id":46650224,"uuid":"41701040","full_name":"arturdm/jacoco-android-gradle-plugin","owner":"arturdm","description":"Gradle plugin that creates JaCoCo test reports for Android unit tests","archived":false,"fork":false,"pushed_at":"2023-03-06T21:00:46.000Z","size":345,"stargazers_count":562,"open_issues_count":42,"forks_count":110,"subscribers_count":24,"default_branch":"master","last_synced_at":"2025-03-28T14:08:07.446Z","etag":null,"topics":["android","gradle","gradle-plugin","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arturdm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-08-31T21:15:54.000Z","updated_at":"2025-03-18T15:14:44.000Z","dependencies_parsed_at":"2024-11-18T01:42:03.273Z","dependency_job_id":"fd420aa3-711d-49ce-be60-7327db199ddd","html_url":"https://github.com/arturdm/jacoco-android-gradle-plugin","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arturdm%2Fjacoco-android-gradle-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arturdm%2Fjacoco-android-gradle-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arturdm%2Fjacoco-android-gradle-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arturdm%2Fjacoco-android-gradle-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arturdm","download_url":"https://codeload.github.com/arturdm/jacoco-android-gradle-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247198463,"owners_count":20900080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","gradle","gradle-plugin","hacktoberfest"],"created_at":"2024-11-18T01:41:57.248Z","updated_at":"2025-04-04T15:10:01.821Z","avatar_url":"https://github.com/arturdm.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jacoco-android-gradle-plugin\n[![Gradle Plugin Portal](https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/com.dicedmelon.gradle/jacoco-android/maven-metadata.xml.svg?label=Gradle%20Plugin%20Portal)](https://plugins.gradle.org/plugin/com.dicedmelon.gradle.jacoco-android)\n[![Build Status](https://travis-ci.org/arturdm/jacoco-android-gradle-plugin.svg)](https://travis-ci.org/arturdm/jacoco-android-gradle-plugin)\n[![codecov](https://codecov.io/gh/arturdm/jacoco-android-gradle-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/arturdm/jacoco-android-gradle-plugin)\n\nA Gradle plugin that adds fully configured `JacocoReport` tasks for unit tests of each Android application and library project variant.\n\n## Why\nIn 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.\n\n## Usage\n```groovy\nbuildscript {\n  repositories {\n    ...\n    maven { url 'https://plugins.gradle.org/m2/' }\n  }\n  dependencies {\n    ...\n    classpath 'com.dicedmelon.gradle:jacoco-android:0.1.5'\n  }\n}\n\napply plugin: 'com.android.application'\napply plugin: 'com.dicedmelon.gradle.jacoco-android'\n\njacoco {\n  toolVersion = \"0.8.4\"\n}\n\ntasks.withType(Test) {\n  jacoco.includeNoLocationClasses = true\n}\n\nandroid {\n  ...\n  productFlavors {\n    free {}\n    paid {}\n  }\n}\n```\n\nThe above configuration creates a `JacocoReport` task for each variant and an additional `jacocoTestReport` task that runs all of them.\n```\njacocoTestPaidDebugUnitTestReport\njacocoTestFreeDebugUnitTestReport\njacocoTestPaidReleaseUnitTestReport\njacocoTestFreeReleaseUnitTestReport\njacocoTestReport\n```\n\nThe plugin excludes Android generated classes from report generation by default. You can use `jacocoAndroidUnitTestReport` extension to add other exclusion patterns if needed.\n```groovy\njacocoAndroidUnitTestReport {\n  excludes += ['**/AutoValue_*.*',\n              '**/*JavascriptBridge.class']\n}\n```\n\nYou can also toggle report generation by type using the extension.\n```groovy\njacocoAndroidUnitTestReport {\n  csv.enabled false\n  html.enabled true\n  xml.enabled true\n}\n```\n\nBy default your report will be in `[root_project]/[project_name]/build/jacoco/`\nBut you can change the local reporting directory :\n```groovy\njacocoAndroidUnitTestReport {\n  destination \"/path/to/the/new/local/directory/\"\n}\n```\n\nTo generate all reports run:\n```shell\n$ ./gradlew jacocoTestReport\n```\n\nReports for each variant are available at `$buildDir/reports/jacoco` in separate subdirectories, e.g. `build/reports/jacoco/jacocoTestPaidDebugUnitTestReport`.\n\n## Examples\n* [example](example)\n* https://github.com/codecov/example-android\n* https://github.com/devinciltd/lib\n\n## Snapshot usage\n\nSnapshots of the development version are available in [Sonatype Nexus `snapshots` repository][snapshots].\n\n```\nbuildscript {\n  repositories {\n    ...\n    maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots' }\n  }\n  dependencies {\n    ...\n    classpath 'com.dicedmelon.gradle:jacoco-android:x.y.z-SNAPSHOT'\n  }\n}\n```\n\n## License\n```\nCopyright 2015-2021 Artur Stępniewski\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n\n[snapshots]: https://s01.oss.sonatype.org/content/repositories/snapshots/com/dicedmelon/gradle/jacoco-android\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farturdm%2Fjacoco-android-gradle-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farturdm%2Fjacoco-android-gradle-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farturdm%2Fjacoco-android-gradle-plugin/lists"}