說到 Python 的單元測試框架,想必接觸過 Python 的朋友腦袋里第一個想到的就是 unittest。
的確,作為 Python 的標準庫,它很優秀,并被廣泛應用于各個項目。但其實在 Python 眾多項目中,主流的單元測試框架遠不止這一個。
一、介紹
unittest 單元測試框架最早受到 JUnit 的啟發,和其他語言的主流單元測試框架有著相似的風格。它支持測試自動化,多個測試用例共享前置(setUp)和清理(tearDown)代碼,聚合多個測試用例到測試集中,并將測試和報告框架獨立。
二、用例編寫
下面這段簡單的示例來自于官方文檔,用來測試三種字符串方法:upper、isupper、split:
上述示例中,通過繼承 unittest.TestCase 來創建一個測試用例。在這個類中,定義以 test 開頭的方法,測試框架將把它作為獨立的測試去執行。
每個用例都采用 unittest 內置的斷言方法來判斷被測對象的行為是否符合預期,比如:
-
在 test_upper 測試中,使用 assertEqual 檢查是否是預期值
-
在 test_isupper 測試中,使用 assertTrue 或 assertFalse 驗證是否符合條件
-
在 test_split 測試中,使用 assertRaises 驗證是否拋出一個特定異常
可能有人會好奇,為什么不使用內置斷言語句 assert,而要額外提供這么多斷言方法并使用呢?原因是通過使用 unittest 提供的斷言方法,測試框架在運行結束后,能夠聚合所有的測試結果并產生信息豐富的測試報告。而直接使用 assert 雖然也可以達到驗證被測對象是否符合預期的目的,但在用例出錯時,報錯信息不夠豐富。
三、用例發現和執行
unittest 支持用例自動(遞歸)發現:
默認發現當前目錄下所有符合 test*.py 測試用例
使用 python -m unittest 或 python -m unittest discover
通過 -s 參數指定要自動發現的目錄, -p 參數指定用例文件的名稱模式
python -m unittest discover -s project_directory -p "test_*.py"
通過位置參數指定自動發現的目錄和用例文件的名稱模式
python -m unittest discover project_directory "test_*.py"
unittest 支持執行指定用例:
指定測試模塊
python -m unittest test_module1 test_module2
指定測試類
python -m unittest test_module.TestClass
指定測試方法
python -m unittest test_module.TestClass.test_method
指定測試文件路徑(僅 Python 3)
python -m unittest tests/test_something.py
四、測試夾具(Fixtures)
測試夾具也就是測試前置(setUp)和清理(tearDown)方法。測試前置方法 setUp() 用來做一些準備工作,比如建立數據庫連接。它會在用例執行前被測試框架自動調用。
測試清理方法 tearDown() 用來做一些清理工作,比如斷開數據庫連接。它會在用例執行完成(包括失敗的情況)后被測試框架自動調用。測試前置和清理方法可以有不同的執行級別。
4.1 生效級別:測試方法
如果我們希望每個測試方法之前前后分別執行測試前置和清理方法,那么需要在測試類中定義好 setUp() 和 tearDown():
4.2 生效級別:測試類
如果我們希望單個測試類中只執行一次前置方法,再執行該測試類中的所有測試,最后執行一次清理方法,那么需要在測試類中定義好 setUpClass() 和 tearDownClass():
4.3 生效級別:測試模塊
如果我們希望單個測試模塊中只執行一次前置方法,再執行該模塊中所有測試類的所有測試,最后執行一次清理方法,那么需要在測試模塊中定義好 setUpModule() 和 tearDownModule():
五、跳過測試和預計失敗
unittest 支持直接跳過或按條件跳過測試,也支持預計測試失敗:
通過 skip 裝飾器或 SkipTest 直接跳過測試
通過 skipIf 或 skipUnless 按條件跳過或不跳過測試
通過 expectedFailure 預計測試失敗
六、子測試
有時候,你可能想編寫這樣的測試:在一個測試方法中傳入不同的參數來測試同一段邏輯,但它將被視作一個測試,但是如果使用了子測試,就能被視作 N(即為參數的個數)個測試。下面是一個示例:
示例中使用了 with self.subTest(i=i) 的方式定義子測試,這種情況下,即使單個子測試執行失敗,也不會影響后續子測試的執行。這樣,我們就能看到輸出中有三個子測試不通過:
七、測試結果輸出
基于簡單示例小節中提到的例子,來說明下 unittest 在運行完測試后的結果輸出。
默認情況下的輸出非常簡單,展示運行了多少個用例,以及所花費的時間:
通過指定 -v 參數,可以得到詳細輸出,除了默認輸出的內容,還額外顯示了用例名稱:
假定 test_upper 測試失敗,則在詳細輸出模式下,結果如下:
如果我們將 test_upper 測試方法中的 self.assertEqual 改為 assert,則測試結果輸出中將會少了對排查錯誤很有幫助的上下文信息:
如果想要生成 HTML 格式的報告,那么就需要額外借助第三方庫(如 HtmlTestRunner)來操作。
在安裝好第三方庫后,你不能直接使用 python -m unittest 加上類似 --html report.html 的方式來生成 HTML 報告,而是需要自行編寫少量代碼來運行測試用例進而得到 HTML 報告。
詳情請查看 HtmlTestRunner 使用說明。
八、小結
unittest 作為 Python 標準庫提供的單元測試框架,使用簡單、功能強大,日常測試需求均能得到很好的滿足。在不引入第三方庫的情況下,是單元測試的不二之選。
最后感謝每一個認真閱讀我文章的人,禮尚往來總是要有的,雖然不是什么很值錢的東西,如果你用得到的話可以直接拿走:
?
這些資料,對于【軟件測試】的朋友來說應該是最全面最完整的備戰倉庫,這個倉庫也陪伴上萬個測試工程師們走過最艱難的路程,希望也能幫助到你!