跳转到主要内容

VillageSQL is a drop-in replacement for MySQL with extensions.

All examples on this page work on VillageSQL. Install Now →
模拟数据库驱动可以让测试跑得很快,但它只能返回您让它返回的内容。它无法强制执行唯一约束、无法拒绝违反严格模式的值,也无法应用您真实的架构。Testcontainers 为测试启动一个真实的、用完即弃的 MySQL 容器,并在测试结束后删除它,因此测试运行所针对的服务器与您的应用程序在生产环境中所针对的服务器相同。

Testcontainers 如何融入测试套件

Testcontainers 是一个库,不是一个单独的服务。它与您的机器或 CI 运行器上已经运行的 Docker 守护进程通信,在测试主体运行前启动一个容器,等到容器真正准备好接受连接,并在测试结束时把它拆除。每个测试(或每个测试文件,取决于您如何划分范围)都有自己的容器,因此测试之间不共享状态,也不需要一个必须有人记得重置的共享测试数据库。 本指南使用 Go 和官方的 testcontainers-go MySQL 模块,因为 Go 的 testing 包让容器的生命周期易于完整展示。Testcontainers 为 Java、Python 和 Node.js/TypeScript 提供了等效的模块;设置因语言而异,但模式(启动容器、等待就绪、加载架构、运行测试、拆除)是相同的。

项目设置

这会把 testcontainers-go 本身作为 MySQL 模块的传递依赖拉取进来,同时拉取测试用来实际连接和运行查询的 go-sql-driver/mysql 驱动。

架构和被测代码

一个带有值得测试的约束的最小架构:
以及一个使用标准库 database/sql、带有两个方法的小型数据访问层:
这里没有任何代码知道自己正在被测试。接下来的测试完全按照应用程序调用它的方式来运行这段代码。

启动容器并加载架构

tcmysql.WithScripts 把 schema.sql 挂载到容器的 /docker-entrypoint-initdb.d/ 目录中,官方 MySQL 镜像会在容器第一次以空数据目录启动时自动运行它一次。container.ConnectionString 返回一个可直接使用的 DSN,其中已经填好了用户名、密码、主机和映射端口。无论测试通过还是失败,t.Cleanup 调用都会按后进先出的顺序运行,正是它们拆除了容器:没有需要单独记住的拆除步骤。

针对真实数据库运行测试

用 go test -v 运行它会启动一个真实的容器、应用架构、通过 CreateUser 插入一行、通过 GetUserByEmail 读回它,然后拆除容器:
这次运行使用的是已经拉取过的 mysql:8.0.36 镜像。在从未拉取过该镜像的机器上,第一次运行明显更久:在这里测量的一次运行中,套件中的第一个测试端到端耗时 25.95 秒(包括镜像拉取),而同一次 go test 调用中之后的每个测试耗时 6.8 到 7.5 秒,因为 Docker 只拉取镜像一次,而 Testcontainers 在之后的每次 Run 调用中都从本地已有的镜像启动一个新容器。具体从”容器已启动”到”容器已就绪”,这次运行中的 MySQL 容器大约用了 5 秒才接受连接。

为什么不模拟数据库

database/sql 的模拟对象返回的是您让它返回的内容。它没有约束引擎,也没有严格模式,因此当您的代码向 MySQL 发送一个 MySQL 会拒绝的值时,它无法重现 MySQL 实际的行为。本项目 store_test.go 中针对真实容器的两个测试直接证明了这一点。 架构声明了 UNIQUE KEY uq_users_email (email)。针对真实容器两次插入相同的电子邮件会失败,并报出一个具体的、真实的 MySQL 错误:
这个测试针对真实容器通过了,mysqlErr.Number 等于 1062,也就是 MySQL 对唯一键冲突返回的真实 ER_DUP_ENTRY 代码。模拟对象需要被事先告知以这种确切形式返回这个确切的错误;而真实数据库之所以强制执行它,是因为约束存在于架构中,而不是存在于测试中。 age 列是 TINYINT UNSIGNED,因此它不能保存负数。在 MySQL 的默认严格模式下(自 MySQL 5.7 起为默认),服务器会拒绝超出范围的值,而不是静默地把它钳制为零:
这个测试也针对真实容器通过了,错误为 1264,即 ER_WARN_DATA_OUT_OF_RANGE。这两种行为都不来自应用代码。两者都来自 MySQL 本身,这正是数据库级别的模拟对象无法重现它们的原因,除非手工编码来伪造这一个特定情况。

改为让 Testcontainers 指向 VillageSQL 镜像

VillageSQL 使用与 MySQL 相同的线路协议,因此同一个 testcontainers-go MySQL 模块可以驱动 villagesql/server 容器,而不是标准的 mysql 容器。这样做需要一处改动。该模块默认的就绪检查等待的是字面日志行 port: 3306 MySQL Community Server,而 VillageSQL 的启动日志从不打印这一行;VillageSQL 自己的就绪行是 ... ready for connections. Version: '8.4.11-villagesql-0.0.6' ... port: 3306 ...。覆盖等待策略以匹配这一行就足够了:
需要 WithOccurrence(2),是因为入口脚本会先启动一个临时服务器来运行初始化脚本,然后再启动容器持续运行的真正服务器。请注意第二次出现实际上是什么:日志中有三行匹配,因为真正服务器的启动会为 X Plugin 打印一行,为 mysqld 本身打印一行。第二次出现是 X Plugin 那一行,它比 mysqld 宣布自己就绪早不到一毫秒,因此在实践中等待它已经足够接近。如果您希望等待精确固定在服务器那一行,请改为匹配 "/usr/bin/mysqld: ready for connections",因为该字符串恰好出现两次。采用这个等待策略后,在这里捕获的一次运行中,容器在 6.81 秒内完成了启动、应用 schema.sql 并接受连接,SELECT VERSION() 返回 8.4.11-villagesql-0.0.6。其他所有部分,包括 WithDatabase、WithUsername、WithPassword、WithScripts 和 ConnectionString,都无需改动即可工作。

选择镜像和版本

对于任何在 CI 中运行的测试,请固定一个精确的标签而不是 latest,这样上游镜像的新版本就不会在您不知情的情况下改变测试结果:
对于 VillageSQL,一旦您有了想要停留的版本,就以同样的方式固定:
在决定使用某个标签之前,请运行 docker manifest inspect <image>:<tag>,以确认它存在并查看它发布了哪些架构;在撰写本文时,mysql:8.0.36 和 villagesql/server:latest 都发布了 amd64 和 arm64 清单,因此同一个标签无需平台覆盖即可在 Intel 和 Apple Silicon 的 CI 运行器上运行。

常见问题

Testcontainers 需要真实的 Docker 守护进程,还是可以配合模拟对象使用?

它需要一个从测试运行处可以访问的真实 Docker 守护进程:本地的 Docker Desktop,或 CI 中的 Docker-in-Docker 或挂载了 Docker 套接字的运行器。如果运行测试的机器上 docker info 失败,Testcontainers 就无法启动容器,测试会在到达您的代码之前就因连接错误而失败。

每个测试都有自己的容器,还是多个测试可以共享一个?

这是您在测试代码中做出的选择,不是 Testcontainers 强加的。像上面展示的那样,在每个 Test... 函数内部调用启动容器的辅助函数,会让每个测试拥有自己的容器和最强的隔离。在 TestMain 中启动一次容器并在包内的测试之间共享它会更快,但这样每个测试都要负责清理自己插入的行,以免看到其他测试的数据。

容器需要多长时间才能就绪?

在为本指南捕获的运行中,镜像已在本地拉取的情况下,mysql:8.0.36 容器从”容器已启动”到”准备好接受连接”大约用了 5 秒,villagesql/server:latest 容器用时相当。在从未拉取过镜像的 go test 运行中,第一个启动的容器耗时明显更长,因为它还要承担镜像拉取的开销;这里测量的一次运行中,第一个容器用了 25.95 秒。

我可以运行已在使用的架构迁移工具,而不是一个纯 SQL 文件吗?

可以。WithScripts 只是把文件挂载到 /docker-entrypoint-initdb.d/ 中,该目录接受 .sql 和 .sh 文件。该目录中的 shell 脚本可以调用任何能够针对主机和端口运行的迁移工具,只要该工具在容器内可用,或者您在脚本中安装它。

故障排除

另请参阅

  • Docker 上的 MySQL:Testcontainers 所基于的镜像、环境变量和卷行为
  • MySQL 中的模式迁移:在生产环境中运行本指南通过 WithScripts 加载的同一批架构变更
  • MySQL 与 ORM:针对 Testcontainers 管理的数据库使用 ORM 自己的连接池和迁移工具