与 Jenkins 集成

安装 Jenkins

Jenkins 是一款自动化构建工具，可以帮助开发人员在软件开发过程中自动化构建、测试和部署应用程序。关于 Jenkins 的安装方法，可以参考 Jenkins 官方文档，里面有各个系统的详细安装教程。

以下是 Linux 系统中的安装示例：

添加 Jenkins GPG 公钥：

wget -q -O - https://pkg.jenkins.io/debian/jenkins.io.key | sudo apt-key add -

将 Jenkins 源添加到 APT 软件源列表中：

sudo sh -c 'echo deb http://pkg.jenkins.io/debian-stable binary/ > /etc/apt/sources.list.d/jenkins.list'

更新 APT 软件包列表：

sudo apt-get update

安装 Jenkins：

sudo apt-get install jenkins

启动 Jenkins 服务：

sudo systemctl start jenkins

安装完成后在 Web 浏览器中输入 http://localhost:8080 或 http://{你的公网IP}:8080 来访问 Jenkins 控制台。控制台提供了 Web 界面以便你管理和配置 Jenkins 服务。

如需了解更多有关于 Jenkins 的说明，请查看 Jenkins 官网。

配置 NodeJS 环境

运行 Apifox CLI 前需确保 Node.js 版本号 >= v16，因此需要先在 Jenkins 环境中配置 NodeJS 依赖。

更具体的操作步骤请参考这篇最佳实践：如何将 Apifox 的自动化测试与 Jenkins 集成？

1、打开 Jenkins 插件管理中找到 NodeJS 插件，安装并重启。

2、在全局工具配置中新建 NodeJS，填写 NodeJS 别名（比如 nodejs18）、版本号 （需 >= v16） 和包名 apifox-cli。

若 Jenkins 宿主机已经安装好 Apifox-CLI，希望直接在 Node 环境运行任务，那么可以参考下图的 Node 配置并填写宿主机的 Node 路径。

你可以通过以下两种方式在 Jenkins 中触发 Apifox 自动化测试。

在可视化流水线中添加配置 （Freestyle Project）

将嵌入式代码集成至流水线 （Pipeline）

运行 CLI 命令

可视化配置流水线

打开 Apifox，在持续集成详情页中获取 CLI 命令。若 Jenkins 环境具备联网条件，可以选择使用「实时运行在线数据」命令；如果不具备联网条件，那么需要先导出 CLI 的 json 数据文件至环境中，再通过 CLI 执行。

在项目配置页面，找到 “构建环境 （Build Environment）” 选项，勾选 “Provide Node & npm bin/ folder to PATH”，并选择你在 “全局工具配置 （Tools）” 中设置的 NodeJS 版本 （如 nodejs18）。

构建环境设置好以后，找到 “构建步骤（Build Steps）” 选项，点击 “添加构建步骤（Add build step）”，选择 “Execute Shell” （如果是 Windows 系统，选择 “Execute Windows Batch Command”）。

在 “命令” 输入框中粘贴 Apifox CLI 命令并保存。

在项目中点击 “Build Now（立即构建）” 即可运行。

将嵌入式代码集成至流水线

轻点「CI/CD」 Tab 页并获取嵌入代码，将它粘贴至 Jenkins 的配置文件中。

将代码直接粘贴至 Jenkins 流水线配置中，即可嵌入至已有的持续集成工作流。

这里的nodejs18就是上文中设置的 NodeJS 别名，请填写你的实际别名。并且，请确保在代码中将变量$APIFOX_ACCESS_TOKEN替换为你实际可用的 Access Token。你也可以在 Jenkins 的「Dashboard -> Manage Jenkins -> System」中添加一个名为APIFOX_ACCESS_TOKEN的环境变量，并将其值设置为你的 Access Token。这样，在执行流水线时，系统将能够读取到你的 Access Token。

上述的代码也可以简化成下面这样的，把安装 Apifox CLI 的脚本去掉，这样就不需要每次执行构建任务时都安装一遍apifox-cli，从而减少构建时间和资源消耗。这是因为预先在 “全局工具配置 （Tools）” 中设置了 NodeJS 和全局 npm 包 （也就是 apifox-cli），它确保了在构建过程中可以直接使用已安装的工具。

在项目中点击 “Build Now （立即构建）” 即可运行。

常见问题

在 Jenkins 流水线内上传接口文档失败怎么办？

确保运行 Jenkins 主机有足够的磁盘空间。

确保 Jenkins 任务的执行用户有足够的权限。

将需要上传的文件拷贝至 Jenkins 主机内的文件地址，并且在 CLI 命令中指定相同的文件地址路径。

有文件上传时如何获取文件？

想要定时构建怎么设置？

安装 Jenkins#

配置 NodeJS 环境#

运行 CLI 命令#

可视化配置流水线#

将嵌入式代码集成至流水线#

常见问题#

安装 Jenkins

配置 NodeJS 环境

运行 CLI 命令

可视化配置流水线

将嵌入式代码集成至流水线

常见问题