引言：年初參與到一個背景系統開發的項目中，裡面涉及了很多接口，我做為項目組測試人員，需要對這些接口進行測試，一開始使用 postman 工具測試，很是友善。但随着接口數量的增加，不光要執行手動點選測試，而且，一旦接口參數變動，都重新更改接口參數，次數多了，使得測試效率嚴重下降。
後來我将目光轉向了自動化測試，考慮到項目組對接口品質要求很高，需要快速開發。最終標明 python 作為腳本開發語言，使用其自帶的 requests 和 urllib 子產品進行接口請求，使用優化後的 unittest 測試架構編寫測試接口函數，測試結果選用 HTMLTestRunner 架構予以展示，并使用 python 的 ssl 子產品支援 https 協定的驗證。接下來，我詳細地介紹這些子產品，并給出各個子產品完整的測試代碼。
python 特别是 python 3.x 中的 urllib 和 requests 子產品，是用來請求 url 的兩個主要子產品。這兩個子產品中，如果僅僅是支援 http 協定的 url 請求，推薦使用 requests 子產品。為什麼這麼說呢？因為愛因斯坦說過一句話：簡潔就是美。requests 子產品對 urllib 子產品又做了一層封裝，使用更加友善。該子產品支援 GET, POST, PUT, DELETE 等請求方法。請求傳回資訊包含狀态碼和消息體，狀态碼用三位數字表示，消息體可用字元串，二進制或json 等格式表示。下面用一個例子來介紹一下 requests 子產品的使用。代碼如下：
import requests
def get_method(url, para, headers):
try:
req = requests.get(url=url, params=para, headers=headers)
except Exception as e:
print(e)
else:
if req.status_code == "200":
return req
else:
print("Requests Failed.")
if __name__=='__main__':
url = "http://www.google.com"
req = get_method(url=url, para=None, headers=None)
print(req.status_code)
print(req.text)
輸出為：
200
<!DOCTYPE html>
<!--STATUS OK--><html> <head><meta...（省略）
上述程式輸出狀态碼為 200，表明請求成功，傳回消息體為網頁内容。這裡我僅對requests 子產品中的 get 請求方法做了封裝，其它方法（如 post，put，delete 等）的封裝類似。當讓你也可以不用封裝，直接使用 requests.methodName 來直接調用該方法。這裡提醒一句，在實際的接口測試中，headers 和 data 都是有值的，要確定這些值的填寫正确，大部分請求下的請求失敗或傳回結果錯誤，基本上都是由于這些值的缺失或錯誤造成的。更多關于 requests 子產品的介紹，請參考官方文檔。
2、測試架構優化unittest 是 python 中進行單元測試使用廣泛的架構，其與 java 中的單元測試架構junit 類似。該架構使用簡單，需要編寫以 test 開頭的函數，選擇 unittest 架構運作測試函數，測試結果在終端顯示。這裡舉一個簡單的例子：
import unittest
class ApiTestSample(unittest.TestCase):
def setUp(self):
pass
def tearDown(self):
pass
def jiafa(self, input01, input02):
result = input01 + input02
return result
def test_jiafa(self):
testResult = self.jiafa(input01=4, input02=5)
self.assertEqual(testResult, 9)
if __name__=='__main__':
unittest.main()
簡單解釋下這段代碼，首先我們建立一個類 ApiTestSample，這個類繼承自unittest.TestCase 類。然後在這個類中寫了 jiafa 函數，它有兩個參數 input01，input02，傳回 input01 與 input02 相加的和。接着在 test_jiafa 方法中，我們對剛才 jiafa 函數進行了和值校驗。通過給 jiafa 輸入兩個值，擷取其函數傳回值，并與真實值做相等判斷，以此實作函數單元測試。這裡用到了 unittest 中斷言值相等的 assertEqual(m, n)函數，上述代碼運作結果如下：
Ran 1 test in 0.000s
OK
以上是 unittest 架構最基本的單元測試應用，但是這個架構有個缺陷，就是不能自己傳入參數。對于接口來說，往往需要傳入很多參數，并且這每個參數又有很多取值，如果不對原先的 unittest 架構做改變，不僅無法用來進行接口測試，而且一個個結合參數取值去寫測試代碼，工作量極其龐大，也沒有實作測試資料與腳本沒有分離。基于此，我們對該架構做出一下兩點優化。
1）擴充 unittest.TestCase 類，支援自定義參數輸入；
2）測試資料與測試腳本分離，測試資料存儲在檔案和資料庫中，以增強測試腳本複用性；
以下是對 unittest.TestCase 類的擴充，使其支援參數化把參數加進去。下面是具體的代碼實作過程：
class ExtendTestCaseParams(unittest.TestCase):
#擴充 unittest.TestCase 類，使其支援自定義參數輸入
def __init__(self, method_name='runTest', canshu=None):
super(ExtendTestCaseParams, self).__init__(method_name)
self.canshu = canshu
#靜态參數化方法
@staticmethod
def parametrize(testcase_klass, default_name=None, canshu=None):
""" Create a suite containing all tests taken from the given
subclass, passing them the parameter 'canshu'
"""
test_loader = unittest.TestLoader()
testcase_names = test_loader.getTestCaseNames(testcase_klass)
suite = unittest.TestSuite()
if default_name != None:
for casename in testcase_names:
if casename == defName:
suite.addTest(testcase_klass(casename, canshu=canshu))
else:
for casename in testcase_names:
suite.addTest(testcase_klass(casename, canshu=canshu))
return suite
這裡，canshu 就是優化後加的自定義參數，參數類型可以是元組或清單。下面使用這個參數化類來改寫之前的代碼。
class ApiTestSample(ExtendTestCaseParams):
def setUp(self):
pass
def tearDown(self):
pass
def jiafa(self, input01, input02):
result = input01 + input02
return result
def test_jiafa(self):
input_01 = self.param[0]
input_02 = self.param[1]
expectedResult = self.param[2]
result = self.sub(input_01, input_02)
print(result)
self.assertEqual(result, expectedResult)
if __name__=='__main__':
testData = [
(10, 9, 19),
(12, 13, 25),
(12, 10, 22),
(2, 4, 6)
]
suite = unittest.TestSuite()
for i in testData:
suite.addTest(ExtendTestCaseParams.parametrize(ApiTestSample, 'test_jiafa', canshu=i))
runner = unittest.TextTestRunner()
runner.run(suite)
執行結果如下：
....
## 19
25
Ran 4 tests in 0.000s
22
6
OK
通過對 unittest 架構優化，我們實作了 unittest 架構的參數化，這樣就可以用于接口測試了。雖然我們實作了參數化，但是測試結果的展示不夠直覺，這個時候需要一個可視化頁面來直接顯示測試結果。所幸的是，python 中有專門展示測試結果的架構：HTMLTestRunner。該架構可以将測試結果轉換為 HTML 頁面，并且該架構可以和unittest 架構完美的結合起來。接下來我們講述一下 HTMLTestRunner 架構的使用。
3、測試結果可視化HTMLTestRunner 架構可用來生成可視化測試報告，并能很好的與 unittest 架構結合使用，接下來我們以一段代碼來展示一下 HTMLTestRunner 的使用。
if __name__=='__main__':
from HTMLTestRunner import HTMLTestRunner
testData = [
(10, 9, 19),
(12, 13, 25),
(12, 10, 22),
(2, 4, 6)
]
suite = unittest.TestSuite()
for i in testData:
suite.addTest(ExtendTestCaseParams.parametrize(ApiTestSample,'test_jiafa',canshu=i))
currentTime = time.strftime("%Y-%m-%d %H_%M_%S")
result_path = './test_results'
if not os.path.exists(path):
os.makedirs(path)
report_path = result_path + '/' + currentTime + "_report.html"
reportTitle = '測試報告'
desc = u'測試報告詳情'
with open(report_path, 'wd') as f:
runner = HTMLTestRunner(stream=f, title=reportTitle, description=desc)
runner.run(suite)
測試結果如下：
下面詳細講解一下 html 報告的生成代碼：
runner = HTMLTestRunner(stream=fp, title=reportTitle, description=desc)
HTMLTestRunner 中的 stream 表示輸入流，這裡我們将檔案描述符傳遞給 stream，title 參數表示要輸出的測試報告主題名稱，description 參數是對測試報告的描述。在使用 HTMLTestRunner 時，有幾點需要注意：
1）HTMLTestRunner 子產品非 Python 自帶庫，需要到 HTMLTestRunner 的官網下載下傳
該安裝包；
2）官網的 HTMLTestRunner 子產品僅支援 Python 2.x 版本，如果要在 Python 3.x中，需要修改部分代碼，修改的代碼部分請自行上網搜尋；
如果需要生成 xml 格式，隻需将上面代碼中的
runner = HTMLTestRunner(stream=fp, title=reportTitle, description=desc)
runner.run(suite)
修改為如下代碼
import xmlrunner
runner = xmlrunner.XMLTestRunner(output='report')
runner.run(suite)
4、接口測試分類前面大家對接口請求，測試架構和測試結果可視化方面有了深入的了解。有了前面的基礎，對于接下來了解和編寫接口測試會有很大幫助。這裡我們先來講解一下接口測試與單元測試的差別。單元測試隻針對函數進行多組參數測試，包括正常和異常參數組合。而接口測試是針對某一接口進行多組參數測試。實際接口測試中，我們又将接口測試分為兩種：
1）單接口測試；
2）多接口測試。
對于單接口測試，隻需針對單個接口測試，測試資料根據接口文檔中的參數規則來設計測試用例；對多接口測試，首先要確定接口之間調用邏輯正确，然後再根據接口文檔中的參數規則來設計用例進行測試。下面我就根據這兩種不同情況的接口測試，用實際項目代碼展示一下。
4.1 單接口測試
class TestApiSample(ExtendTestCaseParams):
def setUp(self):
pass
def tearDown(self):
pass
def register(self, ip, name, desc):
url = 'http://%s/api/v1/reg' % ip
headers = {"Content-Type": "application/x-www-form-urlencoded"}
para = {"app_name": name, "description": desc}
req = self.Post(url, para, headers）
return req
def test_register(self):
for index, value in enumerate(self.param):
print('Test Token {0} parameter is {1}'.format(index, value)）
self.ip = self.param[1]
self.name = self.param[2]
self.desc = self.param[3]
self.expectedValue = self.param[4]
req = self.grant_register(self.ip, self.name, self.desc)
self.assertIn(req.status_code, self.expectedValue, msg="Test Failed.")
if __name__=='__main__':
import random
import string
ip = '172.36.17.108'
testData = [
(1, ip, ''.join(random.sample(string.ascii_letters + string.digits, 7)), '', 200),
(2, ip, ''.join(random.sample(string.ascii_letters + string.digits, 7)), '', 200),
(3, ip, ''.join(random.sample(string.ascii_letters + string.digits, 7)), '', 200)
]
suite = unittest.TestSuite()
for i in testData:
suite.addTest(ExtendTestCaseParams.parametrize(TestApiSample,'test_register',canshu=i))
currentTime = time.strftime("%Y-%m-%d %H_%M_%S")
path = './results'
if not os.path.exists(path):
os.makedirs(path)
report_path = path + '/' + currentTime + "_report.html"
reportTitle = '接口測試報告'
desc = u'接口測試報告詳情'
with open(report_path, 'wd') as f:
runner = HTMLTestRunner(stream=f, title=reportTitle, description=desc)
runner.run(suite)
上述代碼中的 register()為注冊接口函數，test_register()為測試注冊接口函數，testData 為測試資料，這裡沒有完全做到測試腳本與測試資料分離。為了實作測試資料與測試腳本分離，可以将 testData 清單單獨寫在文本檔案或者資料庫中，運作測試腳本時再去加載這些資料，就能實作測試腳本與測試資料的分離。
4.2 多接口測試
class TestApiSample(ExtendTestCaseParams):
def setUp(self):
pass
def tearDown(self):
pass
def register(self, ip, name, desc):
url = 'https://%s/api/v1/reg' % ip
headers = {"Content-Type": "application/x-www-form-urlencoded"}
para = {"app_name": name, "description": desc}
req = self.Post(url, para, headers）
return req
def oauth2_basic(self, ip, name, desc):
apps = self.register(ip, name, desc)
apps = apps.json()
url = 'http://%s/api/v1/basic' % ip
data = {"client_id":apps['appId'], "client_secret":apps['appKey']}
headers = None
req = requests.post(url, data, headers)
basic = str(req.content, encoding='utf-8')
return apps, basic, req
def test_oauth2_basic(self):
count = 0
for i in self.param:
count += 1
self.ip = self.param[1]
self.name = self.param[2]
self.desc = self.param[3]
self.expected = self.param[4]
apps, basic, req = self.oauth2_basic(self.ip, self.name, self.desc)
self.assertIn(req.status_code, self.expected, msg="Grant Failed.")
if __name__=='__main__':
import random
import string
ipAddr = '172.36.17.108'
testData = [
(1, ipAddr, ''.join(random.sample(string.ascii_letters + string.digits, 7)), '', 200),
(2, ipAddr, ''.join(random.sample(string.ascii_letters + string.digits, 7)), '', 200),
(3, ipAddr, ''.join(random.sample(string.ascii_letters + string.digits, 7)), '', 200)
]
suite = unittest.TestSuite()
for i in testData:
suite.addTest(ExtendTestCaseParams.parametrize(TestApiSample, 'test_oauth2_basic',
canshu=i))
currentTime = time.strftime("%Y-%m-%d %H_%M_%S")
path = '../Results'
if not os.path.exists(path):
os.makedirs(path)
report_path = path + '/' + currentTime + "_report.html"
reportTitle = '接口測試報告'
desc = u'接口測試報告詳情'
with open(report_path, 'wd') as f:
runner = HTMLTestRunner(stream=f, title=reportTitle, description=desc)
runner.run(suite)
上述代碼中，我們對兩個接口進行了函數封裝，兩個接口之間有依賴關系，oauth2_basic()函數在請求之前必須先去請求 register()函數擷取資料。對于這種多接口測試，且接口之間存在互相調用的情況，最好是在調用該接口前時，将互相之間有依賴的接口封裝進該接口中，保證接口調用邏輯一緻。其次再針對該接口的其它參數設計測試用例去測試該接口。
5、https 協定請求前面我們提及的接口測試，僅是關于請求 http 協定的。然而，http 協定在傳輸過程中并不安全，通過該協定傳輸内容容易被截取，由此人們提出了 https 協定。該協定在原先的 http 協定之外，對傳輸過程中的内容進行了加密處理，這樣就能確定資訊在傳輸過程中的安全。目前很多公司的通路 url 都已轉換到 https 協定。是以在接口測試中也要考慮到對 https 協定通路的支援。目前對于 https 協定通路的處理有以下幾種方案。
第一種，對于一般網站通路，無法獲得支援 https 協定的證書資訊，是以隻能選擇忽略 ssl 校驗；
第二種，對于外部網絡通路公司内容網絡和内容來說，除了要經過防火牆外，通路具體業務要經過負載均衡器。而負載均衡器一般要求支援 https 協定，這個時候就需要使用 Python 中的 ssl 子產品對證書進行校驗；
關于忽略通路 https 協定的證書校驗，這裡忽略不表。重點講解 https 協定證書的校驗。在 Python 中，提供了 ssl 子產品，用于對 https 協定證書的認證。這裡以一段代碼來展示該子產品的應用。
import ssl
cont = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
cont.check_hostname = False
cont.load_cert_chain(certfile=public_key, keyfile=private_key)
cont.verify_mode = 2
cont.load_verify_locations(ca_key)
上述代碼中先生成 ssl 上下文對象 cont，接下來用這個上下文對象 cont 依次進行域名校驗、證書導入、驗證模式選擇及 CA 證書驗證。cont.checkhostname 用于域名校驗，值為 True 表示進行主機名校驗，值為 False 表示不進行主機名校驗。
cont.loadcertchain(certfile=publickey, keyfile=privatekey)，certfile 表示導入公鑰證書，keyfile 表示導入私鑰證書。一般情況下，Python 支援的 certfile 證書檔案字尾為.crt，keyfile 證書檔案字尾為.pem。cont.verifymode 為驗證模式，值為 0 表示不做證書校驗，值為 1 表示代表可選，值為 2 表示做證書校驗。cont.loadverifylocations(ca_key)表示導入CA 證書。一般的證書校驗都要經過上述這幾個步驟。此時 ssl 證書的基本配置已完成。接下來就需要在發送 https 請求時加入證書驗證環節，示例代碼如下：
req = request.Request(url=url, data=para, headers=headers, method='GET')
response = request.urlopen(req, context=self.context)
整個完整的 ssl 證書驗證代碼如下：
if __name__=='__main__':
from urllib import parse, request
import ssl
context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
context.check_hostname = False
context.load_cert_chain(certfile=pub_key_cert_file, keyfile=pri_key_pem_file)
context.verify_mode = 2
context.load_verify_locations(ca_file)
req = request.Request(url=url, data=para, headers=headers, method='GET')
response = request.urlopen(req, context=self.context)
上述代碼中，我們選擇了 python 中 urllib 子產品做接口請求，是因為在多次對比了reuests子產品和 urllib 對 https 證書驗證的支援之後，發現 urllib 子產品能夠很好地支援 ssl 證書校驗。更多有關 python 中 ssl 子產品的資訊，請參考 ssl 官方文檔
6、總結回顧整個項目經過，應該說是是被現實問題逼着進步，從一開始的走捷徑使用 API內建工具來測試接口，到後來使用自動化測試腳本實作接口測試，再到最後增加對 https協定的支援。這一路走來，帶着遇到問題解決問題地思路，我的測試技能得到很大提升。總結這幾個月的項目經曆就一句話：遇到問題，解決問題，能力才會得到快速提升，與大家共勉。