前言
在測試金字塔中,單元測試處于金字塔底部,所占比例最大。它運(yùn)行速度快,發(fā)現(xiàn)問題和定位問題都比較快。而且一旦建立好覆蓋度足夠的單元測試之后,會極大增強(qiáng)發(fā)版信心。
步驟
不管是單元、接口還是UI,測試的步驟一般都分以下三步:
- 測試數(shù)據(jù)準(zhǔn)備:創(chuàng)建出需要用到符合一定條件的用戶或課程,造完后做一些處理,使他符合你需要測試的情景。
比如需要測試退款的函數(shù),那你首先得把用戶、課程和用戶購買課程的數(shù)據(jù)造出來。 - 調(diào)用需要被測的方法
- 斷言:拿到2步中返回的結(jié)果,對結(jié)果進(jìn)行測試結(jié)果的判斷
數(shù)據(jù)準(zhǔn)備
在Django項(xiàng)目中,推薦使用FactoryBoy,
它可以根據(jù)你Django中的models來創(chuàng)建數(shù)據(jù),示例代碼如下:
class UserFactory(factory.django.DjangoModelFactory):
class Meta:
model = 'myapp.User' # Equivalent to ``model = myapp.models.User``
username = 'john'
它根據(jù)你給他的model來創(chuàng)建數(shù)據(jù),model中沒有設(shè)置默認(rèn)值的字段需要在代碼中賦值。在你的測試代碼中調(diào)用UserFactory(),或者UserFactory.create()時都會在數(shù)據(jù)庫中創(chuàng)建一個名為john的用戶。當(dāng)然,你可能不希望每次創(chuàng)建的用戶都叫相同的名字。所以可以修改代碼為:
class UserFactory(factory.django.DjangoModelFactory):
class Meta:
model = 'myapp.User'
username = factory.Sequence(u'robot{0}'.format)
這樣每次調(diào)用UserFactory時,username都會遞增,從robot1一直到robotN。需要創(chuàng)造的數(shù)據(jù)經(jīng)常會有外鍵的情況,假設(shè)一個用戶報(bào)名參加考試的測試場景,這種情況一般包含三張表,一張用戶表、一張考試表、還有一張報(bào)名記錄表,報(bào)名表存放用戶報(bào)名信息、其中考試和用戶都是外鍵。相應(yīng)的我們測試的時候需要創(chuàng)造三個factory:UserFactory、ExamFactory還有EnrollFactory。在創(chuàng)建EnrollFactory時需要用到SubFactory代碼大致如下:
class EnrollFactory(factory.django.DjangoModelFactory):
class Meta:
model = Enroll
user = factory.SubFactory(UserFactory)
exam = factory.SubFactory(ExamFactory)
這樣在調(diào)用EnrollFactory時,它會先去創(chuàng)建UserFactory和ExamFactory。
方法調(diào)用
單元測試的測試重點(diǎn)往往是某一個方法是否正確,不在乎各個模塊的交互,通常用mock的方式來模擬其他模塊的返回?;蛘哂袝r候我們需要故意制造出某一種異常,也需要用到mock的方法。通??梢允褂胷eturn_value、side_effect等,下面是一些常用方法的偽代碼:
from mock import patch, Mock
#在測試過程中想要某個方法(此列中為check_refundable)在該測試用例中返回True
@patch("XXX.models.check_refundable", Mock(return_value=True))
def test_some_function(self):
pass
#直接不真正執(zhí)行某個方法(check_valid)
@patch("XXX.models.check_valid", Mock())
def test_some_function(self):
pass
#故意在調(diào)用某方法過程中,拋出特定異常
@patch("XXX.models.check_valid", Mock(side_effect=KeyError('whatever')))
def test_some_function(self):
pass
Mock的用法可參考博文python第三方庫系列之十九--python測試使用的mock庫
另外,Django中有一個Client可以用來測接口,可參考Testing in Django
如果使用了django-rest-framework框架,可參考django-rest-framework/Testing
斷言
unittest的TestCase對象有許多斷言的方法可以使用,常用的有assertTrue、assertFalse、assertEqual和assertRaises等。下面是偽代碼示例
#斷言某些值是True
self.assertTrue(some_test_result)
#斷言在測試過程中沒有錯誤日志
with patch('shoppingcart.models.log.error') as mock_error_logger:
XXX.call_test_function()
self.assertFalse(mock_error_logger.called)
#斷言會有異常拋出
self.assertRaises(TypeError):
更多用法點(diǎn)擊查看官方文檔
樣例
一個常見的單元測試長下面這樣
import unittest from somemodule.factories
import UserFactoryfrom needtestmodule
import sometestfun
class TestXXXFunctions(unittest.TestCase):
def setUp(self):
#準(zhǔn)備數(shù)據(jù)
self.User = UserFactory()
def test_somfun(self):
result = sometestfun(self.User)
self.assertEqual(result, "expectedresult")
def test_some2(self):
result = sometestfun(self.User, "other")
self.assertEqual(result, "otherexpectedresult")
覆蓋度
寫了一些單元測試之后,往往還需要關(guān)注一下覆蓋度。各個語言都有一些統(tǒng)計(jì)覆蓋度的包,在Django中可使用coverage, 沒有覆蓋度報(bào)告時,我們在django中跑測試是執(zhí)行
$ python manage.py test
如果需要測試覆蓋度,則執(zhí)行
l$ coverage run manage.py test
這樣,在跑測試的過程中就會在當(dāng)前目錄生成.coverage文件,記錄覆蓋度信息,當(dāng)然你不能直接讀這個文件,還需要一個命令來生成xml或者h(yuǎn)tml格式的覆蓋度報(bào)告。
$ coverage xml
執(zhí)行后,當(dāng)前文件夾生成coverage.xml文件 ,可供后續(xù)展示使用。
總結(jié)
本文主要總結(jié)了做單元測試時的一般步驟,同時簡單介紹了在Django項(xiàng)目中做單元測試需要用到的一些包,希望對剛開始做單元測試的同學(xué)有幫助。