检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
动创建代码检查任务前的复选框,其他参数保持默认即可。单击“确定”,完成代码仓的创建。 创建完成后的代码仓文件目录如图3所示。 图3 代码仓文件目录 配置并执行代码检查任务 在页面导航栏中选择“代码 > 代码检查”。由于在创建代码仓时,已选择自动创建代码检查任务,因此在代码检查任务列表页,已展示对应的代码检查任务。
实践检查第三方代码仓的代码质量,代码检查服务需通过CodeArts提供的扩展插件连接到第三方代码仓。 创建通用Git代码检查任务并获取任务ID 创建代码检查任务并获取任务ID。 创建访问凭证AK和SK 创建调用API时使用的AK和SK。 下载KooCLI工具并获取代码检查API的调用命令
进入代码检查任务详情页面。 单击,在代码托管中新建MR请求。 合并分支相关操作请参见代码托管用户指南。 单击,通过下拉框中,可查看所有的MR触发代码检查的历史记录。 配置代码提交时执行 勾选“代码提交时执行”,表示对代码仓提交代码时会触发执行代码检查任务。 仅对已创建任务的分支有效。 单击“保存”。 父主题:
配置代码检查任务消息通知 CodeArts Check的通知设置支持系统项目级、服务项目级和任务级,您可以根据实际需求,设置代码检查任务事件类型的通知方式。入口分别如下: 服务项目级:进入项目详情页面,选择“代码 > 代码检查 > 配置中心 > 通知管理”。 任务级:进入代码检查详情页面,选择“设置
设置忽略的文件集合 代码检查服务支持用户以任务为单元,设置代码检查的文件范围。 不勾选文件路径时,则检查所选仓库分支的所有代码。 勾选指定文件路径时,则该指定路径下的文件将排除检查。 在“忽略的文件集合”区域,勾选无需进行检查的文件路径。设置完成后,执行代码检查任务,将按照设置排除选中的文件路径执行检查。
else { fmt.Println(err) } } 更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。 状态码 状态码 描述 200 Request succeeded! 400 Bad Request
项目级:进入项目详情页面,选择“代码 > 代码检查> 配置中心 > 质量门禁”。 任务级:进入代码检查详情页面,选择“设置 > 质量门禁”。 项目级和任务级支持事件通知设置。 本节以任务级门禁设置为例介绍操作步骤。 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。
else { fmt.Println(err) } } 更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。 状态码 状态码 描述 200 Request succeeded! 400 Bad Request
配置代码检查任务定时执行 根据实际需要,设置代码检查任务的执行计划,定时执行默认分支的检查任务。 建议在非流水线使用情况下进行配置。 约束与限制 配置当天时间间隔必须在5分钟以上。 配置执行计划 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。
安全 责任共担 身份认证与访问控制 数据保护技术 审计与日志 服务韧性 认证证书
Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置 > 高级选项 ”。 在“新问题起始时间”区域,单击设置新问题起始时间。 默认起始时间为当前任务第一次扫描成功的时间,起始时间之后扫描出的所有问题都将被划分为新问题。 配置源文件编码 设置文件
代码检查服务入门实践 当用户开通代码检查服务后,可以根据不同的业务场景灵活使用。 本文介绍常见的代码检查实践。 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
配置代码检查任务自定义环境 当使用代码检查服务时,若常用的编译构建环境缺少您需要的依赖包、工具,无法满足您的使用需求时,您可通过自定义构建环境提供的基础镜像执行代码检查任务。 前提条件 已将自定义环境推送到镜像仓中,具体操作请参见制作镜像并推送到SWR仓库。 配置自定义镜像 基于项目入口访问CodeArts
API可以不使用华为云前端,从而构建自己的全流程代码质量管控平台,同时也可以实现对非Codearts Repo代码仓的门禁级检查。本示例将以通用Git为例,进行方案介绍。 约束限制 每个通用Git扩展点仅能对接单个代码仓地址,同时1个CodeArts项目下的扩展点数量限制为1000。 示例仅介绍如何调用CodeArtsCheck
执行代码检查任务 用户可以对目标代码检查任务执行检查,及时发现源代码中的代码问题。 执行代码检查有两种方式: 手动执行:创建完代码检查任务后手动执行代码检查任务。本章节介绍的为手动执行代码检查任务的操作指导。 定时执行:多用于日常执行代码检查,配置详情可参考配置代码检查任务定时执行。
问题数:检查出来的代码质量问题数。 延迟上线问题数:由于检查引擎的能力提升,出现的新问题数。 未解决新问题数:当前的代码检查结果中,未解决的问题个数。 已解决问题数:当前的代码检查结果中,已解决的问题个数 代码平均圈复杂度:代码的平均圈复杂度。 代码重复率:代码的重复率。 NBNC代码行:非空非注释的代码行数。
变更代码检查服务规格 变更代码检查服务套餐规格 代码检查服务支持变更套餐规格,变更影响请参见变更配置后对计费的影响。 登录代码检查控制台。 找到代码检查服务套餐,单击“变更”。 根据需要选择变更规格、变更类型,勾选同意声明,单击“下一步”。 若变更类型选择“续费变更”,则还需要选择续费时长。
代码检查安全增强 CodeArts Check提供代码安全检查增强包的能力,其安全检查能力作为深度价值特性,能深度识别代码中安全风险和漏洞,提供了套餐包内规则不覆盖的安全类场景,比如数值错误、加密问题、数据验证问题等。针对业界的安全漏洞检测项提供了更深入的分析能力,如跨函数、跨文件、污点分析、语义分析等。
配置无感扫描:即勾选“代码编辑后保存,是否自动触发代码检查”。扫描完成不影响用户当前作业窗口,修改保存自动扫描、结果自动刷新在CodeArts Check窗口“Defects”页签下区域;取消勾选“代码编辑后保存,是否自动触发代码检查”则关闭该功能。 配置git代码提交时自动扫描:即
CodeArts Check套餐基础上,可以购买资源扩展包。 表1 代码检查套餐详情 代码检查套餐说明 适用场景 规格 特性 基础版 个人开发者和小微企业首选。 代码检查并发数量:5个 支持10+种基础语言代码质量检查:Java/C++/JavaScript/Go/Python/