Last active
September 10, 2019 09:00
-
-
Save fangzhzh/b7c926687e5f670ed003380f9eca5ed7 to your computer and use it in GitHub Desktop.
create jacoco related tasks for Android app
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// https://engineering.rallyhealth.com/android/code-coverage/testing/2018/06/04/android-code-coverage.html | |
ext.enableJacoco = { Project project, String variant -> | |
project.plugins.apply('jacoco') | |
final capVariant = variant.capitalize() | |
StringBuilder folderSb = new StringBuilder(variant.length() + 1) | |
for (int i = 0; i < variant.length(); i++) { | |
char c = variant.charAt(i) | |
if (Character.isUpperCase(c)) { | |
folderSb.append('/') | |
folderSb.append(Character.toLowerCase(c)) | |
} else { | |
folderSb.append(c) | |
} | |
} | |
final folder = folderSb.toString() | |
project.android { | |
buildTypes { | |
debug { | |
testCoverageEnabled true | |
} | |
} | |
testOptions { | |
unitTests.all { | |
jacoco { | |
//You may encounter an issue while getting test coverage for Robolectric tests. | |
//To include Robolectric tests in the Jacoco report, one will need to set the includeNolocationClasses flag to true. | |
// This can no longer be configured using the android DSL block, thus we search all tasks of Test type and enable it | |
includeNoLocationClasses = true | |
} | |
} | |
} | |
jacoco { | |
version = '0.8.1' | |
} | |
} | |
project.jacoco { | |
toolVersion = '0.8.1' | |
} | |
project.tasks.create( | |
name: 'jacocoTestCoverageVerification', | |
type: JacocoCoverageVerification, | |
dependsOn: ["test${capVariant}UnitTest", | |
"create${capVariant}CoverageReport" | |
] | |
) { | |
onlyIf = { | |
true | |
} | |
violationRules { | |
rule { | |
limit { | |
minimum = 0.5 | |
} | |
} | |
rule { | |
enabled = false | |
element = 'CLASS' | |
includes = ['org.gradle.*'] | |
limit { | |
counter = 'LINE' | |
value = 'TOTALCOUNT' | |
maximum = 0.3 | |
} | |
} | |
} | |
def coverageSourceDirs = [ | |
"src/main/java", | |
"src/main/kotlin" | |
] | |
def fileFilter = [ | |
'**/R.class', | |
'**/R$*.class', | |
'**/*$ViewInjector*.*', | |
'**/*$ViewBinder*.*', | |
'**/BuildConfig.*', | |
'**/*_MembersInjector.class', | |
'**/Dagger*Component.class', | |
'**/Dagger*Component$Builder.class', | |
'**/*Module_*Factory.class', | |
'**/*_MembersInjector.class', | |
'**/Dagger*Subcomponent*.class', | |
'**/*Subcomponent$Builder.class', | |
'**/Manifest*.*' | |
] | |
def javaClasses = fileTree( | |
dir: "${project.buildDir}/intermediates/javac/$folder", | |
excludes: fileFilter | |
) | |
def kotlinClasses = fileTree( | |
dir: "${project.buildDir}/tmp/kotlin-classes/$variant", | |
excludes: fileFilter | |
) | |
group = "Reporting" | |
description = "Applying Jacoco coverage verification for the ${project.name} with the " + | |
"$variant variant." | |
classDirectories = files([javaClasses], [kotlinClasses]) | |
additionalSourceDirs = files(coverageSourceDirs) | |
sourceDirectories = files(coverageSourceDirs) | |
executionData = fileTree(dir: "${project.buildDir}", includes: [ | |
"jacoco/testDebugUnitTest.exec", | |
"outputs/code_coverage/debugAndroidTest/connected/*.ec", | |
"outputs/code_coverage/connected/*.ec" //Check this path or update to relevant path | |
]) | |
} | |
project.tasks.create( | |
name: 'jacocoTestReport', | |
type: JacocoReport, | |
dependsOn: ["test${capVariant}UnitTest", | |
"create${capVariant}CoverageReport" | |
] | |
) { | |
def coverageSourceDirs = [ | |
"src/main/java", | |
"src/main/kotlin" | |
] | |
def fileFilter = [ | |
'**/R.class', | |
'**/R$*.class', | |
'**/*$ViewInjector*.*', | |
'**/*$ViewBinder*.*', | |
'**/BuildConfig.*', | |
'**/*_MembersInjector.class', | |
'**/Dagger*Component.class', | |
'**/Dagger*Component$Builder.class', | |
'**/*Module_*Factory.class', | |
'**/*_MembersInjector.class', | |
'**/Dagger*Subcomponent*.class', | |
'**/*Subcomponent$Builder.class', | |
'**/Manifest*.*' | |
] | |
def javaClasses = fileTree( | |
dir: "${project.buildDir}/intermediates/javac/$folder", | |
excludes: fileFilter | |
) | |
def kotlinClasses = fileTree( | |
dir: "${project.buildDir}/tmp/kotlin-classes/$variant", | |
excludes: fileFilter | |
) | |
group = "Reporting" | |
description = "Generate Jacoco coverage reports for the ${project.name} with the " + | |
"$variant variant." | |
classDirectories = files([javaClasses], [kotlinClasses]) | |
additionalSourceDirs = files(coverageSourceDirs) | |
sourceDirectories = files(coverageSourceDirs) | |
executionData = fileTree(dir: "${project.buildDir}", includes: [ | |
"jacoco/testDebugUnitTest.exec", | |
"outputs/code_coverage/debugAndroidTest/connected/*.ec", | |
"outputs/code_coverage/connected/*.ec" //Check this path or update to relevant path | |
]) | |
onlyIf = { | |
true | |
} | |
reports { | |
html.enabled = true | |
html.destination file("reporting/jacocohtml") | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment