代码扫描

本文主要介绍如何使用 ZadigX 的代码扫描。目前支持以下功能：

• 支持对所有语言的代码进行代码扫描
• 支持在 ZadigX 中使用 SonarQube 工具和自定义工具对代码进行扫描
• 支持基于 SonarQube 扫描结果配置质量门禁检查
• 支持一键跳转到 Sonar 系统中分析代码扫描结果
• 支持对多个代码仓库进行代码扫描
• 支持基于代码变更自动触发代码扫描运行
• 支持将代码扫描执行结果通知到钉钉、企业微信、飞书中

新建代码扫描

访问项目 -> 代码扫描，点击新建代码扫描后填写配置。

基本信息

• 名称：代码扫描名称，同一项目下不允许重复
• 扫描工具：可指定 SonarQube 或其他
• 扫描环境：执行扫码任务时的具体运行环境
  • 若使用 SonarQube 工具进行代码扫描，系统已内置了支持该工具的环境 sonar，选择 sonar 即可
  • 若使用其他工具进行代码扫描，可参考自定义镜像按需添加
• 依赖的软件包：使用 SonarQube 工具做代码扫描时可配置该项，用于指定扫描过程中需要用到的各类软件包工具，比如不同版本的 Java、Go、Node 等
  • 选择软件包的过程中需要注意多个软件包之间的依赖关系，按照顺序进行安装。例如：Govendor 依赖 Go，那么请先选 Go，再选择 Govendor
  • 平台已内置一些常见的软件包，如果有其他软件包或者版本需求，系统管理员可以在软件包管理中配置其安装脚本
• Sonar 地址：使用 SonarQube 工具做代码扫描时需配置该项
  • 需要事先在系统中集成 Sonar，参考文档：Sonar 集成
  • 当代码扫描执行完成后，ZadigX 会将结果上传到此处指定的系统中

代码信息

需事先在 ZadigX 中集成代码源，参考文档：代码源集成。

参数说明：

• 代码源：代码库所在的平台，支持的代码源请参考：代码源信息
• 代码库拥有者：支持开源库，以及所配置的代码源下的代码库拥有者
• 代码库名称：代码库的名称。对于 Gerrit 代码源，支持模糊匹配，如上图例中所示
• 默认分支：执行代码扫描任务时，默认选取的分支
• Remote name：指定远程代码仓库的名称，默认 origin
• 克隆目录名：定义代码库被克隆后的目录名称，默认为代码库的名称
• 子模块：同步 submodule 中配置的代码库
• 执行时显示：默认开启，若设置为关闭，执行代码扫描时不显示该代码库选项，代码配置使用默认值

变量

前置脚本

支持前置脚本的运行，在使用 SonarQube 工具进行扫描前，可以按需运行脚本，如 Java 编译。

参数配置

使用 SonarQube 工具进行代码扫描时配置的相关参数，其中 sonar.host.url 和 sonar.login 无需配置，在执行代码扫描时系统会自动注入。更多参数配置可参考 SonarQube 文档 (opens new window)。

若扫描环境为 sonar，则参数配置中可使用 $BRANCH 变量获取当前被扫描代码库的分支信息。

高级配置

说明：

• 策略配置：配置代码扫描的超时时间，若超过设置的时间阈值后扫描仍未结束，则视为超时失败
• 集群选择：选择代码扫描任务运行时所使用的集群资源，其中本地集群指 ZadigX 系统所在的集群，可参考集群管理集成更多集群资源
• 操作系统规格：配置资源规格用于执行代码扫描任务。平台提供 高/中/低/最低 四种配置供选择。此外，还可以根据实际需要自定义，若需使用 GPU 资源，资源配置形式为 vendorname.com/gpu:num，更多信息请参考文档 调度 GPU (opens new window)
• 调度策略：选择集群调度策略，默认使用随机调度策略，集群调度策略管理请参考文档 设置调度策略
• 输出变量：将代码扫描中的环境变量输出，可实现自定义工作流中不同任务之间的变量传递，参考文档 变量传递
• 触发器与通知：配置 Webhook 事件，自动触发代码扫描任务执行，配置细节参考：触发器与通知

输出变量

将测试中的环境变量输出，可实现自定义工作流中不同任务之间的变量传递，参考文档 变量传递。

质量门禁检查

开启质量门禁检查后，ZadigX 将从 Sonar 中获取门禁规则，如果门禁未通过，任务状态将置为失败。同时返回具体规则和规则判定结果

如需设置规则，可前往 Sonar 系统，修改或新增 Quality Gate

触发器与通知

触发器

支持的代码源请参考：代码源信息

参数说明：

• 代码库：即代码信息配置中的代码库
• 目标分支：监听代码变更事件的分支
• 触发事件: 指定触发代码扫描运行的 Webhook 事件，可选事件如下：
  • Push commits 事件（Merge 操作）时触发
  • Pull requests 提交 pull request 时触发
  • Push tags 新建 tag 后触发
• 自动取消：若勾选，则当多个 Webhook 事件先后触发代码扫描任务时，系统会自动取消队列中的任务
• 文件目录: 当指定文件或目录发生变化（新增/修改/删除）时，触发代码扫描，使用以下代码仓库文件结构示例说明：

├── reponame  # 仓库名称
  ├── Dockerfile 
  ├── Makefile
  ├── README.md   
  ├── src        
    ├── service1/
    ├── service2/
    └── service3/

通知

支持将代码扫描执行结果通知到钉钉、企业微信、飞书平台中，配置可参考文档：通知。

执行代码扫描

选择具体的代码扫描 -> 点击执行，可对指定分支或 Tag 中的代码进行扫描。

当代码扫描任务运行完毕，可点击链接快速跳转至 SonarQube 系统中查看结果。

使用 SonarQube 工具做代码扫描时支持该功能。