在 Azure DevOps Server 2020 中优化 C# 代码覆盖率收集和发布

Question

我们使用以下命令行（或多或少）收集管道中的 C# 代码覆盖率：

dotnet test --no-build -l trx -r TheResultsDir --collect "Code coverage" -s  CodeCoverage.runsettings

（我们实际上为此使用了内置的DotNetCoreCLI@2 任务）

这会产生一堆.coverage 文件。我们想和他们做两件事：

1. 发送到我们的 SonarQube 服务器
2. 使用PublishCodeCoverageResults@1 任务在构建本身上发布。

事实证明（惊喜，惊喜），生成的 .coverage 文件只有 VS IDE 才能理解。

像往常一样 - 互联网来救援。我们发现：

1. 使用Microsoft.CodeCoverage 工具，我们可以将.coverage 文件转换为SonarQube 可以理解的.xml，而不是PublishCodeCoverageResults@1 任务。
2. 使用reportgenerator 工具，我们可以将.xml 文件从(1) 转换为PublishCodeCoverageResults@1 任务可以理解的Cobertura 格式

这就是我们所做的，它适用于小型项目。但是，现在我们将代码覆盖率引入我们的大型单体应用程序（叹气，helas - 一切都是真的），而且时间很糟糕。对于一种解决方案（多种解决方案）：

1. 从.coverage 转换为.xml 大约需要20 分钟。
2. 从.xml 转换为 Cobertura - 2h 33m。

所以，这真的很糟糕。

如果我想同时发送到 SQ 并发布到构建，是否有更好的解决方案？

这是我们使用的实际代码：

从.coverage 到.xml

CodeCoverage.exe analyze /output:CoverageResult.xml CoverageResult.coverage

（.coverage文件有好几个，所以对每个都应用命令）

从.xml 到 Cobertura

reportgenerator.exe -reports:CoverageResults\*.xml -targetdir:CoberturaReport -reporttypes:Cobertura

发布构建

  - task: PublishCodeCoverageResults@1
    displayName: Publish Coverage Results
    inputs:
      codeCoverageTool: Cobertura
      summaryFileLocation: CoberturaReport/Cobertura.xml
      failIfCoverageEmpty: true

通过标准 SQ 任务发布到 SonarQube：

1. 准备 SQ 分析
2. 运行 SQ 分析
3. 发布 SQ 分析

准备任务是：

  - task: SonarQubePrepare@4
    displayName: Prepare CI SQ Analysis
    inputs:
      SonarQube: SonarQube
      scannerMode: MSBuild
      projectKey: $(SonarQubeProjectKey)
      projectName: $(SonarQubeProjectName)
      projectVersion: $(SonarQubeProjectVersion)
      extraProperties: |
        sonar.cs.vscoveragexml.reportsPaths=$(Common.TestResultsDirectory)\vstest-coverage\*.xml
        sonar.cs.nunit.reportsPaths=$(Common.TestResultsDirectory)\tests\*.TestResult.xml
        sonar.inclusions=**/*.cs
        sonar.branch.name=$(SonarQubeSourceBranch)
        sonar.scm.disabled=true

Answer 1

理想情况下，我想找到一种完全消除 Cobertura 转换的方法。如果可以直接发布 .coverage 文件就好了。

这是 Azure devops 上的 known issue。现在，AFAIK，没有这样的开箱即用方式来消除 Cobertura 转换。目前唯一的办法是使用reportgenerator工具将测试结果转换为Cobertura格式。

那是因为发布代码覆盖结果任务仅支持覆盖结果格式，例如 Cobertura 和 JaCoCo。并且目前只支持.coverage文件的下载链接。

此外，此问题已在此链接的早期建议票中提交：

support vstest .coverage "code coverage" build results tab

此功能请求在路线图上，相信很快就会发布，您可以关注此线程以了解其最新反馈。