6.1 認識unittest · Python / Linux / Mysql / 軟件測試等等

[TOC] ## **6.1 認識 unittest** 在 Python 中有諸多單元測試框架，如 doctest、unittest、pytest、nose 等，Python 2.1 及其以后的版本已經將 unittest 作為一個標準模塊放入 Python 開發包中。 ### **6.1.1 認識單元測試** 不用單元測試框架能寫單元測試嗎？答案是肯定的。單元測試本質上就是通過一段代碼去驗證另外一段代碼，所以不用單元測試框架也可以寫單元測試。下面就通過例子演示。創建一個被測試文件 calculator.py。 ``` # 計算器類 class Calculator: ''' 用于完成兩個數的加、減、乘、除 ''' def __init__(self, a, b): self.a = int(a) self.b = int(b) # 加法 def add(self): return self.a + self.b # 減法 def sub(self): return self.a - self.b # 乘法 def mul(self): return self.a * self.b # 除法 def div(self): return self.a / self.b ``` 程序非常簡單，創建一個 Calculator 類，通過__init__()方法接收兩個參數，并做 int 類型轉換。創建 add()、sub()、mul()、div()方法分別進行加、減、乘、除運算。根據上面實現的功能，創建 test_calculator.py 文件。 ``` from calculator import Calculator def test_add(): c = Calculator(3, 5) result = c.add() assert result == 8, '加法運算失敗！' def test_sub(): c = Calculator(7, 2) result = c.sub() assert result == 5, "減法運算失敗!" def test_mul(): c = Calculator(3, 3) result = c.mul() assert result == 10, "乘法運算失敗！" def test_div(): c = Calculator(6, 2) result = c.div() assert result == 3, "除法運算失敗！" if __name__ == '__main__': test_add() test_sub() test_mul() test_div() ``` 運行結果如下： ``` ============================= test session starts ============================= collecting ... collected 4 items test_calculator.py::test_add PASSED [ 25%] test_calculator.py::test_sub PASSED [ 50%] test_calculator.py::test_mul FAILED [ 75%] AssertionError: 乘法運算失敗！ 9 != 10 預期:10 實際:9 def test_mul(): c = Calculator(3, 3) result = c.mul() > assert result == 10, "乘法運算失敗！" E AssertionError: 乘法運算失敗！ E assert 9 == 10 test_calculator.py:16: AssertionError test_calculator.py::test_div PASSED [100%] ========================= 1 failed, 3 passed in 0.03s ========================= ``` 在測試代碼中，首先引入 calculator 文件中的 Calculator 類，并對測試數據進行初始化。接下來調用該類下面的方法，得到計算結果，并斷言結果是否正確。下面通過 unittest 單元測試框架重新編寫測試用例。 ``` import unittest from calculator import Calculator class TestCalculator(unittest.TestCase): def test_add(self): c = Calculator(3, 5) result = c.add() self.assertEqual(result, 8) def test_sub(self): c = Calculator(7, 2) result = c.sub() self.assertEqual(result, 5) def test_mul(self): c = Calculator(3, 3) result = c.mul() self.assertEqual(result, 10) def test_div(self): c = Calculator(6, 2) result = c.div() self.assertEqual(result, 3) if __name__ == '__main__': unittest.main() ``` 運行結果如下： ``` ============================= test session starts ============================= collecting ... collected 4 items calculator2.py::TestCalculator::test_add PASSED [ 25%] calculator2.py::TestCalculator::test_div PASSED [ 50%] calculator2.py::TestCalculator::test_mul FAILED [ 75%] calculator2.py:15 (TestCalculator.test_mul) 10 != 9 預期:9 實際:10 calculator2.py::TestCalculator::test_sub PASSED [100%] ========================= 1 failed, 3 passed in 0.06s ========================= ``` 引入 unittest 模塊。如果想用 unittest 編寫測試用例，那么一定要遵守它的“規則”。（1）創建一個測試類，這里為 TestCalculator 類，必須要繼承 unittest 模塊的 TestCase類。（2）創建一個測試方法，該方法必須以“test”開頭。接下來的測試步驟與前面測試代碼相同。首先，調用被測試類，傳入初始化數據。其次，調用被測試方法，得到計算結果。通過 unittest 提供的 assertEqual()方法來斷言結果是否與預期結果相同。該方法由 TestCase 父類提供，由于繼承了該類，所以可以通過self 調用。最后，調用 unittest 的 main()來執行測試用例，它會按照前面的兩條規則查找測試用例并執行。 ### **6.1.2 重要的概念** 在 unittest 文檔中有四個重要的概念：Test Case、Test Suite、Test Runner 和 Test Fixture。只有理解了這幾個概念，才能理解單元測試的基本特征。 **1．Test Case** Test Case 是最小的測試單元，用于檢查特定輸入集合的特定返回值。unittest 提供了TestCase 基類，我們創建的測試類需要繼承該基類，它可以用來創建新的測試用例。 **2．Test Suite** 測試套件是測試用例、測試套件或兩者的集合，用于組裝一組要運行的測試。unittest提供了 TestSuite 類來創建測試套件。 **3．Test Runner** Test Runner 是一個組件，用于協調測試的執行并向用戶提供結果。Test Runner 可以使用圖形界面、文本界面或返回特殊值來展示執行測試的結果。unittest 提供了 TextTestRunner類運行測試用例，為了生成 HTML 格式的測試報告，后面會選擇使用 HTMLTestRunner 運行類。 **4．Test Fixture** Test Fixture 代表執行一個或多個測試所需的環境準備，以及關聯的清理動作。例如，創建臨時或代理數據庫、目錄，或啟動服務器進程。unittest 中提供了 setUp()/tearDown()、setUpClass()/tearDownClass()等方法來完成這些操作。 在理解了上面幾個概念之后，我們對前面的測試用例做如下修改。 ``` import unittest from calculator import Calculator class TestCalculator(unittest.TestCase): # 測試用例前置動作 def setUp(self): print("test start:") # 測試用例后置動作 def tearDownClass(self): print("test end") def test_add(self): c = Calculator(3, 5) result = c.add() self.assertEqual(result, 8) def test_sub(self): c = Calculator(7, 2) result = c.sub() self.assertEqual(result, 5) def test_mul(self): c = Calculator(3, 3) result = c.mul() self.assertEqual(result, 10) def test_div(self): c = Calculator(6, 2) result = c.div() self.assertEqual(result, 3) if __name__ == '__main__': # 創建測試套件 suit = unittest.TestSuite() suit.addTest(TestCalculator("test_add")) suit.addTest(TestCalculator("test_sub")) suit.addTest(TestCalculator("test_mul")) suit.addTest(TestCalculator("test_div")) # 創建測試運行器 runner = unittest.TextTestRunner() runner.run(suit) ``` 首先，創建一個測試類并繼承 TestCase 類，在該類下面創建一條以“test”開頭的方法為測試用例。這個前面已有說明，這里再次說明是為了強調它的重要性。 其次，在測試類中增加了 setUp()/tearDown()方法，用于定義測試用例的前置和后置動作。因為在當前測試中暫時用不上，所以這里定義了一些簡單的打印。 接下來，是測試用例的執行，這里做了很大的改動。首先，拋棄了 unittest 提供的 main()方法，而是調用 TestSuite 類下面的 addTest()來添加測試用例。因為一次只能添加一條用例，所以需要指定測試類及測試方法。然后，再調用 TextTestRunner 類下面的 run()運行測試套件。 這樣做確實比直接使用 main()方法要麻煩得多，但也并非沒有優點。 首先，測試用例的執行順序可以由測試套件的添加順序控制，而 main()方法只能按照測試類、方法的名稱來執行測試用例。例如，TestA 類比 TestB 類先執行，test_add()用例比test_div()用例先執行。 其次，當一個測試文件中有很多測試用例時，并不是每次都要執行所有的測試用例，尤其是比較耗時的 UI 自動化測試。因而通過測試套件和測試運行器可以靈活地控制要執行的測試用例。執行結果如下。 ``` ============================= test session starts ============================= collecting ... collected 4 items calculator3.py::TestCalculator::test_add PASSED [ 25%]test start: calculator3.py::TestCalculator::test_div PASSED [ 50%]test start: calculator3.py::TestCalculator::test_mul FAILED [ 75%]test start: calculator3.py:23 (TestCalculator.test_mul) 10 != 9 預期:9 實際:10 calculator3.py::TestCalculator::test_sub PASSED [100%]test start: calculator3.py::TestCalculator::test_sub ERROR [100%] ==================== 1 failed, 3 passed, 1 error in 0.18s ===================== ``` 從執行結果可以看到，setUp/tearDown 作用于每條測試用例的開始之處與結束之處。 ### **6.1.3 斷言方法** 在執行測試用例的過程中，最終測試用例執行成功與否，是通過測試得到的實際結果與預期結果進行比較得到的。unittest 框架的 TestCase 類提供的用于測試結果的斷言方法如表 6-1 所示。 :-: 表 6-1 TestCase 類提供的用于測試結果的斷言方法 | 方法 | 檢查 | 版本 | | --- | --- |--- | | assertEqual(a, b) | a == b | | | assertNotEqual(a, b) | a != b | | | assertTrue(x) | bool(x) is True | | | assertFalse(x) | bool(x) is False | | | assertIs(a, b) | a is b | 3.1 | | assertIsNot(a, b) | a is not b | 3.1 | | assertIsNone(x) | x is None | 3.1 | | assertIsNotNone(x) | x is not None | 3.1 | | assertIn(a, b) | a in b | 3.1 | | assertNotIn(a, b) | a not in b | 3.1 | | assertIsInstance(a, b) | isinstance(a, b) | 3.2 | | assertNotIsInstance(a, b) | not isinstance(a, b) | 3.2 | 斷言方法的使用如下所示。 ``` import unittest class TestAssert(unittest.TestCase): def test_equal(self): self.assertEqual(2+2, 4) self.assertEqual("python", "python") self.assertNotEqual("hello", "python") def test_in(self): self.assertIn("hello", "hello_world") self.assertNotIn("hi", "hello") def test_true(self): self.assertTrue(True) self.assertFalse(False) if __name__ == "__main__": unittest.main() ``` 運行上面的測試用例，即可通過測試結果推斷出這些斷言方法是如何使用的。