如果你聽說過“測試驅(qū)動開發(fā)”(TDD:Test-Driven Development)娃弓,單元測試就不陌生河绽。
單元測試是用來對一個模塊话速、一個函數(shù)或者一個類來進(jìn)行正確性檢驗(yàn)的測試工作。
比如對函數(shù)abs()庄新,我們可以編寫出以下幾個測試用例:
輸入正數(shù)赊窥,比如1逝钥、1.2隘弊、0.99,期待返回值與輸入相同送悔;
輸入負(fù)數(shù)慢显,比如-1、-1.2欠啤、-0.99荚藻,期待返回值與輸入相反;
輸入0跪妥,期待返回0鞋喇;
輸入非數(shù)值類型,比如None眉撵、[]侦香、{},期待拋出TypeError纽疟。
把上面的測試用例放到一個測試模塊里罐韩,就是一個完整的單元測試。
如果單元測試通過污朽,說明我們測試的這個函數(shù)能夠正常工作散吵。如果單元測試不通過,要么函數(shù)有bug蟆肆,要么測試條件輸入不正確矾睦,總之,需要修復(fù)使單元測試能夠通過炎功。
單元測試通過后有什么意義呢枚冗?如果我們對abs()函數(shù)代碼做了修改,只需要再跑一遍單元測試蛇损,如果通過赁温,說明我們的修改不會對abs()函數(shù)原有的行為造成影響坛怪,如果測試不通過,說明我們的修改與原有行為不一致股囊,要么修改代碼袜匿,要么修改測試。
這種以測試為驅(qū)動的開發(fā)模式最大的好處就是確保一個程序模塊的行為符合我們設(shè)計的測試用例稚疹。在將來修改的時候居灯,可以極大程度地保證該模塊行為仍然是正確的。
我們來編寫一個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開頭的方法不被認(rèn)為是測試方法蛤袒,測試的時候不會被執(zhí)行。
對每一類測試都需要編寫一個test_xxx()方法膨更。由于unittest.TestCase提供了很多內(nèi)置的條件判斷妙真,我們只需要調(diào)用這些方法就可以斷言輸出是否是我們所期望的。最常用的斷言就是assertEqual():
self.assertEqual(abs(-1), 1) # 斷言函數(shù)返回的結(jié)果與1相等
另一種重要的斷言就是期待拋出指定類型的Error荚守,比如通過d['empty']訪問不存在的key時珍德,斷言會拋出KeyError:
with self.assertRaises(KeyError):
value = d['empty']
而通過d.empty訪問不存在的key時,我們期待拋出AttributeError:
with self.assertRaises(AttributeError):
value = d.empty
運(yùn)行單元測試
一旦編寫好單元測試矗漾,我們就可以運(yùn)行單元測試锈候。最簡單的運(yùn)行方式是在mydict_test.py的最后加上兩行代碼:
if name == 'main':
unittest.main()
這樣就可以把mydict_test.py當(dāng)做正常的python腳本運(yùn)行:
$ python3 mydict_test.py
另一種方法是在命令行通過參數(shù)-m unittest直接運(yùn)行單元測試:
$ python3 -m unittest mydict_test
.....
Ran 5 tests in 0.000s
OK
這是推薦的做法,因?yàn)檫@樣可以一次批量運(yùn)行很多單元測試敞贡,并且泵琳,有很多工具可以自動來運(yùn)行這些單元測試。
setUp與tearDown
可以在單元測試中編寫兩個特殊的setUp()和tearDown()方法誊役。這兩個方法會分別在每調(diào)用一個測試方法的前后分別被執(zhí)行获列。
setUp()和tearDown()方法有什么用呢?設(shè)想你的測試需要啟動一個數(shù)據(jù)庫蛔垢,這時击孩,就可以在setUp()方法中連接數(shù)據(jù)庫,在tearDown()方法中關(guān)閉數(shù)據(jù)庫啦桌,這樣溯壶,不必在每個測試方法中重復(fù)相同的代碼:
class TestDict(unittest.TestCase):
def setUp(self):
print('setUp...')
def tearDown(self):
print('tearDown...')
可以再次運(yùn)行測試看看每個測試方法調(diào)用前后是否會打印出setUp...和tearDown...及皂。
小結(jié)
單元測試可以有效地測試某個程序模塊的行為,是未來重構(gòu)代碼的信心保證且改。
單元測試的測試用例要覆蓋常用的輸入組合验烧、邊界條件和異常。
單元測試代碼要非常簡單又跛,如果測試代碼太復(fù)雜碍拆,那么測試代碼本身就可能有bug。
單元測試通過了并不意味著程序就沒有bug了慨蓝,但是不通過程序肯定有bug感混。