scality/ci-cosbench

Integration镜像文档

镜像概述和主要用途

Integration镜像旨在为Scality项目提供端到端测试的完整解决方案，由Ultron和Nimrod两个核心组件构成，支持自动化构建触发、测试环境部署及测试执行，适用于CI/CD流程和本地开发测试场景。

核心功能和特性

Ultron

• 轻量级REST服务，基于NodeJS开发，用于处理GitHub推送通知并向CircleCI发送构建请求
• 支持通过GitHub PR评论或curl命令两种方式触发构建流程
• 可通过环境变量定制构建参数，灵活配置测试环境

Nimrod

• Python集成包装器，兼容CircleCI环境和本地部署
• 通过Federation实现完整测试环境的自动化部署
• 自动识别包含master.yml配置文件的测试用例，简化测试扩展

使用场景和适用范围

• Scality项目的自动化端到端测试流程
• CI/CD pipeline中集成测试环节的构建触发与环境管理
• 开发人员本地验证代码变更对整体系统的影响

详细使用方法和配置说明

Ultron

配置

Ultron在根目录下读取config.json配置文件，需包含以下必填字段：

json
{
    "username": "your_robot_github_username",  // GitHub机器人用户名
    "hubtoken": "your_robot_github_token",      // GitHub访问令牌
    "citoken": "your_circle_ci_token"           // CircleCI访问令牌
}

安装

进入bot目录，执行标准NodeJS依赖安装：

bash
cd bot
npm install

使用

启动Ultron服务：

bash
npm start

前置条件：需在GitHub项目界面配置Webhook，将PR评论转发至Ultron服务端点。

构建触发方式：

1. GitHub PR评论触发
   在PR评论中引用配置文件中定义的@username，并可在单独行添加环境变量：

@username
ENV_VAR=自定义值
SCALITY_S3_BRANCH=feature-branch

2. curl命令触发

bash
curl -X POST --header "Content-Type: application/json" -d '{
  "build_parameters": {
    "SCALITY_REPO_BRANCH": "_x_"  // 替换为目标分支
  }
}' https://ci.ironmann.io/api/v1/project/scality/Integration/tree/wip%2Fultron?circle-token=_circlecitoken_ -k

注意：将_circlecitoken_替换为实际的CircleCI令牌

重要环境变量说明

• SCALITY_*_BRANCH：为指定项目指定构建分支，支持项目包括：S3、VAULT、METADATA、UTAPI、FEDERATION、INTEGRATION、VAULTCLIENT、BUCKETCLIENT、SPROXYDCLIENT、ARSENAL、WERELOGS、GUIDELINES
• SVC_BASE_FORCE_BUILD：强制重建Federation中所有容器化服务的基础镜像svc-base，同时自动触发nodesvc-base镜像重建
• NODESVC_BASE_FORCE_BUILD：强制重建Node.js容器化服务的基础镜像nodesvc-base
• CI_COSBENCH_FORCE_BUILD：强制重建CI测试使用的cosbench镜像
• CI_AGGRESSOR_FORCE_BUILD：强制重建测试启动器容器aggressor镜像

Nimrod

安装

执行Python安装命令：

bash
python setup.py install

使用命令

• nimrod-build：通过Federation部署完整的测试环境
• nimrod：自动完成环境部署、测试执行的全流程

添加新测试用例

测试用例需满足以下条件：

• 在仓库任意路径下提供master.yml文件，描述aggressor测试配置
• 包含与部署系统交互所需的测试代码和资源

系统会自动扫描并执行符合上述条件的测试用例。