接口测试教程 - Postman(十二)Newman 使用

现在只要谈到自动化测试,必然谈到持续集成(CI)。目前最流行的持续集成工具就是Jenkins,为了与Jenkins结合,那么这些自动化测试工具都必须要支持命令行执行方式,也就是说能够通过命令行来运行自动化测试的用例。

为此,Newman就是 Postman 提供的命令行执行工具,可以在命令行中执行 Collection 运行过程,并生成测试报告。这样就能把 Postman 编写的接口测试用例与持续集成工具和系统构建结合起来。

使用 Newman 执行 Collection ,必须把 Collection 导出为 Json 文件。以我们之前一直用的 Postman echo 为例:

导出的文件名为Postman Echo.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 目录来存放。

如果你想更为深入的了解 Newman 所有参数,你可以查看本文的后续内容。


参数选项

除了上面的基本命令外,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 中的某个文件夹来运行。

也就是部分运行了:

运行上图中导出的 Collection,并指定运行Request Methods文件夹:

命令如下:

newman run "Echo.postman_collection.json" --folder "Request Methods"

-e, --environment [file|URL] 指定环境文件

在 Postman 中运行时,可以通过界面指定运行的环境 Environment 。在 Newman 中就必须需要通过参数指定了。

之前讲环境的时候已经讲过,Postman 中的环境可以导出为 Json 文件。在 Newman 运行时,可以使用 -e 参数指定导出的环境 Json 文件。

例如:导出的环境文件名为localhost.postman_environment.json

newman run "Postman Echo.postman_collection.json" -e localhost.postman_environment.json

-d, --iteration-data [file] 指定要使用json或csv的数据文件

运行参考设置一节中我们讲过了 Postman 支持的数据文件类型(csv,json),并了解了文件的格式。

在 Newman 中运行时,通过 -d 参数指定这些数据文件。

newman run "Postman Echo.postman_collection.json" -d user.csv 

-g, --globals [file] 指定全局变量文件

-g 参数,通过文件指定当次运行 Collection 中所需要的全局变量。

全局变量文件可以从 Postman 中导出,也可以遵照全局变量的文件格式自己书写,再通过 -g 参数指定。

newman run "Postman Echo.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
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 210,978评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 89,954评论 2 384
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,623评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,324评论 1 282
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,390评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,741评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,892评论 3 405
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,655评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,104评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,451评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,569评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,254评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,834评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,725评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,950评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,260评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,446评论 2 348

推荐阅读更多精彩内容