eXo CI Docker镜像文档

!Docker Stars - !Docker Pulls

目录

• 镜像概述和主要用途
• 核心功能和特性
• 使用场景和适用范围
• 详细的使用方法和配置说明
  • 如何执行测试
  • 如何使用eXo CI Docker镜像
    • 基础示例：JDK7 - Maven 3.0
    • 高级示例：JDK8 - Maven 3.2与Release Profile
  • 如何使用eXo Puppet Docker镜像
  • XMLStarlet工具
  • 开发者配置
    • 配置.bash_profile
    • 使用正确配置构建项目

镜像概述和主要用途

本仓库提供的Docker镜像用于在Docker容器中构建所有eXo Platform组件，适用于开发和持续集成场景。镜像包含构建eXo Platform组件所需的Dockerfile、测试用例和环境配置，旨在提供标准化、可重复的构建环境，确保开发和CI流程的一致性。

核心功能和特性

镜像列表

以下是eXo CI镜像的详细信息，包含JDK版本、依赖工具及测试配置：

核心特性

• 多版本JDK支持：覆盖JDK 6至17，满足不同项目的Java版本需求。
• 丰富构建工具：集成Maven（3.0.5至3.9.2）、Gradle（2.14、4.1、6.1）、Mavend等主流构建工具。
• 基础依赖预装：包含Python 2.7/3、GCC 4.8等基础工具，支持复杂构建场景。
• 标准化测试：每个镜像均通过goss.yaml定义测试用例，确保环境一致性。
• 轻量级选项：提供Alpine版本镜像（如jdk17-alpine），减少镜像体积。

使用场景和适用范围

• eXo Platform组件开发：为eXo Platform各组件提供一致的本地开发构建环境。
• 持续集成（CI）流程：在CI/CD管道中自动化构建、测试eXo Platform项目。
• 多环境兼容测试：验证项目在不同JDK和构建工具版本下的兼容性。
• Puppet配置验证：通过puppet镜像验证Puppet模块配置正确性。
• XML文档处理：集成XMLStarlet工具，支持CI流程中对XML文件（如Maven POM）的自动化修改。

详细的使用方法和配置说明

如何执行测试

前提条件

执行测试需先安装dgoss（Goss的Docker封装工具）。

批量测试所有镜像

通过项目根目录的脚本批量构建并测试所有镜像：

$ ./test_all_images.sh

测试特定镜像

进入目标镜像的测试目录，执行测试脚本：

$ cd maven/jdk7-maven32/tests
$ ./test_image.sh

INFO: 启动Docker容器
INFO: 容器ID: 59897f6f
INFO: 等待0.2秒
INFO: 运行测试
标题: 验证eXo全局设置文件是否存在
文件: /usr/share/maven/conf/settings.xml: 存在: 符合预期: [true]
标题: 验证Maven仓库目录是否存在
文件: /home/ciagent/.m2/repository: 存在: 符合预期: [true]
标题: 验证eXo用户设置文件是否不存在
文件: /home/ciagent/.m2/settings.xml: 存在: 符合预期: [false]
标题: 检查git是否安装
包: git: 已安装: 符合预期: [true]
命令: mvn --version: 退出状态: 符合预期: [0]
命令: mvn --version: 标准输出: 符合预期: [3.2.5 1.7.0 默认语言环境: en_US, 平台编码: UTF-8]

总耗时: 0.650s
测试总数: 6, 失败: 0, 跳过: 0
INFO: 删除容器

real    0m2.929s
user    0m0.064s
sys     0m0.288s

如何使用eXo CI Docker镜像

基础示例：JDK7 - Maven 3.0

通过docker run命令挂载项目目录、Maven仓库和设置文件，使用jdk7-maven30镜像构建项目：

$ cd my-project
$ docker run --name=my-project-build -it \
  -v $(pwd):/srv/ciagent/workspace \  # 挂载当前项目目录到容器工作区
  -v ~/.m2/repository:/home/ciagent/.m2/repository \  # 共享本地Maven仓库，加速构建
  -v ~/.m2/settings.xml:/home/ciagent/.m2/settings.xml \  # 挂载Maven设置文件
  exoplatform/ci:jdk7-maven30 clean package  # 执行Maven构建命令

高级示例：JDK8 - Maven 3.2与Release Profile

如需使用GPG签名发布版本，挂载GPG密钥文件并指定Release Profile：

$ cd my-project
$ docker run --name=my-project-build -it \
  -v $(pwd):/srv/ciagent/workspace \
  -v ~/.m2/repository:/home/ciagent/.m2/repository \
  -v ~/.m2/settings.xml:/home/ciagent/.m2/settings.xml \
  -v ~/.gnupg/pubring.gpg:/home/ciagent/.gnupg/pubring.gpg:ro \  # 只读挂载公钥环
  -v ~/.gnupg/secring.gpg:/home/ciagent/.gnupg/secring.gpg:ro \  # 只读挂载私钥环
  -v ~/.gnupg/gpg.conf:/home/ciagent/.gnupg/gpg.conf:ro \  # 挂载GPG配置
  exoplatform/ci:jdk8-maven32 install -Prelease  # 使用Release Profile执行安装

如何使用eXo Puppet Docker镜像

使用puppet镜像验证Puppet模块配置：

$ cd my-project  # 进入包含Puppet代码的目录
$ docker run --name puppet-validation -it \
  -v ${PWD}:/srv/ciagent/workspace \  # 挂载项目目录到容器工作区
  exoplatform/ci:puppet  # 执行Puppet验证

如需强制更新Puppet模块（通过r10k），添加-u参数：