Python+Requests實作介面自動化-有解無憂

一般對于自動化的理解，有兩種方式的自動化，

第一，不需要寫代碼，完全由工具實作，這種方式的工具一般是公司自己研發的，方便黑盒測驗人員使用，這種工具的特點是學習成本低，方便使用，但是通用性不強，也就是換了一家公司，就很有可能無法使用之前的工具，

第二，需要自己寫代碼，在別人的框架下撰寫代碼測驗，或者是需要自己搭建自動化測驗框架，這種方式對測驗人員的代碼要求高，學習成本高，但是通用性很強，去任何一家都可以用這套東西，
鑒于以上介紹，本文當然是介紹第二種方式了，

介面自動化測驗，我們的目的是使用python進行介面測驗，并完成輸出測驗報告，我們需要用到的東西有如下：python3，unittest，requests，

一、介面專案

我們使用的專案是發布會簽到系統，總共有5個介面，雖然不多，但足夠學習使用，

介面檔案如下：

二、介面用例

軟體測驗都需要寫測驗用例，不管你做的性能，自動化還是其它任何的測驗作業，

真實的作業寫介面的測驗用例，可能考慮很多場景，如介面的功能（正常場景），介面的邊界等價，介面的例外場景，介面引陣列合，介面的性能等等，本文采用輸出法分析，根據出參的不同設計出測驗用例，詳細用例參考如下：（用例太小看不清楚，可以查看原圖，然后放大）

三、代碼階段

3.1 框架的設計

我們使用unittest框架，case目錄存放所有的測驗用例，lib目錄存放自己封裝的一些代碼，result目錄存放測驗結果和測驗日志，runner.py是主程式，

3.2 主程式 runner.py

這個主程式跟之前的《selenium unittest實戰》文章類似，不再詳細介紹，不太一樣的地方是使用一個logging模塊，不知道大家有沒有感受，測驗介面的時候，想看完整的請求和回應，以便分析定位問題，

import unittest
import time
import os
import logging
from HTMLTestRunner import  HTMLTestRunner

#獲取專案的根目錄
test_dir = os.path.join(os.getcwd())

# 自動搜索專案根目錄下的所有case，構造測驗集；回傳TestSuite物件
discover = unittest.defaultTestLoader.discover(test_dir, pattern='test_*.py')

# 實體化TextTestRunner類
# runner = unittest.TextTestRunner(verbosity=2)

now = time.strftime('%Y-%m-%d %H_%M_%S')  # 獲取當前日期
result = test_dir+ '\\result\\'+now + '_result.html'  # 測驗報告的完整路徑
log = test_dir+'\\result\\'+now+'_log.txt'  #日志的完整路徑

logging.basicConfig(filename=log,level=logging.INFO,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s') #filename 日志檔案路徑 level 日志的級別 format 格式

fp = open(result, 'wb')  # wb方式寫入
runner = HTMLTestRunner(stream=fp, title='測驗報告', description='aguest_master專案用例執行情況',verbosity=2)  #構造runner

# 使用run()方法運行測驗套件（即運行測驗套件中的所有用例）
runner.run(discover)

3.3 測驗用例和lib庫

1）由于總共只有5個介面，所以設計為5個代碼檔案，分別為：test_add_event,py，test_add_guest.py，test_get_event_list.py，test_get_guest_list.py，test_user_sign.py，

2）我們使用python的requests測驗介面，這個庫大名鼎鼎，而且官網還有中文，

官網網址：http://docs.python-requests.org/zh_CN/latest/

3）每個代碼檔案都是一個介面，介面的url地址是固定的，所以設計成類屬性，方便后續測驗用例使用，

4）每個測驗用例都寫明代碼邏輯，方便以后除錯，
5）如果遇到經常呼叫的東西，如獲取最新發布會ID，獲取添加發布會body資料，都封裝成庫，
6）最后根據出參的狀態碼斷言是否成功
7）使用http://logging.info 記錄每個測驗用例的日志情況

添加發布會介面代碼檔案：test_add_event.py

import requests
import unittest
import logging
import addEventDataTemplate
import getNewID
from urllib import  parse  #使用requests發送post請求，body的漢字會進行url編碼，即%xx形式，想看到原始body，需要使用parse.unquote進入url解碼
class Test_addEvent(unittest.TestCase):
    '''添加發布會介面'''
    @classmethod
    def setUpClass(cls):
        cls.url="http://127.0.0.1:8000/api/add_event/"
    @classmethod
    def tearDownClass(cls):
        pass
    def setUp(self):
        pass
    def tearDown(self):
        pass
    def test_00(self):   #代碼邏輯::獲取當前最新發布會ID，設定入參，eid置空，發送post請求
        '''添加發布會-eid為空'''
        id=getNewID.getNewID()   #獲取當前最新發布會ID
        data=https://www.cnblogs.com/1024testing/archive/2022/04/19/addEventDataTemplate.getEventData(id)  #獲取添加發布會的資料模板
        data['eid']=''  #eid為空，即引數錯誤
        r=requests.post(self.url,data=https://www.cnblogs.com/1024testing/archive/2022/04/19/data)
        status=r.json()['status']
        self.assertEqual(10021,status)
        logging.info(f"case:添加發布會，eid為空\n請求地址：{r.url}\t請求方式:{r.request.method}\n請求頭：{r.request.headers}\n請求正文：{parse.unquote(r.request.body)}\n回應頭：{r.headers}\n回應正文：{r.text}\n")

    def test_01(self):    #代碼邏輯::獲取當前最新發布會ID，設定入參，發送post請求
        '''添加發布會-成功'''
        id = getNewID.getNewID()  # 獲取當前最新發布會ID
        data = https://www.cnblogs.com/1024testing/archive/2022/04/19/addEventDataTemplate.getEventData(id)#獲取添加最新發布會的資料模板
        r=requests.post(self.url,data=https://www.cnblogs.com/1024testing/archive/2022/04/19/data)
        status=r.json()['status']
        self.assertEqual(10000,status)
        logging.info(f"case:添加發布會，成功\n請求地址：{r.url}\t請求方式:{r.request.method}\n請求頭：{r.request.headers}\n請求正文：{parse.unquote(r.request.body)}\n回應頭：{r.headers}\n回應正文：{r.text}\n")

    def test_02(self):   #代碼邏輯::獲取當前最新發布會ID，ID-1即為發布會已經存在的ID（發布會ID是遞增加1）
        '''添加發布會-發布會ID已存在'''
        id = getNewID.getNewID()  # 獲取當前最新發布會ID
        data=https://www.cnblogs.com/1024testing/archive/2022/04/19/addEventDataTemplate.getEventData(id)#獲取添加最新發布會的資料模板
        data['eid']=data['eid']-1  #最新模板ID減一即為重復ID
        r=requests.post(self.url,data=https://www.cnblogs.com/1024testing/archive/2022/04/19/data)
        status = r.json()['status']
        self.assertEqual(10022, status)
        logging.info(f"case:添加發布會，發布會ID已存在\n請求地址：{r.url}\t請求方式:{r.request.method}\n請求頭：{r.request.headers}\n請求正文：{parse.unquote(r.request.body)}\n回應頭：{r.headers}\n回應正文：{r.text}\n")
    def test_03(self):   #代碼邏輯::先新增發布會，再獲取最新發布會ID，設定入參的name為重復，
        '''添加發布會-發布會標題已存在'''
        #新增發布會
        id = getNewID.getNewID()  # 獲取當前最新發布會ID
        r=requests.post(self.url,data=https://www.cnblogs.com/1024testing/archive/2022/04/19/addEventDataTemplate.getEventData(id))  #先新增一個發布會

        id = getNewID.getNewID()  # 獲取當前最新發布會ID
        data = https://www.cnblogs.com/1024testing/archive/2022/04/19/addEventDataTemplate.getEventData(id)#獲取添加最新發布會的資料模板
        data['name']=f'發布會測驗標題{id}' #最新模板ID減一，標題即為重復
        r=requests.post(self.url,data=https://www.cnblogs.com/1024testing/archive/2022/04/19/data)
        status = r.json()['status']
        self.assertEqual(10023,status)
        logging.info(f"case:添加發布會，發布會標題已存在\n請求地址：{r.url}\t請求方式:{r.request.method}\n請求頭：{r.request.headers}\n請求正文：{parse.unquote(r.request.body)}\n回應頭：{r.headers}\n回應正文：{r.text}\n")
    def test_04(self):   #代碼邏輯::獲取最新發布會ID，設定入參，開始時間:改為-,再提交請求
        '''添加發布會-發布會時間錯誤'''
        id = getNewID.getNewID()  # 獲取當前最新發布會ID
        data = https://www.cnblogs.com/1024testing/archive/2022/04/19/addEventDataTemplate.getEventData(id)#獲取添加最新發布會的資料模板
        data['start_time']=data['start_time'].replace(':','-')  #時間 : 改為 - ,即為時間錯誤
        r = requests.post(self.url, data=https://www.cnblogs.com/1024testing/archive/2022/04/19/data)
        status = r.json()['status']
        self.assertEqual(10024,status)
        logging.info(f"case:添加發布會，發布會時間錯誤\n請求地址：{r.url}\t請求方式:{r.request.method}\n請求頭：{r.request.headers}\n請求正文：{parse.unquote(r.request.body)}\n回應頭：{r.headers}\n回應正文：{r.text}\n")
if __name__ == '__main__':
    unittest.main(verbosity=2)
lib庫 getNewID.py：

def getNewID():
    '''獲取最新的（最大的）發布會編號id'''
    import sqlite3
    con=sqlite3.connect(r'D:\backup\guest2-master\db.sqlite3')
    cur=con.cursor()
    cur.execute("select max(id) from sign_event")
    new_id=cur.fetchone()
    new_id=new_id[0]
    cur.close()
    con.close()
    return new_id
lib庫 addEventDataTemplate.py：

import datetime
def getEventData(id):
    '''添加發布會 body模板'''
    startTime=(datetime.datetime.now()+datetime.timedelta(days=30)).strftime("%Y-%m-%d %H:%M:00")  #獲得當前時間，并往后30天為發布會時間

    data={
          'eid':id+1,
          'name':f"發布會測驗標題{id+1}",  #當前發布會編號加1
          'limit':100,    #默認值
          'status':1,    #默認值
          'address':'新街口金鷹',    #默認值
          'start_time':startTime  #%格式   Y-%m-%d %H:%M:00
        }
    return data