检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
代码检查服务入门实践 当用户开通代码检查服务后,可以根据不同的业务场景灵活使用。 本文介绍常见的代码检查实践。 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
Array of RuleSetV2 objects 指定规则集 task_type 否 String 检查类型,支持full/inc两种类型,full表示全量检查,inc表示mr检查 username 否 String 仓库有权限的用户名 access_token 否 String
配置代码检查任务 配置代码检查任务规则集 配置代码检查任务质量门禁 配置代码检查任务定时执行 配置代码检查任务消息通知 配置代码检查任务检查模式 查看徽标状态 配置代码检查任务集成服务 配置代码检查任务自定义环境 配置代码检查任务高级选项
代码检查安全增强 CodeArts Check提供代码安全检查增强包的能力,其安全检查能力作为深度价值特性,能深度识别代码中安全风险和漏洞,提供了套餐包内规则不覆盖的安全类场景,比如数值错误、加密问题、数据验证问题等。针对业界的安全漏洞检测项提供了更深入的分析能力,如跨函数、跨文件、污点分析、语义分析等。
终止检查任务 功能介绍 根据任务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参数
查看徽标状态 执行完代码检查任务后,您可通过徽标状态查看代码健康度,并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下: 致命:5 严重:3 一般:1 提示:0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量,各个健康度对应的标识如下: A:健康度<=0
自研代码检查引擎 自研代码检查引擎,全面评估代码质量七特征 代码检查服务的核心就是代码检查引擎,高效精准的代码检查引擎能够很好地帮助用户在开发早期快速、准确地发现代码问题,兼顾开发效率与产品质量。 代码检查引擎团队凝聚了国内40+博士、海外研究所50+专家、国内外10+老师合作成
当页面显示,表示任务执行成功。 如果任务执行失败,请根据页面弹出报错提示排查修改。 查看检查结果 代码检查服务提供检查结果统计,并对检查出的问题提供修改建议,可以根据修改建议优化项目代码。 在代码检查任务中,选择“概览”页签,即可查看任务执行结果统计。 单击“代码问题”页签,即可看到问题列表。
查询任务检查失败日志 功能介绍 查询任务检查失败日志,不传execute_id则查询最近一次的检查日志 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/log-detail 表1 路径参数 参数 是否必选 参数类型
际业务场景选择。 前提准备 已开通并授权使用代码检查服务授权使用代码检查服务。 操作流程 表1 操作流程 流程 说明 创建代码检查任务所属项目 为本实践新建项目。 新建通用Git服务扩展点 本实践检查第三方代码仓的代码质量,代码检查服务需通过CodeArts提供的扩展插件连接到第三方代码仓。
执行检查任务 功能介绍 执行检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArts
自定义规则参数说明 参数 说明 规则名称 创建的规则名称,可自定义。例如:检查调试代码。 工具规则名称 默认填充为规则源码文件名,不可手动修改。 检查工具 该检查规则使用的检查工具,当前仅支持SecBrella。 语言 该规则检查的编译语言,当前仅支持Java。 规则源码 该规则的源码文件。上传创建规则文件中生成的文件。
内置多款的开源工具与自研引擎一起提供丰富的检查规则(9000+)。 梳理各类场景需要,内置全面检查规则集、关键检查规则集、移动领域规则集、华为编程规范规则集等50+规则集,便于用户开箱即用。更多规则集详情,请参见代码检查规则集列表。 用户也可基于规则库定制满足场景专项需求的检查规则集
epo01”。 检查语言:选择需要检查的代码语言。这里选择“Java”。 单击“新建任务”自动进入代码检查详情页面。 单击“开始检查”执行代码检查任务。 查看代码检查结果 待代码检查任务执行完成后,自动显示代码检查结果,包括检查结果概览、代码问题、代码度量、检查日志以及代码健康度。
1 创建代码检查任务所属项目 创建代码检查任务所属的项目。 2 新建通用Git服务扩展点 本实践检查第三方代码仓的代码质量,代码检查服务需通过CodeArts提供的扩展插件连接到第三方代码仓。 3 创建通用Git代码检查任务 创建代码检查任务。 4 执行通用Git代码检查任务 执行代码检查任务。
选择需要检查的代码仓库,保持默认即可。 分支 选择需要检查的仓库分支,保持默认即可。 检查语言 选择需要检查的代码语言,选择“Java”。 单击“新建任务”,完成检查任务的创建。 执行GitCode代码检查任务 在代码检查页面任务列表中,单击“GitCodeCheckTask”代码检查任务所在行。 根据页面提示等待任务执行完成。
旧版代码检查计费方式如何收费? 本章节仅供老用户参考。 代码检查服务依赖需求管理服务,开通前请先开通需求管理服务。 服务的开通需要区分区域,因此开通前注意选择自己需要开通的区域。 服务开通后,需注意创建的资源也分区域。 例如,在“华北-北京四”中创建了“项目A”,在下次查看“项目
为本实践新建所需的自定义执行机资源池。 新建CodeArts Repo代码仓 为本实践新建存储代码的代码仓。 配置并执行代码检查任务 配置代码检查任务使用自定义执行机执行检查。 查看代码检查结果 通过查看检查日志可验证本次代码检查任务使用自定义执行机执行。 新建项目 使用华为云账号登录华为云控制台页面。 单击页面左上角,在服务列表中选择“开发与运维
Integer 检查工具ID name String 编译参数名称 checker_configs Array of CheckConfigInfo objects 检查参数配置信息 表6 CheckConfigInfo 参数 参数类型 描述 name String 检查参数名称 cfg_key