TUnit项目中动态测试生成与源码生成器的协同工作

在自动化测试领域，动态生成测试用例是一项非常有价值的技术，可以显著减少重复代码的编写。本文探讨了在TUnit测试框架中如何解决源码生成器(Source Generator)与动态测试生成(BuildTests)之间的协同工作问题。

问题背景

当开发人员尝试使用源码生成器自动生成包含BuildTests方法的测试代码时，发现TUnit框架无法发现这些生成的测试方法。这是因为TUnit自身也使用源码生成技术，而Roslyn编译器在设计上有意禁止不同源码生成器之间相互分析生成的代码。

技术原理

Roslyn编译器的源码生成器执行机制决定了：

1. 源码生成器之间是隔离的，无法看到其他生成器产生的代码
2. 生成顺序由编译器控制，无法保证特定顺序
3. 这种设计确保了生成过程的确定性和可靠性

解决方案

经过技术讨论，确定了以下两种可行的解决方案：

代理方法模式

通过将关键部分保留在手工编写的代码中，让生成器只负责实现细节：

// 手工编写部分
public partial sealed class Basic
{
  [DynamicTestBuilder]
  public void BuildTests(DynamicTestBuilderContext context) =>
    GeneratedBuildTests(context);
}

// 生成器生成部分
partial class Basic
{
  private void GeneratedBuildTests(DynamicTestBuilderContext context)
  {
    // 生成的动态测试逻辑
  }
}

分部方法模式

利用C#的分部方法特性，将方法声明和实现分离：

// 手工编写部分
public partial sealed class Basic
{
  [DynamicTestBuilder]
  partial void BuildTests(DynamicTestBuilderContext context);
}

// 生成器生成部分
partial class Basic
{
  partial void BuildTests(DynamicTestBuilderContext context)
  {
    // 生成的动态测试逻辑
  }
}

实现要点

1. 关键注解保留：必须确保[DynamicTestBuilder]等TUnit相关注解保留在手工编写的代码中
2. 访问级别控制：根据实际需要选择适当的访问修饰符(private/partial等)
3. 代码组织：合理划分手工编写部分和生成部分，保持代码清晰

技术展望

TUnit团队正在开发基于反射的扫描方案，这将提供另一种解决方案，但需要注意性能考量。当前动态测试生成功能仍处于预览状态，开发者应关注其稳定性。

最佳实践建议

1. 优先考虑使用分部方法模式，它更符合C#的设计哲学
2. 对于复杂场景，可以采用代理方法模式提供更多灵活性
3. 注意将框架相关注解保留在手工代码中
4. 合理组织生成代码结构，便于维护

通过这种模式，开发者可以充分利用源码生成器的自动化优势，同时确保TUnit框架能够正确识别和执行生成的动态测试用例，实现高效的自动化测试开发。