chatwork/circleci-docker

circleci-docker 镜像文档

镜像概述

circleci-docker是专为CircleCI持续集成平台设计的Docker镜像，主要用于在CI/CD流程中执行Docker镜像构建操作和运行基于docker-compose.test.yaml配置的自动化测试。

核心功能与特性

• 支持在CircleCI环境中直接执行Docker build命令
• 集成Docker BuildKit以优化镜像构建过程
• 兼容docker-compose命令，可处理测试环境配置文件
• 支持CircleCI远程Docker设置（setup_remote_docker），包括镜像层缓存功能
• 提供与sut（System Under Test）容器的交互能力，支持测试文件注入与执行

使用场景

适用于需要在CircleCI平台上实现以下需求的CI/CD流程：

• 自动化构建Docker镜像
• 基于docker-compose配置进行容器化应用的集成测试
• 需要在测试阶段向容器注入测试文件（如goss测试套件）的场景

使用方法与配置说明

前提条件

• 已配置CircleCI项目
• 项目中包含Dockerfile（用于构建镜像）
• 项目中包含docker-compose.test.yaml（测试环境配置）
• 测试所需的goss文件已放置在项目根目录

配置示例

在项目的.circleci/config.yml文件中添加以下配置：

yaml
jobs:
  build:
    docker:
      - image: chatwork/circleci-docker:18.09.3
    steps:
      - checkout  # 检出代码仓库
      - setup_remote_docker:  # 配置远程Docker环境
          docker_layer_caching: true  # 启用镜像层缓存
          version: 18.09.3  # 指定Docker版本
      - run: DOCKER_BUILDKIT=1 docker build -t [your image] .;  # 使用BuildKit构建镜像
      - run: |  # 执行测试流程
          docker-compose -f docker-compose.test.yml up --no-start sut  # 启动测试容器（不自动运行）
          docker cp $PWD/goss sut:/goss  # 将本地goss测试文件复制到sut容器
          docker-compose -f docker-compose.test.yml up --no-recreate sut  # 运行测试容器

参数说明

• image: chatwork/circleci-docker:18.09.3: 指定使用的镜像及版本
• setup_remote_docker: CircleCI提供的远程Docker环境配置，docker_layer_caching: true可加速后续构建
• DOCKER_BUILDKIT=1: 启用Docker BuildKit构建模式，提供更高效的构建体验
• docker-compose -f docker-compose.test.yml: 指定使用测试环境的docker-compose配置文件
• --no-start sut: 仅创建sut容器但不启动服务，便于预先准备测试环境
• --no-recreate sut: 不重新创建已存在的sut容器，直接运行测试