11.3 單元測(cè)試
如果你聽(tīng)說(shuō)過(guò)“測(cè)試驅(qū)動(dòng)開(kāi)發(fā)”(TDD:Test-Driven Development),單元測(cè)試就不陌生。
單元測(cè)試是用來(lái)對(duì)一個(gè)模塊、一個(gè)函數(shù)或者一個(gè)類來(lái)進(jìn)行正確性檢驗(yàn)的測(cè)試工作。
比如對(duì)函數(shù)abs()
,我們可以編寫出以下幾個(gè)測(cè)試用例:
輸入正數(shù),比如
1
、1.2
、0.99
,期待返回值與輸入相同;輸入負(fù)數(shù),比如
-1
、-1.2
、-0.99
,期待返回值與輸入相反;輸入
0
,期待返回0
;輸入非數(shù)值類型,比如
None
、[]
、{}
,期待拋出TypeError
。
把上面的測(cè)試用例放到一個(gè)測(cè)試模塊里,就是一個(gè)完整的單元測(cè)試。
如果單元測(cè)試通過(guò),說(shuō)明我們測(cè)試的這個(gè)函數(shù)能夠正常工作。如果單元測(cè)試不通過(guò),要么函數(shù)有bug,要么測(cè)試條件輸入不正確,總之,需要修復(fù)使單元測(cè)試能夠通過(guò)。
單元測(cè)試通過(guò)后有什么意義呢?如果我們對(duì)abs()
函數(shù)代碼做了修改,只需要再跑一遍單元測(cè)試,如果通過(guò),說(shuō)明我們的修改不會(huì)對(duì)abs()
函數(shù)原有的行為造成影響,如果測(cè)試不通過(guò),說(shuō)明我們的修改與原有行為不一致,要么修改代碼,要么修改測(cè)試。
這種以測(cè)試為驅(qū)動(dòng)的開(kāi)發(fā)模式最大的好處就是確保一個(gè)程序模塊的行為符合我們?cè)O(shè)計(jì)的測(cè)試用例。在將來(lái)修改的時(shí)候,可以極大程度地保證該模塊行為仍然是正確的。
我們來(lái)編寫一個(gè)Dict
類,這個(gè)類的行為和dict
一致,但是可以通過(guò)屬性來(lái)訪問(wèn),用起來(lái)就像下面這樣:
mydict.py
代碼如下:
為了編寫單元測(cè)試,我們需要引入Python自帶的unittest
模塊,編寫mydict_test.py
如下:
編寫單元測(cè)試時(shí),我們需要編寫一個(gè)測(cè)試類,從unittest.TestCase
繼承。
以test
開(kāi)頭的方法就是測(cè)試方法,不以test
開(kāi)頭的方法不被認(rèn)為是測(cè)試方法,測(cè)試的時(shí)候不會(huì)被執(zhí)行。
對(duì)每一類測(cè)試都需要編寫一個(gè)test_xxx()
方法。由于unittest.TestCase
提供了很多內(nèi)置的條件判斷,我們只需要調(diào)用這些方法就可以斷言輸出是否是我們所期望的。最常用的斷言就是assertEqual()
:
另一種重要的斷言就是期待拋出指定類型的Error,比如通過(guò)d['empty']
訪問(wèn)不存在的key時(shí),斷言會(huì)拋出KeyError
:
而通過(guò)d.empty
訪問(wèn)不存在的key時(shí),我們期待拋出AttributeError
:
運(yùn)行單元測(cè)試
一旦編寫好單元測(cè)試,我們就可以運(yùn)行單元測(cè)試。最簡(jiǎn)單的運(yùn)行方式是在mydict_test.py
的最后加上兩行代碼:
這樣就可以把mydict_test.py
當(dāng)做正常的python腳本運(yùn)行:
另一種方法是在命令行通過(guò)參數(shù)-m unittest
直接運(yùn)行單元測(cè)試:
這是推薦的做法,因?yàn)檫@樣可以一次批量運(yùn)行很多單元測(cè)試,并且,有很多工具可以自動(dòng)來(lái)運(yùn)行這些單元測(cè)試。
setUp與tearDown
可以在單元測(cè)試中編寫兩個(gè)特殊的setUp()
和tearDown()
方法。這兩個(gè)方法會(huì)分別在每調(diào)用一個(gè)測(cè)試方法的前后分別被執(zhí)行。
setUp()
和tearDown()
方法有什么用呢?設(shè)想你的測(cè)試需要啟動(dòng)一個(gè)數(shù)據(jù)庫(kù),這時(shí),就可以在setUp()
方法中連接數(shù)據(jù)庫(kù),在tearDown()
方法中關(guān)閉數(shù)據(jù)庫(kù),這樣,不必在每個(gè)測(cè)試方法中重復(fù)相同的代碼:
可以再次運(yùn)行測(cè)試看看每個(gè)測(cè)試方法調(diào)用前后是否會(huì)打印出setUp...
和tearDown...
。
小結(jié)
單元測(cè)試可以有效地測(cè)試某個(gè)程序模塊的行為,是未來(lái)重構(gòu)代碼的信心保證。
單元測(cè)試的測(cè)試用例要覆蓋常用的輸入組合、邊界條件和異常。
單元測(cè)試代碼要非常簡(jiǎn)單,如果測(cè)試代碼太復(fù)雜,那么測(cè)試代碼本身就可能有bug。
單元測(cè)試通過(guò)了并不意味著程序就沒(méi)有bug了,但是不通過(guò)程序肯定有bug。