VerifyTests/Verify 项目中使用 Fixie 测试框架的配置指南

背景介绍

VerifyTests/Verify 是一个流行的 .NET 测试验证库，它提供了强大的快照测试功能。当与 Fixie 测试框架结合使用时，需要进行特定的配置才能正常工作。本文将详细介绍如何正确配置 Verify 与 Fixie 的集成，特别是在 F# 项目中的实现方式。

核心问题

在集成 Verify 和 Fixie 时，开发者可能会遇到"未找到状态"的错误提示，这是因为缺少了必要的配置类。这个配置类需要继承自 VerifyTestProject 并实现特定的接口。

解决方案

基本配置结构

在 F# 项目中，我们需要创建一个测试项目类来实现必要的接口。以下是完整的配置示例：

module Tests.XmlDocFormatterTests

open Fixie
open System
open System.Collections.Generic
open System.Reflection

[<AttributeUsage(AttributeTargets.Method)>]
type TestAttribute() =
    inherit Attribute()

type TestModuleDiscovery() =
    interface IDiscovery with
        member this.TestClasses(concreteClasses: IEnumerable<Type>) =
            concreteClasses
            |> Seq.filter (fun cls ->
                cls.GetMembers() |> Seq.exists (fun m -> m.Has<TestAttribute>())
            )

        member this.TestMethods(publicMethods: IEnumerable<MethodInfo>) =
            publicMethods |> Seq.filter (fun x -> x.Has<TestAttribute>() && x.IsStatic)

type TestProject() =
    interface ITestProject with
        member _.Configure(configuration: TestConfiguration, environment: TestEnvironment) =
            VerifyTests.VerifierSettings.AssignTargetAssembly(environment.Assembly)
            configuration.Conventions.Add<TestModuleDiscovery, TestProject>()

    interface IExecution with
        member _.Run (testSuite : TestSuite) =
            task {
                for testClass in testSuite.TestClasses do
                    for test in testClass.Tests do
                        use _ = VerifyFixie.ExecutionState.Set(testClass, test, null)
                        let! _ = test.Run()
                        ()
            }

关键组件解析

1. TestAttribute: 自定义测试方法标记属性，用于标识哪些方法是测试方法。

2. TestModuleDiscovery: 实现测试发现逻辑，确定哪些类和方法应该被视为测试。

3. TestProject: 核心配置类，实现了两个关键接口：

   • ITestProject: 配置测试项目和验证设置
   • IExecution: 控制测试执行流程，特别是为 Verify 设置执行状态

测试方法示例

配置完成后，可以编写使用 Verify 的测试方法：

open System.Threading.Tasks
open VerifyFixie

[<Test>]
let ShouldAddTask() : Task =
    Verifier.Verify("something").ToTask()

注意事项

1. 执行状态管理: ExecutionState.Set 的调用至关重要，它为 Verify 提供了必要的上下文信息。

2. 异步测试: 测试方法需要返回 Task 类型以支持异步操作。

3. 程序集指定: AssignTargetAssembly 确保 Verify 知道在哪个程序集中查找测试。

总结

通过实现上述配置，开发者可以在 F# 项目中成功集成 Verify 和 Fixie，利用 Verify 的强大验证功能进行快照测试。关键在于正确设置测试项目类并管理执行状态，这为 Verify 提供了必要的上下文信息来执行验证操作。

这种配置方式不仅解决了初始的错误问题，还为项目提供了灵活且强大的测试能力，特别是在需要验证复杂输出或维护测试一致性的场景中。