检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
自研代码检查引擎 自研代码检查引擎,全面评估代码质量七特征 代码检查服务的核心就是代码检查引擎,高效精准的代码检查引擎能够很好地帮助用户在开发早期快速、准确地发现代码问题,兼顾开发效率与产品质量。 代码检查引擎团队凝聚了国内40+博士、海外研究所50+专家、国内外10+老师合作成
配置代码检查任务定时执行 根据实际需要,设置代码检查任务的执行计划,定时执行默认分支的检查任务。 建议在非流水线使用情况下进行配置。 配置当天时间间隔必须在5分钟以上。 配置执行计划 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。
进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置 > 质量门禁”。 在“质量门禁”区域,根据质量要求开启门禁开关,并设置门禁阈值。 图1 配置质量门禁 完成后,单击“保存”。 您可单击“开始检查”执行检查任务并查看检查结果。 若问题级别数超过设定阈值,任务概览页面提示门禁结果为
选择需要检查的代码仓库。 是 Branch 选择需要检查的仓库分支。 是 检查语言 选择需要检查的代码语言。 否 创建代码检查任务后,如果您需要修改任务名称或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置
配置代码检查任务高级选项 配置新问题起始时间 在每个任务的基础上可以设置新问题起始时间。起始时间设置之后要重新扫描,问题的发现时间大于设置时间将被划分为新问题。如果没有设置起始时间,连续两次的检查结果对比,新增的就是新问题数。 基于项目入口访问CodeArts Check服务首页。
配置代码检查任务规则集 配置代码检查任务预置规则集 配置代码检查任务自定义规则集 父主题: 配置代码检查任务
查看代码检查结果 前提条件 您已创建并执行代码检查任务。 查看代码检查详情 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,搜索目标任务。在任务列表页,可以查看检查任务的状态。 新问题:表示本次代码检查任务执行后新增的问题。 未解决:表示该代码检查任务未解决的问题。
在代码检查详情页面可以手动切换“已检查分支列表”和“未检查分支列表”进行检查。 单击代码检查任务名称。 在“代码检查详情”页面,默认显示“概览”页签,单击可以切换不同分支。 切换目标分支后,单击“开始检查”,等待代码检查任务执行完成。 再次单击代码检查任务所在行的执行检查任务时,
变更代码检查服务规格 变更代码检查服务套餐规格 代码检查服务支持变更套餐规格,变更影响请参见变更配置后对计费的影响。 登录代码检查控制台。 找到代码检查服务套餐,单击“变更”。 根据需要选择变更规格、变更类型,勾选同意声明,单击“下一步”。 若变更类型选择“续费变更”,则还需要选择续费时长。
TaskCheckSettingsItem objects 检查参数信息 表4 TaskCheckSettingsItem 参数 是否必选 参数类型 描述 cfg_key 是 String 检查参数对应的key值,例如buildToolVersion编译工具版本 status 是 String 参数状态,off:关闭,on:开启
配置代码检查任务 配置代码检查任务规则集 配置代码检查任务质量门禁 配置代码检查任务定时执行 配置代码检查任务消息通知 配置代码检查任务检查模式 查看徽标状态 配置代码检查任务集成服务 配置代码检查任务自定义环境 配置代码检查任务高级选项
代码检查服务入门实践 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
Array of RuleSetV2 objects 指定规则集 task_type 否 String 检查类型,支持full/inc两种类型,full表示全量检查,inc表示mr检查 username 否 String 仓库有权限的用户名 access_token 否 String
当页面显示,表示任务执行成功。 如果任务执行失败,请根据页面弹出报错提示排查修改。 查看检查结果 代码检查服务提供检查结果统计,并对检查出的问题提供修改建议,可以根据修改建议优化项目代码。 在代码检查任务中,选择“概览”页签,即可查看任务执行结果统计。 单击“代码问题”页签,即可看到问题列表。
查看徽标状态 执行完代码检查任务后,您可通过徽标状态查看代码健康度,并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下: 致命:5 严重:3 一般:1 提示:0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量,各个健康度对应的标识如下: A:健康度<=0
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个C
删除检查任务 功能介绍 删除检查任务,执行中的任务删除无法再查看 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header参数
执行检查任务 功能介绍 执行检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArts
epo01”。 检查语言:选择需要检查的代码语言。这里选择“Java”。 单击“新建任务”自动进入代码检查详情页面。 单击“开始检查”执行代码检查任务。 查看代码检查结果 待代码检查任务执行完成后,自动显示代码检查结果,包括检查结果概览、代码问题、代码度量、检查日志以及代码健康度。
应用场景 Web应用安全检查 应用:使用规则集对Web开发语言进行代码检视,并为开发角色提供修复建议,比如修改的代码位置、系统、语言、模块、引擎等。 场景特点:Web服务面向Internet互联网,容易遭受DDos攻击、信息泄露等风险。 适用场景:互联网服务交付安全等级验收。 项目质量控制