Compass-CI 用户指南：从注册到提交测试任务的终极教程

Compass-CI 用户指南：从注册到提交测试任务的终极教程

【免费下载链接】compass-ciCompass-CI 是一个可持续集成的开源软件平台。为开发者提供针对上游开源软件（来自 Github, Gitee, Gitlab 等托管平台）的测试服务、登录服务、故障辅助定界服务和基于历史数据的分析服务。项目地址: https://gitcode.com/openeuler/compass-ci

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

Compass-CI 是一个可持续集成的开源软件平台，为开发者提供针对上游开源软件（来自 Github, Gitee, Gitlab 等托管平台）的测试服务、登录服务、故障辅助定界服务和基于历史数据的分析服务。本教程将带您从账号注册到成功提交测试任务，快速掌握 Compass-CI 的核心使用流程。

一、Compass-CI 平台架构概览

在开始使用前，先了解 Compass-CI 的整体架构有助于您更好地理解任务流转过程。Compass-CI 采用分层设计，从接入层到资源层形成完整的测试生态：

• 接入层：支持 SSH、代码托管平台（Gitee/GitHub/GitLab）和门户网站多种接入方式
• 服务层：提供调试任务、测试任务、结果分析等核心服务
• 支撑层：负责任务调度、队列管理和数据处理
• 数据层：存储任务数据、设备信息和测试结果
• 资源层：包括物理机、虚拟机和各类依赖仓库

二、账号注册与准备工作 🚀

2.1 注册账号

要使用 Compass-CI 服务，首先需要注册账号。详细的申请流程请参考官方文档：user-guide/apply-account.zh.md

2.2 安装客户端工具

注册成功后，需要安装 Compass-CI 客户端工具。推荐通过源码编译安装：

git clone https://gitcode.com/openeuler/compass-ci cd compass-ci make install-client

安装完成后，配置账号信息：

cci config --username your_account --email your_email@example.com

三、创建第一个测试任务 📝

3.1 了解任务配置文件

Compass-CI 使用 YAML 格式的配置文件定义测试任务。一个典型的任务配置文件包含测试套件、架构、操作系统版本等关键信息。示例配置文件路径：user-client/jobs/

3.2 编写任务配置

创建一个简单的测试任务配置文件my_test_job.yaml，内容如下：

suite: iperf category: benchmark os: openEuler arch: x86_64 testbox_group: vm-2p32g my_account: your_account

其中：

• suite：指定测试套件（如 iperf 网络性能测试）
• category：任务分类（如 benchmark 基准测试）
• os和arch：指定测试环境的操作系统和架构
• testbox_group：指定测试设备组
• my_account：您的 Compass-CI 账号

3.3 提交测试任务

使用cci submit命令提交任务：

cci submit my_test_job.yaml

提交成功后，您将获得一个任务 ID，用于后续查询任务状态和结果。

四、任务监控与结果查看 🔍

4.1 查看任务状态

提交任务后，可以通过以下命令查看任务状态：

cci job status <task_id>

您也可以在 Compass-CI 门户网站查看所有任务状态，典型的任务列表界面如下：

4.2 分析测试结果

任务完成后，测试结果会自动存储并生成分析报告。您可以通过以下命令获取结果：

cci result show <task_id>

测试结果包含详细的性能数据和对比分析，例如：

五、任务调试与环境重现 🔧

如果测试任务失败或需要复现测试环境，Compass-CI 提供了便捷的环境重现功能。参考文档：user-guide/reproduce-the-job-environment/

通过以下命令可以获取任务执行的详细环境配置：

cci job env <task_id>

配置信息将包含测试所用的根文件系统、内核版本、设备信息等关键参数，示例如下：

六、高级功能与最佳实践 ✨

6.1 使用任务模板

Compass-CI 提供了多种预定义的任务模板，位于 user-client/maintain/，您可以直接使用或根据需求修改。

6.2 批量提交任务

对于需要在多个环境中测试的场景，可以使用矩阵测试功能批量提交任务。配置示例：

matrix: arch: [x86_64, aarch64] os: [openEuler-22.03, openEuler-23.09]

6.3 故障辅助定界

Compass-CI 提供故障辅助定界服务，帮助定位测试失败原因。相关工具位于 sbin/git-bisect。

七、总结

通过本教程，您已经掌握了 Compass-CI 的基本使用流程，包括账号注册、任务配置、提交监控和结果分析。Compass-CI 为开源项目提供了强大的持续集成测试能力，帮助开发者提高代码质量和稳定性。

如需了解更多高级功能，请参考官方文档：doc/ 和 user-guide/。祝您在 Compass-CI 平台上测试愉快！

【免费下载链接】compass-ciCompass-CI 是一个可持续集成的开源软件平台。为开发者提供针对上游开源软件（来自 Github, Gitee, Gitlab 等托管平台）的测试服务、登录服务、故障辅助定界服务和基于历史数据的分析服务。项目地址: https://gitcode.com/openeuler/compass-ci