1. 基本知識

unittest 是 Python 標準庫中的一個單元測試框架，用于編寫和執行測試用例以驗證代碼的正確性

提供了一種結構化的方法來編寫測試，使得測試代碼更加模塊化和易于維護

以下是對 unittest 的詳細分析和示例：

概念：

• 測試用例（Test Case）：測試代碼的最小單元，通常對應于要測試的函數、方法或類的特定行為或功能
  測試用例是獨立的，不依賴于其他測試用例的執行順序

• 測試套件（Test Suite）：一組相關的測試用例的集合
  可以使用測試套件來組織和運行一系列相關的測試

• 測試運行器（Test Runner）：用于執行測試用例或測試套件的組件
  unittest 提供了一個默認的測試運行器來運行測試

• 斷言（Assertion）：在測試用例中用于判斷實際結果與預期結果是否相符的表達式
  如果斷言失敗，測試用例將會失敗

• 設置（Setup）和清理（Teardown）：在執行測試用例之前或之后執行的代碼
  使用 setUp() 方法在每個測試用例執行前進行設置操作
  使用 tearDown() 方法在每個測試用例執行后進行清理操作

作用：

• 自動化測試：通過編寫測試用例，可以自動化地驗證代碼的正確性，提高代碼的質量和穩定性
• 回歸測試：在修改或更新代碼后，可以運行測試用例來確保修改不會破壞現有功能
• 文檔化：測試用例也可以作為代碼的文檔，說明每個函數或方法應該如何被正確使用

2. API

在編寫單元測試時，通常會遵循一些規范和最佳實踐，以確保測試的可讀性、可維護性和準確性

以下是一些常見的單元測試規范要求：

1. 測試用例命名規范：測試用例的命名應該清晰明了，描述被測試函數或方法的行為
   通常采用test_<functionality>的命名方式，例如test_add_positive_numbers和test_add_negative_numbers

2. 測試用例設計完整性：每個測試用例應該獨立、完整地測試一個特定的行為或情況
   不要在一個測試用例中測試多個不相關的行為

3. 測試用例覆蓋率：盡可能覆蓋被測試代碼的各種情況，包括邊界情況、異常情況等

4. 斷言選擇：選擇適當的斷言來驗證測試結果
   常見的斷言包括assertEqual、assertTrue、assertFalse等

5. 測試組織結構：通常測試用例會被組織成一個測試類，每個測試方法對應一個測試用例
   在Python中，通常使用unittest模塊來實現單元測試，可以通過繼承unittest.TestCase來創建測試類

2.1 斷言

以下是幾個常見的斷言及其使用方式：

• assertEqual(expected, actual)：用于驗證預期值和實際值是否相等

import unittestclass TestExample(unittest.TestCase):def test_addition(self):result = 2 + 2self.assertEqual(result, 4)if __name__ == '__main__':unittest.main()

• assertTrue(condition)：用于驗證條件是否為True

import unittestclass TestExample(unittest.TestCase):def test_positive_number(self):result = 10self.assertTrue(result > 0)if __name__ == '__main__':unittest.main()

• assertFalse(condition)：用于驗證條件是否為False

import unittestclass TestExample(unittest.TestCase):def test_negative_number(self):result = -10self.assertFalse(result > 0)if __name__ == '__main__':unittest.main()

• assertRaises(exception, callable, *args, **kwargs)：用于驗證是否會引發特定的異常

import unittestdef divide(x, y):return x / yclass TestExample(unittest.TestCase):def test_divide_by_zero(self):with self.assertRaises(ZeroDivisionError):divide(1, 0)if __name__ == '__main__':unittest.main()

這些斷言方法之間的區別在于它們用于驗證的條件以及驗證的方式

• assertEqual用于檢查值是否相等
• assertTrue和assertFalse用于檢查條件是否為True或False
• assertRaises用于驗證是否引發了特定的異常

在編寫單元測試時，根據需要選擇最適合場景的斷言方法，以確保測試的準確性和可讀性

2.2 setUp() 和 tearDown()

setUp() 和 tearDown() 是unittest框架中的兩個特殊方法，用于在測試用例執行前后進行設置和清理操作

它們的作用是確保測試用例在獨立的環境中執行，從而保證測試的可靠性和可重復性

• setUp()
  ~ 在每個測試用例執行前進行設置操作，例如初始化對象、創建臨時文件或者建立數據庫連接等
  ~ 這個方法可以在測試用例的每次執行前，提供一個統一的環境，以確保測試用例在相同的初始條件下執行。如果測試用例需要共享一些設置，setUp() 是一個很好的地方來定義它們，這樣可以避免在每個測試用例中重復代碼
• tearDown()
  ~ 在每個測試用例執行后進行清理操作，例如關閉文件、釋放資源或者關閉數據庫連接等
  ~ 可以確保在測試用例執行后，環境得到適當的清理，以避免測試用例之間的相互影響。如果在 setUp() 中進行了一些設置，需要在 tearDown() 中進行相應的清理，以確保環境的恢復

示例代碼：

import unittestclass MyTestCase(unittest.TestCase):def setUp(self):# 設置操作，例如初始化對象self.my_list = [1, 2, 3]def tearDown(self):# 清理操作，例如釋放資源del self.my_listdef test_list_append(self):self.my_list.append(4)self.assertEqual(self.my_list, [1, 2, 3, 4])def test_list_remove(self):self.my_list.remove(2)self.assertEqual(self.my_list, [1, 3])if __name__ == '__main__':unittest.main()

• setUp() 方法用于在每個測試用例執行前初始化了一個列表 self.my_list
• tearDown() 方法用于在每個測試用例執行后清理了這個列表

兩個測試方法 test_list_append() 和 test_list_remove() 分別對這個列表執行了添加和刪除操作，并通過斷言來驗證操作的正確性
setUp() 和 tearDown() 方法確保了每個測試方法在獨立的環境中執行，不會相互影響。

3. Demo

通過簡易的Demo熟悉這個庫的基本用法

import unittestdef add(x, y):return x + yclass TestAddFunction(unittest.TestCase):def test_add_positive_numbers(self):self.assertEqual(add(1, 2), 3)self.assertEqual(add(0, 0), 0)self.assertEqual(add(-1, 1), 0)def test_add_negative_numbers(self):self.assertEqual(add(-1, -1), -2)self.assertEqual(add(-5, -7), -12)if __name__ == '__main__':unittest.main()

截圖如下：

對應如果修改某個參數，讓程序報錯，截圖如下：