You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,14 @@
1
1
# Android-Root-Coverage-Plugin
2
2
**A Gradle plugin for easy generation of combined code coverage reports for Android projects with multiple modules.**
3
-
Android Projects that make use of the Gradle build system by default come with easy methods to generate code coverage reports. Unfortently by default code coverage is generated seperatly per module, this means each modules takes into account it's own sources and tests, which is in terms of domain seperation fine. Howerver it is very common to find multi-module Android project where only one module has instrumented tests, or full-fledged UI tests using Espresso. This plugin comes in handy for those projects. It generates code coverage reports using Jacoco taking into account all the modules and tests at once.
3
+
Generating code coverage reports for Android Projects that make use of the Gradle build is quite easy. Unfortunately by default code coverage is generated separately per module, this means each modules takes into account it's own sources and tests, which is in terms of domain separation fine. However it is very common to find multi-module Android project where only one module has instrumented tests, or full-fledged UI tests using Espresso. This plugin comes in handy for those projects. It generates code coverage reports using Jacoco taking into account all the modules and tests at once.
4
4
5
5
- Supports both Android app and library modules (`com.android.application` & `com.android.library`).
6
6
- Supports different build variants per module within the same report.
7
7
- Supports custom filters.
8
8
9
-
# Download
10
-
The plugin is not yet available on Maven Central, so currently it is needed to add the following repository to your top-level gradle file:
9
+
# Setup
10
+
Apply the Android-Root-Coverage-Plugin plugin to your top-level (root project) gradle file following these 3 steps:
11
11
12
-
**Step 1:**
13
12
```
14
13
// Step 3: Apply the plugin to the top-level gradle file
15
14
apply plugin: 'org.neotech.plugin.rootcoverage'
@@ -32,7 +31,7 @@ buildscript {
32
31
# How to use
33
32
Currently only modules with the plugin type `com.android.application` or `com.android.library` are taken into account when generating the root code coverage report, besides this any module that does not have `testCoverageEnabled true` for the default build variant (`debug`) will be skipped::
34
33
35
-
You can add a module by enableing`testCoverageEnabled`:
34
+
You can add a module by enabling`testCoverageEnabled`:
36
35
```
37
36
android {
38
37
buildTypes {
@@ -64,7 +63,7 @@ rootCoverage {
64
63
65
64
66
65
# Development
67
-
Want to contribute? Great! Currently this plugin is in need of extensive testing. Besides this there is also a small whish list:
66
+
Want to contribute? Great! Currently this plugin is in need of extensive testing. Besides this there is also a small wish list:
68
67
69
68
- Support for Java modules
70
69
- Make use of the JacocoMerge task? To merge the `exec` en `ec` files?
0 commit comments