解决Quarkus @QuarkusTest集成测试JaCoCo Gradle配置类不匹配问题
环境信息
- Quarkus 3.0.1.Final
- Gradle 7.5.1
- JaCoCo插件 0.8.9
- Java 17 (Corretto-17.0.6.10.1)
项目结构
- 单元测试(仅使用Mockito):
app/test目录 - 集成测试(带
@QuarkusTest注解):app/integrationTest目录,以fast-jar方式执行 - 需求:为两类测试分别生成独立的
.exec文件,并基于这些文件生成XML格式的JaCoCo测试报告
当前Gradle配置
jacoco { toolVersion = jacocoVersion } jacocoTestReport { mustRunAfter quarkusIntTest getExecutionData().setFrom(fileTree(buildDir).include("/jacoco/*.exec")) reports { xml.required = true } }
执行情况与错误
执行命令:
./gradlew clean quarkusIntTest jacocoTestReport -x test
成功生成quarkusIntTest.exec文件,但生成报告时抛出类不匹配错误:
Task :app:jacocoTestReport
[ant:jacocoReport] Classes in bundle 'app' do not match with execution data. For report generation the same class files must be used as at runtime.
[ant:jacocoReport] Execution data for class com/org/app/rules/configuration/SampleRuleConfiguration does not match.
[ant:jacocoReport] Execution data for class com/org/app/sql/flyway/FlywayLifecycle does not match.
[ant:jacocoReport] Execution data for class com/org/app/config/TenantConfigProvider does not match.
...
疑问
- 已确认测试执行与报告生成使用同一JDK,仍出现类不匹配错误,该如何解决?
- 尝试使用Quarkus的JaCoCo扩展生成覆盖率文件,但未生成任何报告,推测是
test目录下无@QuarkusTest测试导致,该如何处理?
一、解决JaCoCo报告类不匹配问题
错误核心并非JDK版本不一致,而是Quarkus的fast-jar模式会对类文件做字节码重写/优化,导致运行时的类与编译输出的原始类结构不同。可通过以下两种方式解决:
方式1:指定JaCoCo使用Quarkus打包后的类文件
修改jacocoTestReport任务,让其指向fast-jar模式下的类文件位置(默认在build/quarkus-app/quarkus/目录),同时明确指定执行数据文件:
jacocoTestReport { mustRunAfter quarkusIntTest executionData file("$buildDir/jacoco/quarkusIntTest.exec") sourceSets sourceSets.main classDirs.setFrom(fileTree("$buildDir/quarkus-app/quarkus/").include("**/*.class")) reports { xml.required = true } }
方式2:禁用Quarkus测试时的字节码优化
在application.properties中添加配置,让Quarkus在集成测试阶段跳过类文件优化:
quarkus.test.bytecode-transformations.disabled=true
修改后重新执行测试与报告任务,即可使用编译输出的原始类文件生成报告。
二、解决Quarkus JaCoCo扩展不生成报告的问题
Quarkus JaCoCo扩展默认仅为test源集的测试生成覆盖率数据,需明确配置让其针对integrationTest源集生效:
1. 添加扩展依赖
确保build.gradle中包含Quarkus JaCoCo扩展:
implementation 'io.quarkus:quarkus-jacoco'
2. 配置集成测试任务启用JaCoCo
在build.gradle中为quarkusIntTest任务开启JaCoCo并指定输出文件:
quarkusIntTest { jacoco { enabled = true destinationFile = file("$buildDir/jacoco/quarkusIntTest.exec") } }
3. 配置扩展生成XML报告
在application.properties中添加报告相关配置,无需依赖Gradle的jacocoTestReport任务:
quarkus.jacoco.report.enabled=true quarkus.jacoco.report.formats=xml quarkus.jacoco.report.directory=${buildDir}/jacoco/reports
执行./gradlew clean quarkusIntTest后,即可在指定目录找到XML格式的覆盖率报告。
内容的提问来源于stack exchange,提问作者jaype

