dockertest

背景

执行单元测试会依赖一些第三方数据源 如mysql mc redis 如果本地启动则测试可能污染数据 导致每次跑的结果有差异

因此需要依赖docker每次启动干净的容器 但是有些docker容器启动非常慢(如mysql) 常常耗费一分钟以上 不如让其常驻后台 每次跑测试时重建数据

本项目采用扩展docker-compose配置语法的方式指定容器配置

安装

go get -u github.com/XyuWang/dockertest

使用

func TestMain(m *testing.M) {
  path := "./docker-compose.yml"
  dockertest.Run(path)
  os.Exit(m.Run())
}

示例docker-compose配置

version: "3.7"

services:
  redis:
    image: redis
    ports:
      - 16379:6379
    hooks:
      - cmd: ["redis-cli", "flushall"]
  memcached:
    image: memcached:1
    ports:
      - 21211:11211
    hooks:
      - cmd: ["/bin/bash", "-c", "echo 'flush_all' > /dev/tcp/127.0.0.1/11211"]
  db:
    image: mysql:5.6
    ports:
      - 13306:3306
    environment:
      - MYSQL_ALLOW_EMPTY_PASSWORD=yes
      - TZ=Asia/Shanghai
    command: [
      '--character-set-server=utf8',
      '--collation-server=utf8_unicode_ci'
    ]
    volumes:
      - .:/docker-entrypoint-initdb.d
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "--protocol=tcp"]
      interval: 1s
      timeout: 2s
      retries: 20
      start_period: 5s
    hooks:
      - custom: refresh_mysql

扩展语法

    hooks:
      - cmd: []
      - custom: string

容器启动健康检查通过后 会执行用户指定的hook

cmd类型: 根据cmd中的命令会调用docker exec在容器中执行

costom类型: 用户自定义类型 内嵌了 refresh_mysql hook

refresh_mysql

提供以下功能:

1. 清理容器中除 information_schema mysql performance_schema 的所有数据库
2. 根据mount path:/docker-entrypoint-initdb.d 指定的路径 读取出sql文件 重建DB

扩展开发

接口:
type HookFunc func(*Container) error

只要实现此接口并调用dockertest.Register()方法注册即可 例子可以参考mysql_hook.go