Azure DevOps多代理下VSTest代码覆盖率文件收集及发布问题

问题根源排查 #

你当前遇到的问题核心原因有两个：

1. 路径不匹配：VSTest任务指定的结果目录是$(System.ArtifactsDirectory)\TestResults\，但后续发布任务的目标路径是$(build.ArtifactStagingDirectory)/TestResults，导致生成的.coverage文件无法被正确发布。
2. 并行任务无唯一标识：多代理并行运行时，若结果目录未做区分，可能出现文件覆盖或生成失败的情况。

分步解决方案 #

1. 修复覆盖率文件发布路径 #

修改PublishPipelineArtifact@1任务的targetPath，与VSTest的resultsFolder保持一致：

- task: PublishPipelineArtifact@1 
  displayName: 'Publish Artifact: Code Coverage'
  inputs:
    targetPath: '$(System.ArtifactsDirectory)\TestResults\'
    artifact: CodeCoverageResult

2. 确保并行代理生成独立的覆盖率文件 #

为每个并行任务的结果目录添加唯一标识（比如$(System.JobId)），避免文件冲突：

- task: VSTest@2
  displayName: 'Unit Tests'
  inputs:
    # 保留原有其他配置
    resultsFolder: '$(System.ArtifactsDirectory)\TestResults\$(System.JobId)'

同时确认自托管代理的服务账号拥有$(System.ArtifactsDirectory)目录的读写权限，防止因权限不足导致文件无法生成。

3. 合并所有代理的覆盖率文件 #

新增一个独立任务，待所有并行测试完成后，收集所有覆盖率文件并转换为Sonar Cloud支持的XML格式：

- job: Merge_Coverage_Files
  displayName: 'Merge Code Coverage Files'
  dependsOn: UnitTests_Execution
  condition: succeeded()
  pool:
    name: 'Self-Hosted Agent'
  
  steps:
    - checkout: none
    
    # 下载所有并行代理的覆盖率文件
    - task: DownloadPipelineArtifact@2
      displayName: 'Download All Coverage Artifacts'
      inputs:
        artifactName: CodeCoverageResult
        targetPath: '$(System.ArtifactsDirectory)/AllCoverageFiles'
    
    # 使用VS自带的CodeCoverage.exe合并并转换文件
    - script: |
        # 替换为你实际的VS版本路径，示例为VS2022 Enterprise
        set COVERAGE_EXE="C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Team Tools\Dynamic Code Coverage Tools\CodeCoverage.exe"
        
        # 遍历收集所有.coverage文件
        set COVERAGE_FILES=
        for /r "$(System.ArtifactsDirectory)/AllCoverageFiles" %%f in (*.coverage) do (
          set COVERAGE_FILES=!COVERAGE_FILES! "%%f"
        )
        
        # 先合并成单个.coverage文件，再转换成Sonar支持的XML格式
        %COVERAGE_EXE% merge /output:$(System.ArtifactsDirectory)/MergedCoverage.coverage %COVERAGE_FILES%
        %COVERAGE_EXE% analyze /output:$(System.ArtifactsDirectory)/MergedCoverage.xml $(System.ArtifactsDirectory)/MergedCoverage.coverage
      displayName: 'Merge & Convert Coverage Files'
    
    # 发布合并后的XML文件
    - task: PublishPipelineArtifact@1
      displayName: 'Publish Merged Coverage'
      inputs:
        targetPath: '$(System.ArtifactsDirectory)/MergedCoverage.xml'
        artifact: MergedCodeCoverage

4. 提交合并后的覆盖率到Sonar Cloud #

在Sonar Cloud分析任务中，引入合并后的XML文件：

- job: SonarCloud_Analysis
  displayName: 'Sonar Cloud Analysis'
  dependsOn: Merge_Coverage_Files
  condition: succeeded()
  pool:
    name: 'Self-Hosted Agent'
  
  steps:
    - checkout: self
      fetchDepth: 0
    
    - task: SonarCloudPrepare@1
      displayName: 'Prepare Sonar Analysis'
      inputs:
        SonarCloud: '你的SonarCloud服务连接名'
        organization: '你的组织名'
        projectKey: '你的项目Key'
        projectName: '你的项目名'
    
    # 下载合并后的覆盖率XML
    - task: DownloadPipelineArtifact@2
      displayName: 'Download Merged Coverage'
      inputs:
        artifactName: MergedCodeCoverage
        targetPath: '$(System.ArtifactsDirectory)/MergedCoverage'
    
    # 执行Sonar分析，工具会自动识别覆盖率XML
    - task: SonarCloudAnalyze@1
      displayName: 'Run Sonar Analysis'
    
    - task: SonarCloudPublish@1
      displayName: 'Publish Sonar Results'
      inputs:
        pollingTimeoutSec: '300'

额外说明 #

• 若使用.NET Core/.NET 5+项目，可改用dotnet-coverage工具，命令更简洁，无需依赖VS安装路径。
• 确认Sonar Cloud项目配置中，已启用覆盖率收集规则（默认支持**/coverage.xml或指定路径）。

内容的提问来源于stack exchange，提问作者sudalai muthukumar