使用远程Docker进行集成测试

Posted 2021-07-11 西北偏北UP

需求背景

团队有集成测试的需求，集成测试需要依赖一些中间件，比如mysql，rabbitmq。每个研发人员有对自己开发的那部分代码进行测试编写和运行检测的需求。

为了不互相影响，可以选择在研发本地搭建自己的依赖环境，我们希望这些环境搭建要容易、快速，且方便清理。

使用docker进行环境搭建

而docker，则能很好实现上述诉求。但仅仅这样还不够，我们还面临着以下一些问题

•本地环境搭建的繁琐。每个研发，都要在本地安装docker环境，这会导致在使用上的一些门槛和不便，以我司为例，由于有严格的网络管控，我们都是内网进行开发，无法联网。特别windows 在安装docker时，需要联网。虽然可以想办法解决，但每个新来小伙伴都要经历一些本地环境安装调试过程，实属繁琐• 测试运行速度无法保证。当一个项目依赖中间件较多时，基于本地的docker也会占用大量的资源影响测试速度• 多环境集成测试麻烦。由于集成测试依赖本地docker，那么这份代码在不同的环境，比如在Jenkins上打包运行时，需要在对应的环境也安装docker

总结来看，使用docker可以帮助我们快速的搭建项目依赖环境，但是本地化的docker依赖，依然让我们的代码在测试时，不够纯粹，对其各个运行环境，都有有本地docker安装的要求。

以中心化的docker server改进集成测试

而实际上，docker本身提供了远程链接模式，则使得我们可以中心化的部署docker，然后集成测试代码以tcp链接的方式，使用docker server，进行依赖中间件搭建，测试。

Docker Server远程链接配置

以centos 为例7.6为例，讲解如何将一个docker配置成可以远程链接。

•

在/etc/docker/daemon.json中开启远程链接端口

 {"hosts": ["tcp://0.0.0.0:2375", "unix:///var/run/docker.sock"]}

•

添加文件/etc/systemd/system/docker.service.d/override.conf，注意上述路径不存在则手动创建

 [Service]
 ExecStart=
 ExecStart=/usr/bin/dockerd

•

重载守护进程 systemctl daemon-reload

•

重启docker容器systemctl restart docker.service

Testcontainers 框架

在部署好远程docker后，随之而来的问题是

•如何在代码中连接和使用远程docker环境•两个研发同时跑测试用例时，怎么保证他们各自启动的container 在端口上不冲突•使用完后的container，怎么清理

幸运的是，Testcontainers^[1]框架，帮我们很好的解决了上述问题。

•它能于junit 4 ,junit 5集成，帮助我们启停容器•每一次运行测试，都会启动全新的容器，暴露不一样的端口，使得两个研发同时跑测试用例时，环境互不干扰•它使用testcontainers/ryuk在指定延迟后，清理不再使用的container•上述这一切对使用者都是透明的

Testcontainers 同spring boot集成

更进一步的， 游戏公司Playtika^[2]提供了Testcontainers 同spring boot整合的测试框架https://github.com/Playtika/testcontainers-spring-boot，使得Spring Boot或Spring cloud生态的应用在编写集成测试时，更方便

环境变量依赖

•方式1，系统环境变量配置，在当前系统配置环境变量DOCKER_HOST=tcp://remote_docker_server_ip:2375•方式2，直接在java测试代码中，容器构造前，通过代码System.setProperty("DOCKER_HOST","tcp://remote_docker_server_ip:2375")指定环境变量•方式3，如果集成测试使用maven failsafe插件，则在插件上配置环境变量

以command line远程使用和管理docker

上述测试代码不需要安装docker 客户端。但倘若我们需要以命令行的方式，管理docker，则可以安装一些docker客户端，来跟远程docker通信。当然上述的Testcontainers 相当于客户端的一种。

不同操作系统的客户端程序安装方式见: https://gist.github.com/kekru/4e6d49b4290a4eebc7b597c07eaf61f2

参考资料

https://www.testcontainers.org/ https://gist.github.com/styblope/dc55e0ad2a9848f2cc3307d4819d819f https://github.com/Playtika/testcontainers-spring-boot https://gist.github.com/kekru/4e6d49b4290a4eebc7b597c07eaf61f2

References

[1] Testcontainers: https://www.testcontainers.org/
[2] Playtika: https://www.playtika.com/