检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
按照检查的语言筛选代码问题。 规则 按照问题命中的规则筛选代码问题,便于用户一次性解决同一类问题。 标签 按照规则的用户标签筛选代码问题。 负责人 按照问题分配负责人筛选代码问题。 说明: 代码检查过程中,开启精准匹配自动将新问题分配给问题代码行的最后一次提交者。 CWE 按照安全类规则名筛选代码问题。
关于认证鉴权的详细介绍及获取方式,请参见认证鉴权。 访问控制 代码检查对用户操作进行访问控制的方式如下: 角色权限控制:对代码检查任务、规则集的增删改查,规则查看,问题单的创建和导入导出等都均需获得对应的角色及权限。 细粒度权限控制:查询租户项目、设置项目创建者、管理租户项目成员列表等操作需要获得IAM细粒度授权。
API 任务管理 缺陷管理 规则管理
统计工程中所有代码文件的物理行总数,包含空行和注释行。 methods_total 函数总数。 统计工程中所有代码文件的方法总个数。其中Java抽象方法的方法声明后不带函数体,不会被识别成函数。 cyclomatic_complexity_total 圈复杂度总数。 统计所有函数圈复杂度数的总和。
× × × × × √ √ √ 编辑 √ √ √ × × × × × √ √ √ 删除 √ √ × × × × × × √ √ √ 规则集 设置默认规则集 √ √ × × × × × × √ √ √ 缺陷报告 查看 √ √ √ × × × × × √ √ √ 编辑 √ √ √ × ×
配置代码检查任务 配置代码检查任务规则集 配置代码检查任务质量门禁 配置代码检查任务定时执行 配置代码检查任务消息通知 配置代码检查任务检查模式 查看徽标状态 配置代码检查任务集成服务 配置代码检查任务自定义环境 配置代码检查任务高级选项
当用户开通代码检查服务后,可以根据不同的业务场景灵活使用。 本文介绍常见的代码检查实践。 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
项目中使用了私有依赖,但没有配置私有依赖扩展点。 处理方法1 在代码检查详情页,选择“设置 > 规则集 > 检查参数”。 在编译命令中使用“-s settings.xml”指定Maven编译使用的settings。 处理方法2 在项目详情页,选择“设置 > 通用设置 > 服务扩展点管理”页面,增加“nexus
任务执行完成后没有数据 问题现象 任务执行检查完毕后没有数据。 原因分析 源代码仓语言没有获取到。 检查语言开关没有打开。 处理方法 进入任务“设置 > 规则集”页面。 单击“已包含语言”所在行重新获取代码仓语言。 打开需要检查语言的开关。 重新执行检查。 父主题: 技术类问题
缺陷的状态0为解决 1已解决 2已忽略 rule_system_tags String 规则标签,多个标签用逗号隔开 rule_id String 规则id rule_name String 规则名 line_number String 缺陷所在文件行号 defect_content
check_id 是 Integer 检查工具ID,参数已废弃 ruleset_id 是 String 规则集ID,可以通过查询任务的已选规则集列表接口获取 language 是 String 规则集语言 status 是 String off:关闭,on:开启,参数已废弃 task_check_settings
查询任务检查失败日志 功能介绍 查询任务检查失败日志,不传execute_id则查询最近一次的检查日志 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/log-detail 表1 路径参数 参数 是否必选 参数类型
新建检查任务 功能介绍 新建检查任务但是不执行。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID
私有依赖库的授权,导致从私有依赖库中下载组件失败。 处理方法 将组件上传到私有依赖库。 使用拥有私有依赖仓库管理员权限的账号进入私有依赖库的“独立用户权限”页面为用户账号分配此私有依赖库角色(开发者)来进行授权。 操作方法请参见:管理用户权限。 父主题: 技术类问题
位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后,CTS可记录代码检查的管理事件和数据事件用于审计。 CTS的详细介绍和开通配置方法,请参见CTS快速入门。 CTS支持追踪的代码检查操作列表,请参见云审计服务支持的代码检查操作列表。 父主题: 安全
为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限,详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
Repo失败,未授权 问题现象 执行任务失败,提示异常信息:调用CodeArts Repo失败:未授权。 原因分析 无Repo代码仓访问权限。 处理方法 参考管理CodeArts权限,为成员添加代码仓访问权限。 父主题: 技术类问题
WPF项目检查失败。 原因分析 Linux mono不支持Windows WPF(Windows Presentation Foundation)。 处理方法 CodeArts中C#语言代码检查使用Linux mono方式时,C#前端WPF代码检查仅在Windows环境支持。 父主题: 技术类问题