Verify与ApprovalTests对比：技术选型指南

Verify与ApprovalTests对比：技术选型指南

Verify Verify - 一个快照工具，用于简化复杂数据模型和文档的断言，适合从事自动化测试和持续集成/持续部署(CI/CD)的程序员。 项目地址: https://gitcode.com/gh_mirrors/ve/Verify

引言

在单元测试领域，快照测试（Snapshot Testing）是一种验证代码输出是否与预期一致的常用技术。Verify和ApprovalTests都是.NET生态中实现快照测试的流行工具。本文将深入分析这两个工具的差异，帮助开发者做出合理的技术选型。

核心概念

快照测试的基本原理是将被测代码的输出结果与预先存储的"正确"结果（快照）进行比对。当测试运行时，系统会生成新的结果文件，并与已有的快照文件进行比较，以此判断测试是否通过。

功能对比

1. 文件输出机制

ApprovalTests 每个测试方法只能生成一个快照文件，这在处理复杂输出时显得不够灵活。

Verify 支持单个测试方法生成多个快照文件，例如测试网页时可以同时输出PNG图片和HTML源码，大大增强了测试的灵活性。

2. 扩展性设计

ApprovalTests 主要通过包装顶层API实现扩展，这种方式限制了扩展的可能性。

Verify 在设计时就考虑了扩展性，提供了多种扩展点：

• 比较器(Comparers)：自定义对象比较逻辑
• 文件命名(File naming)：自定义快照文件命名规则
• 转换器(Converters)：处理不同类型对象的序列化

3. 对象序列化

Verify 内置支持通过Json.net验证任何对象，无需额外配置，而ApprovalTests在这方面的能力相对有限。

4. 调试符号依赖

ApprovalTests 依赖堆栈跟踪和调试符号信息，要求测试程序集必须启用符号且不能优化。

Verify 完全不依赖这些信息，可以在Release模式下正常运行测试。

5. 异步支持

Verify 默认采用异步API设计，避免了文件系统和剪贴板访问可能导致的IO阻塞问题，提高了测试执行效率。

6. 配置方式

ApprovalTests 主要通过特性(Attribute)进行配置。

Verify 采用显式的代码API和约定(Convention)进行配置，更加灵活直观。

7. 差异对比工具

Verify 默认在验证失败时自动调用差异对比工具显示差异。

ApprovalTests 需要显式通过特性启用此功能。

迁移指南

如果你正在考虑从ApprovalTests迁移到Verify，可以按照以下步骤操作：

1. 确定快照管理策略
2. 移除所有ApprovalTests相关的NuGet包
3. 添加对应测试框架的Verify包（如Verify.Xunit、Verify.NUnit等）
4. 临时添加Verify.ApprovalTestsTransition包，它提供了兼容API和迁移指导
5. 修复所有过时API的警告
6. 移除过渡包
7. 删除所有*.approved.*文件
8. 运行测试并接受所有*.verified.*文件

技术选型建议

选择Verify的情况：

• 需要更灵活的扩展能力
• 项目使用异步编程模型
• 需要验证复杂对象结构
• 希望在Release模式下运行测试
• 需要更直观的差异对比体验

选择ApprovalTests的情况：

• 已有大量基于ApprovalTests的测试代码
• 项目对特性(Attribute)驱动配置有偏好
• 需要特定的ApprovalTests独有功能

总结

Verify作为ApprovalTests的现代替代方案，在扩展性、异步支持和开发体验等方面都有显著改进。对于新项目，特别是需要高度定制化和复杂验证的场景，Verify通常是更好的选择。而对于已有大量ApprovalTests测试的现有项目，可以根据实际情况决定是否迁移。

Verify Verify - 一个快照工具，用于简化复杂数据模型和文档的断言，适合从事自动化测试和持续集成/持续部署(CI/CD)的程序员。 项目地址: https://gitcode.com/gh_mirrors/ve/Verify