C#怎么使用Verify快照测试_C#自动化快照验证测试教程【实战】

酷伟大大_6233

酷伟大大_6233

2026-05-13

935人浏览

原创

verify 必须在 mstest/xunit/nunit 的测试方法中 await 调用,依赖测试上下文和生命周期,否则抛出“no test context found”异常;默认仅序列化 public 属性,快照文件需提交至 git,.received 文件应被忽略。

c#怎么使用verify快照测试_c#自动化快照验证测试教程【实战】

Verify 不是“配置完就能跑”的快照库,它依赖测试框架的生命周期和输出路径约定;不显式调用 Verify 方法、不处理 .received 文件、不启用差异工具,就等于没真正用起来。

Verify 必须配合 MSTest/xUnit/NUnit 的 TestMethod 才能工作

Verify 本身不运行测试,它只是在测试执行过程中介入断言环节。如果你把它当成普通工具类直接调用(比如在控制台 Main 里写 await Verify(myObj)),会抛出 InvalidOperationException: No test context found。

  • 必须在标记了 [TestMethod](MSTest)、[Fact](xUnit)或 [Test](NUnit)的方法体内调用 Verify
  • Verify 会自动读取当前测试方法的全名(如 PrimeServiceTests.IsPrime_ReturnsTrueFor7)生成快照文件名,路径默认为 __snapshots__/IsPrime_ReturnsTrueFor7.verified.txt
  • 首次运行时,Verify 只生成 .verified.*,不会失败;后续运行若内容不一致,则生成 .received.* 并让测试失败

Verify 需要显式 await,且返回值不能丢弃

Verify 的核心方法(如 Verify(object)、Verify(string))全部返回 Task,不是同步 void 方法。忽略 await 或用 void 声明测试方法,会导致测试提前结束、快照未写入、结果不可靠。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • 错误写法:Verify(myModel); // 编译通过但快照不生效
  • 正确写法:await Verify(myModel);
  • MSTest 中必须把测试方法声明为 public async Task MyTest(),不能是 void
  • xUnit 同理,[Fact] 方法必须返回 Task

Verify 默认只序列化 public 属性,private/field 不进快照

Verify 使用 System.Text.Json(.NET 6+)或 Newtonsoft.Json(旧版)做序列化,默认行为是只导出 public getter 属性。如果你的对象有 [JsonIgnore]、[XmlIgnore] 或自定义 converter,快照会静默跳过这些成员——但你可能根本没意识到。

  • 验证方式:打开生成的 .verified.json,确认字段是否齐全;若缺,检查属性访问修饰符和序列化特性
  • 想包含 private 字段?需手动注册自定义 JsonSerializerOptions,传给 VerifySettings,再传入 Verify 调用
  • 枚举默认输出名称("Active"),不是数值;如需数值,得配 JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter(JsonNamingPolicy.CamelCase, false))

快照文件不进 Git 就失去意义,但 .received 文件必须被忽略

Verify 的可靠性建立在「已提交的 .verified.* 是权威基准」之上。如果团队成员各自本地生成快照却不提交,或者误把 .received.* 提交了,整个机制就崩了。

  • 必须把 __snapshots__/ 目录加入 Git(不要加 **/__snapshots__/**/.received.*)
  • 推荐在项目根目录的 .gitignore 里加一行:**/__snapshots__/**/*.received.*
  • CI 环境(如 GitHub Actions)跑 Verify 测试前,务必确保 __snapshots__/ 已拉取最新 —— 否则会因找不到 .verified.* 直接报错

最常被跳过的其实是 dotnet verify CLI 工具的初始化:不运行 dotnet tool install -g Verify.Tools,就没法用命令行一键接受变更;不配 IDE 插件(Rider/ReSharper),就只能靠改文件名来“更新快照”,极易出错。快照测试的威力不在写法多炫,而在整个链路是否闭环 —— 从生成、比对、差异查看到合入基准,缺一不可。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

972

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

2771

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

865

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2615

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

312

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

389

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

611

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

329

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习