检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
代码检查服务提供丰富的API接口、涵括任务新建、任务设置、任务扫描、任务报告解析等检查业务全流程,支持用户使用接口方式无缝集成到自建CI/CD或者CodeArts,作业数据灵活对接到客户看板,代码质量可视、可管理。 同时通过灵活的任务管理,支持排除目录设置避免无效扫描,并支持混合语言检查、简化部署、一次获取整个版本代码质量。
√ × × × × × × √ √ 执行 √ √ √ × × × × × √ √ √ 查看 √ √ √ × × × × × √ √ √ 编辑 √ √ √ × × × × × √ √ √ 删除 √ √ × × × × × × √ √ √ 规则集 设置默认规则集 √ √ × × × ×
停止计费 代码检查服务采用包年/包月计费模式,购买时进行一次性付费,订单到期后服务将会自动停止使用。 如果在计费周期内不再使用代码检查服务,您可以执行退订服务,代码检查服务套餐、资源扩展包均支持退订。系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户
如果您购买的代码检查服务套餐、资源扩展的到期日不同,可以将到期日统一设置到固定一个日期,便于日常管理和续费。 图1展示了用户将两个不同时间到期的资源,同时续费一个月,并设置“统一到期日”后的效果对比。 图1 统一到期日 更多关于统一到期日的规则请参见如何设置统一到期日。 父主题: 续费
都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
联系项目管理员(项目创建者、项目经理)修改当前账号角色。 管理员账号CodeArts首页,选中要授权的项目(以Scrum项目为例)。 在项目内单击“设置 > 权限管理”。 选择角色以及服务名称,勾选对应的权限。 父主题: 技术类问题
该规则的源码文件。上传创建规则文件中生成的文件。 严重级别 该规则检查出的代码问题的严重级别,分为致命、严重、一般和提示。这里设置为“提示”。 标签 为该规则设置标签,便于使用时区分该规则使用场景。非必填,无需填写。 说明: 添加多个标签时,需使用英文逗号分隔。 描述 对该规则的使用
单击“规则集”页签,进入规则集列表页面。 单击“新建规则集”,在弹出的“新建规则集”窗口设置规则集名称、描述以及检查语言。 您也可以单击“复制于”下拉框选择复制于已有的规则集,基于复制的规则集配置使用的规则。 单击“确定”。 根据需要勾选规则名称、设置规则级别,单击右上角“保存”。 如果系统预置的规则不满足用户的使用要求,可自定义规则使用。
技术类问题 执行代码检查任务时提示:任务正在执行,稍后重试 执行代码检查任务时提示:权限不足,请核对后再试 执行代码检查任务时提示:单个任务并发数超过套餐限制,任务无法下发 执行代码检查任务时提示:Cppcheck cannot tokenize the code correctly
在调试代码的问题。 使用自定义执行机执行代码检查任务 当CodeArts Check提供的内置执行机不满足业务要求时,您可接入自行提供的执行机,通过注册的方式托管到CodeArts Check服务中,委托CodeArts Check服务进行调度并执行代码检查任务。本实践我们通过检查CodeArts
是否必选 参数类型 描述 execute_id 否 String 任务单次的执行ID 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token
您可创建不同代码源的代码检查任务。 配置代码检查任务 您可对已有的检查任务进行修改或配置。 执行代码检查任务 您可对目标代码检查任务执行检查,及时发现源代码中的代码问题。 查看代码检查结果 代码检查任务执行完成后,您可查看检查结果并修改代码问题。
云容器引擎 CCE 服务介绍 03:23 云容器引擎服务介绍 操作指导 代码检查 CodeArts Check 介绍如何创建并执行、查看任务 03:49 创建并执行、查看代码检查任务 云容器引擎 CCE 熟悉云容器引擎控制台 07:25 熟悉云容器引擎控制台 云容器引擎 CCE 熟悉云容器引擎控制台
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
创建代码检查任务 task create 修改代码检查任务 task modify 删除代码检查任务 task delete 执行代码检查任务 job create 取消执行代码检查任务 job modify_job 关注代码检查任务 followingTask create_followingTask
配置代码检查任务 配置代码检查任务规则集 配置代码检查任务质量门禁 配置代码检查任务定时执行 配置代码检查任务消息通知 配置代码检查任务检查模式 查看徽标状态 配置代码检查任务集成服务 配置代码检查任务自定义环境 配置代码检查任务高级选项
拥有60天的缓冲周期对代码进行修改,周期内没有修改或者屏蔽的缺陷,在周期结束后后会计算到正式缺陷中。 执行计划 定义代码检查任务自动触发的方式。通过触发器,使代码检查的自动化执行更加灵活易用。
创建代码检查任务后,如果您需要修改任务名称或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行,在下拉框中,选择“删除”。
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
通过代码圈复杂度报表评估代码质量风险。 NBNC代码行 代码检查支持扫描的文件代码行,不包括空行和注释行。 代码重复率 通过代码重复率报表评估代码质量风险。 定时执行检查 提供每周、每日定时检查代码功能,让用户休息编译两不误。 检查结果通知 检查完成后,通过邮件通知和消息通知相关人员检查结果,便于进行及时处理。