使用postman做爲rest api自動化測試工具

時間 2019-11-07

標籤使用 postman 做爲 rest api 自動化測試工具欄目測試自動化简体版

原文原文鏈接

序

寫的api多了之後或者接手別人的項目以後，對api的運維也會比較多，特別是在測試環境，種種因素會致使接口出現不符合預期，這個時候當產品啊、測試啊，都跑過來騷擾你的時候，你的第一個反應是本身執行一下，看是否是真的接口有問題，而後再具體分析。html

一般是拼接好接口地址，構造好參數，而後請求api，看看返回結果。這類動做作多了以後一般比較煩人，特別是最後發現是接口ok的。git

因而就想找個rest api的自動化測試工具，方便本身排查問題。github

工具選型

選型標準

可以批量導入swaggernpm
可以本身構造測試接口json
能批量runapi
能輸出reportapp
最好可以alertless

候選工具

jmeter——網上找了一圈，首先入眼的是jmeter，可是因爲界面界面有點粗糙，學習成本有點高，故暫時沒有考慮。運維
soupui——看起來是老牌的工具，不過因爲免費版不支持導出report，也就放棄了ide
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，而後跑一下。

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