Kotlin Gradle项目SonarCloud与Jacoco覆盖率报告不一致排查

1. SonarCloud是否具备自行计算覆盖率的能力？ #

SonarCloud不具备自行计算代码覆盖率的能力，它完全依赖Jacoco、Cobertura这类外部覆盖率工具生成的报告来展示数据。你看到的结果和本地Jacoco不符，通常是以下原因导致：

• SonarCloud未正确读取到你指定的Jacoco报告文件
• CI流程中报告生成环节出错，导致Sonar读取了旧报告或空报告
• SonarCloud的项目配置覆盖了Jacoco的排除规则，统计了不该被统计的文件

2. 如何让Jacoco覆盖率报告与SonarCloud的结果匹配？ #

按以下步骤排查和修复：

（1）确保CI流程的任务顺序正确 #

在CircleCI的config.yml中，必须保证先执行测试并生成Jacoco报告，再运行Sonar分析任务，不能颠倒顺序或并行执行。示例流程：

jobs:
  build-and-test:
    steps:
      - checkout
      - run: ./gradlew test jacocoTestReport
      - store_artifacts:
          path: build/reports/jacoco/test
      - run: ./gradlew sonar

（2）同步Jacoco与SonarCloud的排除规则 #

Jacoco的排除规则不会自动同步到SonarCloud，需要在build.gradle.kts的Sonar配置中重复设置排除项，避免Sonar统计被Jacoco排除的文件：

sonar {
    properties {
        // 指定使用Jacoco作为覆盖率插件
        property("sonar.java.coveragePlugin", "jacoco")
        // 明确指定Jacoco报告路径（和本地生成路径一致）
        property("sonar.jacoco.reportPaths", "${layout.buildDirectory.get()}/reports/jacoco/test/jacocoTestReport.xml")
        // 同步Jacoco的排除规则到Sonar
        property("sonar.exclusions", "**/generated/**,**/some/package/**,**/YourExcludedClass.kt")
    }
}

同时检查Jacoco自身的排除配置是否生效，确保本地生成的报告中确实不含被排除的文件：

tasks.jacocoTestReport {
    dependsOn(tasks.test)
    reports {
        xml.required.set(true) // 必须开启XML报告，Sonar依赖该格式
        html.required.set(true)
    }
    afterEvaluate {
        classDirectories.setFrom(files(classDirectories.files.map {
            fileTree(it) {
                // 这里是Jacoco的排除规则
                exclude("**/generated/**", "**/some/package/**")
            }
        }))
    }
}

（3）验证CI中生成的报告正确性 #

在CircleCI的任务界面，找到store_artifacts环节下载jacocoTestReport.xml，检查：

• 报告中是否包含被排除的类（如果有，说明Jacoco配置在CI中未生效）
• 报告中的覆盖率数值是否和本地生成的一致（如果不一致，说明CI的测试执行有差异，比如缓存问题）

（4）检查SonarCloud项目配置 #

登录SonarCloud，进入项目的「Administration → General Settings → Analysis Scope」，确保：

• 未在Sonar端额外添加需要统计的文件
• 报告路径配置和build.gradle.kts中的一致，没有冲突

（5）确保依赖版本兼容 #

• 使用兼容的Jacoco版本（建议0.8.8+），适配Kotlin编译
• 确保Sonar Kotlin插件版本与项目的Kotlin版本匹配

内容的提问来源于stack exchange，提问作者Lavínia Beghini