xUnit.net v3 新增 CTRF 测试报告格式支持

xUnit.net 作为 .NET 生态中广受欢迎的单元测试框架，在其最新的 v3 版本中新增了对 CTRF（Common Test Results Format）报告格式的支持。这一功能为开发者提供了更加标准化和跨平台的测试结果输出方式。

CTRF 格式简介

CTRF 是一种通用的测试结果格式标准，旨在为不同测试框架提供统一的报告格式。相比传统的 XML 或 TRX 格式，CTRF 具有更好的跨平台兼容性和更简洁的结构设计。

实现细节

xUnit.net v3 通过其内置的 JSON 序列化器实现了 CTRF 格式的输出功能。在实现过程中，开发团队做了以下关键设计决策：

1. 环境信息增强：在报告的 environment 部分额外添加了运行测试的计算机名称、用户名等信息，并将每个测试程序集及其包含的测试集合作为"套件"列出。

2. 测试元数据扩展：在测试项的 extra 部分包含了测试 ID、所属测试集合 ID、CLR 类型和方法名称等详细信息。

3. 特殊标签处理：特别处理了名为 Category 的特性（Trait），将其放入标准的 tags 元素中，实现了与 NUnit 和 MSTest 中 [Category] 特性的兼容。

性能考量

从文件大小角度来看，各种报告格式的表现如下：

• XML v2 报告始终是最紧凑的格式
• HTML 和 CTRF 格式大小相近，通常比 XML v2 大 0-50%
• TRX 格式通常比 XML v2 大 200% 以上

这使得 CTRF 成为测试框架间交换数据时既标准又高效的格式选择。

使用方式

根据不同的测试运行方式，开发者可以通过以下方法生成 CTRF 报告：

1. 原生命令行运行：使用 -ctrf <filename> 参数
2. MSBuild 运行器：通过 <xunit> 任务的 Ctrf 属性指定
3. Microsoft.Testing.Platform：使用 --report-ctrf 参数（可配合 --report-ctrf-filename 指定文件名）

值得注意的是，原生运行器会生成包含所有测试程序集结果的单一 CTRF 报告，而 Microsoft.Testing.Platform 会为每个测试程序集生成单独的 CTRF 报告。

实际应用建议

对于在 CI/CD 流水线中使用 CTRF 报告的开发者，需要注意：

1. 当通过 dotnet test 命令运行时，需要使用 -- 分隔符来传递参数，例如：dotnet test -- --report-ctrf

2. 目前生成的 CTRF 文件采用 UTF-8 with BOM 编码，某些 Node.js 解析器可能需要额外处理才能正确读取

3. 该功能目前仅在 xUnit.net v3 中提供，不计划向后移植到 v2 版本

这一功能的加入使得 xUnit.net 能够更好地融入现代测试生态系统，为开发者提供了更多元化的测试结果处理选择。