Python单元测试：unittest使用简介

Posted 2020-08-09

一、概述

   本文介绍python的单元测试框架unittest，这是Python自带的标准模块unittest。unittest是基于java中的流行单元测试框架junit设计的，其功能强大且灵活，对于熟悉junit的人来说掌握unittest很简单。

    unittest涉及的知识点较多，但核心的就那一些，本文只介绍最核心和基础的内容。

    类似junit，使用unittest编写python的单元测试代码，包括如下几个步骤：

1）编写一个python类，继承 unittest模块中的TestCase类，这就是一个测试类

2）在上面编写的测试类中定义测试方法（这个就是指的测试用例），每个方法的方法名要求以 test 打头，没有额外的参数。 在该测试方法中 调用被测试代码，校验测试结果，TestCase类中提供了很多标准的校验方法，如 最常见的assertEqual。

3）执行 unittest.main() ，该函数会负责运行测试，它会实例化所有TestCase的子类，并运行其中所有以test打头的方法。

 

二、案例1

我们下面看一个例子，编写如下的python文件，为了简单，我们将被测函数与测试代码放在一个文件中了：

#coding=utf-8
import unittest
#被测试方法
def  cal(a,b):
    return a+b

#测试类    
class CalTest(unittest.TestCase):
    def testA(self):
        expected = 6
        result = cal(2,4)
        self.assertEqual(expected,result)
        
    def testB(self):
        expected = 0
        result = cal(2,1)
        self.assertEqual(expected,result)

#执行所以测试代码        
if __name__==‘__main__‘:unittest.main()        

上面的测试类CalTest中有两个测试方法，显然testB方法我们估计让校验出错。在命令行下执行上述python文件，输出如下信息：

.F

======================================================================

FAIL: testB (__main__.CalTest)

----------------------------------------------------------------------

Traceback (most recent call last):

  File "test2.py", line 19, in testB

    self.assertEqual(expected,result)

AssertionError: 0 != 3

----------------------------------------------------------------------

Ran 2 tests in 0.001s

FAILED (failures=1)

上面显示出了执行出错的用例，以及出错信息。最后两句给出了整个测试执行所花的时间，以及测试失败的用例数。

如果我们将testB修改正确，运行结果输出如下：

..
----------------------------------------------------------------------
Ran 2 tests in 0.000s

 

三、案例2

上面的例子只有一个测试文件(python文件)。在实际的项目中，往往又多个测试文件，每个测试文件针对不同的业务代码进行测试。

那这时该怎么去执行所有测试文件中的测试用例呢？

假设我们有test1.py测试文件中定义了一个测试类CalTest1 ， 另外一个测试test2.py测试文件中定义了一个测试类CalTest2.

这样要想同时能执行这两个测试文件中的测试用例，可编写如下的一个总的测试文件，作为执行的总入口：

#coding=utf-8
import unittest
from test1 import CalTest1
from test2 import CalTest2
if __name__==‘__main__‘:unittest.main()  

 

从上面的例子，可以看出，使用unittest框架还是比较简单和方便的。