Testcontainers-dotnet 中使用 MSSQL 容器的正确姿势

在使用 Testcontainers-dotnet 进行集成测试时，许多开发者会遇到一个常见问题：尝试在容器启动后立即连接 MSSQL 服务时，会遇到"pre-login handshake"错误。本文将深入分析这一问题的根源，并提供正确的解决方案。

问题现象分析

当开发者使用 Testcontainers-dotnet 的 MsSqlBuilder 创建容器时，可能会尝试在启动回调(startup callback)中立即建立数据库连接。这时通常会遇到类似以下的错误：

A connection was successfully established with the server, but then an error occurred during the pre-login handshake

这个错误表明虽然客户端能够连接到服务器，但在认证前的握手阶段出现了问题。有趣的是，在调试模式下运行时，有时连接能够成功建立，这暗示着这是一个与时机相关的问题。

问题根源

关键在于理解 Testcontainers-dotnet 的启动流程。startup callback 是在容器启动后立即执行的，但此时 MSSQL 服务可能尚未完全初始化并准备好接受连接。具体来说：

1. 容器启动命令执行
2. 触发 startup callback
3. 执行等待策略(Wait Strategies)

这意味着在 startup callback 中尝试连接时，数据库服务可能仍在启动过程中，尚未达到可用状态。

正确使用方法

正确的做法是将数据库初始化逻辑放在 StartAsync() 方法调用之后。因为 StartAsync() 方法会确保所有等待策略都完成，这意味着数据库服务已经完全启动并准备好接受连接。

以下是正确的代码示例：

[OneTimeSetUp]
public async Task OneTimeSetup() {
    _msSqlContainer = new MsSqlBuilder().Build();
    
    // 先确保容器完全启动
    await _msSqlContainer.StartAsync();
    
    // 现在可以安全地连接数据库
    string connectionString = _msSqlContainer.GetConnectionString();
    using var connection = new SqlConnection(connectionString);
    await connection.OpenAsync(cancellationToken);
    
    // 执行数据库初始化操作
    using var command = connection.CreateCommand();
    command.CommandText = "CREATE PROCEDURE dbo.TestProc AS BEGIN SELECT 1 END";
    await command.ExecuteNonQueryAsync(cancellationToken);
}

最佳实践建议

1. 分离容器启动和数据库初始化：将容器启动和数据库初始化逻辑分开，确保启动完成后再进行操作。

2. 使用等待策略：Testcontainers 提供了多种等待策略，可以确保服务真正可用后再继续执行测试。

3. 错误处理：添加适当的重试逻辑和错误处理，以应对可能的暂时性连接问题。

4. 资源清理：在测试完成后，确保正确清理和释放容器资源。

通过遵循这些实践，可以避免常见的连接时机问题，确保集成测试的稳定性和可靠性。Testcontainers-dotnet 是一个强大的工具，正确理解其生命周期和工作原理对于编写有效的测试至关重要。