classTestStringMethods(unittest.TestCase):
deftest_upper(self):self.assertEqual('foo'.upper, 'FOO')
deftest_isupper(self):self.assertTrue('FOO'.isupper)self.assertFalse('Foo'.isupper)
deftest_split(self):s = 'hello world'self.assertEqual(s.split, ['hello', 'world'])# check that s.split fails when the separator is not a stringwithself.assertRaises(TypeError):s.split(2)
if__name__ == '__main__':unittest.main
上述示例中,通過繼承 unittest.TestCase[4] 來建立一個測試用例。在這個類中,定義以 test 開頭的方法,測試架構将把它作為獨立的測試去執行。
每個用例都采用 unittest 内置的斷言方法來判斷被測對象的行為是否符合預期,比如:
在 test_upper 測試中,使用 assertEqual[5] 檢查是否是預期值
在 test_isupper 測試中,使用 assertTrue[6] 或 assertFalse[7] 驗證是否符合條件
在 test_split 測試中,使用 assertRaises[8] 驗證是否抛出一個特定異常
可能有人會好奇,為什麼不使用内置斷言語句 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[9] 用來做一些準備工作,比如建立資料庫連接配接。它會在用例執行前被測試架構自動調用。
測試清理方法 tearDown[10] 用來做一些清理工作,比如斷開資料庫連接配接。它會在用例執行完成(包括失敗的情況)後被測試架構自動調用。
測試前置和清理方法可以有不同的執行級别。
4.1 生效級别:測試方法
如果我們希望每個測試方法之前前後分别執行測試前置和清理方法,那麼需要在測試類中定義好 setUp[11] 和 tearDown[12]:
classMyTestCase(unittest.TestCase):defsetUp(self):passdeftearDown(self):pass
4.2 生效級别:測試類
如果我們希望單個測試類中隻執行一次前置方法,再執行該測試類中的所有測試,最後執行一次清理方法,那麼需要在測試類中定義好 setUpClass[13] 和 tearDownClass[14]:
classMyTestCase(unittest.TestCase):defsetUpClass(self):passdeftearDownClass(self):pass
4.3 生效級别:測試子產品
如果我們希望單個測試子產品中隻執行一次前置方法,再執行該子產品中所有測試類的所有測試,最後執行一次清理方法,那麼需要在測試子產品中定義好 setUpModule[15] 和 tearDownModule[16]:
defsetUpModule:passdeftearDownModule:pass
五、跳過測試和預計失敗
unittest 支援直接跳過或按條件跳過測試,也支援預計測試失敗:
通過 skip[17] 裝飾器或 SkipTest[18] 直接跳過測試
通過 skipIf[19] 或 skipUnless[20] 按條件跳過或不跳過測試
通過 expectedFailure[21] 預計測試失敗
classMyTestCase(unittest.TestCase):@unittest.skip("直接跳過")deftest_nothing(self):self.fail("shouldn't happen")
@unittest.skipIf(mylib.__version__ < (1, 3),"滿足條件跳過")deftest_format(self):# Tests that work for only a certain version of the library.pass
@unittest.skipUnless(sys.platform.startswith("win"), "滿足條件不跳過")deftest_windows_support(self):# windows specific testing codepass
deftest_maybe_skipped(self):ifnotexternal_resource_available:self.skipTest("跳過")# test code that depends on the external resourcepass
@unittest.expectedFailuredeftest_fail(self):self.assertEqual(1, 0, "這個目前是失敗的")
六、子測試
有時候,你可能想編寫這樣的測試:在一個測試方法中傳入不同的參數來測試同一段邏輯,但它将被視作一個測試,但是如果使用了子測試[22],就能被視作 N(即為參數的個數)個測試。下面是一個示例:
classNumbersTest(unittest.TestCase):deftest_even(self):"""Test that numbers between 0 and 5 are all even."""fori inrange(0, 6):withself.subTest(i=i):self.assertEqual(i % 2, 0)
示例中使用了 with self.subTest(i=i) 的方式定義子測試,這種情況下,即使單個子測試執行失敗,也不會影響後續子測試的執行。這樣,我們就能看到輸出中有三個子測試不通過:
======================================================================FAIL: test_even (__main__.NumbersTest) (i=1)----------------------------------------------------------------------Traceback (most recent call last):File "subtests.py", line 32, intest_evenself.assertEqual(i % 2, 0)Asserti: 1 != 0======================================================================FAIL: test_even (__main__.NumbersTest) (i=3)----------------------------------------------------------------------Traceback (most recent call last):File "subtests.py", line 32, intest_evenself.assertEqual(i % 2, 0)Asserti: 1 != 0
======================================================================FAIL: test_even (__main__.NumbersTest) (i=5)----------------------------------------------------------------------Traceback (most recent call last):File "subtests.py", line 32, intest_evenself.assertEqual(i % 2, 0)Asserti: 1 != 0
七、測試結果輸出
基于簡單示例小節中提到的例子,來說明下 unittest 在運作完測試後的結果輸出。
預設情況下的輸出非常簡單,展示運作了多少個用例,以及所花費的時間:
...----------------------------------------------------------------------Ran 3 tests in0.000sOK
通過指定 -v 參數,可以得到詳細輸出,除了預設輸出的内容,還額外顯示了用例名稱:
test_isupper (__main__.TestStringMethods) ... oktest_split (__main__.TestStringMethods) ... oktest_upper (__main__.TestStringMethods) ... ok----------------------------------------------------------------------Ran 3 tests in0.001s
OK
假定 test_upper 測試失敗,則在詳細輸出模式下,結果如下:
test_isupper (tests.test.TestStringMethods) ... oktest_split (tests.test.TestStringMethods) ... oktest_upper (tests.test.TestStringMethods) ... FAIL======================================================================FAIL: test_upper (tests.test.TestStringMethods)----------------------------------------------------------------------Traceback (most recent call last):File "/Uvsers/prodesire/projects/tests/test.py", line 6, intest_upperself.assertEqual('foo'.upper, 'FOO1')Asserti: 'FOO'!= 'FOO1'- FOO+ FOO1? +
----------------------------------------------------------------------Ran 3 tests in0.001s
FAILED (failures=1)
如果我們将 test_upper 測試方法中的 self.assertEqual 改為 assert,則測試結果輸出中将會少了對排查錯誤很有幫助的上下文資訊:
test_isupper (tests.test.TestStringMethods) ... oktest_split (tests.test.TestStringMethods) ... oktest_upper (tests.test.TestStringMethods) ... FAIL======================================================================FAIL: test_upper (tests.test.TestStringMethods)----------------------------------------------------------------------Traceback (most recent call last):File "/Users/prodesire/projects/tests/test.py", line 6, intest_upperassert 'foo'.upper == 'FOO1'Asserti
----------------------------------------------------------------------Ran 3 tests in0.001s
FAILED (failures=1)
如果想要生成 HTML 格式的報告,那麼就需要額外借助第三方庫(如 HtmlTestRunner[23])來操作。
在安裝好第三方庫後,你不能直接使用 python -m unittest 加上類似 --html report.html 的方式來生成 HTML 報告,而是需要自行編寫少量代碼來運作測試用例進而得到 HTML 報告。詳情請檢視 HtmlTestRunner 使用說明[24]。
八、小結
unittest[25] 作為 Python 标準庫提供的單元測試架構,使用簡單、功能強大,日常測試需求均能得到很好的滿足。在不引入第三方庫的情況下,是單元測試的不二之選。
在下篇文章中,我們将介紹第三方單元測試架構 nose 和 nose2,講講它對比于 unittest 有哪些改進,以至于讓很多開發人員優先選擇了它。
References [1] unittest:https://docs.python.org/3/library/unittest.html
[2] unittest:https://docs.python.org/3/library/unittest.html
[3] 官方文檔:https://docs.python.org/3/library/unittest.html#basic-example [4] unittest.TestCase:https://docs.python.org/3/library/unittest.html#unittest.TestCase
[5] assertEqual:https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertEqual
[6] assertTrue:https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertTrue [7] assertFalse:https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertFalse
[8] assertRaises:https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertRaises
[9] setUp:https://docs.python.org/3/library/unittest.html#unittest.TestCase.setUp [10] tearDown:https://docs.python.org/3/library/unittest.html#unittest.TestCase.tearDown
[11] setUp:https://docs.python.org/3/library/unittest.html#unittest.TestCase.setUp [12] tearDown:https://docs.python.org/3/library/unittest.html#unittest.TestCase.tearDown
[13] setUpClass:https://docs.python.org/3/library/unittest.html#unittest.TestCase.setUpClass
[14] tearDownClass:https://docs.python.org/3/library/unittest.html#unittest.TestCase.tearDownClass [15] setUpModule:https://docs.python.org/3/library/unittest.html#setupmodule-and-teardownmodule
[16] tearDownModule:https://docs.python.org/3/library/unittest.html#setupmodule-and-teardownmodule [17] skip:https://docs.python.org/3/library/unittest.html#unittest.skip
[18] SkipTest:https://docs.python.org/3/library/unittest.html#unittest.SkipTest [19] skipIf:https://docs.python.org/3/library/unittest.html#unittest.skipIf
[20] skipUnless:https://docs.python.org/3/library/unittest.html#unittest.skipUnless [21] SkipTest:https://docs.python.org/3/library/unittest.html#unittest.SkipTest [22] skipIf:https://docs.python.org/3/library/unittest.html#unittest.skipIf
[23] HtmlTestRunner:https://github.com/oldani/HtmlTestRunner [24] HtmlTestRunner 使用說明:https://github.com/oldani/HtmlTestRunner#usage [25] unittest:https://docs.python.org/3/library/unittest.html 傳回搜狐,檢視更多