Python接口自动化之unittest单元测试

以下主要介绍unittest特性、运行流程及实际案例。



单元测试三连问


1
什么是单元测试?


按照阶段来分,一般就是单元测试,集成测试,系统测试,验收测试。单元测试是对单个模块、单个类或者单个函数进行测试。

  • 将访问接口的过程封装在函数里面;

  • 接口测试就变成了单元测试;

  • 单元测试就是通过传参,对某个模块、某个类、某个函数进行结果输出后验证的测试。



2
为什么要做单元测试?


1.单元测试之后,才是集成测试,单个的功能模块测试通过之后,才能把单个功能模块集成起来做集成测试,为了从底层发现bug,减少合成后出现的问题。

2.越早发现bug越好,否则问题累计到后期,如果做错了就要推倒重来,对于时间和人力成本来说非常耗费精力。

对于我们测试来说:单元测试是为了执行测试用例。



3
怎么做单元测试?


Python里有两个单元测试类:

1.Unittest(Python自带);

2.Pytest(下载安装);

前者多用于接口自动化项目用,后者多用于WEB自动化项目、APP自动化项目。





unittest模块说明



1
unittest简介


unittest是Python自带的单元测试框,具备编写用例、组织用例、执行用例、输出报告等自动化框架的条件,可以用来作自动化测试框架的用例组织执行框架。

unittest框架的特性:

  • 提供用例组织与执行:当测试用例只有几条的时候可以不考虑用例的组织,但是当测试用例数量较多时,此时就需要考虑用例的规范与组织问题。unittest单元测试框架就是用来解决这个问题的。

  • 提供丰富的断言方法:既然是测试,就有一个预期结果和实际结果的比较问题。比较就是通过断言来实现,unittest单元测试框架提供了丰富的断言方法,通过捕获返回值,并且与预期值进行比较,从而得出测试通过与否。

  • 提供丰富的日志:每一个失败用例我们都希望知道失败的原因,所有用例执行结束我们有希望知道整体执行情况,比如总体执行时间,失败用例数,成功用例数。unittest单元测试框架为我们提供了这些数据。



2
unittest组成
unittest单元测试中最核心的四个部分是:TestCase(测试用例),TestSuite(测试套件),TestRunner(测试运行器),TestFixture(测试环境数据准备和清理)。
1.TestCase(测试用例):一个TestCase的实例就是一个测试用例。什么是测试用例呢?就是一个完整的测试流程。包括测试前准备环境的搭建(setUp)、实现测试过程的代码(run),以及测试后环境的还原(tearDown)。单元测试(Unittest)的本质也就在这里,一个测试用例就是一个完整的测试单元,通过运行这个测试单元,可以对某一个功能进行验证。

2.TestSuite(测试套件):一个功能的验证往往需要多个测试用例,可以把多个测试用例集合在一起执行,这就产生了测试套件TestSuite的概念。TestSuite用来组装单个测试用例。可以通过addTest加载TestCase到TestSuite中,从而返回一个TestSuite实例。而且TestSuite也可以嵌套TestSuite。


3.TestLoader(测试用例加载器):用来加载TestCase到TestSuite中的,其中loadTestsFrom__()方法用于寻找TestCase,并创建它们的实例,然后添加到TestSuite中,返回TestSuite实例;


4.TextTestRunner(执行测试用例):用来执行测试用例,其中run(test)会执行TestSuite/TestCase中的run(result)方法,并将测试结果保存到TextTestResult实例中,包括运行了多少测试用例,成功多少,失败多少等信息;


5.Test Fixture(测试环境数据准备和清理):一个测试用例的初始化准备及环境还原,主要是setUp() 和 tearDown()方法;比如说在测试用例中需要访问数据库,那么可以在setUp()中建立数据库连接以及进行一些初始化,在tearDown()中清除在数据库中产生的数据,然后关闭连接。注意tearDown的过程很重要,要为以后的TestCase留下一个干净的环境。



3
unittest核心工作原理
unittest的静态类图:

Python接口自动化之unittest单元测试Python接口自动化之unittest单元测试


大体流程:编写TestCase,由TestLoader加载TestCase到TestSuite,然后由TextTestRunner来运行TestSuite,最后将运行的结果保存在TextTestResult中。





unittest单元测试


1
实现思路


1.导入unittest模块、 被测文件或者其中的类;

2.创建一个测试类,并继承unittest.TestCase方法;

3.重写setUp和tearDown方法(如果有初始化条件和结束条件)。若setup()成功运行,无论测试方法是否成功,都会运行tearDown ();

4.定义测试函数,函数名以test_开头,以识别测试用例;

5.调用unittest.main()方法运行测试用例;

6.用例执行后,需要判断用例是Pass还是Fail,可以用unittest.TestCase模块的:断言

断言就是比对预期结果。如果不加断言,没有结果对比,需要手动去检查运行的结果是否符合预期。



2
使用介绍


  1. 要想使用unittest单元测试框架,必须得先导入:import unittest

  2. 查看unittest源码;

import unittest
print(help(unittest))


从打印结果中提取出unittest简易的例子:

import unittest
class IntegerArithmeticTestCase(unittest.TestCase):
    def testAdd(self):  # test method names begin with 'test'
        self.assertEqual((1 + 2), 3)
        self.assertEqual(0 + 1, 1)
    def testMultiply(self):
        self.assertEqual((0 * 10), 0)
        self.assertEqual((5 * 8), 40)
if __name__ == '__main__':
    unittest.main()





unittest实例


1
TestCase(测试用例)


看了官方代码后,我们自己写个例子熟悉下,并总结出规律:

import unittest
class TestDemo(unittest.TestCase):
    # test_sub用例
    def test_sub(self):
        self.assertEqual(2-1,1)
    # test_add用例
    def test_add(self):
        self.assertEqual(2+1,3)
if __name__ == "__main__":
    # unittest.main()是运行主函数
    unittest.main(verbosity=2)


运行结果为:

test_add (__main__.TestDemo) ... ok
test_sub (__main__.TestDemo) ... ok
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK


接下来,我们来总结一些规律:

1.使用unittest前,需导入unittest框架。

2.TestDemo这个类必须继承unittest.TestCase,TestCase类,所有测试用例类继承的基类。

3.类内的方法必须以test开头,比如test_add。

4.断言:assertEqual用来断言预期结果和实际结果是否一致。当然unittest还包含很多其他断言方法,后面统一介绍。

5.用例执行顺序。在代码中test_sub方法写在test_add前,但实际,test_add比test_sub先运行。为什么呢?unittest执行测试用例,默认是根据ASCII码的顺序加载测试用例,数字与字母的顺序为:0-9,A-Z,a-z。

6.verbosity是一个选项,表示测试结果的信息复杂度,有0、1、2 三个值。verbosity=0 : 你只能获得测试用例数总的结果;verbosity=1 (默认模式): 在每个成功的用例前面有个“.” 每个失败的用例前面有个 “F”;verbosity=2 (详细模式):测试结果会显示每个测试用例的所有相关的信息。


如下,在测试用例中写入断言:

import unittest
#测试MathMethod类
class TestMathMethod(unittest.TestCase):
    #编写测试用例
    def test_add_two_positive(self): #测试两个正数相加
        res=MathMethod(1,1).add()
        print("1+1的结果是:",res)
        self.assertEqual(2,res,"两个正数相加出错!") #断言
    def test_add_two_zero(self): #测试两个0相加
        res = MathMethod(0, 0).add()
        print("0+0的结果是:", res)
        self.assertEqual(0, res, "两个0相加出错!") #断言
    def test_add_two_negative(self): #测试两个负数相加
        res = MathMethod(-1, -1).add()
        print("-1+(-1)的结果是:", res)
        self.assertEqual(-2, res, "两个负数相加出错!") #断言
if __name__ == '__main__':
    unittest.main()


测试用例里面的setUp函数与tearDown函数的使用:

class TestMathMethod(unittest.TestCase):
def setUp(self):
    print("开始准备执行测试用例!")
    
def tearDown(self):
    print("结束!")
    
#编写测试用例
def test_add_two_positive(self): #测试两个正数相加
    res=MathMethod(1,1).add()
    print("1+1的结果是:",res)


  • setUp函数:初始化环境(执行每条用例之前,都要执行setUp函数下面的代码,每次都要执行);


  • tearDown函数:清洗环境(执行每条用例之后,都要执行tearDown函数下面的代码,每次都要执行);


  • setUp()、tearDown()是TestCase里的方法,写在测试类中,就是方法的重写。


  • 执行顺序是:setUp->testA->tearDown->setUp->testB>tearDown



2
TestSuit(测试集)


当测试用例全部写完,但是只想执行其中部分,可以使用TestSuit()来收集测试用例。

import unittest
from xxx import xxx      #测试用例的类
suite=unittest.TestSuit()
suite.addTest(测试用例的类("用例名称1"))    #用例名称用字符串的形式传入
suite.addTest(测试用例的类("用例名称2"))
suite.addTest(测试用例的类("用例名称3"))
.....



3
TestLoader(加载测试用例)


方式一:通过测试类来加载用例(loadTestsFromTestCase)

一次性加载测试用例类名1下的所有用例。

import unittest
    from xxx import xxx      #测试用例的类
    suite=unittest.TestSuit()
    loader=unittest.TestLoader()
    suite.addTest(loader.loadTestsFromTestCase(测试用例类名1))  
    #测试用例类名直接传入


方式二:通过测试类所在的模块加载用例(loadTestsFromModule)

一次性加载测试用例模块名下的所有用例。

import unittest
from xxx import xxx      #测试用例模块
suite=unittest.TestSuit()
loader=unittest.TestLoader()
suite.addTest(loader.loadTestsFromTestCase(测试用例模块名))   #测试用例模块名直接传入



4
生成测试报告


方式一:使用unittest自带的TextTestRunner生成测试报告(文本格式,不推荐使用)。

Python接口自动化之unittest单元测试

TextTestRunner是一个以文本形式展示测试结果的测试运行程序类

  • stream 输出报告的路径,默认输出控制台;

  • verbosity 控制输出报告的详细程度,从0-2,越来越详细;



方式二:使用第三方模块HTMLTestRunnerNew(生成HTML格式的测试报告,推荐使用)。

  • file:文件

  • verbosity:详细程度

  • title:标题

  • description:描述

  • tester:作者

with open("接口测试报告.html","wb") as file:
    runner = HTMLTestRunnerNew.HTMLTestRunner(stream=file,  
                                              verbosity=2,
                                              title="接口自动化测试报告",
                                              description="接口测试V1",
                                              tester="ITester软件测试小栈")
    runner.run(suite)


方式三:使用unittest.defaultTestLoader.discover() 模糊匹配。

import unittest
import HTMLTestRunnerNew

all_testcases=unittest.defaultTestLoader.discover(contants.testcases_dir, pattern='test_*.py',top_level_dir=None) 

#利用上下文管理器自动关闭资源
with open(contants.reports_html,"wb+") as file:    #选择绝对路径,把文件打开,写进内容 (报告的文件名直接写在路径里面)
    runner=HTMLTestRunnerNew.HTMLTestRunner(stream=file,
                                            title="接口自动化测试报告",
                                            description="接口测试V1",
                                            tester="ITester软件测试小栈")
    runner.run(all_testcases)


总结:本文主要介绍单元测试,unittest模块特性、大致流程、源码及实战例子。

上一篇:unittest的封装方法


下一篇:在主流测试框架中,相比于unitTest,Pytest才是永远的神