您还未登录! 登录 | 注册 | 帮助  

您的位置: 首页 > 软件测试技术 > 单元测试 > 正文

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

发表于:2020-10-17 作者:萩茝 来源:简书

前言

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

步骤

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

测试数据准备:创建出需要用到符合一定条件的用户或课程,造完后做一些处理,使他符合你需要测试的情景。

比如需要测试退款的函数,那你首先得把用户、课程和用户购买课程的数据造出来。

调用需要被测的方法。

断言:拿到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

断言

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项目中做单元测试需要用到的一些包,希望对刚开始做单元测试的同学有帮助。