文档首页> 流水线 CodeArts Pipeline> 最佳实践> 准出条件之Check代码检查策略
更新时间:2023-10-26 GMT+08:00
分享

准出条件之Check代码检查策略

CodeArts Pipeline提供统一的准出条件管理能力,使用规则和策略将插件和流水线联系起来,并最终实现阶段准出的校验。用户根据实际需要将策略资源应用到流水线作为准出条件,帮助高效管理项目,保障产品高质量交付。

策略在流水线编排时进行展示和选择,作为阶段准出条件来控制流水线的执行;规则基于扩展插件的输出阈值,设置比较关系和阈值条件,供策略使用,并最终应用到流水线准出条件中,作为准出的判断依据。目前支持配置规则的官方插件包括:Check代码检查、Build构建和TestPlan接口测试。

  • Check代码检查:调用CodeArtsCheck代码检查能力,返回检查结果中致命、严重、一般、提示问题数与问题总数。
  • Build构建:调用CodeArtsBuild构建能力,返回Maven单元测试的用例通过率、用例总数和分支覆盖率。
  • TestPlan接口测试:调用CodeArtsTestPlan接口测试能力,返回测试结果的API测试通过率。

操作流程

以“Check代码检查”为例,通过添加代码检查任务所在阶段的准出条件,对代码检查任务的检查结果进行校验,只有检查结果满足准出条件,才可以进入下一个阶段。基本操作流程如下:

准备工作

  • 新建项目(以Scrum项目为例,命名为“Project01”)。
  • 在项目下新建代码仓库并自动创建代码检查任务(以Maven模板为例,去勾选“自动创建代码检查任务”,命名为“repo01”)。
  • 基于“repo01”仓库新建代码检查任务(命名为“check01”)。
  • 基于“repo01”仓库新建构建任务(以Maven模板为例,命名为“build01”)。
  • 基于“repo01”仓库新建流水线(以空模板为例,命名为“pipeline01”)。

步骤1:新建规则并配置阈值

  1. 登录软件开发生产线
  2. 单击右上角头像图标,在下拉菜单中选择“租户设置”,进入租户设置页面。
  3. 单击左侧导航“策略管理 > 规则”,进入规则管理页面。
  4. 单击“新建规则”,进入“新建规则”页面,配置以下信息。
    图1 新建规则
    表1 配置规则信息

    参数项

    说明

    名称

    规则名称,输入“规则01”。

    类型

    规则类型,选择“代码检查”。

    选择插件

    规则绑定的插件名称,选择“Check代码检查”。

    插件版本

    规则绑定的插件版本,选择“0.0.1”。

    阈值配置

    根据选中的插件版本自动获取的插件输出阈值配置,这里使用默认值即可。

  5. 单击“确定”。

步骤2:新建策略并添加规则

策略实行分层管理,可分为租户级策略和项目级策略。其中,租户级策略可以应用到当前租户下所有项目的流水线,项目级策略可以应用到当前项目下所有流水线。本节以租户级策略为例进行介绍。

  1. 单击左侧导航“策略”,进入策略管理页面。

    租户级策略中默认存在一条“系统策略”,用户可查看和使用该策略,但不能进行编辑和删除。

  2. 单击“新建策略”,进入“新建策略”页面,策略名称输入“策略01”,勾选步骤1中新建好的规则“规则01”。
    图2 新建策略
  3. 单击“确定”。

步骤3:配置流水线

  1. 单击顶部导航“首页”,返回软件开发生产线首页。
  2. 找到准备工作中已创建的项目,单击项目名称,进入项目。
  3. 单击左侧导航“持续交付 > 流水线”,进入项目下流水线列表页面。
  4. 搜索准备工作中已创建的流水线,单击“操作”列,选择“编辑”,进入“任务编排”页面。
  5. 在“阶段_1”添加准备工作中已创建的代码检查任务,然后单击“阶段_1”的,在弹出的侧滑框里添加“标准策略准出条件”,并选择步骤2中新建好的策略“策略01”。
    图3 添加准出条件
  6. 单击或者,为流水线添加一个新阶段,并在新阶段添加准备工作中已创建的构建任务。
    图4 配置流水线

步骤4:执行流水线验证准出条件

  1. 配置完流水线后,单击“保存并执行”,等待流水线执行。
  2. 执行完成后,可以看到当代码检查任务检查结果通过准出条件校验,并顺利执行到下一阶段。
    图5 执行流水线
分享:

    相关文档

    相关产品