使用 Gradle 运行所有子项目测试

Question

我有一个结构如下的多模块android项目：

:a
:b
  :c
  :d
    :e

我正在尝试在模块 :b 上运行 jacoco 报告，以便它在 :b、:c、:d 和 :e 上运行而不运行 :a。我希望所有的 xml 报告都放在一个带有 project.xml 名称的公共文件夹中（例如 b.xml、c.xml 等）我有一个非常标准的 jacoco 设置

task jacocoTestReport(type: JacocoReport, dependsOn: ['testDebugUnitTest', 'createDebugCoverageReport']) {

    reports {
        xml.enabled = true
        xml.destination = file(allTestCoverageDir + project.name + ".xml")
        html.enabled = true
    }

    def fileFilter = [
            '**/R.class',
            '**/R$*.class',
            '**/BuildConfig.*',
            '**/Manifest*.*',
            '**/*Test*.*',
            'android/**/*.*',

            //Dagger 2
            '**/*Dagger*Component*.*',
            '**/*Module.*',
            '**/*Module$*.*',
            '**/*MembersInjector*.*',
            '**/*_Factory*.*',
            '**/*Provide*Factory*.*',
    ]

    def kotlinDebug = [fileTree(dir: "${project.buildDir}/tmp/kotlin-classes/debug", excludes: fileFilter)]
    def mainSrc = files([
            "$project.projectDir/src/main/java",
            "$project.projectDir/src/main/kotlin"
    ])

    sourceDirectories = files([mainSrc])
    classDirectories = files(kotlinDebug)
    executionData = fileTree(dir: project.buildDir, includes: [
            'jacoco/testDebugUnitTest.exec', 'outputs/code-coverage/connected/*coverage.ec'
    ])
}

但是当我尝试遍历 doLast 块中的子项目时，doLast 块永远不会运行，并且在此之前尝试访问子项目也表明 :a 没有子项目。

编辑我可以使用 ./gradlew b:jacocoTestReport 或 ./gradlew c:jacocoTestReport 以及所有报告以及具有正确名称的文件夹中的每个子项目运行这些。但是随着我的项目的增长，我不想运行几十个命令（每个模块一个）我想要一个命令 ./gradlew b:jacocoTestReport （或类似的东西），它为 b 运行，它是子树

Answer 1

据我了解，目前您正在使用allprojects {} 配置所有子项目。尽管过去这是配置一组项目的规范，但现在不鼓励这样做。此外，项目应使用出版物相互连接，而不是跨项目边界复制文件。所以你需要做两件事：

1. 您应该创建一个插件来配置 jacoco 并创建将保存报告的配置，而不是从根根项目配置子项目。

为此，请在您的项目中创建一个pre-compiled script plugin。这个想法是在buildSrc 项目中拥有一个 kotlin 构建脚本，并从该文件动态创建一个 Gradle 插件。所以你应该把配置jacoco的逻辑移到文件buildSrc/src/main/kotlin/jacoco-conventions.gradle.kts：

plugins {
    jacoco
}

val jacocoTestReport by tasks.getting(JacocoReport::class) {
  // jacoco configuration 
}

configurations.create("jacocoReports") {
    isCanBeResolved = false
    isCanBeConsumed = true
    attributes {
        attribute(Usage.USAGE_ATTRIBUTE, project.objects.named(Usage::class, "jacocoReports"))
    }
    outgoing.artifact(jacocoTestReport.reports.xml.destination) {
        builtBy(jacocoTestReport)
    }
}

最后一部分在应用预编译脚本插件的项目中创建一个新配置。此配置使用由 jacoco 报告任务构建的 xml 目标文件作为传出工件。这里的重要部分是USAGE_ATTRIBUTE，因为我们稍后将需要它来使用文件。

现在可以将预编译的脚本插件应用到您想要通过以下方式收集 jacoco 指标的项目中：

// for example in c/build.gradle.kts
plugins {
  `jacoco-conventions`
}

现在您已配置子项目以将 Jacoco xml 报告放入使用属性jacocoReports 的配置中。

1. 在根项目中创建一个从配置复制报告的任务。

为此，我们需要设置一个使用jacocoReports 变体的配置，然后依赖于子项目的变体：

// main build file
val jacocoReports by configurations.creating {
    isCanBeResolved = true
    isCanBeConsumed = false
    attributes {
        attribute(Usage.USAGE_ATTRIBUTE, project.objects.named(Usage::class, "jacocoReports"))
    }
}

dependencies {
    jacocoReports(project(":b:c"))
    jacocoReports(project(":b:d:e"))
    // other jacocoReports you want to consume
}

tasks.register<Copy>("aggregateJacocoReports") {
    from(jacocoReports)
    into(file("$buildDir/jacoco"))
}

如您所见，jacocoReports 配置具有相同的使用属性，因此它可以用于解析具有相同属性的配置中的文件。然后我们需要定义我们想要使用哪些项目报告。这是通过使用jacocoReports 配置定义项目依赖关系的锥体。最后一步是一个简单的复制任务，将文件复制到根项目的构建目录中。因此，现在当您调用 ./gradlew aggregateJacocoReports 时，此任务会解析 jacocoReports 配置中的所有文件，这反过来将为根项目所依赖的所有项目创建 jacoco 报告。

为什么这比交叉配置更好？如果项目没有被交叉配置和在项目之间复制内容的任务所纠缠，那么 gradle 可以更有效地安排和并行化必须完成的工作。

我创建了一个可以帮助您以这种方式设置项目的最小示例：https://github.com/britter/gradle-jacoco-aggregate。为了简单起见，我删除了 android 特定的配置，但我相信你会明白的。