检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。在为新开发的业务场景寻找适用的规则时需要耗费大量的时间,增加开发成本。 不同用户之间的代码差异大,研发无法实时掌握不同用户的具体需求,在开发规则过程中难以针对不同用户的业务代码场景来制定全面有效的工具规则。 本示例为您介绍如何使用自定义规则检查代码中存在调试代码的问题。
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请
根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity 否 String 缺陷等
购买CodeArts Check 指导您如何开通代码检查服务。 配置CodeArts Check项目级角色权限 为您介绍如何配置CodeArts Check服务项目级权限以及访问代码检查服务首页的方式。 创建代码检查任务 您可创建不同代码源的代码检查任务。 配置代码检查任务 您可对已有的检查任务进行修改或配置。
如何调用API 构造请求 认证鉴权 返回结果
单次检查支持扫描的问题数量 一个代码检查任务支持扫描的问题数量最多为300000。 租户自定义规则集数(个) 租户可以自定义的规则集数最大为1000。 租户创建代码检查任务数(个) 租户下可以创建的总任务数最大为50000。 单次代码检查最大时长 12小时。 支持的自定义规则数量 不同套餐支持的数量不同。
存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。返回该状态码,表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition
”、空格,不超过256个字符。例如:Endpoint01。 Git仓库Url 输入待连接的Git仓库的https地址。 用户名 输入待连接的Git仓库的用户名,不超过300个字符。 密码或Access Token 输入待连接的Git仓库的密码,不超过300个字符。 创建通用Git代码检查任务 在导航栏选择“代码
用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。在为新开发的业务场景寻找适用的规则时需要耗费大量的时间,增加开发成本。 不同用户之间的代码差异大,研发无法实时掌握不同用户的具体需求,在开发规则过程中难以针对不同用户的业务代码场景来制定全面有效的工具规则。 本示例为您介绍如何使用自定义规则检查代码中存在调试代码的问题。
服务扩展点的名称,可自定义。例如:GitCode。 Token 填写GitCode上获取的Token,获取方法如下: 登录GitCode。 单击页面右上角账号名称,选择“个人设置”。 单击 “+访问令牌”,填写令牌名称以及到期时间。 单击“新建访问令牌”,生成“你的个人访问令牌”,即Token。
代码检查服务可检查不同代码仓的代码质量,在创建代码检查任务前,需满足以下条件: 已新建CodeArts项目。 如果使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”,完成新建代码仓库。 如果使用的是第三方代码仓库,需已创建可用的代码仓库。
代码检查 计费说明 规则集设置 任务设置 API 代码检查 CodeArts Check(原CodeCheck)是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量,助力企业成功。 支持区域:
续费。 统一包年/包月资源的到期日 统一到期日是指通过续费将包年/包月实例的到期日统一固定为一个月的某一天。 如果您购买的代码检查服务套餐、资源扩展的到期日不同,可以将到期日统一设置到固定一个日期,便于日常管理和续费。 图1展示了用户将两个不同时间到期的资源,同时续费一个月,并设置“统一到期日”后的效果对比。
请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务
想继续使用,需要在指定的时间内为代码检查服务续费。 代码检查服务在到期前续费成功,代码检查服务可正常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。 续费相关的功能 代码检查服务续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费
修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值
不上传代码到云服务的情况下使用代码检查服务 应用场景 部分用户的代码有严格的保密机制,不允许将代码上传到外部网络,用户希望仅在信任的自有执行机上完成代码扫描服务。华为云CodeArts Check为此提供本实践的扫描方案,在不上传代码到云服务的情况下使用代码检查服务检查代码问题。
冗余代码数。 统计注释中冗余代码块的个数。注释中的代码被视作冗余代码;注释中包含编程语言关键字的或符合语法规则的连续单词组会被判断为冗余代码。 其中块注释有多行冗余代码,只算一次冗余代码数。 redundant_code_kloc 冗余代码块密度(每千行代码中包含的冗余代码数)。 冗余代码
} else { fmt.Println(err) } } 更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。 状态码 状态码 描述 200 Request succeeded! 400 Bad
Check通过调用API执行MR增量检查 应用场景 在用户实际的使用场景中,用户往往有构建自己的代码质量管控平台,集成代码检查及其他检查项的需求。并且在用户的应用场景中,MR合入过程中的质量监控是一个高频应用场景。 本示例介绍如何通过调用CodeArtsCheck API方式,执行MR增