Android-kotlin 项目中的 Jacoco 代码覆盖率 0%

Question

我一直在尝试在 Android kotlin 项目中实现 Jacoco 的代码覆盖率。 我使用了默认的 android 工作室覆盖工具，但它并不可靠。 所以我尝试实施 Jacoco，但即使在测试成功通过后我的代码覆盖率也是 0%。

0% 覆盖率 -

试运行成功——

这是 gradle 脚本 -

plugins {
id 'com.android.library'
id 'kotlin-android'
id 'jacoco'
}


android {
compileSdkVersion 30
buildToolsVersion "30.0.3"

defaultConfig {
    minSdkVersion 21
    targetSdkVersion 30
    versionCode 1
    versionName "1.0"

    testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    consumerProguardFiles "consumer-rules.pro"
}

buildTypes {
    debug {
        debuggable true
        minifyEnabled false
        testCoverageEnabled true
    }
    release {
        minifyEnabled false
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
}
compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}
kotlinOptions {
    jvmTarget = '1.8'
}
testOptions {
    unitTests.returnDefaultValues = true
}

}



dependencies {

implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
implementation 'androidx.core:core-ktx:1.5.0'
implementation 'androidx.appcompat:appcompat:1.3.0'
implementation 'com.google.android.material:material:1.3.0'
testImplementation 'junit:junit:4.+'
testImplementation 'org.mockito:mockito-core:3.11.2'

testImplementation 'org.mockito:mockito-inline:3.11.2'
androidTestImplementation 'androidx.test.ext:junit:1.1.2'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
}

jacoco {
toolVersion = "0.8.5"
// Custom reports directory can be specfied like this:
// reportsDir = file("$buildDir/customJacocoReportDir")
}

tasks.withType(Test) {
jacoco.includeNoLocationClasses = true
jacoco.excludes = ['jdk.internal.*']
// see related issue https://github.com/gradle/gradle/issues/5184#issuecomment-457865951
}

project.afterEvaluate {

(android.hasProperty('applicationVariants')
        ? android.'applicationVariants'
        : android.'libraryVariants')
        .all { variant ->
            def variantName = variant.name
            def unitTestTask = "test${variantName.capitalize()}UnitTest"
            def androidTestCoverageTask = "create${variantName.capitalize()}CoverageReport"

            tasks.create(name: "${unitTestTask}Coverage", type: JacocoReport, dependsOn: [
                    "$unitTestTask",
                    "$androidTestCoverageTask"
            ]) {
                group = "Reporting"
                description = "Generate Jacoco coverage reports for the ${variantName.capitalize()} build"

                reports {
                    html.enabled = true
                    xml.enabled = true
                    csv.enabled = true
                }

                def excludes = [
                        // data binding
                        'android/databinding/**/*.class',
                        '**/android/databinding/*Binding.class',
                        '**/android/databinding/*',
                        '**/androidx/databinding/*',
                        '**/BR.*',
                        // android
                        '**/R.class',
                        '**/R$*.class',
                        '**/BuildConfig.*',
                        '**/Manifest*.*',
                        '**/*Test*.*',
                        'android/**/*.*',
                        // kotlin
                        '**/*MapperImpl*.*',
                        '**/*$ViewInjector*.*',
                        '**/*$ViewBinder*.*',
                        '**/BuildConfig.*',
                        '**/*Component*.*',
                        '**/*BR*.*',
                        '**/Manifest*.*',
                        '**/*$Lambda$*.*',
                        '**/*Companion*.*',
                        '**/*Module*.*',
                        '**/*Dagger*.*',
                        '**/*Hilt*.*',
                        '**/*MembersInjector*.*',
                        '**/*_MembersInjector.class',
                        '**/*_Factory*.*',
                        '**/*_Provide*Factory*.*',
                        '**/*Extensions*.*',
                        // sealed and data classes
                        '**/*$Result.*',
                        '**/*$Result$*.*'
                ]

                def javaClasses = fileTree(dir: variant.javaCompileProvider.get().destinationDir,
                        excludes: excludes)
                def kotlinClasses = fileTree(dir: "${buildDir}/tmp/kotlin-classes/${variantName}",
                        excludes: excludes)

                classDirectories.setFrom(files([
                        javaClasses,
                        kotlinClasses
                ]))

                def variantSourceSets = variant.sourceSets.java.srcDirs.collect { it.path }.flatten()
                sourceDirectories.setFrom(project.files(variantSourceSets))

                def androidTestsData = fileTree(dir: "${buildDir}/outputs/code_coverage/${variantName}AndroidTest/connected/", includes: ["**/*.ec"])

                executionData(files([
                        "$project.buildDir/jacoco/${unitTestTask}.exec",
                        androidTestsData
                ]))
            }

        }
}

Answer 1

现在，对于一个具有以下功能的 android 多模块项目：

• 雅可可 0.8.7
• 毕业插件 7.0.2

我发现如果设置了debug { testCoverageEnabled true } ，jacoco 不会为单元测试生成任何输出（例如 testDebugUnitTest）。 如果不是，则创建 /build/jacoco/testDebugUnitTest.exec，并带有实际的覆盖率数据。

这显然是一个错误，但不确定它在哪个组件中。这很糟糕，因为这意味着它可以用于设备测试或单元测试，但不能同时用于两者。

Answer 2

我记得只支持特定版本的 jacoco：

apply plugin: 'jacoco'
jacoco {
    toolVersion = '0.7.5.201505241946'
}

Answer 3

对于仍然面临问题的任何人：

这是一个Android Gradle 插件问题

将 Android Gradle 插件升级到 7.2.1 即可解决此问题。

Answer 4

我在多个项目中为这个问题苦苦挣扎了 3 年，但我有一个解决方案（或者更确切地说是有人解决了我的问题）。

Android-Root-Coverage-Plugin可用于在 Java 和/或 Kotlin 多模块项目中组合 jUnit 和仪器测试，无需任何其他配置。 它解决了我的以下问题：

• 在多模块项目中获得覆盖
• Kotlin 中的错误覆盖
• 结合 jUnit 和仪表测试覆盖率

已确认我的问题的原因是由于 android gradle 插件中的错误，截至 2022 年 8 月，该问题尚未解决。

Answer 5

在同一个项目中使用 hilt + jacoco 时，这似乎是个问题，所以可能是我们没有得到覆盖的原因...... https://github.com/google/dagger/issues/2740

Answer 6

如果您在项目中使用 Hilt，请尝试在 Jacoco 任务的 classDirectories 中添加build/intermediates/asm_instrumented_project_classes/<Product>Debug/文件夹。

问题跟踪器中的相关问题： https://issuetracker.google.com/issues/161300933#comment5

Answer 7

我假设您只有单元测试并且没有任何 Android Instrument 测试？

如果是这种情况，请在运行./gradlew ${unitTestTask}Coverage之后。 您应该看到生成了以下文件

请绝对避免使用 coverage 文件夹，该文件夹还包含一个报告，但是，仅生成 Android Instrument Test 覆盖率是硬连线的。

如果单击打开 app/build/reports/jacoco 文件夹

这个 xml 报告是从我们的 jacoco gradle 任务生成的。 它应该包含 Android Instrument 测试和单元测试。

我从 gradle 任务中启用了 html 选项。 如果我在这个 jacoco 文件夹中打开 index.html。 它与从报告/覆盖文件夹生成的结果不同。

还要仔细检查单元测试编译和运行是否正常，否则它会被忽略并导致 0%