1. 程式人生 > >快速打造屬於你的介面自動化測試框架

快速打造屬於你的介面自動化測試框架

![](https://img2020.cnblogs.com/blog/2029875/202006/2029875-20200622173637203-655189065.png) #### 1 介面測試 介面測試是對系統或元件之間的介面進行測試,主要是校驗資料的交換,傳遞和控制管理過程,以及相互邏輯依賴關係。 介面自動化相對於UI自動化來說,屬於更底層的測試,這樣帶來的好處就是測試收益更大,且維護成本相對來說較低,是我們進行自動化測試的首選 #### 2 框架選型 目前介面自動化的框架比較多,比如jmeter,就可以集介面自動化和效能測試於一體,該工具編寫用例效率不高;還有我們常用的postman,結合newman也可以實現介面自動化;__Python+unittest+requests+HTMLTestRunner__ 是目前比較主流的測試框架,對python有一定的編碼要求; 本期我們選擇robotframework(文中後續統一簡稱為RF)這一個比較老牌的測試框架進行介紹,RF是一個完全基於 __關鍵字__ 測試驅動的框架,它即能夠基於它的一定規則,匯入你需要的測試庫(例如:其集成了selenium的測試庫,即可以理解為操作控制元件的測試底層庫),然後基於這些測試庫,你能應用TXT形式編寫自己的關鍵字(支援python和java語言,這些關鍵字即你的庫組成),之後,再編寫(測試用例由測試關鍵字組成)進行測試;他支援移動端、UI自動化和介面自動化的測試 #### 3 環境搭建 - python的安裝:目前選取的python3以上的版本,RF的執行依賴python - robotframework:參考https://www.jianshu.com/p/9dcb4242b8f2 - jenkins:用於排程RF的用例執行環境 - gitlab:程式碼倉庫 #### 4 需求 4.1 需求內容 介面內容:實現一個下單,並檢查訂單狀態是否正常的場景;該需求涉及到如下三個介面 - 下單介面 - 訂單結果查詢介面 - 下單必須帶上認證標識,生成token的介面 環境覆蓋:需要支援能在多套環境執行,比如測試和預釋出環境 系統整合:需要能夠整合在CICD中,實現版本更新後的自動檢測 4.2 用例設計 4.2.1 用例設計,根據業務場景設計測試用例,方便後續實現 ![20200616180851](https://fulu-item11-zjk.oss-cn-zhangjiakou.aliyuncs.com/images/20200616180851.png) 4.2.2 測試資料構造,預置不同環境的測試資料,供實現呼叫 ![20200616181307](https://fulu-item11-zjk.oss-cn-zhangjiakou.aliyuncs.com/images/20200616181307.png) #### 5 整體實現架構 ![20200615120654](https://fulu-item11-zjk.oss-cn-zhangjiakou.aliyuncs.com/images/20200615120654.png) 介面測試實現層:在RF,通過引用預設關鍵字 __RequestsLibrary__ (實現http請求)和通過python自定義關鍵字來完成用例實現的需求; jenkins排程:在jenkins上配置一個job,設定好RF用例執行的伺服器和傳送給伺服器相關的RF執行的指令,並且在jenkins中配置好測試報告模板,這樣用例便可以通過jenkins完成執行併發送測試結果給專案干係人; 生成用例執行的API:上圖中藍色部分,就是為了將jenkins的job生成一個可訪問api介面,方便被測專案的CICD整合; 整合到被測系統CICD流程:將上面步驟中封裝的API配置在被測應用的__gitlab-ci.yml__中,完成整個介面自動化的閉環 #### 6 RF用例實現 6.1 引用的內建關鍵字 - RequestsLibrary 構造http的請求,get|post等請求 ``` getRequests # get請求的入參 [Arguments] ${url_domain} ${getbody} ${geturl} ${getToken} Create session postmain ${url_domain} # 定義header的內容 ${head} createdictionary content-type=application/json Authorization=${getToken} MerchantId=${s_merchant_id} # get請求 ${addr} getRequest postmain ${geturl} params=${getbody} headers=${head} # 請求狀態碼斷言 Should Be Equal As Strings ${addr.status_code} 200 ${response_get_data} To Json ${addr.content} # 返回http_get請求結果 Set Test Variable ${response_get_data} Delete All Sessions ``` 6.2 自定義關鍵字 - getEnvDomain 用於從自定義的configs.ini檔案獲取對應環境的微服務的請求域名 configs.ini的內容 ![20200615081943](https://fulu-item11-zjk.oss-cn-zhangjiakou.aliyuncs.com/images/20200615081943.png) ``` # 獲取configs.ini的內容 import configparser def getEnv(path,env): config = configparser.ConfigParser() config.read(path) passport = config[env]['passport'] stock=config[env]['stock'] finance=config[env]['finance'] SUP = config[env]['SUP'] publicApi = config[env]['publicApi'] publicOrder = config[env]['publicOrder'] data_dict={'passport':passport,'stock':stock,'finance':finance,'SUP':SUP,'publicApi':publicApi,'publicOrder':publicOrder} return data_dict ``` - excelTodict 使用者將excel中的內容作為字典返回 ``` import xlrd ''' 通用獲取excel資料 @:param path excel檔案路徑 @:param sheet_name excel檔案裡面sheet的名稱 如:Sheet1 @:env 環境,是IT還是PRE ''' def getExcelDate(path, sheet_name,env): bk = xlrd.open_workbook(path) sh = bk.sheet_by_name(sheet_name) row_num = sh.nrows data_list = [] for i in range(1, row_num): row_data = sh.row_values(i) data = {} for index, key in enumerate(sh.row_values(0)): data[key] = row_data[index] data_list.append(data) data_list1 = [] for x in data_list: #print('這是'+str(x)) if(x.get('env')==env): data_list1.append(x) return data_list1 ``` - getToken 提供介面下單的授權token ``` *** Keywords *** # 根據傳入的clientid、secret生成對應的token getToken [Arguments] ${client_id} ${client_secret} ${url_domain} Create session postmain ${url_domain} ${auth} createdictionary grant_type=client_credentials client_id=${client_id} client_secret=${client_secret} ${header} createdictionary content-type=application/x-www-form-urlencoded ${addr} postRequest postmain /oauth/token data=${auth} headers=${header} Should Be Equal As Strings ${addr.status_code} 200 ${responsedata} To Json ${addr.content} ${access} Get From Dictionary ${responsedata} access_token ${token} set variable bearer ${access} Set Test Variable ${token} Delete All Sessions ``` - getAllDate 獲取該用例下的所有資料 ``` getAllData [Arguments] ${row_no} getEnvDomain getBalance ${row_no} getStockNum ${row_no} getSupProPrice ${row_no} getProPrice ${row_no} Set Test Variable ${publicOrderUrl} Set Test Variable ${FPbalance} Set Test Variable ${Pbalance} Set Test Variable ${Sbalance} Set Test Variable ${Jbalance} Set Test Variable ${Cardnum} Set Test Variable ${sprice} Set Test Variable ${price} Set Test Variable ${j_merchant_id} Set Test Variable ${s_merchant_id} Set Test Variable ${stock_id} Set Test Variable ${p_product_id} Set Test Variable ${s_product_id} ``` - 實現demo ``` *** Settings *** Test Template Resource 引用所有資源.txt *** Test Cases *** *** Settings *** Test Template Resource 引用所有資源.txt *** Test Cases *** 01 下單卡密直儲商品 [Tags] order LOG ---------------------獲取下單前的數量、餘額------------------------------------------ getAllData 0 ${Cardnum1} set variable ${Cardnum} ${FPbalance1} set variable ${FPbalance} ${Pbalance1} set variable ${Pbalance} ${Sbalance1} set variable ${Sbalance} ${Jbalance1} set variable ${Jbalance} ${CustomerOrderNo1} Evaluate random.randint(1000000, 9999999) random ${Time} Get Time log ------------------------下單操作------------------------------------------------------- getToken 100xxxx 295dab07a9xxxx9780be0eb95xxxx ${casUrl} ${input_cs} create dictionary memberId=${j_merchant_id} clientId=1xxx079 userId=string shopType=string customerOrderNo=${CustomerOrderNo1} ... productId=${p_product_id} buyNum=1 chargeAccount=otest888888 notifyUrl=string chargeIp=string chargePassword=string ... chargeGameName=string chargeGameRole=string chargeGameRegion=string chargeGameSrv=string chargeType=string remainingNumber=0 ... contactTel=string contactQQ=string customerPrice=0 poundage=0 batchNumber= originalOrderId=string ... shopName=string appointSupProductId=0 stemFromSubOrderId=123456 externalBizId=456789 postRequests ${publicOrderUrl} ${input_cs} /api/Order ${token} ${data} get from dictionary ${responsedata} data ${orderid} get from dictionary ${data} id sleep 6 ${getdata} create dictionary Id=${orderid} PageIndex=1 PageSize=1 getRequests ${publicOrderUrl} ${getdata} /api/Order/GetList ${token} ${datalist} get from dictionary ${response_get_data} data ${data} get from dictionary ${datalist} list ${dict} set variable ${data}[0] ${orderOuterStatus} get from dictionary ${dict} orderOuterStatus LOG ---------------------獲取下單後的數量、餘額---------------------------------------------- getAllData 0 ${Cardnum2} set variable ${Cardnum} ${FPbalance2} set variable ${FPbalance} ${Pbalance2} set variable ${Pbalance} ${Sbalance2} set variable ${Sbalance} ${Jbalance2} set variable ${Jbalance} ${sprice} set variable ${sprice} ${price} set variable ${price} log ------------------斷言----------------------------------------------------------------- ${Cardnum3} Evaluate ${Cardnum1} ${Jbalance3} Evaluate ${Jbalance1} ${Sbalance3} Evaluate ${Sbalance1} ${Pbalance3} Evaluate ${Pbalance1} should be true ${orderOuterStatus}==90 should be true ${Cardnum3}==${Cardnum2} should be true ${Jbalance3}==${Jbalance2} should be true ${Sbalance3}==${Sbalance2} should be true ${Pbalance3}==${Pbalance2} ``` #### 7 整合到CICD流程 7.1 jenkins配置job 通過jenkins的引數化構建,定義it和pre兩套環境 ![20200615121059](https://fulu-item11-zjk.oss-cn-zhangjiakou.aliyuncs.com/images/20200615121059.png) jenkins傳送RF執行的命令 ![20200615121250](https://fulu-item11-zjk.oss-cn-zhangjiakou.aliyuncs.com/images/20200615121250.png) 7.2 封裝的jenkins_job的執行介面地址 通過python的flask框架,根據測試和pre兩套環境包一層jenkins的job執行介面 ``` __author__ = 'paul' # !/usr/bin/env python # -*- coding: utf-8 -*- from flask import Flask, abort, request, jsonify import jenkins server = jenkins.Jenkins('http://10.0.1.xxx:80', username='xxx', password='fuluxxxx') app = Flask(__name__) tasks = [] # it的測試集合http請求介面 @app.route('/test/it', methods=['get']) def robot_Test_It(): server.build_job('CI_FuluOrder', {'environment': 'IT'}) return jsonify({'result': 'success'}) # pre的測試集合http請求介面 @app.route('/test/pre', methods=['get']) def robot_Test_Pre(): server.build_job('CI_FuluOrder', {'environment': 'PRE'}) return jsonify({'result': 'success'}) if __name__ == "__main__": # 將host設定為0.0.0.0,則外網使用者也可以訪問到這個服務 app.run(host="0.0.0.0", port=80, debug=True) ``` 7.3 將上述flask封裝的介面打包成映象 根據dockerfile生成映象 ``` FROM python:3.6 WORKDIR /app EXPOSE 80 COPY . . RUN pip install -r requirements.txt  ENTRYPOINT ["python","robotTestApi.py"] ``` 7.4 將映象部署到kubernetes,對外提供服務 供觸發測試執行的呼叫入口 ,這部分封裝的介面部署在本地的k8s叢集下ordermiddle ![](https://img2020.cnblogs.com/blog/2029875/202006/2029875-20200622182901988-751067441.png) IT: http://ordermiddle.xxx.cn/test/it pre:http://ordermiddle.xxx.cn/test/pre 7.5 被測專案的CICD整合介面自動化測試 gitlab目前採取直接對CICD指令碼加入測試步驟,在部署到容器30秒後(考慮到容器在K8S啟動時間)呼叫測試介面 ![20200615121532](https://fulu-item11-zjk.oss-cn-zhangjiakou.aliyuncs.com/images/20200615121532.png) 7.6 傳送測試報告 ![20200616181105](https://fulu-item11-zjk.oss-cn-zhangjiakou.aliyuncs.com/images/20200616181105.png) ![](https://img2020.cnblogs.com/blog/2029875/202006/2029875-20200622173655161-18915676