检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
参考 CodeArts Check插件使用指南(IntelliJ IDEA版本)
API 任务管理 缺陷管理 规则管理
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
图解CodeArts Check
续费 续费概述 手动续费 自动续费
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
配置代码检查任务规则集 配置代码检查任务预置规则集 配置代码检查任务自定义规则集 父主题: 配置代码检查任务
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
基本概念 表1 代码检查服务基本概念 词汇 定义 重复率 重复行数是指涉及至少一次重复的代码行数;重复块是指包含重复行的代码块(最小重复块定义:Java语言连续10行重复,其它语言10行中连续100个字符重复算一个重复块);重复率=重复行/代码总行数(不包含空行与注释)。 规则
Shell/KOTLIN/SCALA/ArkTS/SQL10+种语言。 支持质量类、安全类规则。 检查并发:5个任务并发数。 专业版 基础版所有特性 提供增强的代码安全检查规则,深度识别代码安全风险和漏洞 检查并发:10个任务并发数。 购买时长 可选择1个月~3年。 自动续费 勾
传代码到云服务的情况下使用代码检查服务检查代码问题。 方案架构 图1 方案架构 约束限制 使用自定义执行机功能为受限功能,如需使用,请联系技术支持。 前提准备 已在私有网络创建自定义执行机。执行机规格为CentOS 7,推荐配置为CPU:8U,内存:32G,系统盘:100G,数据盘:250G。
任务设置 API 代码检查 CodeArts Check(原CodeCheck)是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量,助力企业成功。 支持区域: 华北-北京一,华北-北京四
配置代码检查服务钉钉通知 进入钉钉群,找到“群设置 > 智能群助手”,然后添加机器人(选择自定义类型)。 填写机器人名字,选择群组,完成安全设置(需勾选“加签”,并单击加签文本框旁的“复制”获取加签密钥)。 已阅读并同意相关协议后,单击“完成”。 单击Webhook文本框旁的“复制”,获取钉钉Webhook地址。
合作成果,经过华为内部(15W+开发人员,日均500亿行扫描)大规模持续使用和打磨而成。 覆盖了业界主流开发语言,针对代码的可读、可维护、安全、可靠、可测试、高效、可移植等方面进行全面的分析。 融合了多年对代码质量及可信度提升方面持续思考与探索、实践,积累了丰富的检查规则。 父主题:
随着现在项目的代码量越来越大,以及现有开发框架的增加,静态分析所需要覆盖的场景也日益增多,存在的问题如下: 传统静态分析引擎靠工具提供通用规则来对常见安全,风格和质量场景下的编码问题进行扫描分析,难以实时覆盖不同用户特定场景下的代码问题。 用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。