cci-job-client集成指南：如何与CI/CD流水线无缝对接

cci-job-client集成指南：如何与CI/CD流水线无缝对接

【免费下载链接】cci-job-clientA LKP jobs client for Compass-ci: submit LKP jobs and get the status of the LKP jobs项目地址: https://gitcode.com/openeuler/cci-job-client

前往项目官网免费下载：https://ar.openeuler.org/ar/

cci-job-client是openEuler社区推出的LKP作业客户端工具，专为Compass-ci设计，能够轻松提交LKP作业并实时获取作业状态，是实现自动化测试与持续集成的关键组件。通过本指南，您将快速掌握如何将cci-job-client无缝集成到现有CI/CD流水线中，提升开发效率与测试质量。

一、环境准备：3分钟完成安装配置

1.1 一键安装依赖

确保系统已安装Python 3.6+及pip工具，执行以下命令安装项目依赖：

pip install -r requirements.txt

依赖配置文件路径：requirements.txt

1.2 仓库克隆

通过以下命令获取最新代码：

git clone https://gitcode.com/openeuler/cci-job-client cd cci-job-client

二、核心功能解析：流水线集成的关键能力

2.1 作业提交核心脚本

项目提供三个核心Python脚本满足不同场景需求：

• submit_job.py：基础作业提交工具，支持自定义参数
• submit_wait_job.py：提交作业并阻塞等待完成，适合简单流水线
• wait_job_finish.py：独立等待工具，用于复杂流程控制

脚本路径：src/submit_job.py、src/submit_wait_job.py、src/wait_job_finish.py

2.2 参数解析工具

src/lib/parse_params_utils.py模块提供强大的参数解析能力，支持：

• 命令行参数与配置文件混合使用
• 环境变量自动注入
• 参数优先级管理（命令行 > 配置文件 > 默认值）

三、流水线集成实战：3种典型场景示例

3.1 示例1：提交并等待完成（简单管道）

在GitLab CI等简单流水线中，可直接使用submit_wait_job.py实现提交后等待结果：

python src/submit_wait_job.py \ --spec ./tests/mock_tbox_spec.py \ --os openEuler-22.03-LTS-SP1 \ --arch x86_64 \ --my_email your_email@example.com

此命令会阻塞执行直到作业完成，返回0表示成功，非0表示失败，便于流水线状态判断。

3.2 示例2：提交并等待完成（完整脚本）

对于Jenkins等复杂流水线，推荐使用封装脚本scripts/submit-jobs.sh：

#!/bin/bash # 流水线环境变量注入 export OS_NAME="openEuler-22.03-LTS-SP1" export ARCH="aarch64" # 提交作业并获取JOB_ID JOB_ID=$(python src/submit_job.py \ --spec ./tests/mock_tbox_spec.py \ --my_email your_email@example.com) # 等待作业完成 python src/wait_job_finish.py --job_id $JOB_ID # 根据结果设置流水线状态 if [ $? -eq 0 ]; then echo "Job succeeded" exit 0 else echo "Job failed" exit 1 fi

3.3 示例3：批量提交多个作业

针对需要并行执行多个测试的场景，可使用循环批量提交：

# 定义测试规格列表 SPECS=("spec1.py" "spec2.py" "spec3.py") JOB_IDS=() # 批量提交作业 for spec in "${SPECS[@]}"; do JOB_ID=$(python src/submit_job.py --spec $spec --os openEuler-22.03-LTS-SP1) JOB_IDS+=($JOB_ID) echo "Submitted job: $JOB_ID" done # 等待所有作业完成 for job_id in "${JOB_IDS[@]}"; do python src/wait_job_finish.py --job_id $job_id if [ $? -ne 0 ]; then echo "Job $job_id failed" exit 1 fi done

四、高级配置：优化流水线执行效率

4.1 配置文件使用

通过config/logger.conf配置日志级别与输出格式，建议在流水线中设置为INFO级别减少冗余输出：

[logger_root] level=INFO handlers=consoleHandler

4.2 架构适配工具

scripts/arch_utils.sh提供架构自动检测功能，可动态适配不同硬件环境：

source scripts/arch_utils.sh current_arch=$(get_arch) echo "Current architecture: $current_arch"

五、常见问题解决：流水线集成排障指南

5.1 作业提交失败

• 检查网络连接：确保CI节点可访问Compass-ci服务
• 参数验证：使用--help查看参数要求，重点检查spec文件路径
• 权限设置：确保CI用户对项目目录有读写权限

5.2 等待超时

• 调整超时参数：通过--timeout设置更长等待时间
• 优化作业：检查spec文件是否包含耗时操作，考虑拆分作业

六、总结：打造高效CI/CD流水线

cci-job-client通过简洁的API设计和丰富的功能模块，为openEuler项目提供了强大的CI/CD集成能力。无论是简单的提交等待，还是复杂的批量作业管理，都能通过灵活的脚本组合实现自动化流程。结合项目提供的示例脚本和工具函数，您可以快速构建稳定、高效的持续集成流水线，加速软件交付周期。

更多使用示例可参考README.md中的"组合使用示例"章节，或查看测试用例tests/test_wait_job_finish.py了解详细实现逻辑。

【免费下载链接】cci-job-clientA LKP jobs client for Compass-ci: submit LKP jobs and get the status of the LKP jobs项目地址: https://gitcode.com/openeuler/cci-job-client