postman接口自动化（四）Newman使用并与Jenkins结合

一、Newman使用

目前最流行的持续集成工具就是Jenkins，为了与Jenkins结合，那么这些自动化测试工具都必须要支持命令行执行方式，也就是说能够通过命令行来运行自动化测试的用例。
为此，Newman就是 Postman 提供的命令行执行工具，可以在命令行中执行 Collection 运行过程，并生成测试报告。这样就能把 Postman 编写的接口测试用例与持续集成工具和系统构建结合起来。

使用 Newman 执行 Collection ，必须把 Collection 导出为 Json 文件。

导出的文件名为tws.postman_collection.json。
使用 Newman 执行的效果为：

安装 Newman

Newman 是基于 Node.js 开发，因此必须要先安装 Node.js 环境。
下载 Node.js 并安装之后，可以在 CMD 中使用 npm 命令安装 Newman：

npm install -g newman

等待安装完成即可。

Newman 基本命令

直接指定一个 Collection 导出的 Json 文件运行：

newman run collection.json

Newman 完整命令

如果你只想通过 Newman 运行 Collection，或者在 Jenkins 中执行接口用例。你可以参考如下这个完整的命令，仿写就可以了：

newman run postman_collection.json 
-e postman_environment.json 
-d test_data.csv 
-g postman_globals.json 
-n 迭代次数  
-r cli,html,json,junit 
--reporter-json-export jsonOut.json 
--reporter-junit-export xmlOut.xml 
--reporter-html-export htmlOut.html

简要说明：
postman_collection.json：导出的 collection 文件名
postman_environment.json：包含环境变量的环境文件 test_data.csv：数据文件，也可以是 Json
格式。具体格式参考运行参考设置 postman_globals.json：包含全局变量的文件 迭代次数：重复执行所有请求的次数
cli,html,json,junit：指定导出报表格式，cli 指控制台的标准输出，html 为导出 html 报告，json 为
json 格式报告，Junit 导出 xml格式的报告；你需要导出哪些报表，就要先指定导出的格式
jsonOut.json/xmlOut.xml/htmlOut.html：分别指定报告文件存放的路径，如果不指定，会在命令所在的当前目录下生成一个
Newman 目录来存放。

参数选项

如果要查看所有参数，可以使用 -h 参数：

newman -h

可以看到 Newman 有如下选项：

Options:

公共设置选项:
-h, --help                       展示参数信息
-v, --version                    查看 Newman 版本

基本设置选项:
--folder [folderName]             指定要从集合运行的单个文件夹
-e, --environment [file|URL]      通过json文件指定环境（环境模块导出的）
-d, --iteration-data [file]       指定要使用json或csv的数据文件
-g, --globals [file]              通过文件指定全局变量（全局变量设置模块导出的）
-n, --iteration-count [number]    指定要迭代运行的次数
-r, --reporters [reporters]       指定用于此运行的报告类型（默认值：cli，也就是控制台输出）

请求设置选项:
--delay-request [number]        指定请求之间的延迟（毫秒）
--timeout [n]                   指定 collection 运行的超时时间（毫秒）（默认值：0）
--timeout-request [number]      为请求指定请求超时（毫秒）
--timeout-script [n]            指定脚本运行超时时间（毫秒）（默认为：0）

其他杂项:
--bail                         当有断言失败时停止所有运行
--silent                       禁止在命令行界面输出日志
--color                        强制进行彩色输出（在 CI 环境中使用）
--no-color                     禁止命令行界面输出日志中使用彩色
-k, --insecure                 禁用 SSL 
--ssl-client-cert <path>       指定客户端 SSL 证书的路径。支持 .cert 和 .pfx 文件。
--ssl-client-key <path>        指定客户端 SSL 密钥的路径
--ssl-client-passphrase <path> 指定客户端 SSL 密码（可选，需要密码保护密钥）
-x, --suppress-exit-code       即使失败也继续运行测试，但退出时 code=0
--ignore-redirects             忽略重定向（响应状态码为3XX）
--export-environment <path>    完成运行后，将环境导出到文件中
--export-globals <path>        完成运行后，导出全局变量到文件中
--export-collection <path>     指定输出文件保存执行的 collection
--disable-unicode              强制将符合 unicode 的符号替换为等效的纯文本
--global-var <value>           允许通过命令行以 key = value 格式指定全局变量

参数解释

–folder [folderName] 运行单个文件夹

直接指定 Collection 的 Json 文件运行的时候默认是运行整个 Collection，可以通过 --folder 可以指定 Collection 中的某个文件夹来运行。
命令如下：

newman run "tws.collection.json" --folder "注册或登录 - 发送短信/邮箱"

-e, --environment [file|URL] 指定环境文件
在 Postman 中运行时，可以通过界面指定运行的环境 Environment 。在 Newman 中就必须需要通过参数指定了。
之前讲环境的时候已经讲过，Postman 中的环境可以导出为 Json 文件。在 Newman 运行时，可以使用 -e 参数指定导出的环境 Json 文件。
例如：导出的环境文件名为localhost.postman_environment.json：

newman run "tws.postman_collection.json" -e localhost.postman_environment.json

-d, --iteration-data [file] 指定要使用json或csv的数据文件
运行参考设置一节中我们讲过了 Postman 支持的数据文件类型（csv，json），并了解了文件的格式。
在 Newman 中运行时，通过 -d 参数指定这些数据文件。

newman run "tws.postman_collection.json" -d user.csv 

-g, --globals [file] 指定全局变量文件
-g 参数，通过文件指定当次运行 Collection 中所需要的全局变量。
全局变量文件可以从 Postman 中导出，也可以遵照全局变量的文件格式自己书写，再通过 -g 参数指定。

newman run "tws.postman_collection.json" -g globals.json

-n, --iteration-count [number] 指定要迭代运行的次数
通过 -n 次数，可以指定当次运行 Collection 的次数。

-r, --reporters [reporters] 指定用于此运行的报告类型
通过 -r 指定报告的类型，不指定的话默认就是 cli ， 也就是控制台输出。
注意，指定多种报告类型的时候中间不能有空格，必须以逗号分隔：

✅ -r cli,json,junit
❌ -r cli , json,junit

如果指定了多个报告，并想为每个报告指定选项的话（比如指定某些报告的保存路径），则需要通过如下方式额外指定：

--reporter-{{reporter-name}}-{{reporter-option}}

{{reporter-name}}：指定报告名称，如 cli，json，junit，html 等
{{reporter-option}}：选项，如指定路径 export

比如 指定报告类型为 cli 和 Junit，而 Junit 导出的文件我想指定保存到 d:\data\report，就可以写为：

-r cli,junit --report-junit-export d:\data\report\junit_report.xml

二、Newman与Jenkins结合

在 Jenkins 中设置 Newman 运行
打开本地的 Jenkins 地址 http://localhost:8080：

新建一个自由风格的构建任务：

在构建Build栏，新建一个构建步骤， 并选择Execute shell：

如果是 windows 上部署的 Jenkins 则选择 Execute Windows batch command

输入以下命令（windows 与 linux 上命令一致）：

$ newman run "tws.postman_collection.json" 
-r cli,junit,html --reporter-junit-export echo.xml --reporter-html-export echo.html

配置报告
上面的命令运行后会生成两份测试报告，junit 格式的和 html 格式的，运行后都会存放在当前任务的根目录jenkins/workspace/Jenkins_Newman_Test中。
在 Post-bulid Actions 中添加 Publish HTML reports 用来展示 HTML 报告，添加 Publish Junit test result report 用来展示 Junit 报告：

点击保存 Save 按钮完成配置：
在任务中点击构建，可以看到构建后的界面：