使用postman作为rest api自动化测试工具

写的api多了以后或者接手别人的项目之后,对api的运维也会比较多,特别是在测试环境,种种因素会导致接口出现不符合预期,这个时候当产品啊、测试啊,都跑过来骚扰你的时候,你的第一个反应是自己执行一下,看是不是真的接口有问题,然后再具体分析。

通常是拼接好接口地址,构造好参数,然后请求api,看看返回结果。这类动作做多了之后通常比较烦人,特别是最后发现是接口ok的。

于是就想找个rest api的自动化测试工具,方便自己排查问题。

工具选型

选型标准

  • 能够批量导入swagger
  • 能够自己构造测试接口
  • 能批量run
  • 能输出report
  • 最好能够alert

候选工具

  • jmeter——网上找了一圈,首先入眼的是jmeter,但是由于界面界面有点粗糙,学习成本有点高,故暂时没有考虑。
  • soupui——看起来是老牌的工具,不过由于免费版不支持导出report,也就放弃了
  • dredd——这个看起来不错,可以支持swagger的,不过自己粗略试一下,没执行成功,也就先放弃了
  • postman——这个以前就有装过,只是没发现深挖它的功能,现在一看,挺简单的,容易上手,也支持swagger,然后就是它了

postman相关知识

导入swagger

这个功能是我最看重的,左上角有个import的按钮,可以选择"Import From Link",输入接口的swagger api docs的地址,比如:http://192.168.99.100:8080/scm/v2/api-docs,然后导入就可以了。

设置collection

保存一个请求的时候,可以选择已有的collection,或者新建一个。collection可以对等为test suite。

设置tests

对于要跑自动化测试的,必须要设置tests这里的脚本,不然即使run,也没有啥意义。最简单最常用的两行脚本如下:

tests["Status code is 200"] = responseCode.code === 200; 
tests['Response time is less than 500ms'] = responseTime < 500;

一个是断言http的状态码,一个是断言响应时间。

设置环境变量

随便选择collection的一个http请求,然后点击右侧的设置按钮,Manage Environments,然后可以定义环境变量,可以定义dev、prod两套,分别设置对应的环境的api的host,这样就不用重复设置api请求了。在url中用{{varname}}来引用变量,假设varname就是你设置的一个变量名。

执行runner

左上角有个runner图标,点一下弹出COLLECTION RUNNER界面。在这里就要进行批量自动测试的地方,选择environment,然后跑一下。

QQ20170207-224521@2x.png

newman命令行执行

  • 导出配置
    在collection那里,export,选择Collection V2,导出为json。如果使用了environment,则需要导出该environment的json配置。
  • 安装newman
sudo npm install -g newman
  • 查看newman版本
newman -version
3.4.3
  • 命令行执行
newman run demo.postman_collection.json --reporters cli,html --environment dev.postman_environment.json  --reporter-html-export result.html

命令行结果如下:

┌─────────────────────────┬──────────┬──────────┐
│                         │ executed │   failed │
├─────────────────────────┼──────────┼──────────┤
│              iterations │        1 │        0 │
├─────────────────────────┼──────────┼──────────┤
│                requests │       22 │        0 │
├─────────────────────────┼──────────┼──────────┤
│            test-scripts │       22 │        0 │
├─────────────────────────┼──────────┼──────────┤
│      prerequest-scripts │        0 │        0 │
├─────────────────────────┼──────────┼──────────┤
│              assertions │       44 │        6 │
├─────────────────────────┴──────────┴──────────┤
│ total run duration: 28s                       │
├───────────────────────────────────────────────┤
│ total data received: 312.29KB (approx)        │
├───────────────────────────────────────────────┤
│ average response time: 1245ms                 │
└───────────────────────────────────────────────┘

  #  failure        detail

 1.  AssertionFai…  Response time is less than 1000ms
                    at assertion:2 in test-script
                    inside "XXXX" of "app1"

 2.  AssertionFai…  Response time is less than 1000ms
                    at assertion:2 in test-script
                    inside "XXXX" of "app2"

 3.  AssertionFai…  Response time is less than 1000ms
                    at assertion:2 in test-script
                    inside "XXXX" of "app1"

 4.  AssertionFai…  Response time is less than 1000ms
                    at assertion:2 in test-script
                    inside "XXXX" of "app3"

 5.  AssertionFai…  Response time is less than 1000ms
                    at assertion:2 in test-script
                    inside "XXXX" of
                    "app2"

 6.  AssertionFai…  Status code is 200
                    at assertion:1 in test-script
                    inside "XXXX" of "app1"

同时会生成result.html报告。

jenkins集成

  • 构建选择Execute Windows batch command——输入上面的命令就可以了
  • Publish JUnit test result report——jenkins有个Publish JUnit test result report可以用来解析junit的xml测试报告。要用这个的话,命令行得输出junit的report
newman run demo.postman_collection.json --reporters cli,html,junit --environment dev.postman_environment.json  --reporter-html-export result.html --reporter-junit-export junit-result.xml

doc

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

推荐阅读更多精彩内容