unittest實現HTTP介面功能測試

阿新 • • 發佈：2019-01-16

作者：vickygui

一、背景

目前主流的H5頁面動態獲取內容的方式是採用ajax非同步請求後臺資料實現實時重新整理，實際上就是用GET/POST的HTTP請求後臺介面，再將返回的資料（一般是json或xml格式）渲染在頁面上，因此保證H5頁面介面的功能正確性就成為了頁面內容資料正確的關鍵，普通的H5頁面測試通常會採用手工測試的方式，這樣只能模擬到正常的場景，對於異常的資料請求是無法覆蓋的，並且對於請求引數很多的情況，效率很低，另外還有一部分資料內容介面是無頁面的，如外部合作介面，只提供資料，對應的頁面由合作方自己來做，則無法採用手工的方式進行測試。

實際上H5頁面介面測試與傳統的介面測試的基本思路是一致的，就是通過資料準備（包括正常和異常的引數）、介面呼叫、結果觀察這三個流程來驗證介面的功能邏輯符合預期，並且對於未預期的異常情況有較好的容錯性和魯棒性，只不過介面的呼叫引數形式有所不同，如下表所示。

另外在H5頁面介面測試中還需要根據介面的實際情況模擬請求的HTTP頭部，這些也是驗證介面資料和邏輯的一部分，這些都是與傳統的介面測試不同的部分。

文章接下來的部分就提供了一種能夠完成H5頁面介面測試的方法，主要應用於新開發的H5頁面介面的功能測試。

二、為什麼選擇unittest

通過第一部分的闡述，我們對H5頁面介面測試的基本流程有了瞭解，那麼為了實現H5頁面測試，我們就需要一種工具，它需要有以下功能：

1、進行GET&POST請求呼叫
2、模擬HTTP頭部進行請求
3、方便的構造引數
4、豐富的斷言庫，對結果進行判斷
5、清晰的結果展示，SUCC /FAIL
6、方便的執行和除錯，用例FAIL時給出除錯資訊

以上需求按照優先順序排列，其中1和2是必須的，之前的測試工作中都是採用python來進行HTTP請求，原因是python中的requests庫能夠方便的模擬各種HTTP請求，並且呼叫非常簡潔，因此很自然的想到了用python，而為了能夠對結果進行斷言並且清晰的展示測試結果，於是我們採用了unittest。

三、什麼是unittest

unittest是python自帶的單元測試模組，與java的單元測試框架junit類似，一個測試類中可以包含多個測試用例，每個用例以test_開頭，執行前在setUp方法中進行初始化工作，執行後在tearDown方法中完成退出清理。多個測試類可以組成test suite同時進行測試。unittest同樣包含豐富的斷言庫，可以對結果型別、內容等多個方面進行驗證，在結果展示方面，在python的IDE Pycharm中能夠得到清晰的結果以及錯誤資訊，如下圖。

在上面的測試結果中，能夠清晰的看到用例總數、執行的用例數及失敗的用例數，點選左邊的用例名稱，可以看到失敗資訊，還可以直接跳至對應的出錯行，最左邊的功能區的第二個按鈕可以重跑所有失敗用例。最後對於執行失敗的用例，只要在對於用例區域右擊，選擇對應的”Debug…”選項就可以單獨除錯用例以確定是否是測試用例的問題導致執行失敗，從而保證結果的準確性。

3.1 unittest基本用法

下面是unittest的基本使用方法，不同的測試用例可能稍有不同，但思路是一致的。

1. import unittest
1. 定義一個繼承自unittest.TestCase的測試用例類
1. 定義setUp和tearDown，在每個測試用例前後做一些輔助工作
1. 定義測試用例，名字以test開頭
1. 一個測試用例應該只測試一個方面，測試目的和測試內容應該很明確。進行了測試所需的操作後獲取結果，然後呼叫assertEqual、assertRaises等斷言方法判斷程式執行結果和預期值是否相符，unittest提供的結果斷言主要有以下幾個，後面的註釋部分是各個斷言的含義
1. 呼叫unittest.main()啟動測試
1. 觀察測試結果，根據結果調整指令碼或反饋問題

四、需要怎麼做

在開始編寫測試用例之前需要確定介面的請求方式（GET/POST）、請求引數、請求所需的HTTP頭部、返回的結果型別和內容基本要素等。其中請求引數又需要知道引數的型別、範圍。根據這些資訊能夠組合出需要測試的場景，每一個場景就是一個測試用例，需要覆蓋正常和異常的情況。

一個基本的用例流程如下圖：

下面將逐一介紹如何實現H5頁面介面的功能測試。

4.1 請求引數設定

這個部分需要根據測試場景設定所需的請求引數，包括呼叫引數和HTTP頭部（主要是referer、content-type、cookie等），對於呼叫引數的多種正常組合，可以使用單個引數迴圈遍歷然後組合的方式，只需要一個測試用例即可，這樣可以減少用例編寫的工作量以及維護的成本。

4.2 介面呼叫

介面呼叫可以採用python的第三方庫—Requests實現，Requests基於urllib，採用Apache2 Licensed開源協議的HTTP庫，支援HTTP連線保持和連線池，支援使用cookie保持會話，支援檔案上傳，支援自動確定響應內容的編碼，支援國際化的URL和POST資料自動編碼。它比 urllib 更加方便，可以節約我們大量的工作，完全滿足HTTP測試需求。

使用requests進行HTTP請求非常簡單，下面分別是GET和POST基本請求：

GET：

POST：

對於POST請求，requests還支援自動編碼，只要將請求body傳入json關鍵字引數即可，上面的程式碼將請求http://httpbin.org/post且請求body為：{“key1”: “value1”, “key2”: “value2”}，如果請求body不是json格式，而是string格式，可以用data關鍵字引數直接設定。另外requests還會對引數自動進行URL編碼。

如果需要為請求新增HTTP頭部，只要簡單地傳遞一個 dict 給頭部引數即可：

上面的程式碼示例是POST請求，當然對於GET請求也是同樣的。

對於請求得到的響應，requests也有豐富的方法處理，比較關鍵的幾個方法：

上面程式碼執行後，code是響應的狀態碼，r_text是響應的內容，r_json是響應內容的json格式。

4.3 結果斷言

得到了響應的狀態和內容之後，就可以利用unittest的斷言庫對結果進行校驗了，首先需要校驗的是響應的狀態碼，上面介紹瞭如何得到響應的狀態碼，直接與預期值進行判等，如：

其次是響應頭，可能需要對Content-Type、Content-Length等關鍵欄位進行驗證，同樣從響應中獲取對應欄位的值，然後直接用asserTrue斷言去驗證。

最後是響應的內容，HTTP介面的響應的內容一般來說有三種格式：json（最主要）、xml和html，對於json格式的響應可以直接用requests自帶的json解析器進行解析，然後判斷其中的關鍵key的值等，如下面的程式碼斷言響應中的”success”是否為”True”；對於xml格式的響應，可以先獲取響應的文字內容然後採用python的第三方類庫如：lxml等，將xml文字轉成標籤樹，然後通過對應的xpath讀取值並進行校驗；對於html格式的響應，獲取響應的文字內容後用正則匹配或者xpath來得到需要校驗的值。

總結

本文主要介紹了一種利用python第三方類庫requests及單元測試工具unittest實現H5頁面介面功能測試的方法，主要運用場景是對於新開發的H5頁面介面的功能測試，能夠模擬到手工測試無法覆蓋的異常場景並且有效降低測試工作量，並且能反覆測試，快速驗證問題。當然對於功能已經比較穩定的介面，需要其他的H5頁面介面測試工具對介面進行監控及質量保證，多種方式結合才能更好的把控H5頁面介面的質量。

本章完~~

我們專注於移動測試技術精華，飽含騰訊多款億級APP的品質祕密，文章皆獨家原創，我們不談虛的，只談乾貨！

掃碼關注我們

unittest實現HTTP介面功能測試

一、背景

二、為什麼選擇unittest