漫談Tavern之API實戰

• 2020 年 2 月 25 日
• 筆記

在API的測試用例編寫文章和接口測試維度的文章中體系中，詳細的介紹了API測試點編寫和涉及到的知識體系。其實在更加細緻的角度上，API的測試也是需要考慮它的分層，很多時候我們聽過金字塔的模型，以及基於金字塔模型演變後的菱形，後微服務架構模式下新的金字塔的模型，其實就單純的API的測試角度上，也是存在它的分層，關於分層，在後面的文章中會詳細的介紹少。在平常的工作中，我們接觸到的API的測試，主要是基於這麼幾個維度，分別是單個API的驗證，外部依賴API的驗證，和基於業務場景的API驗證。

就單純的先說單個API的測試，針對單個API的測試，可以從它的功能行，安全性和性能的維度展開測試，安全要考慮這個接口是否進行了參數的加密，和是否增加了反爬蟲機制，以及請求限制次數，IP白名單的思想來展開設計測試點，性能主要需要考慮它的並發性，以及基於它是IO密集型還是CPU密集型來驗證服務端的資源情況，功能方面的考慮，在服務端的測試技術文章裏面有很多詳細的介紹。

在本文章中，就以一個具體的案例來演示如何高效的來測試它，被測試的API的源碼為：

#!/usr/bin/env python  #!coding:utf-8  from flask import  Flask,jsonify  from flask_restful import  Api,Resource,reqparse      app=Flask(__name__)  api=Api(app)    class LoginView(Resource):     def get(self):        return {'status':0,'msg':'ok','data':'this is a login page'}       def post(self):        parser=reqparse.RequestParser()        parser.add_argument('username', type=str, required=True, help='您的用戶名驗證錯誤')        parser.add_argument('password',type=str,required=True,help='賬戶密碼不能為空')

      parser.add_argument('age',type=int,help='年齡必須為正正數')        parser.add_argument('sex',type=str,help='性別只能是男或者女',choices=['女','男'])        args=parser.parse_args()        return jsonify(args)      api.add_resource(LoginView,'/login',endpoint='login')    if __name__ == '__main__':     app.run(debug=True)

如果需要單純的驗證上面的接口，需要測試具體的點，比如username或者password為空的驗證，以及age參數是否為整數，以及sex如果傳的不是男或者女的處理，針對這樣的單接口的測試場景，我們可以使用Tavern來很輕鬆的解決該問題，並且把它的測試場景覆蓋到。

那什麼是Tavern了？Tavern是用於HTTP，MQTT或其他協議的基於pytest的高級API測試框架。我們為什麼需要選擇它，因為它具備如下的優勢：

1、輕量級，簡單，高效，即使你沒有任何的代碼簡單，只要按照我下面的步驟，也是可以很輕鬆高效的完成API的自動化測試

2、容易編寫，閱讀和理解，它是基於yaml文件來編寫API的測試點的，所以看起來很直觀

3、可以測試基於HTTP協議以及MQTT和其他的協議

4、它的生態在不斷發展和完善中

要使用它，首先需要安裝相關的信息，但是必須已經安裝了Python環境，建議是Python3.7版本的，它支持Python 2.7 / 3.4-3.7。下來需要安裝的庫分別是：

pip install pytest==4.5.0

pip install tavern

安裝如上的庫之後，下來就需要在yaml文件裏面編寫具體的API了，如創建test_login.tavern.yaml，在裏面編寫的測試點內容為：

test_name: 測試登錄接口    stages:    - name: test login api      request:        url: http://127.0.0.1:5000/login        method: POST        data:          username: 無涯          password: asd888          age: 18          sex: 男      response:        status_code: 200        body:          username: 無涯  ---  test_name: 用戶名為空驗證    stages:    - name: test login api      request:        url: http://127.0.0.1:5000/login        method: POST        data:          password: asd888          age: 18          sex: 男      response:        status_code: 400        body:          message:            username: 您的用戶名驗證錯誤  ---  test_name: 密碼為空驗證    stages:    - name: test login api      request:        url: http://127.0.0.1:5000/login        method: POST        data:          username: wuya          age: 18          sex: 男      response:        status_code: 400        body:          message:            password: 賬戶密碼不能為空  ---  test_name: age參數不是整數    stages:    - name: test login api      request:        url: http://127.0.0.1:5000/login        method: POST        data:          username: wuya          password: asd888          age: asd          sex: 男      response:        status_code: 400        body:          message:            age: 年齡必須為正正數  ---  test_name: sex參數只能為男或者女    stages:    - name: test login api      request:        url: http://127.0.0.1:5000/login        method: POST        data:          username: wuya          password: asd888          age: 18          sex: asd      response:        status_code: 400        body:          message:            sex: 性別只能是男或者女

在上面的文件內容中，可以很清晰的看到每個接口的請求信息，以及它的響應數據，和響應數據裏面的業務數據。基於yaml文件的格式編寫後，在該文件的目錄下，執行命令:

pytest -v test_login.tavern.yaml 就會很清晰的執行驗證每個測試點，如下圖所示：

如果被測試的測試點失敗，執行後也會顯示出來，比如新增請求http://httpbin.org/get，實際會請求成功，但是status_code我們給500，如：

test_name: 請求httpbin.org    stages:    - name: test httpbin.org      request:        url: http://httpbin.org/get        method: GET      response:        status_code: 500

執行後，斷言失敗的錯誤信息展示如下圖所示：

可以說Tavern非常的簡單而且很高效，來測試基於單個接口的驗證，即使不會代碼也是可以完成API的自動化測試。

感謝您的閱讀，後續會逐步的介紹Tavern在API自動化測試方面的應用案例實戰。

武漢加油，中國加油！