TestContainers.DotNet 中 MsSqlContainer 的错误处理增强方案

在使用 TestContainers.DotNet 进行集成测试时，开发人员经常会遇到 MsSqlContainer 执行 SQL 脚本时缺乏明确错误反馈的问题。本文将深入分析这一痛点，并提出一种优雅的解决方案。

问题背景

TestContainers.DotNet 是一个用于 .NET 的测试容器库，它允许开发人员在测试环境中轻松启动和管理 Docker 容器。其中 MsSqlContainer 是专门为 SQL Server 设计的容器类型，提供了 ExecScriptAsync 方法来执行 SQL 脚本。

然而，当前实现存在一个明显的缺陷：当 SQL 脚本执行失败时，ExecScriptAsync 方法会静默失败，仅返回一个包含错误码和错误信息的 ExecResult 对象，而不会抛出异常。这种设计使得开发人员在编写集成测试时难以立即发现和定位问题。

技术痛点分析

静默失败的设计模式在测试场景中会带来几个显著问题：

1. 调试困难：开发人员需要手动检查 ExecResult 的 ExitCode 和 Stderr 属性才能发现错误
2. 测试反馈延迟：错误可能被掩盖，直到后续测试步骤失败才会被发现
3. 代码冗余：需要在每个 ExecScriptAsync 调用后添加错误检查逻辑

解决方案设计

我们可以通过扩展方法的方式为 ExecScriptAsync 添加错误抛出功能，核心设计如下：

public static async Task<ExecResult> ThrowOnError(this Task<ExecResult> task)
{
    var result = await task;
    if (result.ExitCode != 0)
    {
        throw new Exception(result.Stderr);
    }
    return result;
}

这个扩展方法具有以下特点：

1. 非侵入式：不影响现有代码，仅在需要时通过方法链式调用
2. 即时反馈：遇到错误立即抛出异常，包含详细的错误信息
3. 保持流畅性：仍然返回 ExecResult，支持进一步处理

使用示例

在实际测试代码中，可以这样使用增强后的方法：

await connection.ExecScriptAsync($"""
                                  CREATE TABLE {table} (
                                    Id int NOT NULL PRIMARY KEY IDENTITY(1, 1),
                                    Data varchar(8001)
                                  );
                                  """).ThrowOnError();

当执行出现错误时（如上述示例中的列大小超出限制），会立即抛出包含详细错误信息的异常：

System.Exception: Msg 131, Level 15, State 2, Server 85186a74865e, Line 3
The size (8001) given to the column 'Data' exceeds the maximum allowed for any data type (8000).

技术实现考量

1. 异常类型选择：当前使用基类 Exception，实际项目中可以考虑派生更具体的异常类型
2. 错误信息处理：可以进一步格式化 SQL Server 的错误输出，使其更易读
3. 性能影响：异步方法设计确保不会阻塞调用线程
4. 兼容性：与现有代码完全兼容，不影响不使用此扩展的调用方

最佳实践建议

1. 在测试初始化代码中统一使用 ThrowOnError 确保环境正确设置
2. 考虑将扩展方法放在测试基础设施项目中集中管理
3. 对于生产代码中的类似需求，可以设计更丰富的错误处理策略
4. 结合日志系统记录详细的执行信息，便于问题追踪

总结

通过这个简单的扩展方法，我们显著提升了 TestContainers.DotNet 中 MsSqlContainer 的错误处理能力，使集成测试更加健壮和易于维护。这种设计模式也可以推广到其他容器类型的类似场景中，为 .NET 测试容器生态提供更完善的开发体验。