如果你聽說過“測試驅動開發”（TDD：Test-Driven Development），單元測試就不陌生。 單元測試是用來對一個模塊、一個函數或者一個類來進行正確性檢驗的測試工作。 比如對函數`abs()`，我們可以編寫出以下幾個測試用例： 1. 輸入正數，比如`1`、`1.2`、`0.99`，期待返回值與輸入相同； 2. 輸入負數，比如`-1`、`-1.2`、`-0.99`，期待返回值與輸入相反； 3. 輸入`0`，期待返回`0`； 4. 輸入非數值類型，比如`None`、`[]`、`{}`，期待拋出`TypeError`。 把上面的測試用例放到一個測試模塊里，就是一個完整的單元測試。 如果單元測試通過，說明我們測試的這個函數能夠正常工作。如果單元測試不通過，要么函數有bug，要么測試條件輸入不正確，總之，需要修復使單元測試能夠通過。 單元測試通過后有什么意義呢？如果我們對`abs()`函數代碼做了修改，只需要再跑一遍單元測試，如果通過，說明我們的修改不會對`abs()`函數原有的行為造成影響，如果測試不通過，說明我們的修改與原有行為不一致，要么修改代碼，要么修改測試。 這種以測試為驅動的開發模式最大的好處就是確保一個程序模塊的行為符合我們設計的測試用例。在將來修改的時候，可以極大程度地保證該模塊行為仍然是正確的。 我們來編寫一個`Dict`類，這個類的行為和`dict`一致，但是可以通過屬性來訪問，用起來就像下面這樣： ~~~ >>> d = Dict(a=1, b=2) >>> d['a'] 1 >>> d.a 1 ~~~ `mydict.py`代碼如下： ~~~ class Dict(dict): def __init__(self, **kw): super().__init__(**kw) def __getattr__(self, key): try: return self[key] except KeyError: raise AttributeError(r"'Dict' object has no attribute '%s'" % key) def __setattr__(self, key, value): self[key] = value ~~~ 為了編寫單元測試，我們需要引入Python自帶的`unittest`模塊，編寫`mydict_test.py`如下： ~~~ import unittest from mydict import Dict class TestDict(unittest.TestCase): def test_init(self): d = Dict(a=1, b='test') self.assertEqual(d.a, 1) self.assertEqual(d.b, 'test') self.assertTrue(isinstance(d, dict)) def test_key(self): d = Dict() d['key'] = 'value' self.assertEqual(d.key, 'value') def test_attr(self): d = Dict() d.key = 'value' self.assertTrue('key' in d) self.assertEqual(d['key'], 'value') def test_keyerror(self): d = Dict() with self.assertRaises(KeyError): value = d['empty'] def test_attrerror(self): d = Dict() with self.assertRaises(AttributeError): value = d.empty ~~~ 編寫單元測試時，我們需要編寫一個測試類，從`unittest.TestCase`繼承。 以`test`開頭的方法就是測試方法，不以`test`開頭的方法不被認為是測試方法，測試的時候不會被執行。 對每一類測試都需要編寫一個`test_xxx()`方法。由于`unittest.TestCase`提供了很多內置的條件判斷，我們只需要調用這些方法就可以斷言輸出是否是我們所期望的。最常用的斷言就是`assertEqual()`： ~~~ self.assertEqual(abs(-1), 1) # 斷言函數返回的結果與1相等 ~~~ 另一種重要的斷言就是期待拋出指定類型的Error，比如通過`d['empty']`訪問不存在的key時，斷言會拋出`KeyError`： ~~~ with self.assertRaises(KeyError): value = d['empty'] ~~~ 而通過`d.empty`訪問不存在的key時，我們期待拋出`AttributeError`： ~~~ with self.assertRaises(AttributeError): value = d.empty ~~~ ### 運行單元測試 一旦編寫好單元測試，我們就可以運行單元測試。最簡單的運行方式是在`mydict_test.py`的最后加上兩行代碼： ~~~ if __name__ == '__main__': unittest.main() ~~~ 這樣就可以把`mydict_test.py`當做正常的python腳本運行： ~~~ $ python3 mydict_test.py ~~~ 另一種方法是在命令行通過參數`-m unittest`直接運行單元測試： ~~~ $ python3 -m unittest mydict_test ..... ---------------------------------------------------------------------- Ran 5 tests in 0.000s OK ~~~ 這是推薦的做法，因為這樣可以一次批量運行很多單元測試，并且，有很多工具可以自動來運行這些單元測試。 ### setUp與tearDown 可以在單元測試中編寫兩個特殊的`setUp()`和`tearDown()`方法。這兩個方法會分別在每調用一個測試方法的前后分別被執行。 `setUp()`和`tearDown()`方法有什么用呢？設想你的測試需要啟動一個數據庫，這時，就可以在`setUp()`方法中連接數據庫，在`tearDown()`方法中關閉數據庫，這樣，不必在每個測試方法中重復相同的代碼： ~~~ class TestDict(unittest.TestCase): def setUp(self): print('setUp...') def tearDown(self): print('tearDown...') ~~~ 可以再次運行測試看看每個測試方法調用前后是否會打印出`setUp...`和`tearDown...`。 ### 小結 單元測試可以有效地測試某個程序模塊的行為，是未來重構代碼的信心保證。 單元測試的測試用例要覆蓋常用的輸入組合、邊界條件和異常。 單元測試代碼要非常簡單，如果測試代碼太復雜，那么測試代碼本身就可能有bug。 單元測試通過了并不意味著程序就沒有bug了，但是不通過程序肯定有bug。 ### 參考源碼 [mydict.py](https://github.com/michaelliao/learn-python3/blob/master/samples/debug/mydict.py) [mydict_test.py](https://github.com/michaelliao/learn-python3/blob/master/samples/debug/mydict_test.py)