前言
隨著項目對外輸出的接口日漸增多,接口測試逐漸提上日程。經(jīng)過一段時間的學(xué)習(xí)和摸索后,總結(jié)了一下。
方案
對于一些比較簡單的接口,我們希望可以通過csv文件進(jìn)行編輯和整理用例,對于一些復(fù)雜的接口可以通過自定義腳本的方式去實(shí)現(xiàn),在執(zhí)行完成后,以郵件的形式發(fā)送給相關(guān)同學(xué)。
為什么用CSV文件呢??接口測試大多數(shù)測試用例會比較相似,對類似的接口進(jìn)行反復(fù)相同的校驗(yàn)。針對這種簡單的情況,我們希望把測試用例與測試腳本分開。如果重復(fù)用數(shù)據(jù)去請求和重寫,是對測試資源的一種浪費(fèi),而CSV文件可以直接用EXCEL進(jìn)行編輯,讀取也非常方便,因此選作我們測試的用例集合。
如何參與測試?
1、對于簡單的接口,我們直接用excel對csv文件進(jìn)行編輯。
在選擇添加的時候,可以填寫當(dāng)前請求的請求頭和請求數(shù)據(jù)(部分舉例)。
2、對于一些復(fù)雜的接口,我們可以自定義腳本。
支持自定義腳本的好處是,我們既可以單獨(dú)運(yùn)行自定義測試腳本,也可以將自定義的文件納入全部測試用例中,作為回歸測試一起執(zhí)行。
開發(fā)流程
測試用例準(zhǔn)備——執(zhí)行測試用例、生成質(zhì)量報告——自動發(fā)送郵件
1、測試用例準(zhǔn)備
測試用例包括兩部分,自定義測試腳本中的測試用例和CSV文件中自動讀取的測試用例。
Unittest是Python自帶的單元測試框架,默認(rèn)有TestCase、TestResult、TestRunner等方法,非常方便。自定義接口測試的腳本類通過繼承Unittest,編寫并驗(yàn)證一些較復(fù)雜的接口。
為兼容自定義接口用例與文件讀取的接口用例類型,從文件中讀取的接口用例也需繼承Unittest類。主要的實(shí)現(xiàn)思路是從指定CSV文件里面中讀取數(shù)據(jù),每讀取一行,便通過自定義工場類TestFactory創(chuàng)建一個繼承于Unittest的AutoTest的類。
AutoTest類當(dāng)中,通過unittest默認(rèn)的setUP()方法對每個參數(shù)進(jìn)行初始化、judge_rule()方法對每行輸入的數(shù)據(jù)進(jìn)行重新處理(關(guān)于接口md5加密、urlencode、時間戳等)、test函數(shù)對接口進(jìn)行簡單的驗(yàn)證。
#每讀取一行,變加入TestSuit里一個已test為名的用例
test_case?=self.testf.create_test(row)
self.test_suit.addTests(map(test_case,?["test"]))
#通過unittest方法獲取到自定義以_test為后綴名的用例
self.get_auto_test_suit?=?unittest.defaultTestLoader.discover("../basepages/",pattern='*_test.py')
#將兩部分用例 通過addTests方法合并在一起,就是全部的接口測試用例
2、執(zhí)行測試用例、生成質(zhì)量報告
引入了BSTestRunner,對其進(jìn)行修改和編輯后,生成測試報告。BSTestRunner也是通過重寫Unittest的TestResult方法,對執(zhí)行的結(jié)果進(jìn)行展示。
在生成質(zhì)量報告中,BSTestRunner生成全部用例的執(zhí)行結(jié)果報告。面對這個情況,我們希望可生成兩份報告,一份僅記錄執(zhí)行失敗的用例報告,另一份為原生的全部用例執(zhí)行結(jié)果報告。所以在BSTestRunner的基礎(chǔ)上稍微進(jìn)行了些改進(jìn),讓其生成兩份報告。
#?自動化測試報告
fp?=open('../doc/my_report.html','wb')
#?僅錯誤版測試報告
fpe?=open('../doc/my_report_email_text.html','wb')
runner?=?BSTestRunner.BSTestRunner(
stream=fp,
stream2=?fpe,
title='接口測試自動質(zhì)量報告',
description='如需接口測試完整報告'
)
這里簡單給大家介紹下BSTestRunner這個引入的開源測試框架。
BSTestRunner 繼承于 Template_mixin類,通過調(diào)用sortResult方法,將用例傳給_TestResult類,獲取到執(zhí)行結(jié)果,用getReportAttribute()方法,將結(jié)果在html中展示出來。
了解這個開發(fā)測試框架后,我們對其改動就會很方便,這里我們重新定義了一個getReport()方法,僅將錯誤的執(zhí)行結(jié)果在另一個html中保存。
3、發(fā)送測試報告郵件
使用python的smtpserver進(jìn)行發(fā)送郵件,默認(rèn)發(fā)送的郵件需要到具體郵箱里設(shè)置授權(quán),這里注意password是授權(quán)碼,不是郵箱的密碼。
簡潔版的執(zhí)行結(jié)果my_report_email_text.html作為郵件內(nèi)容HTML模板,全部執(zhí)行結(jié)果my_report.html作為郵件附件。
發(fā)送郵件后,就可以收到具體的測試質(zhì)量報告啦!
BSTestRunner?Github地址: