diff --git "a/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/CI-META\344\273\223\345\272\223\351\205\215\347\275\256\350\247\204\350\214\203.md" "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/CI-META\344\273\223\345\272\223\351\205\215\347\275\256\350\247\204\350\214\203.md" new file mode 100644 index 0000000000000000000000000000000000000000..623cee7e2a47c84f9ef35ad6b66a638aea5527f6 --- /dev/null +++ "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/CI-META\344\273\223\345\272\223\351\205\215\347\275\256\350\247\204\350\214\203.md" @@ -0,0 +1,190 @@ + +# 简介 +介绍 +```yaml +products: + Anolis23: #产品名称 + short_name: an23 #产品名缩写，用于创建测试任务 + branch: ['a23'] #匹配分支，分支中包含branch，则匹配成功 + Anolis8: + short_name: an8 + branch: ['a8'] + default: True #默认产品配置 + Anolis7: + short_name: an7 + branch: ['a7'] + Anolis8.4: + short_name: an8.4 + branch: ['a8.4'] + Anolis8.2: + short_name: an8.2 + branch: ['a8.2'] + Anolis7.9: + short_name: an7.9 + branch: ['a7.9'] + Anolis7.7: + short_name: an7.7 + branch: ['a7.7'] +``` + +## toneconfs.yaml +公共测试用例配置文件，可以在globals.yaml和ci.yaml中引用。 +```yaml +basic_test: + tone_workspace: packageci + tone_project: Anolis_Packages + tone_test_suite: anolis-ci-test + tone_test_conf: group=basic_test + tone_test_case: check_license,check_specfile,check_codestyle +rpm_test: + tone_workspace: packageci + tone_project: Anolis_Packages + tone_test_suite: anolis-ci-test + tone_test_conf: group=rpm_test + tone_test_case: pkg_smoke_test,check_abi_diff,check_pkg_dependency +custom_test: + tone_workspace: packageci + tone_project: Anolis_Packages + tone_test_suite: anolis-ci-test + tone_test_conf: group=custom_test + tone_test_case: custom_script +``` + +## globals.yaml +全局配置文件，指明组织仓库运行的测试任务和任务运行方式。 +```yaml +src-anolis-os: #仓库所属组织名称 + code_test: #任务名称 + tone_test: basic_test #任务配置，来自公共测试用例配置文件 + server_config: '{product}-anck-x86_64' #任务运行机器配置，product为产品配置 + abs_build: + type: abs #任务类型，默认为tone + integration_test: + depend: [abs_build] #依赖任务，如果依赖任务失败，则不允许本任务 + tone_test: rpm_test + server_config: #支持不同规格服务器 + x86_64: '{product}-anck-x86_64' + aarch64: '{product}-anck-aarch64' + parallel: #任务运行方式，由上到下串行执行 + - code_test, abs_build #同一层并行执行 + - integration_test +``` + +# 自定义配置 + +## ci.yaml +当全局配置不能满足某个仓库的测试需求时，可以通过配置repos中的ci.yaml来接入自定义配置，ci.yaml中分为仓库配置，测试配置，通知配置。 + +### 仓库配置 +```yaml +#pr，即提交pr就会触发测试，支持gitee平台和github平台 +repo: + git_url: https://gitee.com/anolis/ci-meta.git + trigger_mode: pr + +#pull，定时监测指定仓库分支的commit，如果变化则触发测试 +repo: + git_url: https://gitee.com/anolis/ci-meta.git + git_branch: master + trigger_mode: pull + trigger_time: * * * * * #crontab风格时间表达式 +``` + +### 测试配置 +```yaml +#示例1，引用全局配置 +test: + test_task_1: + tone_test: basic_test + server_config: {product}-anck-x86_64 + +#示例2，覆盖全局配置 +test: + test_task_2: + tone_test: basic_test + basic_test: + tone_test_case: check_license,check_specfile + server_config: {product}-anck-x86_64 + +#示例3，自定义测试配置 +test: + test_task_3: + tone_test: keentune + keentune: + tone_workspace: keentune + tone_project: keentune + tone_test_suite: keentune + tone_test_conf: default + server_config: {product}-anck-x86_64 + +#示例4，自定义脚本配置 +test: + test_task_4: + tone_test: script + entry: test.sh #测试脚本需要放到ci.yaml同级目录中 + server_config: {product}-anck-x86_64 + +#示例5，运行并行测试任务 +test: + test_task_5: + tone_test: basic_test + server_config: {product}-anck-x86_64 + test_task_6: + tone_test: basic_test + server_config: {product}-anck-aarch64 + parallel: + - test_task_5, test_task_6 + +#示例6，运行串行测试任务 +test: + test_task_7: + tone_test: basic_test + server_config: {product}-anck-x86_64 + test_task_8: + tone_test: basic_test + server_config: {product}-anck-aarch64 + parallel: + - test_task_7 + - test_task_8 + +#示例8，扩展T-One配置 +test: + test_task_8: + tone_test: basic_test + basic_test: + tone_test_case: check_license,check_specfile + server_config: {product}-anck-x86_64 + tone_extend: #详细参数请参考 T-One API + need_reboot: 1 + script_info: + - pos: before + script: sleep 10 +``` + +### 通知配置 +```yaml +notice: + notice_mode: any/on_success/on_fail #通知模式，支持任意/仅成功/仅失败 + callback: 'https://xxx.com' + email: ['x1@xx.com', 'x2@xx.com'] + dingding: ['token1', 'token2'] +``` +上述三个部分组成一份ci.yaml，以下是一个完整示例： +```yaml +repo: + git_url: https://gitee.com/anolis/keentune.git + git_branch: master + trigger_mode: pull + trigger_time: 23 * * * * +test: + keentune_test: + tone_test: keentune + keentune: + tone_workspace: packageci + tone_project: Anolis_Packages + tone_test_suite: keentune + tone_test_conf: default + server_config: {product}-anck-x86_64 +notice: + dingding: ['token1', 'token2'] +``` diff --git "a/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\345\206\205\346\240\270\344\273\243\347\240\201\351\227\250\347\246\201\347\263\273\347\273\237\344\275\277\347\224\250\346\214\207\345\215\227.md" "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\345\206\205\346\240\270\344\273\243\347\240\201\351\227\250\347\246\201\347\263\273\347\273\237\344\275\277\347\224\250\346\214\207\345\215\227.md" new file mode 100644 index 0000000000000000000000000000000000000000..a982b6595d841123fc991bdc046ff53005cdd7dc --- /dev/null +++ "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\345\206\205\346\240\270\344\273\243\347\240\201\351\227\250\347\246\201\347\263\273\347\273\237\344\275\277\347\224\250\346\214\207\345\215\227.md" @@ -0,0 +1,53 @@ + +# 背景介绍 +5555555555555566665555555555555555 +开发者fork内核代码仓库，并在本地进行开发，无需提交PR也可使用代码门禁的自助检测模式对已开发的代码进行检测，自助模式没有CLA检查和签名检查，仅触发代码测试流程，能够帮助开发者提前了解代码质量情况和问题。
使用社区帐号登录[CBC](https://cbc.openanolis.cn)，点击创建任务，首先选择fork仓库的源分支，然后将默认的代码仓库和代码分支修改为开发者自己的仓库和分支，其余选项可按照自身需求进行选择，最后点击确定即可进入代码测试流程，等待执行完毕，即可点击查看，跳转到任务详情页，查看详细的执行日志。
由于测试资源紧张，每位开发者仅允许创建两个执行的任务（一个x86一个arm，也可以两个x86任务），需等待之前提交的任务完成之后才能再次提交新的任务，每次检测提交的commit个数不能超过50个。 + +# 附录 + +## 命令说明 +| 回复命令 | 功能 | 可使用人员 | +| --- | --- | --- | +| /check-cla | 检查PR提交者签署CLA协议情况 | PR提交者，openanolis企业成员 | +| /retest | 重新进入代码测试流程 | PR提交者，openanolis企业成员 | +| /skip-test | 跳过代码测试流程 | maintainer | +| /merge | 进行代码合入 | maintainer | + + +## 标签说明 +| 标签 | 说明 | +| --- | --- | +| anolis_cla_pass | PR提交者已签署CLA协议 | +| anolis_cla_fail | PR提交者未签署CLA协议 | +| anolis_testing | 代码测试中 | +| code_update | 代码测试中发生了代码更新 | +| anolis_test_pass | 代码测试通过 | +| anolis_test_fail | 代码测试未通过 | +| anolis_merge_pass | 自动合入通过 | +| anolis_merge_fail | 自动合入未通过 | + + +## 检测说明 +| 检测项 | 检测目标 | 检测范围 | +| --- | --- | --- | +| review检测 | 检查每个commit log是否包含规范字段，例如#ANBZ等 | 每一个commit | +| checkpatch检测 | 与上游社区的checkpatch检测保持一致，范围根据情况有一定适配 | 每一个龙蜥自研的commit | +| build检测 | anolis_defconfig | 每一个commit，区分aarch64与x86_64 | +| kconfig检测 | 检测所有的config文件是否有新的config选项未设置，防止编译出错 | 只检测所有提交中的最后一个commit，区分aarch64与x86_64 | +| 全量build检测 | allnoconfig，allyesconfig，defconfig，anolis_defconfig，anolis-debug_defconfig | 只检测所有提交中的最后一个commit，区分aarch64与x86_64 | +| 启动检测 | 检测PR代码所构建出的内核rpm安装之后能否正常启动 | 只检测所有提交中的最后一个commit，区分aarch64与x86_64 | + + + +## checkpatch规则 +| 包含anolis自研前缀 | 修改内核配置 | 来自upstream | 检查checkpatch | +| --- | --- | --- | --- | +| 是 | 是 | 是（warning提示） | 是 | +| 是 | 是 | 否 | 是 | +| 是 | 否 | 是（warning提示） | 是 | +| 是 | 否 | 否 | 是 | +| 否 | 是 | 是（warning提示） | 否 | +| 否 | 是 | 否 | 否 | +| 否 | 否 | 是 | 否 | +| 否 | 否 | 否（error报错） | 否 | + diff --git "a/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\346\227\245\345\277\227\346\226\207\344\273\266/710/CI-META\344\273\223\345\272\223\351\205\215\347\275\256\350\247\204\350\214\203.md" "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\346\227\245\345\277\227\346\226\207\344\273\266/710/CI-META\344\273\223\345\272\223\351\205\215\347\275\256\350\247\204\350\214\203.md" new file mode 100644 index 0000000000000000000000000000000000000000..614cbe570056347caf469ff8fcd12762baace7d5 --- /dev/null +++ "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\346\227\245\345\277\227\346\226\207\344\273\266/710/CI-META\344\273\223\345\272\223\351\205\215\347\275\256\350\247\204\350\214\203.md" @@ -0,0 +1,147 @@ + +# 简介 + + + +## toneconfs.yaml +公共测试用例配置文件，可以在globals.yaml和ci.yaml中引用。 + + +## globals.yaml +全局配置文件，指明组织仓库运行的测试任务和任务运行方式。 +```yaml +src-anolis-os: #仓库所属组织名称 + code_test: #任务名称 + tone_test: basic_test #任务配置，来自公共测试用例配置文件 + server_config: '{product}-anck-x86_64' #任务运行机器配置，product为产品配置 + abs_build: + type: abs #任务类型，默认为tone + integration_test: + depend: [abs_build] #依赖任务，如果依赖任务失败，则不允许本任务 + tone_test: rpm_test + server_config: #支持不同规格服务器 + x86_64: '{product}-anck-x86_64' + aarch64: '{product}-anck-aarch64' + parallel: #任务运行方式，由上到下串行执行 + - code_test, abs_build #同一层并行执行 + - integration_test +``` + +# 自定义配置 + +## ci.yaml +当全局配置不能满足某个仓库的测试需求时，可以通过配置repos中的ci.yaml来接入自定义配置，ci.yaml中分为仓库配置，测试配置，通知配置。 + +### 仓库配置 +```yaml +#pr，即提交pr就会触发测试，支持gitee平台和github平台 +repo: + git_url: https://gitee.com/anolis/ci-meta.git + trigger_mode: pr + +#pull，定时监测指定仓库分支的commit，如果变化则触发测试 +repo: + git_url: https://gitee.com/anolis/ci-meta.git + git_branch: master + trigger_mode: pull + trigger_time: * * * * * #crontab风格时间表达式 +``` + +### 测试配置 +```yaml +#示例1，引用全局配置 +test: + test_task_1: + tone_test: basic_test + server_config: {product}-anck-x86_64 + +#示例2，覆盖全局配置 +test: + test_task_2: + tone_test: basic_test + basic_test: + tone_test_case: check_license,check_specfile + server_config: {product}-anck-x86_64 + +#示例3，自定义测试配置 +test: + test_task_3: + tone_test: keentune + keentune: + tone_workspace: keentune + tone_project: keentune + tone_test_suite: keentune + tone_test_conf: default + server_config: {product}-anck-x86_64 + +#示例4，自定义脚本配置 +test: + test_task_4: + tone_test: script + entry: test.sh #测试脚本需要放到ci.yaml同级目录中 + server_config: {product}-anck-x86_64 + +#示例5，运行并行测试任务 +test: + test_task_5: + tone_test: basic_test + server_config: {product}-anck-x86_64 + test_task_6: + tone_test: basic_test + server_config: {product}-anck-aarch64 + parallel: + - test_task_5, test_task_6 + +#示例6，运行串行测试任务 +test: + test_task_7: + tone_test: basic_test + server_config: {product}-anck-x86_64 + test_task_8: + tone_test: basic_test + server_config: {product}-anck-aarch64 + parallel: + - test_task_7 + - test_task_8 + +#示例8，扩展T-One配置 +test: + test_task_8: + tone_test: basic_test + basic_test: + tone_test_case: check_license,check_specfile + server_config: {product}-anck-x86_64 + tone_extend: #详细参数请参考 T-One API + need_reboot: 1 + script_info: + - pos: before + script: sleep 10 +``` + +### 通知配置 +```yaml +notice: + notice_mode: any/on_success/on_fail #通知模式，支持任意/仅成功/仅失败 + callback: 'https://xxx.com' + email: ['x1@xx.com', 'x2@xx.com'] + dingding: ['token1', 'token2'] +``` +上述三个部分组成一份ci.yaml，以下是一个完整示例： +```yaml +repo: + git_url: https://gitee.com/anolis/keentune.git + git_branch: master + trigger_mode: pull + trigger_time: 23 * * * * +test: + keentune_test: + tone_test: keentune + keentune: + tone_workspace: packageci + tone_project: Anolis_Packages + tone_test_suite: keentune + tone_test_conf: default + server_config: {product}-anck-x86_64 +notice: + dingding: ['token1', 'token2'] +``` diff --git "a/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\351\276\231\350\234\245\345\206\205\346\240\270CI\346\234\215\345\212\241-KernelCI.md" "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\351\276\231\350\234\245\345\206\205\346\240\270CI\346\234\215\345\212\241-KernelCI.md" new file mode 100644 index 0000000000000000000000000000000000000000..37557cb85194881c190a6f17712a06f5d1e7aa33 --- /dev/null +++ "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\351\276\231\350\234\245\345\206\205\346\240\270CI\346\234\215\345\212\241-KernelCI.md" @@ -0,0 +1,85 @@ + +# 服务介绍 +为保障龙蜥社区内核代码的质量，每当有新的内核代码仓库代码合入请求，即PR请求时，都会自动触发bot里的KernelCI流程（内核代码门禁系统），并由bot通过评论方式实时反馈流程进度，开发者可根据bot的回复，在PR中评论相应的命令，以推进流程继续，直至通过评审和测试，最终合入内核代码仓库。更多内核代码开发流程，请参考[Cloud Kernel开发流程](https://openanolis.cn/sig/Cloud-Kernel/doc/607596680293474815)。 + +# PR 规范 + +- 内核CI服务仅支持龙蜥社区官方[内核仓库](https://gitee.com/anolis/cloud-kernel)，及其它已被管理员审批的内核仓库。 +- 向内核仓库提交PR，请遵守[社区规范](https://openanolis.cn/sig/Cloud-Kernel/doc/607605992881480196)。 +- 为保证PR review质量，每个PR的commit数量请不要超过25个。 + + +# 操作流程 + +1. 每当内核仓库有新的PR提交时，bot首先会检查PR提交者的贡献者协议（CLA协议）签署情况，如果已签署，则会自动进入代码测试流程。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653584171830-16d6f12d-a4dc-426a-8ff5-e93bd91620c1.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=141&id=SmlPp&name=image.png&originHeight=282&originWidth=1746&originalType=binary&ratio=1&rotation=0&showTitle=false&size=143475&status=error&style=none&taskId=ucacd180f-47fe-4910-8a8e-b53987befd8&title=&width=873) + +2. 如果未签署，则会评论PR提示提交者未签署CLA协议。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653584416737-f1a82789-85d4-49d5-887e-8c1b949dca3f.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=160&id=wV9Sf&name=image.png&originHeight=320&originWidth=1740&originalType=binary&ratio=1&rotation=0&showTitle=false&size=195377&status=error&style=none&taskId=u7f8ed7c5-c23a-410e-abee-290983d196b&title=&width=870) + +3. 当开发者签署CLA协议之后，可以在PR中评论/check-cla重新检查协议签署情况，评论/check-cla不会触发测试流程，如需测试，评论/retest即可进入测试流程。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653584503259-d1fb4700-00ed-4852-9c68-c9baec30b35b.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=278&id=wFTwV&name=image.png&originHeight=556&originWidth=1766&originalType=binary&ratio=1&rotation=0&showTitle=false&size=196642&status=error&style=none&taskId=u134459b8-a67d-4c78-87c7-3171f2e4cbd&title=&width=883) + +4. 当测试完成之后，会把测试结果和详细结果链接一起评论到PR中。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653584761977-c682b4be-7d2d-473d-adcc-8109904ff2cd.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=276&id=yOgnc&name=image.png&originHeight=552&originWidth=1740&originalType=binary&ratio=1&rotation=0&showTitle=false&size=264370&status=error&style=none&taskId=u7c9b6e15-5a9d-4f8d-9a03-c31ca9a6345&title=&width=870) + +5. 如果测试失败，开发者可在修改代码之后，评论/retest重新进入代码测试流程。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2023/png/28856758/1677121622562-c0ffd198-a124-4456-bed3-9a81717b368a.png#clientId=ucd86df8e-644d-4&from=paste&height=600&id=R2nYg&name=image.png&originHeight=1200&originWidth=1650&originalType=binary&ratio=2&rotation=0&showTitle=false&size=542157&status=done&style=none&taskId=u44d508d9-ca90-4268-9055-2bb7297ccef&title=&width=825) + +6. maintainer可以评论/skip-test帮助开发者跳过某些可以忽略测试失败的场景。 +7. 当代码测试通过后，需由maintainer进行review，review不通过，则请开发者按照maintainer的意见和建议进行修改，如果有代码修改，则需要评论/retest重新进行测试。 +8. 当代码测试和review均通过时，可由maintainer评论/merge进行自动合入，合入后将会对本次PR的commit进行自动签名。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2023/png/28856758/1677122175219-2edb14fa-f5b4-4451-9590-bfd06e53179e.png#clientId=ucd86df8e-644d-4&from=paste&height=453&id=U5vnw&name=image.png&originHeight=906&originWidth=1532&originalType=binary&ratio=2&rotation=0&showTitle=false&size=359777&status=done&style=none&taskId=u998bc880-2735-4c36-b544-732464bbd06&title=&width=766) + +# 可用命令 +| 回复命令 | 功能 | 可使用人员 | +| --- | --- | --- | +| /check-cla | 检查PR提交者签署CLA协议情况 | PR提交者，openanolis企业成员 | +| /retest | 重新进入代码测试流程 | PR提交者，openanolis企业成员 | +| /skip-test | 跳过代码测试流程 | maintainer | +| /merge | 进行代码合入和自动签名 | maintainer | + + +# 标签说明 +每次bot操作均会在PR上打上状态标签，开发者可根据标签信息判断当前流程，并进行后续操作： + +| 标签 | 说明 | +| --- | --- | +| anolis_cla_pass | PR提交者已签署CLA协议 | +| anolis_cla_fail | PR提交者未签署CLA协议 | +| anolis_testing | 代码测试中 | +| code_update | 代码测试中发生了代码更新 | +| anolis_test_pass | 代码测试通过 | +| anolis_test_fail | 代码测试未通过 | +| anolis_merge_pass | 自动签名成功 | +| anolis_merge_fail | 自动签名失败 | + + +# 检测项 +| 检测项 | 检测目标 | 检测范围 | +| --- | --- | --- | +| review检测 | 检查每个commit log是否包含规范字段，例如#ANBZ等 | 每一个commit | +| checkpatch检测 | 与上游社区的checkpatch检测保持一致，范围根据情况有一定适配 | 每一个龙蜥自研的commit | +| build检测 | anolis_defconfig | 每一个commit，区分aarch64与x86_64 | +| kconfig检测 | 检测所有的config文件是否有新的config选项未设置，防止编译出错 | 只检测所有提交中的最后一个commit，区分aarch64与x86_64 | +| 全量build检测 | allnoconfig，allyesconfig，defconfig，anolis_defconfig，anolis-debug_defconfig | 只检测所有提交中的最后一个commit，区分aarch64与x86_64 | +| 启动检测 | 检测PR代码所构建出的内核rpm安装之后能否正常启动 | 只检测所有提交中的最后一个commit，区分aarch64与x86_64 | + + +# 接入方式 +KernelCI测试服务不但为龙蜥内核提供服务，还可以开放给合作企业，为合作企业的内核仓库提供测试服务。目前主要由SIG组形式进行合作，有需要的企业可以向内核SIG组提出申请，通过后由管理员进行配置，配置好后即可生效。具体接入流程如下： + +1. 合作企业内核SIG组向龙蜥内核SIG组提出接入申请 +2. 需要准备的材料有： + - 接入门禁的仓库分支和检测版本 + - maintainer邮箱列表 + - 在T-One上创建本SIG组的WorkSpace +3. 等待审批 +4. 通过后由管理员进行配置 +5. 配置完成，立即生效 diff --git "a/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\351\276\231\350\234\245\345\256\271\345\231\250CI\346\234\215\345\212\241-DockerCI.md" "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\351\276\231\350\234\245\345\256\271\345\231\250CI\346\234\215\345\212\241-DockerCI.md" new file mode 100644 index 0000000000000000000000000000000000000000..32cf053a580d3edc263b74572e516e8bcf0ecf54 --- /dev/null +++ "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\351\276\231\350\234\245\345\256\271\345\231\250CI\346\234\215\345\212\241-DockerCI.md" @@ -0,0 +1,134 @@ + +# 服务介绍 +为了支持龙蜥社区容器镜像的构建发布流程，bot为社区容器镜像仓库提供了基于龙蜥系统的DockerCI测试服务，每当有新的PR提交时，bot会自动检测PR中的Dockerfile文件修改，并触发ABS容器镜像构建任务，当测试镜像构建成功时，会触发T-One容器镜像测试任务，测试项包含基础镜像测试和应用镜像测试，同时还允许开发着在仓库中引入自定义测试用例，当测试和review均通过，PR将被maintainer合入，同时系统会自动将测试镜像推送至官方正式仓库。 + +# PR 规范 + +- 容器CI服务仅支持龙蜥社区官方[容器仓库](https://gitee.com/anolis/docker-images)，和github上的容器仓库。 +- 为保证容器发布质量，向容器仓库提交PR时，每个PR中限制最多包含一个Dockerfile文件。 +- 应用镜像Dockerfile存储目录限制为：应用名/应用版本/操作系统版本/Dockerfile，例如：nginx/1.14.1/8.6/Dockerfile。 +- 当PR中不包含Dockerfile时，不触发构建和发布流程，由maintainer自行考虑合入。 + + +# 操作流程 + +1. 每当容器仓库有新的PR提交时，bot首先会检查PR提交者的贡献者协议（CLA协议）签署情况，如果已签署，则会自动进入代码测试流程。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653584171830-16d6f12d-a4dc-426a-8ff5-e93bd91620c1.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=141&id=u0a9e8f87&name=image.png&originHeight=282&originWidth=1746&originalType=binary&ratio=1&rotation=0&showTitle=false&size=143475&status=error&style=none&taskId=ucacd180f-47fe-4910-8a8e-b53987befd8&title=&width=873) + +2. 如果未签署，则会评论PR提示提交者未签署CLA协议。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653584416737-f1a82789-85d4-49d5-887e-8c1b949dca3f.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=160&id=u7365980b&name=image.png&originHeight=320&originWidth=1740&originalType=binary&ratio=1&rotation=0&showTitle=false&size=195377&status=error&style=none&taskId=u7f8ed7c5-c23a-410e-abee-290983d196b&title=&width=870) + +3. 当开发者签署CLA协议之后，可以在PR中评论/check-cla重新检查协议签署情况，评论/check-cla不会触发测试流程，如需测试，评论/retest即可进入测试流程。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653584503259-d1fb4700-00ed-4852-9c68-c9baec30b35b.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=278&id=u48661e02&name=image.png&originHeight=556&originWidth=1766&originalType=binary&ratio=1&rotation=0&showTitle=false&size=196642&status=error&style=none&taskId=u134459b8-a67d-4c78-87c7-3171f2e4cbd&title=&width=883) + +4. 当测试完成之后，会把测试结果和详细结果链接一起评论到PR中。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2023/png/28856758/1677123711013-3ce7aba0-9467-4d11-ae9c-054494f6232a.png#clientId=uc5190962-43ed-4&from=paste&height=545&id=uceeb48aa&name=image.png&originHeight=1090&originWidth=1446&originalType=binary&ratio=2&rotation=0&showTitle=false&size=522042&status=done&style=none&taskId=u2fe84899-483d-4aa0-931f-dfed904610a&title=&width=723) + +5. 如果测试失败，开发者可在修改代码之后，评论/retest重新进入代码测试流程，或者当有新的代码提交时，也会自动触发重新测试。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2023/png/28856758/1677123859843-7ed789bf-12bc-4950-960b-908188e7e486.png#clientId=uc5190962-43ed-4&from=paste&height=838&id=u7de105f3&name=image.png&originHeight=1676&originWidth=1522&originalType=binary&ratio=2&rotation=0&showTitle=false&size=783240&status=done&style=none&taskId=u652976ef-01a9-48c1-be0b-86ac9d5586c&title=&width=761) + +6. maintainer可以评论/skip-test帮助开发者跳过某些可以忽略测试失败的场景。 +7. 当代码测试通过后，需由maintainer进行review，通过之后，可由maintainer评论/merge进行自动合入，并将测试镜像推送到正式仓库中。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2023/png/28856758/1677123913431-70594fdb-96c2-4824-9f40-6e9034b40fec.png#clientId=uc5190962-43ed-4&from=paste&height=593&id=ue5da9dd0&name=image.png&originHeight=1186&originWidth=1454&originalType=binary&ratio=2&rotation=0&showTitle=false&size=427587&status=done&style=none&taskId=u27bf5e52-80a3-429a-bc59-1f71e26dc50&title=&width=727) + +# 可用命令 +| 回复命令 | 功能 | 可使用人员 | +| --- | --- | --- | +| /check-cla | 检查PR提交者签署CLA协议情况 | PR提交者，openanolis企业成员 | +| /retest | 重新进入代码测试流程 | PR提交者，openanolis企业成员 | +| /skip-test | 跳过代码测试流程 | maintainer | +| /merge | 进行代码合入 | maintainer | + + +# 标签说明 +每次bot操作均会在PR上打上状态标签，开发者可根据标签信息判断当前流程，并进行后续操作： + +| 标签 | 说明 | +| --- | --- | +| anolis_cla_pass | PR提交者已签署CLA协议 | +| anolis_cla_fail | PR提交者未签署CLA协议 | +| anolis_testing | 代码测试中 | +| code_update | 代码测试中发生了代码更新 | +| anolis_test_pass | 代码测试通过 | +| anolis_test_fail | 代码测试未通过 | + + +# 检测项 +| 测试类型 | 测试项 | 描述 | +| --- | --- | --- | +| 启动测试 | test_container_startup | 使用被测容器镜像启动容器，检查内核、编程语言等是否符合预期 | +| 应用容器状态检查 | test_container_basic | 启动应用容器后，检查容器的启动状态是否符合预期 | +| 应用容器网络端口检查 | test_container_network | 启动应用容器后，检查容器的网络端口是否能正常访问 | +| 应用容器服务检查 | test_container_service | 启动应用容器后，检查容器内的应用服务是否开启且状态正常 | +| 应用容器进程检查 | test_container_process | 启动应用容器后，检查容器的应用进程存在且处于运行状态 | + + +# 接入方式 +目前暂不支持其它类型的容器仓库接入，但是支持每个应用自定义测试用例，方便开发者进行测试使用。 + +- 自定义测试功能接入 + +需要在应用的Dockerfile文件的同级目录创建配置文件ci.yaml，生效优先级为：源仓库中Dockerfile同级的ci.yaml > 合入仓库中Dockerfile同级的ci.yaml > CI-META仓库中的[全局容器测试配置](https://gitee.com/anolis/ci-meta/blob/master/packages/d/docker-images/ci.yaml)，详细参数配置含义请参考CI-META仓库配置规范，以下是默认ci.yaml配置： +```yaml +repo: + git_url: https://gitee.com/anolis/docker-images + trigger_mode: pr +test: + docker_build: + test_type: docker #1-6行为配置容器构建，无需修改 + docker_base_test: #指定测试case，可按需修改 + tone_test: base_test #测试case名称 + base_test: #测试case详细配置 + tone_workspace: container_ci_test #测试case工作空间 + tone_project: default_container_ci_test #测试case项目 + tone_test_suite: image-ci-test #测试case suite + tone_test_conf: group=container_startup_test #测试case conf + server_config: #测试case机器配置，可按需修改 + x86_64: anolis-container-func-test-x86 + aarch64: anolis-container-func-test-arm64 + docker_app_test: + tone_test: app_test + app_test: + tone_workspace: container_ci_test + tone_project: default_container_ci_test + tone_test_suite: image-ci-test + tone_test_conf: group=application_container_func_test + server_config: + x86_64: anolis-container-test-x86 + aarch64: anolis-container-test-arm64 + parallel: #任务调度逻辑，上下串行，左右并行 + - docker_build + - docker_base_test, docker_app_test +``` + +- 自定义测试脚本接入 + +ci.yaml中支持接入自定义测试脚本，详细参数配置含义请参考CI-META仓库配置规范，以下是自定义测试脚本接入例子： +```yaml +test: #ci.yaml中的test + test_task: #自定义测试任务名称 + tone_test: script #自定义测试任务类型，固定为script + entry: test.sh #测试脚本需要放到ci.yaml同级目录中 + server_config: {product}-anck-x86_64 #自定义测试脚本使用机器配置 +``` + +- 开源测试case接入 + +如果用户将自己的测试用例贡献到开源T-One的测试用例库中，则可以在ci.yaml中直接配置测试case，具体贡献方式请参考T-One测试用例集成文档，以下是开源测试case接入例子： +```yaml +test: #ci.yaml中的test + test_task: #测试任务名称 + tone_test: self_test #开源测试case名称 + self_test: #开源测试case配置 + tone_workspace: self_test #开源测试case工作空间 + tone_project: self_test #开源测试case项目 + tone_test_suite: self_test #开源测试case suite + tone_test_conf: self_test #开源测试case conf + server_config: {product}-anck-x86_64 #开源测试case机器配置 +``` diff --git "a/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\351\276\231\350\234\245\350\275\257\344\273\266\345\214\205CI\346\234\215\345\212\241-PackageCI.md" "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\351\276\231\350\234\245\350\275\257\344\273\266\345\214\205CI\346\234\215\345\212\241-PackageCI.md" new file mode 100644 index 0000000000000000000000000000000000000000..6f62e43fc2f90ad9b0d69f4b4763e0645dd4cdbc --- /dev/null +++ "b/LOCK/CI\345\217\212\344\273\243\347\240\201\351\227\250\347\246\201/\351\276\231\350\234\245\350\275\257\344\273\266\345\214\205CI\346\234\215\345\212\241-PackageCI.md" @@ -0,0 +1,81 @@ + +# 服务介绍 +为了扩展龙蜥操作系统的能力，增强龙蜥系统软件包的兼容度，bot为社区OS软件包和其他主流平台的软件包提供了基于龙蜥系统的PackageCI测试服务，测试项不但包含官方统一的测试用例，还允许开发者自定义测试用例，并且同时支持PR级和Nightly级的CI流程，其中PR测试默认对Gitee上的OpenAnolis企业账户下的所有仓库生效，Nightly测试或者其他主流平台则需要通过注册进行服务接入。 + +# PR 规范 + +- 软件包CI服务支持龙蜥社区[官方仓库](https://gitee.com/openanolis)下所有仓库接入，及其它在CI-META[配置仓库](https://gitee.com/anolis/ci-meta)中注册的软件包仓库。 +- 暂未对软件包PR做规范检查，请自觉遵守社区规范。 + +# 操作流程 + +## PR流程 + +1. 每当软件包仓库有新的PR提交时，bot首先会检查PR提交者的贡献者协议（CLA协议）签署情况，如果已签署，则会自动进入CI测试流程。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653589644396-f695b137-38af-4dcc-8996-8068f450b5d8.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=127&id=W7axP&name=image.png&originHeight=254&originWidth=1716&originalType=binary&ratio=1&rotation=0&showTitle=false&size=109875&status=error&style=none&taskId=u0be67b93-214d-4049-af53-c44e532a864&title=&width=858) + +2. 如果未签署，则会评论PR提示提交者未签署CLA协议。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653589592953-2a9a003f-32e3-41f1-9878-2f0bbe64b11e.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=153&id=y7QgR&name=image.png&originHeight=306&originWidth=1730&originalType=binary&ratio=1&rotation=0&showTitle=false&size=162925&status=error&style=none&taskId=u67455779-cf28-4029-9691-01bfd91516a&title=&width=865) + +3. 当开发者签署CLA协议之后，可以在PR中评论/check-cla重新检查协议签署情况，评论/check-cla不会触发测试流程，如需测试，评论/retest即可进入测试流程。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/28856758/1653584503259-d1fb4700-00ed-4852-9c68-c9baec30b35b.png#clientId=u69fad9a3-bda9-4&errorMessage=unknown%20error&from=paste&height=278&id=sQ2lx&name=image.png&originHeight=556&originWidth=1766&originalType=binary&ratio=1&rotation=0&showTitle=false&size=196642&status=error&style=none&taskId=u134459b8-a67d-4c78-87c7-3171f2e4cbd&title=&width=883) + +4. 当测试完成之后，会把测试结果和详细结果链接一起评论到PR中。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2023/png/28856758/1677122840696-10f795d4-ef41-487b-b9e8-7e15ebc4efa1.png#clientId=uc86325b6-3082-4&from=paste&height=513&id=Agv7g&name=image.png&originHeight=1026&originWidth=1066&originalType=binary&ratio=2&rotation=0&showTitle=false&size=350252&status=done&style=none&taskId=u88b136b4-0369-4334-8e9c-ad3847fcbfc&title=&width=533) + +5. 如果测试失败，开发者可在修改代码之后，评论/retest重新进入代码测试流程，或者当有新的代码提交时，也会自动触发重新测试。 + +![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2023/png/28856758/1677123092022-c6892bca-5aa3-497b-99f0-4b9294e49273.png#clientId=uc86325b6-3082-4&from=paste&height=837&id=Rz4QM&name=image.png&originHeight=1674&originWidth=1466&originalType=binary&ratio=2&rotation=0&showTitle=false&size=704176&status=done&style=none&taskId=u937ed7e6-2a33-44ac-a619-cebb610dbff&title=&width=733) + +6. maintainer可以评论/skip-test帮助开发者跳过某些可以忽略测试失败的场景。 +7. 当CI测试通过之后，由maintainer进行评审，评审通过后将进行PR合入。 + +## Nightly流程 +（待后续实现） + +# 可用命令 +| 回复命令 | 功能 | 可使用人员 | +| --- | --- | --- | +| /check-cla | 检查PR提交者签署CLA协议情况 | PR提交者，openanolis企业成员 | +| /retest | 重新进入代码测试流程 | PR提交者，openanolis企业成员 | +| /skip-test | 跳过代码测试流程 | maintainer | + + +# 标签说明 +每次bot操作均会在PR上打上状态标签，开发者可根据标签信息判断当前流程，并进行后续操作： + +| 标签 | 说明 | +| --- | --- | +| anolis_cla_pass | PR提交者已签署CLA协议 | +| anolis_cla_fail | PR提交者未签署CLA协议 | +| anolis_testing | 代码测试中 | +| code_update | 代码测试中发生了代码更新 | +| anolis_test_pass | 代码测试通过 | +| anolis_test_fail | 代码测试未通过 | + + +# 检测项 +| 测试类型 | 测试项 | 描述 | +| --- | --- | --- | +| 合规检查 | check_license
许可证检查 | 对spec文件和源码中的许可证进行检查 | +| 代码检查 | check_spec_file
Spec检查 | 对spec文件进行格式检查 | +| 代码检查 | check_code_style
编码规范 | 对源文件做检查，目前支持c/c++,python,shell | +| 构建测试 | abs_build
ABS构建 | 调用ABS构建服务进行软件包构建，回传rpm包链接 | +| 冒烟测试 | pkg_smoke_test
RPM Smoke | 下载rpm软件包，安装测试，命令行测试，LDD检查等，依赖构建测试结果 | +| 兼容性测试 | check_abi_diff
ABI兼容性测试 | 对rpm包的前后版本进行abidiff检查，依赖构建测试结果 | +| 依赖测试 | check_pkg_dependency
软件包依赖测试 | 对rpm包的前后版本进行依赖包检查，依赖构建测试结果 | + +# 接入方式 +在OpenAnolis企业账户下的所有仓库默认接入PackageCI流程，对每个PR进行测试。
同时，如果您有以下需求： + +1. OpenAnolis企业里的仓库想在PR中运行其他的CI测试 +2. 其他平台的软件包仓库也想进行PackageCI测试 +3. 想针对某个仓库进行Nightly级别的CI测试 +4. 等等 + + +通过在anolis/ci-meta仓库中提交PR进行注册，即可接入PackageCI流程，满足您的个性化测试需求，详细接入规范请参考《CI-META仓库配置规范》。