检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。在为新开发的业务场景寻找适用的规则时需要耗费大量的时间,增加开发成本。 不同用户之间的代码差异大,研发无法实时掌握不同用户的具体需求,在开发规则过程中难以针对不同用户的业务代码场景来制定全面有效的工具规则。 本示例为您介绍如何使用自定义规则检查代码中存在调试代码的问题。
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请
配置代码检查任务质量门禁 根据质量要求设置门禁阈值,即可了解您的项目是否已准备好投入生产。例如,实际的检查结果超出设置的门禁阈值,则表示当前项目还不具备生产条件。 门禁质量设置支持租户级、项目级以及任务级,优先级为租户级 > 项目级 > 任务级。入口分别如下: 租户级:进入代码检
代码检查服务页面有两种访问方式:首页入口和项目入口。 首页入口 单击“立即使用”,进入代码检查服务首页。该页面展示的是与当前用户相关的代码检查任务列表。 项目入口 单击“立即使用”,进入代码检查服务首页。 单击导航栏“首页”。 单击需要查看的项目名称。 选择“代码 > 代码检查”,进入指定项目下代码检查任务列表页。 单击页面左上角,可根据需要选择区域。
码评审(MR)的自动化检查。 当所在任务的代码仓库中有分支合并时,代码检查服务会自动生成一个代码检查子任务。 进入代码检查任务详情页面。 单击,在代码托管中新建MR请求。 合并分支相关操作请参见代码托管用户指南。 单击,通过下拉框中,可查看所有的MR触发代码检查的历史记录。 配置代码提交时执行
如何调用API 构造请求 认证鉴权 返回结果
String 工具规则ID,即可配置阈值规则的各种阈值对应的ID,当前无便利手段获取,请联系客服咨询 default_value 否 String 默认值 option_value 否 String 当前 option_key 否 String 当前规则配置项key option_name
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题。
攻击者利用外部输入构造系统命令,通过可以调用系统命令的应用,实现非法操作的目的。 支持 支持 路径遍历 不支持 支持 攻击者利用系统漏洞访问合法应用之外的数据或文件目录,导致数据泄露或被篡改。 不支持 支持 SQL注入 支持 支持 攻击者利用事先定义好的查询语句,通过外部输入构造额外语句,实现非法操作的目的。 支持 支持
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity 否 String
修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值
续费管理”,进入“续费管理”页面。 自定义查询条件。 可在“手动续费项”、“自动续费项”、“到期转按需项”、“到期不续费项”页签查询全部待续费项,对套餐进行手动续费的操作,具体操作请参见如何恢复为手动续费。 在列表中找到需要续费的订单,单击操作列的“续费”。 选择续费时长,判断是否勾选
1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
单击“新建规则集”,在弹出的“新建规则集”窗口设置规则集名称、描述以及检查语言。 您也可以单击“复制于”下拉框选择复制于已有的规则集,基于复制的规则集配置使用的规则。 单击“确定”。 根据需要勾选规则名称、设置规则级别,单击右上角“保存”。 如果系统预置的规则不满足用户的使用要求,可自定义规则使用。
配置代码检查任务预置规则集 规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求,规则集也有相应的分类,比如对安全类、安卓应用、编程风格,使用这些类别进行检查的时候,规则集内的规则也会有所不同。 用户可根据实际需要更换代码检查任务使用的规则集,新启用的规则集将在下一次执行检查时生效。
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
当CodeArts Check提供的内置执行机不满足业务要求时,您可接入自行提供的执行机,通过注册的方式托管到CodeArts Check服务中,委托CodeArts Check服务进行调度并执行代码检查任务。本实践我们通过检查CodeArts Repo代码仓的代码问题来演示使用自定义执行机执行代码检查任务。
项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数 参数 是否必选 参数类型
调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过A
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API