与詹金斯集成

Postman 包含一个功能齐全的测试沙箱,使您能够为您的 API 编写和执行基于 JavaScript 的测试。然后,您可以使用 Postman的命令行收集运行程序Newman将 Postman 与您的 CI/CD 构建系统集成。

以下示例显示了如何设置使用 Newman 运行集合的 Je​​nkins 构建。如果集合通过了所有测试,Jenkins 构建将被标记为成功。这使用在本地运行的 Jenkins 安装,但您通常会在构建服务器上运行它以供生产使用。

内容

安装

  1. 在本地安装 Jenkins 并启动它。有关更多信息,请参阅https://www.jenkins.io上的 Jenkins 文档。

  2. 在 Jenkins 中安装 Node.js 和 Newman:

    1. 转到您的 Jenkins 服务器(http://localhost:8080如果您在本地运行它,则默认情况下处于此状态)并登录。
    2. 转到管理 Jenkins > 管理插件并安装 NodeJS 插件。
    3. 转到Manage Jenkins > Global Tool Configuration并在NodeJS下,选择Add NodeJS
    4. 输入 Node.js 安装的名称。
    5. 要安装的全局 npm 包中,输入newman.
    6. 选择保存

创建 Postman 集合

对于此示例,您将需要一个 Postman 集合,其中包含一些带有测试的请求。对于此示例,您可以通过选择下面的Run in Postman按钮将示例“Hello World”集合导入您的工作区。

在邮递员中运行

要演示故障排除过程,请编辑请求并故意中断其中一项测试。例如,更改最终测试,使其查找文本“Hello,Everyone!” 而不是“你好,世界!”

创建集合后,将其导出为 JSON 文件

设置詹金斯

  1. 在 Jenkins 运行的情况下,转到http://localhost:8080并登录。

  2. Dashboard页面上,选择左侧边栏上的New Item以创建新作业。

  3. 从选项中选择一个Freestyle 项目。为您的项目命名,然后选择OK

    詹金斯的新工作

  4. General > Build中,在项目中添加一个构建步骤,然后选择Execute Shell。构建步骤执行一个 shell 命令。输入要运行的 shell 命令,例如newman run ~/Desktop/jenkins_demo_postman_collection.json.

  5. Build Environment > Build Environment中,选择Provide Node & npm bin/ folder to PATH并选择您使用 Newman 配置的 NodeJS 安装。

  6. 选择保存以完成项目的创建。

故障排除

  1. 通过选择侧栏中的立即构建来手动运行此构建测试。

    运行构建

    Jenkins 指示构建失败,并在构建历史记录中的构建旁边显示一个红叉。这是因为集合中故意失败的测试。

  2. 在历史列表中选择构建,然后选择控制台输出以查看 Newman 返回的内容。

  3. 在您的集合中修复这些测试。导出它,然后重试。

Jenkins 用绿色复选标记表示构建成功。

配置运行频率

设置 Jenkins 运行 Newman 的频率:

  1. 打开构建窗口。

  2. 选择配置

  3. 导航到构建触发器并选择定期构建

  4. 输入时间表。将频率设置为每 30 分钟的语法是H/(30) * * * *.

    选择计划旁边的帮助图标以查看有关如何指定构建频率的信息。

  5. 选择保存

Jenkins 现在将以您想要的频率运行 Newman,并会告诉您构建是失败还是成功。

在真实世界的构建环境中,Newman 将成为您生产环境的一部分。您可以根据需要设置通知和自定义 Jenkins。您可以使用多种其他配置来使您的收藏更具动态性。

有关收集运行的更多信息,请参阅: