引言：年初參與到一個後臺系統開發的專案中，裡面涉及了很多介面，我做為專案組測試人員，需要對這些介面進行測試，一開始使用 postman 工具測試，很是方便。但隨著介面數量的增加，不光要執行手動點選測試，而且，一旦介面引數變動，都重新更改介面引數，次數多了，使得測試效率嚴重下降。

後來我將目光轉向了自動化測試，考慮到專案組對介面質量要求很高，需要快速開發。最終選定 python 作為指令碼開發語言，使用其自帶的 requests 和 urllib 模組進行介面請求，使用最佳化後的 unittest 測試框架編寫測試介面函式，測試結果選用 HTMLTestRunner 框架予以展示，並使用 python 的 ssl 模組支援 https 協議的驗證。接下來，我詳細地介紹這些模組，並給出各個模組完整的測試程式碼。

1、介面請求

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 = "

req = get_method(url=url, para=None, headers=None)

print(req.status_code)

print(req.text)

輸出為：

200

<!DOCTYPE html>

<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協議的支援。這一路走來，帶著遇到問題解決問題地思路，我的測試技能得到很大提升。總結這幾個月的專案經歷就一句話：遇到問題，解決問題，能力才會得到快速提升，與大家共勉。

歡迎加入 51軟體測試大家庭，在這裡你將獲得【最新行業資訊】，【免費測試工具安裝包】，【軟體測試技術乾貨】，【面試求職技巧】... 51與你共同學習，一起成長！ 加我VX：ww-51testing 回覆關鍵詞“測試”進入軟體測試學習交流群哦~~

乾貨丨Python介面測試自動化實戰及程式碼示例：含get、post等方法

相關文章