使用dotnet test收集XPlat代码覆盖率时API项目未被纳入问题

针对你遇到的API项目未被纳入代码覆盖率报告的问题，结合整洁/洋葱架构的特点，整理几个常见原因和排查方案：

1. API测试项目的引用配置问题 #

虽然单元测试能正常运行，但测试项目对API项目的引用可能存在限制，导致覆盖率工具无法关联到API程序集。

• 检查API测试项目的.csproj文件，确保项目引用没有设置PrivateAssets="all"这类会隐藏程序集的属性：

  <!-- 正确的引用方式 -->
  <ProjectReference Include="..\YourAPI\YourAPI.csproj" />
  <!-- 避免这种可能导致覆盖率工具无法访问的配置 -->
  <ProjectReference Include="..\YourAPI\YourAPI.csproj" PrivateAssets="all" />
  

2. 覆盖率工具默认排除了Web项目 #

洋葱架构中API属于外层Web项目，部分覆盖率工具（如Coverlet）默认可能跳过输出类型为Exe的项目（Web API默认是自托管Exe类型）。

• 在API项目的.csproj中添加强制测试标记，让覆盖率工具识别它：

  <PropertyGroup>
    <IsTestable>true</IsTestable>
  </PropertyGroup>
  

3. 存在全局排除规则 #

检查项目根目录下的coverlet.runsettings或.runsettings文件，看是否有明确排除API项目的配置：

<!-- 排查是否有这类排除规则 -->
<Exclude>
  <Module>YourProject.API</Module>
  <Namespace>YourProject.API.*</Namespace>
</Exclude>

如果有，删除对应的排除项即可。

4. 测试命令/管道配置未包含API测试项目 #

• 本地执行dotnet test时，确保命令覆盖了API的测试项目，比如直接运行解决方案级命令：

  dotnet test YourSolution.sln --collect:"XPlat Code Coverage"
  

  避免只指定部分测试项目（比如只跑了领域层和应用层的测试）。
• Azure DevOps管道中，检查DotNetCoreCLI@2任务的projects参数，确保包含API测试项目：

  - task: DotNetCoreCLI@2
    inputs:
      command: 'test'
      projects: '**/*Tests*.csproj' # 匹配所有测试项目，包括API测试
      arguments: '--collect:"XPlat Code Coverage"'
  

快速验证步骤 #

1. 单独运行API测试项目的覆盖率收集命令，确认是否能生成包含API的报告：

   dotnet test Tests/Tests.API.csproj --collect:"XPlat Code Coverage"
   

2. 打开生成的coverage.cobertura.xml文件，搜索API项目的命名空间，确认是否有相关条目。

内容的提问来源于stack exchange，提问作者lokanath das