正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开通CodeArts Check 前提条件 已注册华为云并实名认证,如果还没有华为账号,请参考以下步骤创建。 打开华为云网站。 单击“注册”,根据提示信息完成注册。 注册成功后,系统会自动跳转至您的个人信息界面。 参考实名认证完成个人或企业账号实名认证。 购买CodeArts Check须知
代码检查服务(CodeArts Check)使用流程 代码检查(CodeArts Check)是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上,为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面的质量报告、便捷的问题闭环
任务执行完成后没有数据 问题现象 任务执行检查完毕后没有数据。 原因分析 源代码仓语言没有获取到。 检查语言开关没有打开。 处理方法 进入任务“设置 > 规则集”页面。 单击“已包含语言”所在行重新获取代码仓语言。 打开需要检查语言的开关。 重新执行检查。 父主题: 技术类问题
查询任务执行状态 功能介绍 根据任务ID查询任务执行状态。任务状态:0表示检查中,1表示检查失败,2表示检查成功,3表示任务中止。只有正在检查中才有进度的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/progress 表1 路径参数
新建检查任务 功能介绍 新建检查任务但是不执行。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 请求参数 表2 请求Header参数
创建的规则名称,可自定义。例如:检查调试代码。 工具规则名称 默认填充为规则源码文件名,不可手动修改。 检查工具 该检查规则使用的检查工具,当前仅支持SecBrella。 语言 该规则检查的编译语言,当前仅支持Java。 规则源码 该规则的源码文件。上传创建规则文件中生成的文件。 严重级别 该规则检
支持五大业界主流标准和华为编程规范 支持五大业界主流标准和华为编程规范,提升产品代码规范度 软件产品的质量问题往往导致产品产生不可接受的运营风险或过度成本,因此在源代码级别建立质量检测措施的标准是非常重要的,业界如ISO/IEC 5055标准、CERT编程规范等。 使用代码检查服务,可以对您的代码进行全面的质量检查。
什么是代码检查 代码检查(CodeArts Check)是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上,为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷闭环处理问题,帮助企业有效管控代码质量,助力企业成功。
查看徽标状态 执行完代码检查任务后,您可通过徽标状态查看代码健康度,并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下: 致命:5 严重:3 一般:1 提示:0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量,各个健康度对应的标识如下: A:健康度<=0
默认起始时间为当前任务第一次扫描成功的时间,起始时间之后扫描出的所有问题都将被划分为新问题。 配置源文件编码 设置文件的编码方式,源文件编码会影响系统识别的源码内容的完整性,系统默认编码为UTF-8。 在“源文件编码”区域,单击下拉框选择源文件编码。 完成后,提示修改成功。 配置问题责任人精准匹配
执行代码检查任务 用户可以对目标代码检查任务执行检查,及时发现源代码中的代码问题。 执行代码检查有两种方式: 手动执行:创建完代码检查任务后手动执行代码检查任务。本章节介绍的为手动执行代码检查任务的操作指导。 定时执行:多用于日常执行代码检查,配置详情可参考配置代码检查任务定时执行。
字符长度范围为1~128 是 工具规则名称 默认填充为规则源码文件名,不可手动修改。 是 检查工具 该检查规则使用的检查工具,当前仅支持SecBrella。 是 语言 该规则检查的编译语言,当前仅支持Java。 是 规则源码 该规则的源码文件。 由用户创建“.kirin”文件编写dsl规
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity
示例1:查询任务列表 场景描述 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下: 查询任务列表:根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI格式:GET
示例2:查询缺陷概要 场景描述 本章节指导用户根据检查任务ID查询缺陷结果的概要,包括问题概述、问题状态、圈复杂度、代码重复率等。 约束限制 任务存在。 涉及接口 涉及的接口如下: 查询缺陷概要:查询缺陷概要,包括问题概述、问题状态、圈复杂度、代码重复率等。 操作步骤 接口相关信息
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID 表2
创建自定义规则集 功能介绍 可根据需求灵活的组合规则。 调用方法 请参见如何调用API。 URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token
配置代码检查任务检查模式 您可以根据实际需求设置检查模式和检查目录,提高检查效率。 C#语言和secbrella引擎均不支持MR合入。 设置检查模式 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置
查询任务的已选规则集列表v2 功能介绍 查询任务的已选规则集列表v2。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。