TUnit框架中自定义断言的高级应用

理解TUnit断言扩展机制

TUnit测试框架提供了强大的断言扩展能力，允许开发者根据项目需求创建自定义断言。在Web API测试场景中，我们经常需要验证HTTP响应结果，特别是使用ASP.NET Core的TypedResults时，需要更专业的断言方式。

典型场景分析

在ASP.NET Core Minimal API开发中，TypedResults提供了类型化的HTTP响应结果。例如，我们可能有如下API端点返回Results<BadRequest, Ok<A>>类型的结果。测试这类API时，我们需要：

1. 验证返回的是否为Ok结果
2. 提取Ok结果中的值对象
3. 对值对象进行进一步断言

自定义断言实现方案

基础实现方式

最直接的方式是创建一个扩展方法，该方法接收结果源并返回解析后的值：

public static async Task<T?> IsOkValue<T>(this IValueSource<INestedHttpResult> valueSource)
{
    var nestedHttpResult = (await new InvokableValueAssertionBuilder<INestedHttpResult>(valueSource))!;
    var value = (await Assert.That(nestedHttpResult.Result).IsTypeOf<Ok<T>>())!.Value;
    return value;
}

这种方式虽然有效，但存在两个主要缺点：

1. 无法支持流畅的链式调用
2. 代码结构不够优雅

高级实现方案

更理想的实现方式是利用TUnit的断言构建器模式：

public class OkHttpResultAssertCondition<T> : BaseAssertCondition<INestedHttpResult>
{
    protected override string GetExpectation() => $"to be of result type {typeof(T).Name}";
    
    protected override ValueTask<AssertionResult> GetResult(
        INestedHttpResult? actualValue, 
        Exception? exception, 
        AssertionMetadata assertionMetadata)
    {
        var result = actualValue?.Result;
        return AssertionResult.FailIf(
            result is not Ok<T>, 
            $"{result} it is {result?.GetType().Name ?? "null"}");
    }
}

public class OkHttpResultAssertionBuilder<T> : InvokableValueAssertionBuilder<T>
{
    public OkHttpResultAssertionBuilder(InvokableAssertionBuilder<INestedHttpResult> assertionBuilder) 
        : base(assertionBuilder) {}
    
    public new TaskAwaiter<T?> GetAwaiter() => AssertType().GetAwaiter();
    
    private async Task<T?> AssertType()
    {
        var data = await ProcessAssertionsAsync();
        return ((data.Result as INestedHttpResult?)?.Result as Ok<T>)?.Value;
    }
}

public static class TypedResultsAssertionExtensions
{
    public static InvokableValueAssertionBuilder<T> IsOkValue<T>(
        this IValueSource<INestedHttpResult> resultSource)
    {
        return new OkHttpResultAssertionBuilder<T>(
            resultSource.RegisterAssertion(new OkHttpResultAssertCondition<T>(), []));
    }
}

这种实现方式更加模块化，支持流畅的链式调用，并且符合TUnit的设计哲学。

最佳实践建议

1. 遵循单一职责原则：每个自定义断言应该只做一件事
2. 提供清晰的错误信息：重写GetExpectation方法提供有意义的错误提示
3. 支持链式调用：确保自定义断言能与其他断言流畅组合
4. 类型安全：充分利用泛型提供类型安全的断言

实际应用示例

[Test]
public async Task MinimalEndpointTest()
{
    // Arrange
    var id = 1;

    // Act
    Results<BadRequest, Ok<A>> result = await MinimalEndpoints.GetA(id, TestContext.Current?.CancellationToken ?? default);

    // Assert
    var actual = await Assert.That(result).IsOkValue<ReportBase>();
    await Assert.That(actual).IsNotNull();
}

通过自定义断言，我们可以使测试代码更加简洁、表达性更强，同时保持类型安全和良好的错误报告能力。