使用 TestContainers 进行数据库集成测试

在软件开发过程中，集成测试是至关重要的一环。它确保不同组件之间的协作正常，并验证系统在整体上的功能和性能。然而，传统的集成测试往往需要依赖于外部资源，如数据库、消息队列等，这给测试环境的搭建和维护带来了一定的挑战。
为了解决这个问题，我们可以使用 TestContainers 这个强大的开源工具。TestContainers 提供了一种简单而强大的方式来管理和运行容器化的测试环境。它支持多种容器化技术，如 Docker、Kubernetes 等，并且可以与各种编程语言和测试框架集成。

什么是 TestContainers？

TestContainers 是一个用于集成测试的开源工具，它的目标是简化集成测试中的容器管理。它提供了一套简洁的 API，可以轻松地创建、启动和销毁容器。通过使用 TestContainers，我们可以在测试中使用真实的容器化环境，而无需手动安装和配置外部资源。

TestContainers 的优势

使用 TestContainers 进行集成测试有以下几个优势：

1. 简化环境搭建
   TestContainers 可以自动下载和启动所需的容器镜像，无需手动安装和配置外部资源。这样，我们可以快速搭建测试环境，减少了环境搭建的时间和工作量。
2. 隔离性和可重复性
   每个测试用例都可以在独立的容器中运行，确保了测试的隔离性和可重复性。每次测试运行时，TestContainers 都会为每个测试用例创建一个新的容器实例，避免了测试之间的相互影响。
3. 真实环境测试
   通过使用真实的容器化环境，我们可以更准确地模拟生产环境，并进行真实环境下的集成测试。这有助于发现潜在的问题和缺陷，并提高系统的稳定性和可靠性。

使用 TestContainers

1. 引入 TestContainers 依赖
   首先，我们需要在项目中引入 TestContainers 的相关依赖。具体的依赖配置可以根据项目的需求和使用的编程语言进行调整。
   
2. 创建容器实例
   在测试用例中，我们可以使用 TestContainers 提供的 API 创建容器实例。可以根据需要选择合适的容器类型，如 PostgreSQL、MySQL、Redis 等。
3. 启动容器
   在测试开始前，我们需要启动容器。TestContainers 提供了简单的方法来启动容器，并等待容器完全启动。
4. 运行测试
   在容器启动后，我们可以在测试用例中使用容器提供的连接信息，如数据库连接字符串、端口号等。这样，我们可以在测试中使用真实的容器化环境进行集成测试。
   
   可以看到当测试运行的时候 TestContainers 会在容器环境内建立多个实例。
5. 销毁容器
   在测试结束后，我们需要销毁容器，释放资源。TestContainers 提供了相应的方法来销毁容器，并确保资源的正确释放。

示例

以下我们对常见的 Repositroy 进行一个单元测试。通常我们的单元测试是无法测试 Repostiory 的方法的，因为它直接原来数据库。

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Testcontainers.PostgreSql;
using Microsoft.EntityFrameworkCore;

namespace TestContainersTryRun.Tests
{
    [TestClass()]
    public class EfRepositoryTests
    {
        static PostgreSqlContainer _container = new PostgreSqlBuilder().WithImage("postgres:15.1").Build();

        [ClassInitialize]
        public static async Task ClassInitialize(TestContext context)
        {
            await _container.StartAsync();
        }

        [ClassCleanup]
        public static async Task ClassCleanup()
        {
            await _container.DisposeAsync();
            Console.WriteLine($"PostgreSqlContainer dispose");
        }

        [TestMethod()]
        public async Task AddTest()
        {
            // Arrange
            DbContext dbContext = new PostgresqlDbContext(_container.GetConnectionString());
            dbContext.Database.EnsureCreated();
            var repository = new EfRepository<User>(dbContext);

            // Act
            var user = new User { 
                Id = 1,
                Name = "Test",
                Email = "xx@xx.com",
                Password = "123456"
            };

            repository.Add(user);
            await repository.SaveAsync();

            // Assert
            var users = await dbContext.Set<User>().ToListAsync();
            Assert.AreEqual(1, users.Count);
            Assert.AreEqual(user.Id, users[0].Id);
        }
    }
}

使用 TestContainers 的时候可以轻而易举的对其进行测试。

总结

TestContainers 是一个强大而灵活的工具，可以帮助我们简化集成测试中的容器管理。通过使用 TestContainers，我们可以快速搭建测试环境，提高测试的隔离性和可重复性，并进行真实环境下的集成测试。
希望本文对你理解和使用 TestContainers 有所帮助！如果你对 TestContainers 感兴趣，可以查阅官方文档以获取更多详细信息和示例代码。
Happy testing with TestContainers！