Gradle怎么生成XML报告

Gradle test任务默认不生成XML报告,需在build.gradle中显式配置junitXml.required = true,路径为build/test-results/test/,文件名如TEST-MyTestClass.xml。

Gradle测试任务默认不生成XML报告

Gradle的 test 任务默认只输出控制台日志和二进制结果(TEST-*.bin),不会自动生成JUnit风格的XML报告。如果你在CI里看到“找不到TEST-*.xml”或Jenkins/JUnit插件报解析失败,大概率是因为这个默认行为没被覆盖。

启用XML报告需显式配置 test 任务

必须在 build.gradle(Groovy)或 build.gradle.kts(Kotlin DSL)中手动开启XML输出,且要指定格式为 JUNIT。默认的 PLAINHTML 都不产生XML。

  • Groovy写法:
    test {
        reports {
            junitXml.required = true
            html.required = false
        }
    }
  • Kotlin DSL写法:
    tasks.test {
        reports {
            junitXml.required.set(true)
            html.required.set(false)
        }
    }
  • 生成路径固定为 build/test-results/test/,文件名形如 TEST-MyTestClass.xml
  • 注意:Gradle 7.6+ 中 junitXml.enabled 已废弃,必须用 required 属性

使用 --no-build-cache 或清理可能影响报告生成

如果之前执行过 test 且失败过,Gradle可能跳过后续执行(尤其启用了构建缓存或增量编译),导致XML文件没更新甚至缺失。常见现象是目录里只有旧的 .bin 文件,没有新 .xml

  • 强制重新运行测试:./gradlew cleanTest test
  • 禁用缓存避免跳过:./gradlew test --no-build-cache
  • 检查输出是否真被触发:./gradlew test --info | grep "Generating XML report"

第三方测试框架(如TestNG、Spock)需要额外适配

Gradle原生只对JUnit(包括JUnit 4/5)的 junitXml 报告有开箱支持。用 testngspock 时,即使配置了 junitXml.required = true,也只会生成空文件或报错。

  • TestNG:需添加 useTestNG() 并确认使用 org.testng:testng ≥7.0,旧版不兼容
  • Spock:必须搭配JUnit Platform Launcher,且在 test 块中显式声明:
    useJUnitPlatform {
        includeEngines 'spock'
    }
  • 验证是否生效:运行后检查 build/test-results/test/ 下是否有非零大小的 .xml 文件,而不是只看目录是否存在
XML报告不是“开了就一定有”,它依赖测试真正执行、引擎正确注册、以及Gradle版本与插件的匹配。最容易忽略的是——你以为任务运行了,其实被跳过了。