检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限,详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数
代码检查服务(CodeArts Check)使用流程 代码检查(CodeArts Check)是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上,为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面的质量报告、便捷的问题闭环处理流程,帮助企业有效管控代码质量,助力企业成功。
Repo代码仓库中的代码质量 在代码开发过程中,编程人员能力和代码风格不一致,会影响代码的可阅读性和可维护性,例如代码注释要求。或者在某个平台/行业的代码编写要求比较特殊等一列问题,可通过使用代码检查服务检查代码质量。 本示例为您演示检查CodeArts Repo代码仓库中的代码质量,帮助您快速建立对代码检查服务的整体印象。
攻击者利用外部输入构造系统命令,通过可以调用系统命令的应用,实现非法操作的目的。 支持 支持 路径遍历 不支持 支持 攻击者利用系统漏洞访问合法应用之外的数据或文件目录,导致数据泄露或被篡改。 不支持 支持 SQL注入 支持 支持 攻击者利用事先定义好的查询语句,通过外部输入构造额外语句,实现非法操作的目的。 支持 支持
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
已参考软件开发生产线(CodeArts)的“用户指南 > 软件开发生产线(CodeArts)使用前准备 > 添加CodeArts项目成员”章节添加成员,并参考“管理CodeArts权限”章节为新增的成员赋予角色。 访问CodeArts Check服务首页 使用华为云账号登录华为云控制台页面。
项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数 参数 是否必选 参数类型
应用场景 在用户实际的使用场景中,用户往往有构建自己的代码质量管控平台,集成代码检查及其他检查项的需求。并且在用户的应用场景中,MR合入过程中的质量监控是一个高频应用场景。 本示例介绍如何通过调用CodeArtsCheck API方式,执行MR增量代码检查并获取检查结果。通过调用CodeArtsCheck
及服务组合开通方式。 也可单独开通代码检查服务。单独开通的计费方式请参见旧版代码检查计费方式如何收费?。 前提条件 请先注册华为账号并开通华为云(如果华为云账号已注册并开通华为云,请忽略该步骤),详细操作请参见注册华为账号并开通华为云。 开通按需 登录CodeArts控制台,在左
定义规则名.json”的源码文件,上传json文件即可。使用插件生成规则文件可参考插件使用指南。 是 严重级别 该规则检查出的代码问题的严重级别,分为致命、严重、一般和提示。 是 标签 为该规则设置标签,便于使用时区分该规则使用场景。 添加多个标签时,需使用英文逗号分隔。 否 描述
String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数
准确定位到问题所在代码行,用户可以在线查看并分析代码问题。 延迟上线 在工具版本升级后,由于代码检查服务检查引擎的能力提升,可能会出现新的缺陷。但新检查出来的缺陷,不会计算到正式缺陷中,开发者拥有60天的缓冲周期对代码进行修改,周期内没有修改或者屏蔽的缺陷,在周期结束后后会计算到正式缺陷中。
服务韧性 代码检查通过多活无状态的跨AZ部署、AZ之间数据容灾等技术方案,保证业务进程故障时快速启动并修复,以保障服务的持久性和可靠性。 父主题: 安全
代码检查服务可检查不同代码仓的代码质量,在创建代码检查任务前,需满足以下条件: 已新建CodeArts项目。 如果使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”,完成新建代码仓库。 如果使用的是第三方代码仓库,需已创建可用的代码仓库。
用代码风格检查规则集,检查自己的代码是否匹配选定风格。 代码健康度评分 一个综合性统一指标,与告警影响度、告警数量、代码量都有关系。自动计算代码健康度分数。 问题管理 通过问题管理中的问题描述、问题状态、检查规则、文件路径、源码以及修改建议等,对检查出来的问题进行处理。 代码圈复杂度
task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
配置代码检查任务预置规则集 规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求,规则集也有相应的分类,比如对安全类、安卓应用、编程风格,使用这些类别进行检查的时候,规则集内的规则也会有所不同。 用户可根据实际需要更换代码检查任务使用的规则集,新启用的规则集将在下一次执行检查时生效。
检查Worker功能对应代码的任务。 phoenix-codecheck-result 检查Result功能对应代码的任务。 phoenix-codecheck-vote 检查Vote功能对应代码的任务。 phoenix-sample-javas 检查整个代码仓库对应的JavaScript代码的任务。
兼顾效率与质量 优秀的代码质量保障实践,往往将代码检查融入到开发作业流中,在用户代码编写、代码提交时进行自动化的审计检查,并对团队每日产出的代码进行持续编程规范和质量检查。 这一活动实践要求已是安全开发过程SDL、DevSecOps等众多优秀开发模式推荐进行的实践要求。 代码检查