Gradle多模块项目中sonarqube 6.2中的错误覆盖计算

Question

我目前正在使用一个具有良好覆盖范围的渐变多模块java项目和带有sonarJava插件的声纳库6.2 4.10.0.1026。我正在使用Gradle 4.0.1，声纳库插件2.5和哈科0.7.9！代码是爪哇 8。

由于 API 驱动的开发，API 测试在 API 项目中编写为抽象测试，并从为测试提供构造函数的实现项目中调用。

在sonarqube服务器上分析projekt时，正确测量了实施项目的覆盖率，但IMPL项目测试中包含的API项目覆盖率为0.0%。这些项目的覆盖率结果被忽略。

当简单地使用Jacoco插件时，我能够得到相同的行为。在做了一些研究后，我找到了一个解决方案来获得适当的Jacoco报告：

task codeCoverageReport(type: JacocoReport) {
  description "Creates a unified JaCoCo test report for the project."

  // Gather execution data from all subprojects
  // (change this if you e.g. want to calculate unit test/integration test coverage separately)
  executionData fileTree(project.rootDir.absolutePath).include("**/build/jacoco/*.exec")

  // Add all relevant sourcesets from the subprojects 
  subprojects.each {
    sourceSets it.sourceSets.main
  }

  reports {
    xml.enabled true
    html.enabled true
    html.destination file("${buildDir}/reports/jacoco")
    csv.enabled false
  }
}

// always run the tests before generating the report
codeCoverageReport.dependsOn {
  subprojects*.test
}

我目前的结果如下：

JaCoCo：

• JaCoCo（CODECOVERAGERPORT任务）
  • 73%的指令覆盖率
  • 91%的分行覆盖率
  < li>43.1%的线路覆盖率(计算中仅考虑约30%的线路！) < li>82.1%的条件覆盖率(仅覆盖约20%的条件！)

  因此，声纳的覆盖结果不可用。我读过一篇文章，宣布“sonar.jacoco.reportpath”-参数从sonar 6.2开始，我认为java analyzer 4.4或类似的东西。将此参数添加到我的gradle构建脚本时，脚本将不再编译。当通过sonar项目管理将jacoco.exec文件添加到sonar时，没有任何变化。

  如果有办法管理声纳来计算正确的覆盖范围，那就太好了。

Answer 1

我不确定我是否理解为什么只有一些项目有Jacoco而其他项目没有是一个问题。您可以使用Gradle的丰富API（例如TaskCollection和Project）来动态查找它们。

例如：

[':project1', ':project3', ':project5'].each {
    project(it) {
        apply plugin: 'java'
        apply plugin: 'jacoco'
    }
}

project(':merger') {
    Collection<Project> jacocoProjects = allprojects.findAll { it.plugins.hasPlugin('jacoco' }
    evaluationDependsOn jacocoProjects 

    task jacocoMerge(type: JacocoMerge) {
        dependsOn jacocoProjects*.tasks.withType(Test)
        executionData jacocoProjects*.tasks.withType(Test)
    }

    task mergedReport(type: JacocoReport) {
        dependsOn jacocoMerge
        executionData jacocoMerge.destinationFile
        sourceDirectories.add(files(jacocoProjects*.sourceSets*.java.srcDirs))
        classDirectories.add(files(jacocoProjects*.sourceSets*.output.classesDir))
    }
}

Answer 2

如果您的测试与要报告覆盖范围的源位于不同的项目中，则需要设置其他源Dirs和额外的ClassDirs。例如：

evaluationDependsOn ':foo' 
task codeCoverageReport(type: JacocoReport) {
    additionalSourceDirs.add project(':foo').sourceSets.main.java.sourceDirectories
    additionalClassDirs.add project(':foo').sourceSets.main.output.classesDirs
    // etc
} 

Answer 3

Thx @Lance Java！他向我推荐了一个比下面更干净的解决方案。如果所有子项目都有jacoco报告，这也可以。如果像我一样，只有几个项目的报告，原始解决方案似乎更好。

apply plugin: 'base'
apply plugin: 'org.sonarqube'
[...]
allprojects {
  apply plugin: 'java'
  apply plugin: "jacoco"
  [...]
  test {
    [...]
    jacoco {
      append=true
    }
  }
}
[...]
task jacocoMerge( type: JacocoMerge ) {
  dependsOn( subprojects.jacocoTestReport.dependsOn )
  mustRunAfter( subprojects.jacocoTestReport.mustRunAfter )
  destinationFile = file( "${buildDir}/jacoco/mergedTests.exec" )
  executionData = files( subprojects.jacocoTestReport.executionData )
                       .filter { jacocoReportFile -> jacocoReportFile.exists() }
}
tasks.sonarqube.dependsOn jacocoMerge
[...]
sonarqube {
  properties {
    [...]
    property "sonar.jacoco.reportPath", "${buildDir}/jacoco/*.exec"
  }
}

原答复：

需要一些时间才能设法获得声纳的正确覆盖数据。有多个问题需要解决。有时声纳会丢失对类别中雅各科变化的跟踪，因此测试需要参数：

append=true

这并没有完成所有的工作。收集跨项目覆盖范围仍然存在问题。因此，最好的解决方案是强制Jacoco将覆盖范围数据写入单个. exec文件并将其交给声纳。

最终解决方案如下：

apply plugin: 'base'
apply plugin: 'org.sonarqube'
[...]
allprojects {
  apply plugin: 'java'
  apply plugin: "jacoco"
  [...]
  test {
    [...]
    jacoco {
      append=true
      destinationFile = file( "${rootProject.buildDir}/jacoco/jacocoTest.exec" ) 
    }
  }
}
[...]
sonarqube {
  properties {
    [...]
    property "sonar.jacoco.reportPath", "${buildDir}/jacoco/*.exec"
  }
}

现在声纳有了我的项目的正确覆盖数据。添加一些额外的测试后，结果如下:

< li >总覆盖率91.6% < li >线路覆盖率91.7% < li >条件覆盖率91.3% < li >未覆盖的线36 < li >未覆盖的条件11 < li >覆盖433的线条 < li >单元测试1，114 < li >单元测试错误0 < li >单元测试失败0次 < li >跳过了单元测试0 < li >单元测试成功(%) 100.0% < li >单元测试持续时间4s

希望这能帮助你们中的一些人…；）