SonarQube集成C# xUnit测试项目时测试覆盖率显示为0如何解决

确认扫描执行顺序正确 #

.NET项目的Sonar扫描必须严格按照三步顺序执行，顺序错误会直接导致覆盖率采集失败：

• 第一步：项目根目录执行扫描启动命令，必须提前指定opencover格式报告的读取路径，示例命令：

  dotnet sonarscanner begin /k:"你的项目唯一标识" /d:sonar.login="你的Sonar访问令牌" /d:sonar.host.url="你的Sonar服务地址" /d:sonar.cs.opencover.reportsPaths="**/coverage.opencover.xml"
  

• 第二步：执行构建、测试、覆盖率采集全流程，不要在这一步之前提前跑测试，示例命令：

  dotnet test --collect:"XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=opencover
  

  SonarQube的C#扫描插件默认只识别opencover格式的覆盖率报告，不要生成其他格式（比如纯xml、cobertura早期版本）的报告，否则无法解析。

• 第三步：执行扫描结束命令，上传所有构建、测试、覆盖率数据到Sonar服务：

  dotnet sonarscanner end /d:sonar.login="你的Sonar访问令牌"
  

检查覆盖率文件是否正常生成 #

测试命令执行完成后，逐层进入测试项目下的TestResults文件夹，确认是否存在有效coverage.opencover.xml文件：

• 如果文件不存在：
  • 检查测试项目是否安装了兼容当前.NET SDK版本的coverlet.collector、coverlet.msbuild NuGet包，版本过低会导致采集失败
  • 检查所有需要统计覆盖率的项目（含业务项目、测试项目）的csproj配置，在PropertyGroup节点下确认DebugType配置为portable或者full，如果配置为none会直接阻断覆盖率采集：

    <DebugType>portable</DebugType>
    

  • 查看测试命令的执行日志，有没有coverlet组件抛出的找不到PDB文件、找不到目标程序集的报错，按报错提示修复路径问题即可
• 如果文件存在：
  • 先看文件大小，如果只有几KB说明是空报告，没有采集到有效覆盖率数据，优先检查项目构建是否完整、有没有正常还原依赖
  • 打开xml文件，确认文件内是否包含业务项目的程序集覆盖率节点，如果只有测试项目本身的节点，说明构建时业务项目的PDB文件没有输出到测试运行目录，重新清理解决方案后全量构建即可

检查Sonar侧配置兼容性 #

• 确认SonarQube服务端安装了对应版本的SonarC#插件，插件版本和本地使用的dotnet-sonarscanner工具版本差不要超过2个大版本，版本不兼容会导致覆盖率文件解析失败
• 核对扫描启动命令里的sonar.cs.opencover.reportsPaths路径配置是否正确，支持通配符匹配，如果不确定路径是否正确，可以先写绝对路径做验证，确认能读到文件后再换回相对路径
• SonarQube 9.0及以上版本不要同时配置旧版的sonar.cs.vscoveragexml.reportsPaths、sonar.cs.dotcover.reportsPaths这类其他覆盖率工具的路径参数，多参数冲突会导致覆盖率解析异常
• 确认使用的Sonar访问令牌有分析结果上传权限，权限不足时服务端会静默丢弃覆盖率数据，不会抛出显性错误

排查特殊场景问题 #

• 如果项目配置了多目标框架（TargetFrameworks指定了多个版本），跑测试和扫描时要指定同一个框架版本，否则会出现覆盖率文件记录的程序集和扫描的程序集不匹配的问题
• CI/CD流水线中不要做路径映射，比如容器内运行时把代码挂载到和本地构建不一致的路径下，会导致覆盖率文件里记录的源码路径、程序集路径和Sonar扫描时读取的路径不一致，最终解析出的覆盖率为0
• 检查项目的排除规则配置（sonar.exclusions），不要误把业务代码路径加入排除列表，比如不要配置**/*.cs这类全量过滤规则。

内容的提问来源于stack exchange，提问作者Chathu.Thanthrige