从零开始学习 Postman Newman 工具

Postman Newman 是什么？

Postman Newman 是一个 CLI（命令行界面）工具，可以使用它来运行 Postman 中的集合（Collection）和环境（Environment）进行自动化测试。它是 Postman 的命令行 Collection Runner，能够直接从命令行运行 Postman 集合。使用 Newman 可以测试 API 的功能、性能、可靠性和安全性，同时可以将测试结果输出成多种格式的报告，例如 HTML、JSON、JUnit 等，以方便开发人员进行问题定位和分析。

Postman Newman 的作用

通过 Postman Newman 进行自动化测试，开发人员可以在代码更改后快速获得有关 API 性能的反馈，并确保代码的稳定性。Newman 可以与 CI（持续集成）集成，如果推送任何更改，CI 将与 Newman 一起运行 Postman 集合，以确保环境的稳定性。使用 Newman 还可以测试 API 的各种方面，例如功能、性能、可靠性和安全性，从而帮助开发人员发现和解决问题。

如何使用 Postman Newman？

以下是使用 Postman Newman 进行测试的步骤：

第一步：安装 Node.js

Newman 建立在 Node.js 之上，因此在使用 Newman 之前需要先安装 Node.js。请确保安装了 Node.js，建议使用 Node.js v4 或更高版本。

第二步：全局安装 Newman

使用 npm 全局安装 Newman，可以通过以下命令安装：

npm install -g newman

第三步：导出集合或环境变量为 JSON 格式

使用 Postman 导出 Collection 或环境变量为 JSON 格式的文件，在使用 Newman 时需要使用这些文件。可以通过以下步骤来导出文件：

• Collection：选择要导出的 Collection，在右上角点击“导出”按钮，选择“Collection v2.1”，并保存为 JSON 文件。
• 环境变量：选择要导出的环境变量，在右上角点击“导出”按钮，选择“Environment”，并保存为JSON 文件。

第四步：使用 Newman 运行测试

使用 Newman 运行测试集合，使用以下命令：

newman run <collection.json> -e <environment.json> -r <reporter> --reporter-<option> <value>

其中，collection.json 是集合文件的路径，environment.json 是环境变量文件的路径，reporter 是报告格式，--reporter-[option] [value] 是报告选项和值。

第五步：导出报告

Newman 提供了三种格式的报告，包括 CLI、JSON 和 HTML 格式，可以通过 -r 参数指定：

• CLI 格式：基础格式，默认 cmd 中显示的报告格式；

• JSON 格式：使用 -r json 指定导出相应的文件，需要 --reporter-json-export 指定导出文件的存放路径，文件内容与 Postman Runner 中的 export result 内容类似，不建议使用。
• HTML 格式：使用 -r html 指定导出相应的文件，需要 --reporter-html-export 指定导出文件的存放路径。在使用前需要安装（npm -g install newman-reporter-html），建议使用。

例如，可以运行 sample-collection.json 集合中的测试用例，并生成一个名为 report.html 的 HTML 报告。可以使用以下命令：

newman run sample-collection.json -e environment.json -r html --reporter-html-export report.html

这将生成一个 HTML 报告文件，报告文件名为 report.html。

以上是使用 Postman Newman 进行测试的基本步骤。如果您需要进行更高级的测试，可以查看 Newman 的文档和示例，以了解其他功能和选项。

知识扩展：

了解更多 Postman 相关使用技巧：

• 如何使用 Postman 发送 gRPC 请求
• 如何在 Postman 中进行 HTTPS 请求