检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置代码检查任务预置规则集 规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求,规则集也有相应的分类,比如对安全类、安卓应用、编程风格,使用这些类别进行检查的时候,规则集内的规则也会有所不同。 用户可根据实际需要更换代码检查任务使用的规则集,新启用的规则集将在下一次执行检查时生效
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
执行代码检查任务 用户可以对目标代码检查任务执行检查,及时发现源代码中的代码问题。 执行代码检查有两种方式: 手动执行:创建完代码检查任务后手动执行代码检查任务。本章节介绍的为手动执行代码检查任务的操作指导。 定时执行:多用于日常执行代码检查,配置详情可参考配置代码检查任务定时执行
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权
代码检查服务入门实践 当用户开通代码检查服务后,可以根据不同的业务场景灵活使用。 本文介绍常见的代码检查实践。 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
计费项 资源扩展计费说明 代码检查支持资源并发扩展,计费项为代码检查并发数。 表1 并发数计费 计费项 计费项说明 适用资源扩展类型 计费公式 代码检查并发数 某一Region内,租户中所有代码检查任务的并发执行数量总和。 代码检查并发扩展 单价*并发数*购买时长
购买CodeArts Check 前提条件 已注册华为云并实名认证,如果还没有华为账号,请参考以下步骤创建。 打开华为云网站。 单击“注册”,根据提示信息完成注册。 注册成功后,系统会自动跳转至您的个人信息界面。 参考实名认证完成个人或企业账号实名认证。 购买CodeArts Check
手动续费 在云服务控制台续费 登录管理控制台。 单击左侧导航栏的图标,选择“开发与运维 > 代码检查 CodeArts Check”。 在页面订单列表中,单击待续费订单右上角“续费”。 进入“续费”页面,根据续费时长,判断是否勾选“统一到期日”,将资源到期时间统一到各个月的某一天(
配置代码检查任务定时执行 根据实际需要,设置代码检查任务的执行计划,定时执行默认分支的检查任务。 建议在非流水线使用情况下进行配置。 配置当天时间间隔必须在5分钟以上。 配置执行计划 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称
CodeArts Check最佳实践汇总 本文汇总了基于代码检查服务(CodeArts Check)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松检查代码。 表1 CodeArts Check最佳实践一览表 最佳实践 说明 使用预置规则检查GitCode
查看徽标状态 执行完代码检查任务后,您可通过徽标状态查看代码健康度,并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下: 致命:5 严重:3 一般:1 提示:0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量,各个健康度对应的标识如下: A:健康度<=0.001
支持主流开发语言 支持主流开发语言,内置9000+检查规则,便于用户开箱即用 代码检查服务支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/ArkTS等10+
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需要使用一个
使用前必读 欢迎使用代码检查服务(CodeArts Check)。代码检查是基于云端实现代码质量管理的服务,软件开发者可在编码完成后执行多语言的代码静态检查和安全检查,获取全面的质量报告,并提供缺陷的分组查看与改进建议,有效管控代码质量,帮助产品成功。 您可以使用本文档提供API对代码检查进行相关操作
代码检查服务(CodeArts Check)使用流程 代码检查(CodeArts Check)是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上,为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面的质量报告、便捷的问题闭环处理流程
身份认证与访问控制 身份认证 用户访问代码检查服务的方式有多种,包括代码检查用户界面、API、SDK,无论访问方式封装成何种形式,其本质都是通过代码检查提供的REST风格的API接口进行请求。 代码检查的接口需要经过认证请求后才可以访问成功。代码检查支持两种认证方式: Token认证
配置代码检查任务高级选项 配置新问题起始时间 在每个任务的基础上可以设置新问题起始时间。起始时间设置之后要重新扫描,问题的发现时间大于设置时间将被划分为新问题。如果没有设置起始时间,连续两次的检查结果对比,新增的就是新问题数。 基于项目入口访问CodeArts Check服务首页。
配置代码检查任务自定义环境 当使用代码检查服务时,若常用的编译构建环境缺少您需要的依赖包、工具,无法满足您的使用需求时,您可通过自定义构建环境提供的基础镜像执行代码检查任务。 前提条件 已将自定义环境推送到镜像仓中,具体操作请参见制作镜像并推送到SWR仓库。 配置自定义镜像 基于项目入口访问
资源扩展包 代码检查提供的资源扩展包为并发扩展,采用包年/包月,可增加检查任务并发执行数。 代码检查并发扩展 表1 代码检查并发扩展 计费方式 包年/包月 适用场景 当代码检查服务套餐中包含的代码检查任务并发数不满足实际使用需求时,可购买代码检查并发扩展。 计费项 并发数。 购买限制
基本概念 表1 代码检查服务基本概念 词汇 定义 重复率 重复行数是指涉及至少一次重复的代码行数;重复块是指包含重复行的代码块(最小重复块定义:Java语言连续10行重复,其它语言10行中连续100个字符重复算一个重复块);重复率=重复行/代码总行数(不包含空行与注释)。 规则 应用于检查某类代码问题