从零开始建立单元测试-以Django项目为例

前言

在测试金字塔中,单元测试处于金字塔底部,所占比例最大。它运行速度快,发现问题和定位问题都比较快。而且一旦建立好覆盖度足够的单元测试之后,会极大增强发版信心。

步骤

不管是单元、接口还是UI,测试的步骤一般都分以下三步:

  1. 测试数据准备:创建出需要用到符合一定条件的用户或课程,造完后做一些处理,使他符合你需要测试的情景。
    比如需要测试退款的函数,那你首先得把用户、课程和用户购买课程的数据造出来。
  2. 调用需要被测的方法
  3. 断言:拿到2步中返回的结果,对结果进行测试结果的判断

数据准备

在Django项目中,推荐使用FactoryBoy
它可以根据你Django中的models来创建数据,示例代码如下:

class UserFactory(factory.django.DjangoModelFactory):    
    class Meta:        
        model = 'myapp.User'  # Equivalent to ``model = myapp.models.User``    
    username = 'john'

它根据你给他的model来创建数据,model中没有设置默认值的字段需要在代码中赋值。在你的测试代码中调用UserFactory(),或者UserFactory.create()时都会在数据库中创建一个名为john的用户。当然,你可能不希望每次创建的用户都叫相同的名字。所以可以修改代码为:

class UserFactory(factory.django.DjangoModelFactory):  
     class Meta:       
        model = 'myapp.User'   
     username = factory.Sequence(u'robot{0}'.format)

这样每次调用UserFactory时,username都会递增,从robot1一直到robotN。需要创造的数据经常会有外键的情况,假设一个用户报名参加考试的测试场景,这种情况一般包含三张表,一张用户表、一张考试表、还有一张报名记录表,报名表存放用户报名信息、其中考试和用户都是外键。相应的我们测试的时候需要创造三个factory:UserFactory、ExamFactory还有EnrollFactory。在创建EnrollFactory时需要用到SubFactory代码大致如下:

class EnrollFactory(factory.django.DjangoModelFactory):   
    class Meta:       
         model = Enroll    
    user = factory.SubFactory(UserFactory)    
    exam = factory.SubFactory(ExamFactory)

这样在调用EnrollFactory时,它会先去创建UserFactory和ExamFactory。

方法调用

单元测试的测试重点往往是某一个方法是否正确,不在乎各个模块的交互,通常用mock的方式来模拟其他模块的返回。或者有时候我们需要故意制造出某一种异常,也需要用到mock的方法。通常可以使用return_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

#直接不真正执行某个方法(check_valid)
@patch("XXX.models.check_valid", Mock())
def test_some_function(self):    
    pass

#故意在调用某方法过程中,抛出特定异常
@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):

更多用法点击查看官方文档

样例

一个常见的单元测试长下面这样

import unittest  from somemodule.factories
import UserFactoryfrom needtestmodule
import sometestfun

class TestXXXFunctions(unittest.TestCase):      
    def setUp(self):        
        #准备数据       
        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")  

覆盖度

写了一些单元测试之后,往往还需要关注一下覆盖度。各个语言都有一些统计覆盖度的包,在Django中可使用coverage, 没有覆盖度报告时,我们在django中跑测试是执行

$ python manage.py test

如果需要测试覆盖度,则执行

l$ coverage run manage.py test

这样,在跑测试的过程中就会在当前目录生成.coverage文件,记录覆盖度信息,当然你不能直接读这个文件,还需要一个命令来生成xml或者html格式的覆盖度报告。

$ coverage xml

执行后,当前文件夹生成coverage.xml文件 ,可供后续展示使用。

总结

本文主要总结了做单元测试时的一般步骤,同时简单介绍了在Django项目中做单元测试需要用到的一些包,希望对刚开始做单元测试的同学有帮助。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容