You need to enable JavaScript to run this app.
导航
规则管理
最近更新时间:2024.07.16 19:52:12首次发布时间:2024.05.23 10:52:58

CodeCT 是一款自动检测任务代码和配置问题的工具,旨在提前发现开发流程中可能会遇到的风险,并落实数据研发规范。
在大数据开发过程中,通过使用 CodeCT ,可自动检测数据开发代码中存在的问题,例如 SQL 语法错误、代码风格不符合团队规范、潜在 BUG 等,帮助您有效提升开发代码质量,减少后续运维过程中可能出现的问题。
通过本功能,您可创建并管理开发规范校验规则。

1 约束限制

仅主账号或具备 DataLeapFullAccess 权限的子账号才可添加、修改、删除、开启/关闭规则。

2 前提条件

已开通湖仓一体分布式数据自治或、DataOps敏捷研发企业定制中的某个版本的解决方案。详细操作说明请参见 DataLeap 服务信息

3 操作步骤

  1. 登录 DataLeap 控制台。
  2. 选择智能市场 > CodeCT,单击控制台按钮,进入CodeCT页面。
  3. 选择规则管理,进入规则管理页面。
    图片
  4. 可查看当前租户下的所有检测规则,并执行以下操作:
    • 新建规则
      单击添加规则按钮,在弹出的侧拉窗口中,设置相关信息后,单击确认新建按钮,完成自定义规则创建。
      新建规则相关参数说明如下表所示。其中名称前带 * 的参数为必填参数,名称前未带 * 的参数为可选参数。

      参数

      说明

      *规则名称

      代码检测规则的名称。
      检测规则支持内置规则和自定义规则两种类型。

      • 内置规则:系统自带规则,仅可查看,不支持任何改动。
      • 自定义规则:名称自行设定,由字符点“.”、字母、数字、下划线、连字符、[]、【】、()、()或中文字符组成,长度不超过 127 个字符。

      *规则描述

      规则的描述信息,长度不超过200个字符。

      *添加方式

      自定义规则的添加方式,支持正则表达式可执行文件DSL文件三种方式,可根据实际场景选择。

      *正则表达式

      输入相应的正则表达式,来检查数据开发中的代码情况,例如:\s*(SELECT|select)\s+\*\s+
      添加方式正则表达式时,需设置该参数。

      *可执行文件

      通过点击上传按钮,将本地已创建好的可执行文件上传。
      添加方式可执行文件时,需设置该参数。

      *DSL文件

      通过点击上传按钮,将本地已创建好的脚本文件上传。
      添加方式DSL文件时,需设置该参数。

      参数

      规则中要使用到的参数信息,可为流水线 CodeCT 节点配置参数时提供参考。
      通过单击添加参数按钮,可设置参数名称、参数描述、默认值。

    • 搜索规则
      设置搜索条件,可以查看符合条件的规则信息列表。

    • 查看规则详情
      单击列表中某条规则的规则名称,可以查看该规则的详情。

    • 开启/关闭规则
      单击列表中某条规则的状态按钮,可以开启/关闭该规则的生效状态。

    • 编辑规则
      单击列表中某条规则操作列的修改按钮,可以修改该规则信息。

    • 删除规则
      单击列表中某条规则操作列的删除按钮,二次确认后,可删除该规则。

      说明

      若校验规则已被使用,则需先前往流水线管理页面,将项目绑定的该校验规则去除后,才可删除。

4 后续操作

规则创建后,可前往相关项目的项目管理 > 流水线管理页面,为流水线配置相应的 CodeCT 规则节点。流水线配置相关说明请参见配置流水线