使用 Gadle kotlin 为多模块 Android 代码库设置 jacoco

在传统的Java或Kotlin JVM项目中，只有一个测试任务，可以通过tasks.test访问.

然而，在Android项目中，没有一个test任务.相反，有多个测试任务，one for each build variant个.测试任务命名为test<Variant>UnitTest.例如，您可能有testDebugUnitTest和testReleaseUnitTest.

当您try 访问Android项目中的tasks.test时，由于没有名称为test的任务，因此会出现"Unsolved Reference:Test"错误.

类似地，finalizedBy(tasks.jacocoTestReport)是一种指定任务依赖关系的方法，即jacocoTestReport任务应该始终在test任务之后运行.然而，由于Android项目中没有test个任务，这会导致"Unresolved reference: finalizedBy"错误.

在"How do I add plugins to subprojects based on what plugins are present?"之后，您可能需要在根build.gradle.kts中创建一个Jacoco设置，以便为使用Android插件的每个模块自动应用正确的Jacoco设置.

使用Gradle DLS script:

import org.gradle.testing.jacoco.tasks.JacocoReport

plugins {
    // your existing plugins...

    id("jacoco")
}

// rest of your configurations...

subprojects { subproject ->
    subproject.plugins.withId(Dependencies.Plugins.androidApplication) {
        setupJacoco(subproject)
    }
    subproject.plugins.withId(Dependencies.Plugins.androidLibrary) {
        setupJacoco(subproject)
    }
}


fun setupJacoco(project: Project) {
    project.tasks.register("jacocoTestReport", JacocoReport::class.java) { task ->
        task.group = "Reporting"
        task.description = "Generate Jacoco coverage reports after running tests."
        task.reports {
            xml.isEnabled = true
            html.isEnabled = true
        }
        task.executionData.setFrom(
            project.fileTree(project.buildDir).apply {
                include("**/jacoco/*.exec")
            }
        )
        task.sourceDirectories.setFrom(
            project.files(
                project.extensions.getByType<SourceSetContainer>().getByName("main").allSource.srcDirs
            )
        )
        task.classDirectories.setFrom(
            project.fileTree(
                project.extensions.getByType<SourceSetContainer>().getByName("main").output.classesDirs
            )
        )
    }
}

That script will check every subproject in the build. If a subproject applies your IDs, like Dependencies.Plugins.androidApplication or Dependencies.Plugins.androidLibrary plugin, it adds Jacoco tasks for that subproject.
For each of these projects, add a jacocoTestReport task which generates the Jacoco reports.

需要注意的一点是，Android Gradle插件creates a test task for each build variant的应用程序/库模块.例如，如果您有debug和release构建类型，Android Gradle插件将创建testDebugUnitTest和testReleaseUnitTest个任务.

这意味着，您需要运行特定的test任务，然后运行jacocoTestReport任务，如下所示:

# Do this once, after making changes to your build.gradle.kts 
./gradlew --refresh-dependencies

# Then, each time you want to generate the report
./gradlew module1:testDebugUnitTest module1:jacocoTestReport

这将为module1运行单元测试，然后生成Jacoco报告.请注意，如果您使用的是产品风格，您可能有两种以上类型的test任务(例如，testFreeDebugUnitTest、testPaidDebugUnitTest等)，因此请相应地调整您的命令以适应您的项目配置.