基于testcontainers的redis单元测试实践

发表于:2023-10-18 09:11

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:Java小卷    来源:稀土掘金

  在我们将redis整合并应用到业务模块后,单元测试这块我们希望对redis服务器也进行隔离,思路和之前内存模式启动的h2一样,我们将引入testcontainers测试框架。
  当开始单元测试后,会临时从目标的docker服务器启动一个用于redis单元测试的docker容器来实现测试数据与数据运行数据的隔离。当单元测试完成后,该docker容器将停止并随后被删除。我们发现针对一些中间件采用testcontainers进行单元测试会非常优雅。
  不多说,直接开干!
  准备工作
  首先testcontainers所要推送image并启动容器的docker服务器可以在本地也可以是远程的,这里我们采用的是后者。因此需要做服务器的客户端连接配置,参考:jenkins基础CI实践。
  同时在本机环境变量中新增DOCKER_HOST,值为:tcp://192.168.1.113:2375,也就是docker服务器的ip和端口。
  引入依赖
  build.gradle
  plugins {
      id 'org.springframework.boot' version '2.2.6.RELEASE'
  }
  ...
  dependencies {
      ...
      testImplementation 'org.testcontainers:junit-jupiter:1.17.6'
      testImplementation 'com.redis.testcontainers:testcontainers-redis-junit-jupiter:1.4.6'
  }
  ...
  注意,这里我们将采用spring中提供的动态注册属性值的方式,即@DynamicPropertySource注解,这在spring的5.2.5.RELEASE版本中才支持,因此我们对spring boot从2.2.5.RELEASE升级到2.2.6.RELEASE。
  而在测试依赖中我们引入了与junit5的junit-jupiter框架相匹配的testcontainers和testcontainers-redis依赖,用于通过testcontainers测试工具来基于image启动一个独立的中间件docker容器服务以便连接测试。
  单元测试调整
  对之前的RedistTest测试类做相关调整:
  package com.xiaojuan.boot.redis;
  import ...
  @Slf4j
  @Testcontainers
  public class RedisTest extends TestBase {
      @Resource
      private RedisTemplate<String, Object> redisTemplate;
      @BeforeEach
      public void initDb() {
          flushdb();
      }
      @Container
      private static final RedisContainer REDIS_CONTAINER = new RedisContainer(
              DockerImageName.parse("redis:6.2.6-alpine")).withExposedPorts(6379);
      @DynamicPropertySource
      private static void registerRedisProperties(DynamicPropertyRegistry registry) {
          registry.add("spring.redis.host", REDIS_CONTAINER::getHost);
          registry.add("spring.redis.port", () -> REDIS_CONTAINER.getMappedPort(6379).toString());
      }
      // 测试用例省略
      ...
      private void flushdb() {
          redisTemplate.execute((RedisCallback<Object>) connection -> {
              connection.flushDb();
              return "ok";
          });
      }
      ...
  }
  调整说明
  redis的单元测试依然我们从继承的TestBase中类头部修饰的@SpringBootTest启动,额外我们再加一个@Testcontainers用于管理启动的docker容器的生命周期,这样确保在容器启动后才进行客户端的连接设置并发起单元测试,最后在单元测试结束后再停止和销毁容器。
  然后我们通过@Container注解修饰一个静态成员变量的方式来定义redis容器对象,包括了再启动容器时使用的image版本,这里我们采用的是轻量级的alpine版本,并指定了内部端口。
  然后通过@DynamicPropertySource注解修饰的静态方法来实现redis连接属性的动态添加,这里的端口设置为redis容器对外映射出来的端口号。
  这样我们单元测试在运行时所采用的redis库从原先真实的redis库切换到临时启动的一个干净的docker容器库进行测试,而application.yml中的redis配置不用做任何调整。
  为了实现单元测试直接完全的数据隔离,我们依然保留@BeforeEach修饰的initDb方法,在每个单元测试启动前先清除redis库中的数据,因为对于每个测试类,testcontainers只会启动一次容器,测试类运行结束才停止销毁容器。
  问题修复
  在接下来运行单元测试时,报了一个问题:
  原因是我们在application.yml中对redis连接设置了password属性,而在testcontainers框架中完全可以跳过认证这一块,因此我们只需要在application-test.yml中覆盖设置该值为空即可:
  spring:
    ...
    redis:
      password:
  最后运行单元测试,ok!
  从运行的日志中可以看到:
  好了,商品分类模块的接口开发就到此结束了,下一节开始我们将进入商品模块的开发,大家加油!
  本文内容不用于商业目的,如涉及知识产权问题,请权利人联系51Testing小编(021-64471599-8017),我们将立即处理
《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号