测试报告聚合插件(插件 ID:test-report-aggregation)提供用于将多个 Test 任务调用(可能跨越多个 Gradle 项目)的结果聚合到单个 HTML 报告中的任务和配置。

用法

要使用测试报告聚合插件,请在您的构建脚本中包含以下内容

plugins {
    id 'test-report-aggregation'
}
plugins {
    id("test-report-aggregation")
}

请注意,除非与 JVM 测试套件插件 结合使用,否则此插件不会执行任何操作。 Java 插件 会自动应用 JVM 测试套件插件。

现在有两种方法可以跨多个子项目收集测试结果

  1. 从发行版的项目,例如应用程序或 WAR 子项目 → 发行版示例

  2. 使用独立项目指定子项目 → 独立示例

示例 2 也可以用于通过根项目聚合结果。

测试报告聚合插件目前不适用于 com.android.application 插件。

任务

当项目也应用了 jvm-test-suite 插件时,将为每个测试套件添加以下任务

testSuiteAggregateTestReportTestReport

取决于:与以下属性匹配的变体工件

通过testReportAggregation配置收集直接和传递项目依赖项的变体。将匹配以下属性

    - org.gradle.category              = verification   (1)
    - org.gradle.testsuite.type        = unit-test      (2)
    - org.gradle.verificationtype      = test-results   (3)
1 类别属性;值是固定的。
2 TestSuiteType 属性;值从 JvmTestSuite#getTestType() 中得出。
3 VerificationType 属性;值是固定的。

有关测试执行生成的变体的更多信息,请参阅 JVM 测试套件插件文档的 输出变体 部分。

报告

默认情况下,Gradle 在任何任务失败时(包括测试失败)停止执行任务。为了确保您的构建始终生成聚合报告,请在您的 Gradle 命令中指定--continue选项。有关更多信息,请参阅 在发生故障时继续构建

自动报告创建

当项目也应用jvm-test-suite插件时,将为每个测试套件添加以下报告对象

testSuiteAggregateTestReportAggregateTestReport

创建一个容器来参数化 TestSuiteType 值。

手动报告创建

当项目不应用jvm-test-suite插件时,您必须手动注册一个或多个报告

build.gradle.kts
reporting {
    reports {
        val testAggregateTestReport by creating(AggregateTestReport::class) { (1)
            testType = TestSuiteType.UNIT_TEST
        }
    }
}
build.gradle
reporting {
    reports {
        testAggregateTestReport(AggregateTestReport) { (1)
            testType = TestSuiteType.UNIT_TEST
        }
    }
}
1 创建一个名为testAggregateTestReport的类型为AggregateTestReport的报告。为了方便起见,使用 TestSuiteType 类中的常量值设置TestType。任何字符串值都是可以接受的。

报告创建会自动创建支持任务,以根据给定的测试套件类型值进行聚合。

依赖管理

测试报告聚合插件添加了以下依赖配置

表 1. Test Report Aggregation 插件 - 依赖配置
名称 含义

testReportAggregation

用于声明所有具有要聚合的测试结果数据的项目依赖项的配置。

aggregateTestReportResults

使用 变体感知匹配testReportAggregation 配置中使用项目依赖项来查找合适的测试套件类型。

如果项目也应用了 jvm-test-suite 插件,则无需显式将依赖项添加到 testReportAggregation 配置中。