voltha/voltha-ci-tools

VOLTHA CI流程版本化容器镜像

镜像概述

本镜像为VOLTHA代码库提供版本化的容器环境，专门用于运行持续集成（CI）流程。通过容器化封装CI所需的工具链和依赖，确保不同开发阶段、不同代码版本的CI流程在一致的环境中执行，解决因环境差异导致的CI流程不稳定问题。

核心功能与特性

版本化容器管理

• 采用明确的版本标签（如v1.0.0、v2.3.1）区分容器环境配置，每个版本对应VOLTHA代码库特定版本的CI需求，支持多版本并行开发的环境隔离。
• 版本变更记录清晰，包含工具链版本更新、依赖调整等关键信息，便于追溯CI环境变更历史。

完整CI流程支持

• 内置VOLTHA CI流程所需的全套工具链，包括代码检查工具（如lint）、编译工具、单元测试框架、集成测试环境及依赖管理工具。
• 支持CI流程全生命周期，可直接执行代码拉取、构建、静态分析、单元测试、集成测试及结果报告生成等标准CI步骤。

环境一致性保障

• 容器化封装所有CI环境依赖（系统库、工具版本、配置文件等），消除“本地可运行，CI失败”的环境差异问题。
• 跨平台兼容，支持在不同CI平台（如Jenkins、GitLab CI、GitHub Actions）中部署使用，保持执行结果一致性。

轻量级与高效性

• 基于精简基础镜像构建，优化容器体积，减少CI流程启动时间。
• 内置缓存机制，加速依赖下载和构建过程，提升持续集成效率。

使用场景

• 日常开发CI流程：VOLTHA开发团队提交代码后，通过该容器自动触发CI流程，执行代码检查和测试，快速反馈代码质量问题。
• 版本发布验证：在VOLTHA版本发布前，使用对应版本的容器执行完整集成测试，确保发布版本满足质量要求。
• 多版本并行开发：不同开发分支使用不同版本的容器，避免工具链或依赖冲突，支持同时维护多个VOLTHA版本。

使用方法

版本选择

通过镜像标签指定所需版本，标签格式为voltha-ci:<version>，其中<version>对应VOLTHA代码库版本或CI环境版本（如voltha-ci:v2.1.0）。可通过镜像仓库（如Docker Hub、私有镜像仓库）查询所有可用版本。

基本运行命令

bash
docker run -it --rm \
  -v /path/to/local/voltha-code:/workspace/code \  # 挂载本地VOLTHA代码目录
  -v /path/to/ci-cache:/workspace/cache \          # 挂载缓存目录（可选，加速依赖下载）
  -e CI_SCRIPT_PATH="/workspace/code/ci/run-ci.sh" \  # 指定CI脚本路径
  -e LOG_LEVEL="info" \  # 设置日志级别（可选，默认info）
  voltha-ci:v2.1.0       # 指定容器版本

参数说明

• 数据卷挂载：

  • /workspace/code：必须挂载，用于容器访问VOLTHA代码目录，需将本地代码路径映射至此。
  • /workspace/cache：可选挂载，用于缓存依赖文件（如npm、pip缓存），减少重复下载。

• 环境变量：

  • CI_SCRIPT_PATH：必填，指定CI流程执行脚本的路径（相对于容器内路径），脚本需包含代码检查、构建、测试等步骤。
  • LOG_LEVEL：可选，日志级别，支持debug、info、warn、error，默认info。
  • CI_BRANCH：可选，指定代码分支（如main、release/v2.1），用于CI流程中分支相关操作。

CI流程执行

容器启动后，将自动执行CI_SCRIPT_PATH指定的脚本，输出CI流程日志。执行完成后，容器自动退出，退出码说明：

• 0：CI流程执行成功，所有检查和测试通过。
• 非0：CI流程失败，具体错误信息可查看日志。

docker-compose配置示例

yaml
version: '3'
services:
  voltha-ci:
    image: voltha-ci:v2.1.0
    volumes:
      - ./voltha-code:/workspace/code
      - ci-cache:/workspace/cache
    environment:
      - CI_SCRIPT_PATH=/workspace/code/ci/run-ci.sh
      - LOG_LEVEL=debug
      - CI_BRANCH=main

volumes:
  ci-cache:  # 持久化缓存卷

注意事项

• 确保本地代码目录权限正确，容器需有读取代码和执行脚本的权限。
• 不同版本容器的工具链和依赖可能存在差异，使用时需匹配VOLTHA代码库版本，避免因版本不兼容导致CI失败。
• 敏感信息（如测试环境密钥）建议通过环境变量或Docker Secrets传入，避免硬编码在容器或脚本中。