检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
任务设置 API 代码检查 CodeArts Check(原CodeCheck)是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量,助力企业成功。 支持区域: 华北-北京一,华北-北京
文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下: 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下: 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置。 增加任务配置高级配置。
单击任务名称时提示权限不足 问题现象 在代码检查服务任务列表中,单击任务名称,提示权限不足。 原因分析 操作的用户项目权限不足,当账号的项目权限为“测试经理”、“测试人员(含跨租户)”、“浏览者(含跨租户)”时,没有访问查看代码检查任务的权限。 处理方法 联系项目管理员(项目创建者、项目经理)修改当前账号角色。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
代码检查服务入门实践 当用户开通代码检查服务后,可以根据不同的业务场景灵活使用。 本文介绍常见的代码检查实践。 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
码评审(MR)的自动化检查。 当所在任务的代码仓库中有分支合并时,代码检查服务会自动生成一个代码检查子任务。 进入代码检查任务详情页面。 单击,在代码托管中新建MR请求。 合并分支相关操作请参见代码托管用户指南。 单击,通过下拉框中,可查看所有的MR触发代码检查的历史记录。 配置代码提交时执行
基础版所有特性 提供增强的代码安全检查规则,深度识别代码安全风险和漏洞 检查并发:10个任务并发数。 购买时长 可选择1个月~3年。 自动续费 勾选后将开启自动续费。自动续费规则请参考自动续费规则说明。 建议根据您业务所在物理区域就近选择,以减少网络延时。购买的套餐只在对应的区域生效,不能跨区域使用。
配置代码检查任务预置规则集 规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求,规则集也有相应的分类,比如对安全类、安卓应用、编程风格,使用这些类别进行检查的时候,规则集内的规则也会有所不同。 用户可根据实际需要更换代码检查任务使用的规则集,新启用的规则集将在下一次执行检查时生效。
计费价格请以代码检查价格详情实际计算中的价格为准。 资源扩展的计费项请参见计费项。 计费周期 代码检查服务计费周期是根据您购买的时长来确定的(以GMT+08:00时间为准)。一个计费周期的起点是您开通或续费套餐的时间(精确到秒),终点则是到期日的23:59:59。 例如,如果您在2023/03/08
Check”窗口,在底部工具栏单击“Setting”,弹出配置窗口。 单击配置窗口中“规则”左侧的图标可以查看规则详细信息。 根据实际需要确定勾选是否自动触发代码检查,然后输入检查的屏蔽目录和指定的扫描目录。 可以查看当前被激活/应用到的规则(包括状态、危险级别、编程语言、引擎标签、规则类型)或者根据规则集筛选规则(所有规则集/推荐规则集)。
从控制台获取项目ID 在调用接口的时候,部分URL中需要填入项目编号,所以需要获取到项目编号。项目编号获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,在项目列表中查看项目ID。 多项目时,展开“所属
配置代码检查任务自定义环境 当使用代码检查服务时,若常用的编译构建环境缺少您需要的依赖包、工具,无法满足您的使用需求时,您可通过自定义构建环境提供的基础镜像执行代码检查任务。 前提条件 已将自定义环境推送到镜像仓中,具体操作请参见制作镜像并推送到SWR仓库。 配置自定义镜像 基于项目入口访问CodeArts
兼顾效率与质量 优秀的代码质量保障实践,往往将代码检查融入到开发作业流中,在用户代码编写、代码提交时进行自动化的审计检查,并对团队每日产出的代码进行持续编程规范和质量检查。 这一活动实践要求已是安全开发过程SDL、DevSecOps等众多优秀开发模式推荐进行的实践要求。 代码检查
如修改的代码位置、系统、语言、模块、引擎等。 场景特点:Web服务面向Internet互联网,容易遭受DDos攻击、信息泄露等风险。 适用场景:互联网服务交付安全等级验收。 项目质量控制 应用:在交付过程中实时根据代码复杂度、重复率、质量得分控制风险。 场景特点:项目经理的共识“
云容器引擎 CCE 服务介绍 03:23 云容器引擎服务介绍 操作指导 代码检查 CodeArts Check 介绍如何创建并执行、查看任务 03:49 创建并执行、查看代码检查任务 云容器引擎 CCE 熟悉云容器引擎控制台 07:25 熟悉云容器引擎控制台 云容器引擎 CCE 熟悉云容器引擎控制台
问题数:检查出来的代码质量问题数。 延迟上线问题数:由于检查引擎的能力提升,出现的新问题数。 未解决新问题数:当前的代码检查结果中,未解决的问题个数。 已解决问题数:当前的代码检查结果中,已解决的问题个数 代码平均圈复杂度:代码的平均圈复杂度。 代码重复率:代码的重复率。 NBNC代码行:非空非注释的代码行数。
查询审计日志 云审计服务是安全解决方案中专业的日志审计服务,记录了CodeArts Check的相关操作事件,方便您日后的查询、审计和回溯。 支持审计日志的操作 表1 云审计服务支持CodeArts Check服务操作 操作名称 资源类型 事件名称 创建代码检查任务 task create
Service,CTS),是华为云安全解决方案中专业的日志审计服务,提供对各种云资源操作记录的收集、存储和查询功能,可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后,CTS可记录代码检查的管理事件和数据事件用于审计。 CTS的详细介绍和开通配置方法,请参见CTS快速入门。
配置项为目录且不支持文件,默认检查代码仓中所有代码。 配置的目录层级中不能包含“.”开头的目录。 如果检查目录输入框路径为空,则默认全部检查。如果有指定检查目录,则只检查检查目录中的文件,如果指定的检查目录中有勾选设置忽略文件,则被忽略的文件不参与检查。 检查目录只生效于不需要编译的文件。例如,A文件编译后产生了B文件,则不会输出B文件上的告警。
计费FAQ 旧版代码检查计费方式如何收费? 旧版本开通/关闭按需计费方式说明 已开通旧版代码检查服务,能否转换为新版本计费?