检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单击“已包含语言”之后的图标,重新获取代码仓库语言,刷新后的列表新增了多种语言。 如果页面中已显示“PYTHON”,则忽略此步骤。 将PYTHON语言对应的开关打开。 在弹框中单击“确定”。 执行任务。 单击“开始检查”,启动任务。 当页面显示,表示任务执行成功。 如果任务执行失败,请根据页面弹出报错提示排查修改。
warning_suppression_total 抑制告警数。 统计被扫描文件的告警抑制语句出现的数量。注释中的字符串符合特定正则表达式,则会被认为是告警抑制语句。不同语言对应的正则表达式请参考表5。 该参数需启用Cmetrics规则后生效。 warning_suppression_kloc 抑制告警密度。
status 是 String 新/老数据表示,默认1 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body参数 参数 参数类型 描述
基本概念 表1 代码检查服务基本概念 词汇 定义 重复率 重复行数是指涉及至少一次重复的代码行数;重复块是指包含重复行的代码块(最小重复块定义:Java语言连续10行重复,其它语言10行中连续100个字符重复算一个重复块);重复率=重复行/代码总行数(不包含空行与注释)。 规则
Check服务页面的导航栏选择“设置 > 通用设置 > 服务扩展点管理”。 单击“新建服务扩展点”,在下拉列表中选择“通用Git”。 在弹框中配置以下信息,单击“确定”。 表2 新建通用Git服务扩展点 参数 说明 连接名称 自定义,支持中文、英文、数字、“-”、“_”、“.”、空
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
在项目下的CodeArts Check服务页面的导航栏选择“设置 > 通用设置 > 服务扩展点管理”。 单击“新建服务扩展点”,在下拉列表中选择“GitCode”。 参考表2在弹框中配置参数。 表2 GitCode服务扩展点参数说明 参数 说明 连接名称 服务扩展点的名称,可自定义。例如:GitCode。
200 表6 响应Body参数 参数 参数类型 描述 task_id String 检查任务id 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表8 响应Body参数
检查任务列表可查看对应仓库的检查任务。 以下示例为在代码托管服务中创建云端仓库不勾选“自动创建代码检查任务”时,Repo代码源代码检查任务的创建步骤。 基于项目入口访问CodeArts Check服务首页。 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表1配置参数。
String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型 描述 check_id 是 Integer 检查工具ID,参数已废弃 ruleset_id 是 String 规则集ID,可以通过查询任务的已选规则集列表接口获取 language 是 String
本文汇总了基于代码检查服务(CodeArts Check)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松检查代码。 表1 CodeArts Check最佳实践一览表 最佳实践 说明 使用预置规则检查GitCode代码仓中的代码质量 如果您的代码存放在GitCode代码仓中,可参考
置代码检查任务定时执行。 前提条件 已创建代码检查任务。 如果创建的是Repo代码源检查任务,则需要有代码仓库的访问权限。参考成员管理,可添加代码仓访问权限。 执行代码检查任务 基于项目入口访问CodeArts Check服务首页。 单击代码检查任务所在行的,根据页面提示等待任务执行完成。
201 表6 响应Body参数 参数 参数类型 描述 template_id String 规则集ID 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表8 响应Body参数
String 规则集ID 表2 Query参数 参数 是否必选 参数类型 描述 language 是 String 规则集语言 offset 否 Integer 分页索引,偏移量,非必填 limit 否 Integer 每页显示的数量,非必填 请求参数 表3 请求Header参数 参数
“代码编写、代码合并、版本发布”三层缺陷防护 “代码编写、代码合并、版本发布”三层缺陷防护,兼顾效率与质量 优秀的代码质量保障实践,往往将代码检查融入到开发作业流中,在用户代码编写、代码提交时进行自动化的审计检查,并对团队每日产出的代码进行持续编程规范和质量检查。 这一活动实践要
基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,搜索目标任务。在任务列表页,可以查看检查任务的状态。 新问题:表示本次代码检查任务执行后新增的问题。 未解决:表示该代码检查任务未解决的问题。 已解决:表示该代码检查任务已解决的问题。 单击检查任务名称,进入代码检查详情概览页,可查看的信息如下:
查看规则集的规则列表 功能介绍 根据项目ID、规则集ID等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/ruleset/{ruleset_id}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id
lt 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID ruleset_id 是 String 规则集ID language 是 String 规则集语言 请求参数 表2 请求Header参数
已开通CodeArts体验版套餐,如果还没有开通,可参考购买CodeArts套餐。 准备Repo代码仓 使用华为云账号登录华为云控制台页面。 单击页面左上角,在服务列表中选择“开发与运维 > 软件开发生产线 CodeArts”。 单击“立即使用”,进入软件开发生产线服务首页。 单击“新建项目”,选用“Scr
终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,服务的终端节点信息可参考地区和终端节点。 代码检查的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 代码检查的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京四 cn-north-4 codecheck-ext