Apifox 测试平台接入

本文主要介绍如何将 Apifox 测试平台接入 Zadig,执行自动化测试,分析测试报告,并结合 Zadig 的环境能力实现测试左移,赋能其他角色也参与到质量建设中来,有效降低问题发现和修复成本。

Apifox 接入

第一步:在 Apifox 中配置持续集成

访问 Apifox 自动化测试 -> 持续集成,新增持续集成后保存 Apifox CLI 命令。

Apifox 测试平台接入 - 图1 Apifox 测试平台接入 - 图2

第二步:在 Zadig 中配置 Nodejs

Zadig 系统管理员访问系统设置 -> 集成管理 -> 软件包管理,新增软件包。

Apifox

具体配置如下:

  • 名称node
  • 版本20.5.1
  • Bin Path$HOME/node/bin
  • 启用:开启
  • Bin Pathhttps://nodejs.org/dist/v20.5.1/node-v20.5.1-linux-x64.tar.xz
  • 安装脚本:内容如下

点击查看

  1. sudo apt-get update
  2. sudo apt install software-properties-common -y
  3. mkdir -p $HOME/node
  4. tar -C $HOME/node -xJf ${FILEPATH} --strip-components=1
  5. npm config --global set registry https://registry.npm.taobao.org

第三步:在 Zadig 中配置测试

新增测试,配置软件包、测试脚本、Html 报告文件地址以及 IM 通知。

Apifox

软件包

选择 node 20.5.1

测试脚本

第一步中复制的 CICD 命令,并增加 --out-file=report 指定测试报告文件名,示例如下:

点击查看

  1. #!/bin/bash
  2. set -ex
  3. npm install -g apifox-cli --verbose
  4. apifox run https://api.apifox.cn/api/v1/projects/3172191/api-test/ci-config/373357/detail?token=xcOv********pbMj_H -r html --out-file report

关于 apifox-cli 的更多命令可参考 官方文档Apifox 测试平台接入 - 图5 (opens new window)

Html 报告文件地址

本例中为 $WORKSPACE/apifox-reports/report.html,report.html 即为测试脚本中通过 --out-file=report 指定,请根据实际情况配置。

通知

参考文档:通知配置

自动化测试执行

执行 Zadig 测试,将会自动触发 Apifox 执行自动化测试,待 Zadig 测试成功执行完毕后会将执行情况通知到 IM 中,以飞书示例如下。

Apifox

测试报告分析

点击 IM 通知中的测试结果链接可查看测试报告,对测试报告进行分析。

Apifox

测试左移

配置自定义工作流,编排构建、部署(开发环境)、测试任务,参考文档:自定义工作流

Apifox

功能开发完成后提交代码变更 PR,选择 PR 变更执行自定义工作流部署开发环境并执行自动化测试,在研发环节即可发现质量问题,及早修复。

Apifox 测试平台接入 - 图9 Apifox 测试平台接入 - 图10