乐趣区

Spring、Spring Boot和TestNG测试指南 – 集成测试中用Docker创建数据库

原文地址
在测试关系型数据库一篇里我们使用的是 H2 数据库,这是为了让你免去你去安装 / 配置一个数据库的工作,能够尽快的了解到集成测试的过程。
在文章里也说了:
在真实的开发环境中,集成测试用数据库应该和最终的生产数据库保持一致
那么很容易就能想到两种解决方案:

开发团队使用共用同一个数据库。这样做的问题在于:当有多个集成测试同时在跑时,会产生错误的测试结果。
每个人使用自己的数据库。这样做的问题在于让开发人员维护 MySQL 数据库挺麻烦的。

那么做到能否这样呢?

测试启动前,创建一个 MySQL 数据库
测试过程中连接到这个数据库
测试结束后,删除这个 MySQL 数据库

So, Docker comes to the rescue。
我们还是会以测试关系型数据库里的 FooRepositoryImpl 来做集成测试(代码在这里)。下面来讲解具体步骤:
安装 Docker
请查阅官方文档。并且掌握 Docker 的基本概念。
配置 fabric8 docker-maven-plugin
farbic8 docker-maven-plugin 顾名思义就是一个能够使用 docker 的 maven plugin。它主要功能有二:

创建 Docker image
启动 Docker container

我们这里使用启动 Docker container 的功能。
大致配置如下
<plugin>
<groupId>io.fabric8</groupId>
<artifactId>docker-maven-plugin</artifactId>
<version>0.28.0</version>

<configuration>
<images>
<image>
<!– 使用 mysql:8 docker image –>
<name>mysql:8</name>
<!– 定义 docker run mysql:8 时的参数 –>
<run>
<ports>
<!– host port 到 container port 的映射
这里随机选择一个 host port,并将值存到 property docker-mysql.port 里 –>
<port>docker-mysql.port:3306</port>
</ports>
<!– 启动时给的环境变量,参阅文档:https://hub.docker.com/_/mysql –>
<env>
<MYSQL_ROOT_PASSWORD>123456</MYSQL_ROOT_PASSWORD>
<MYSQL_DATABASE>test</MYSQL_DATABASE>
<MYSQL_USER>foo</MYSQL_USER>
<MYSQL_PASSWORD>bar</MYSQL_PASSWORD>
</env>
<!– 设置判定 container 启动成功的的条件及 timeout –>
<wait>
<!– 如果 container 打出了这行日志,则说明容器启动成功 –>
<log>MySQL init process done. Ready for start up.</log>
<time>120000</time>
</wait>
</run>
</image>
</images>
</configuration>

<executions>
<execution>
<!– 在集成测试开始前启动容器 –>
<id>start</id>
<phase>pre-integration-test</phase>
<goals>
<goal>start</goal>
</goals>
</execution>
<execution>
<!– 在集成测试结束后停止并删除容器 –>
<id>stop</id>
<phase>post-integration-test</phase>
<goals>
<goal>stop</goal>
</goals>
</execution>
</executions>
</plugin>
配置 maven-failsafe-plugin
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<executions>
<execution>
<id>integration-test</id>
<goals>
<goal>integration-test</goal>
</goals>
</execution>
<execution>
<id>verify</id>
<goals>
<goal>verify</goal>
</goals>
</execution>
</executions>
<configuration>
<!– 我们被测的是一个 Spring Boot 项目,因此可以通过 System Properties 把 MySQL container 的相关信息传递给程序
详见文档:https://docs.spring.io/spring-boot/docs/1.5.4.RELEASE/reference/html/boot-features-external-config.html
–>
<systemPropertyVariables>
<spring.datasource.url>jdbc:mysql://localhost:${docker-mysql.port}/test</spring.datasource.url>
<spring.datasource.username>foo</spring.datasource.username>
<spring.datasource.password>bar</spring.datasource.password>
</systemPropertyVariables>
</configuration>
</plugin>
执行
三种常见用法:

mvn clean integration-test,会启动 docker container、运行集成测试。这个很有用,如果集成测试失败,那么你还可以连接到 MySQL 数据库查看情况。

mvn clean verify,会执行 mvn integration-test、删除 docker container。

mvn clean install,会执 mvn verify,并将包安装到本地 maven 仓库。

下面是 mvn clean verify 的日志:

[INFO] — docker-maven-plugin:0.28.0:start (start) @ spring-test-examples-rdbs-docker —
[INFO] DOCKER> [mysql:8]: Start container f683aadfe8ba
[INFO] DOCKER> Pattern ‘MySQL init process done. Ready for start up.’ matched for container f683aadfe8ba
[INFO] DOCKER> [mysql:8]: Waited on log out ‘MySQL init process done. Ready for start up.’ 13717 ms
[INFO]
[INFO] — maven-failsafe-plugin:2.22.1:integration-test (integration-test) @ spring-test-examples-rdbs-docker —
[INFO]
[INFO] ——————————————————-
[INFO] T E S T S
[INFO] ——————————————————-

[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO]
[INFO] — docker-maven-plugin:0.28.0:stop (stop) @ spring-test-examples-rdbs-docker —
[INFO] DOCKER> [mysql:8]: Stop and removed container f683aadfe8ba after 0 ms
[INFO]
[INFO] — maven-failsafe-plugin:2.22.1:verify (verify) @ spring-test-examples-rdbs-docker —
[INFO] ————————————————————————
[INFO] BUILD SUCCESS
[INFO] ————————————————————————

可以看到 fabric8 dmp 在集成测试前后 start 和 stop 容器的相关日志,且测试成功。
如何找到 MySQL 的端口开在哪一个呢?运行 docker ps 查看端口(注意下面的 0.0.0.0:32798->3306/tcp):
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
a1f4b51d7c75 mysql:8 … … Up 19… 33060/tcp, 0.0.0.0:32798->3306/tcp mysql-1
参考文档

Fabric8 dmp
Spring boot – Externalized Configuration

退出移动版