利用Docker和JUnit进行集成测试

利用Docker和JUnit进行集成测试

1.前言

---

“集成测试的目的是验证各组件之间的通信路径与交互以检测接口上的缺陷”

——敏捷开发创始人Martin Fowler

随着云端服务的普及，微服务架构开始应用于越来越多的项目上，比如项目中的一些服务会“外包”出去，如PostgreSQL, Apache Kafka, etcd等。这就需要本地服务与外部组件进行交互，如果用传统的方法进行集成测试，在各种不同服务配置下很难快速跑完全部用例，这就需要一种方法更够将各类服务快速集成、执行、并输出结果。

本文将分享一种利用Docker Compose和JUnit的方法来搭建微服务的集成测试环境。我们利用Docker Compose启动依赖项，JUnit和Gradle来执行测试，以及docker-compose-rule将他们粘在一起。

2.配置步骤

---

2.1 前提条件

你的测试机需要预安装Docker和Docker Compose，没了，就这么简单。
Docker：https://www.docker.com/docker-centos-distribution
Docker Compose： https://docs.docker.com/compose/install/

2.2 Step 1: 配置build.gradle

配置环境的第一步是配置build.gradle，在测试时我们使用docker-compose-rule来协调系统与Docker Compose的交互。为此我们需要将它们的bintray repository添加至我们的’repositories’配置中，并在’com.palantir.docker.compose：docker-compose-rule-junit4：0.31.1’上定义一个testCompile依赖关系。

另外，还需要将单元测试与集成测试分开，以便可以独立运行Gradle任务测试和集成测试。因此我们可以创建一个称为integration Test的测试任务来完成此任务，其中我们将包括一个category（稍后会介绍）。

配好的build.gradle大致为：
图片1

2.3 Step 2: 配置docker-compose文件

第二步是为与系统需要进行交互的外部组件配置docker-compose文件。在本文中，我们使用docker 镜像persperhour / dynamodb。

完整的配置如下：
图2
这里有个坑，要确保不要暴露任何端口，避免发生冲突。

为了使docker-compose-dynamodb.yml可用于我们的测试，需要将这个文件放入src/test/resources文件夹中。然后，通过使用docker-compose -f docker-compose-dynamodb.yml启动容器来测试我们的配置，最后用docker-compose -f docker-compose-dynamodb-yml将其卸下。

2.4 Step 3: 执行前配置

现在开始可以配置我们需要的测试了，首先，测试之前需要创建上文提到的category接口。

public interface IntegrationTest {
}

然后，我们可以使用这个类对集成测试进行注释：

@Category(IntegrationTest.class)
public class UserRepositoryIntegrationTest {

接下来配置docker-compose-rule，使用@ClassRule:

@ClassRule
public static DockerComposeRule docker = DockerComposeRule.builder()
    .file("src/test/resources/docker-compose-dynamodb.yml")
    .waitingForService(DYNAMODB, HealthChecks.toHaveAllPortsOpen())
    .build();

此配置可保证在docker-compose文件中指定的服务会在测试之前启动，在测试完成停止并拆除。

现在，我们可以在@BeforeClass中使用DockerComposeRule docker来获取从Docker分配的外部端口来配置DynamoDB连接：

private static UserRepository repository;

@BeforeClass
public static void initialize() {
    DockerPort dynamodb = docker.containers()
        .container(DYNAMODB)
        .port(DATABASE_PORT);
    String dynamoEndpoint = String.format("http://%s:%s", dynamodb.getIp(), dynamodb.getExternalPort());
    repository = new UserRepository(dynamoEndpoint,
        "KEY",
        "SECRET_KEY",
        "AP-SOUTHEAST-1");
}

到此为止，所有配置已经完成了，你可以按照测试需求部署服务与业务逻辑了。

3.参考资料

1. https://docs.docker.com/compose/overview/
2. https://segmentfault.com/a/1190000005810427
3. https://stackoverflow.com/questions/36808351/running-junit-tests-in-parallel-with-docker