1、Python接口自动化系列之unittest

最新推荐文章于 2024-09-04 20:35:34 发布

那你多喝点水

最新推荐文章于 2024-09-04 20:35:34 发布

阅读量4.6k

点赞数 29

本文链接：https://blog.csdn.net/weixin_45608577/article/details/113579238

版权

好久没写博客了，最近在给朋友讲接口自动化，顺便记录一下，以便后面复习用，目前是打算用两三个月的时间来写整个Python接口自动框架从0到1的搭建过程，以及实际工作中接口框架是怎么用的，好了，现在就开始搞吧。
我们在学习任何技术之前都要弄清楚几个问题，这样会更方便理解。
1、什么是单元测试？
按照阶段来分，一般就是单元测试，集成测试，系统测试，验收测试。单元测试是对单个模块、单个类或者单个函数进行测试。
将访问接口的过程封装在函数里面;
接口测试就变成了单元测试；
单元测试就是通过传参，对某个模块、某个类、某个函数进行结果输出后验证的测试。
2、为什么要做单元测试？
1）.单元测试之后，才是集成测试，单个的功能模块测试通过之后，才能把单个功能模块集成起来做集成测试，为了从底层发现bug，减少合成后出现的问题。
2）.越早发现bug越好，否则问题累计到后期，如果做错了就要推倒重来，对于时间和人力成本来说非常耗费精力。
对于我们测试来说:单元测试是为了执行测试用例。
3、怎么做单元测试？
Python里有两个单元测试类：
1.Unittest（Python自带）；
2.Pytest（第三方库，需要下载安装）；
unittest多用于接口自动化项目用，pytest多用于WEB自动化项目、APP自动化项目。

4、unittest简介
unittest是Python自带的单元测试框，具备编写用例、组织用例、执行用例、输出报告等自动化框架的条件，可以用来作自动化测试框架的用例组织执行框架。
unittest框架的特性：
1）提供用例组织与执行：当测试用例只有几条的时候可以不考虑用例的组织，但是当测试用例数量较多时，此时就需要考虑用例的规范与组织问题。unittest单元测试框架就是用来解决这个问题的。
2）提供丰富的断言方法：既然是测试，就有一个预期结果和实际结果的比较问题。比较就是通过断言来实现，unittest单元测试框架提供了丰富的断言方法，通过捕获返回值，并且与预期值进行比较，从而得出测试通过与否。
3）提供丰富的日志：每一个失败用例我们都希望知道失败的原因，所有用例执行结束我们有希望知道整体执行情况，比如总体执行时间，失败用例数，成功用例数。unittest单元测试框架为我们提供了这些数据。

4、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留下一个干净的环境。

5、实现思路
1）导入unittest模块、被测文件或者其中的类；
2）创建一个测试类，并继承unittest.TestCase方法；
3）重写setUp和tearDown方法(如果有初始化条件和结束条件)。若setup()成功运行，无论测试方法是否成功，都会运行tearDown ()；
4）定义测试函数，函数名以test_开头，以识别测试用例；
5）调用unittest.main()方法运行测试用例；
6）用例执行后，需要判断用例是Pass还是Fail，可以用unittest.TestCase模块的:断言
断言就是比对预期结果。如果不加断言，没有结果对比，需要手动去检查运行的结果是否符合预期

前面5个模块百度都有，目的主要就是为了让那些手懒和不怎么会用百度的小伙伴不用自己百度了。接下来就是要敲代码来实现了。

6、使用介绍
前面我们提到过，unittest是Python自带的单元测试框架，所以无需下载，直接import unittest就可以

import unittest


# 我们先打印一下unittest的源码
print(help(unittest))

# 粘贴出源码里面提供的例子，然后我们总结一下每行代码的意思

# Simple
# usage:
# import unittest  1、使用unittest前，需导入unittest框架

# 2、IntegerArithmeticTestCase这个类必须继承unittest.TestCase，TestCase类，所有测试用例类继承的基类
class IntegerArithmeticTestCase(unittest.TestCase):
    # 3、类内的方法必须以test开头，比如testAdd或者test_Add
    def testAdd(self):  # test method names begin with 'test'
        # 4、断言：assertEqual用来断言预期结果和实际结果是否一致。当然unittest还包含很多其他断言方法，后面统一介绍
        self.assertEqual((1 + 2), 3)
        self.assertEqual(0 + 1, 1)
    # 测试用例
    def testMultiply(self):
        self.assertEqual((0 * 10), 0)
        self.assertEqual((5 * 8), 40)

# 5、用例执行顺序。在代码中不是写在前面的方法就先执行，如果把testMultiply放在testAdd方法之前，也是先执行testAdd方法，这是因为unittest执行测试用例，默认是根据ASCII码的顺序加载测试用例，数字与字母的顺序为：0-9，A-Z，a-z。


if __name__ == '__main__':
    # unittest.main()是运行主函数
    unittest.main(verbosity=2)

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

看一下运行结果
在这里插入图片描述
7、测试用例里面的setUp函数与tearDown函数的使用:

import unittest


# 我们先打印一下unittest的源码
#print(help(unittest))

# 粘贴出源码里面提供的例子，然后我们总结一下每行代码的意思

# Simple
# usage:
# import unittest  1、使用unittest前，需导入unittest框架

# 2、IntegerArithmeticTestCase这个类必须继承unittest.TestCase，TestCase类，所有测试用例类继承的基类
class IntegerArithmeticTestCase(unittest.TestCase):
    # setUp函数：初始化环境（执行每条用例之前，都要执行setUp函数下面的代码，每次都要执行）
    # 前置条件。测试方法之前自动运行setup里面的代码，比如在接口自动化中需要先登录的接口就需要频繁获取cookie，这样很不方便，所以就可以把获取cookie的方法写在setup里面
    def setUp(self):
        print("用例执行前置条件")
    # tearDown函数：清洗环境（执行每条用例之后，都要执行tearDown函数下面的代码，每次都要执行)
    # 后置条件。测试方法之后自动运行teardown里面的代码，比如在接口自动化中清理跑完一条case在数据库里产生的垃圾数据就可以写在teardown里面
    def tearDown(self):
        print("用例执行后置条件")
    # 3、类内的方法必须以test开头，比如testAdd或者test_Add
    def testAdd(self):  # test method names begin with 'test'
        # 4、断言：assertEqual用来断言预期结果和实际结果是否一致。当然unittest还包含很多其他断言方法，后面统一介绍
        self.assertEqual((1 + 2), 3)
        self.assertEqual(0 + 1, 1)
        print("我是第一个方法")
    # 测试用例
    def testMultiply(self):
        self.assertEqual((0 * 10), 0)
        self.assertEqual((5 * 8), 40)
        print("我是第二个方法")
# 5、用例执行顺序。在代码中不是写在前面的方法就先执行，如果把testMultiply放在testAdd方法之前，也是先执行testAdd方法，这是因为unittest执行测试用例，默认是根据ASCII码的顺序加载测试用例，数字与字母的顺序为：0-9，A-Z，a-z。


if __name__ == '__main__':
    # unittest.main()是运行主函数
    unittest.main(verbosity=2)

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

在这里插入图片描述
看打印结果我们很容易就能看出来setup和teardown在什么时候执行
注意：若 setUp() 成功运行，无论测试方法是否成功，都会运行 tearDown()
setUp()、tearDown()是TestCase里的方法，写在测试类中，就是方法的重写

8、setUpClass函数与tearDownClass函数的使用：

import unittest


# 2、IntegerArithmeticTestCase这个类必须继承unittest.TestCase，TestCase类，所有测试用例类继承的基类
class IntegerArithmeticTestCase(unittest.TestCase):
    # @classmethod 装饰器，根据名字就知道是类方法，在类运行之前运行，先知道这种用法就行，后面会单独讲一下装饰器的用法
    @classmethod
    # 当类中的测试方法被执行前会被调用的一个类方法。该方法只会在类方法前调用，也就是带有calssmethod装饰器并且没有其他参数的方法。
    def setUpClass(cls):
        print("测试类之前运行")
    @classmethod
    # 当类测试方法被执行完后会被调用的一个类方法。该方法只会在一个类的所有方法执行完成后调用，该方法被调用时，必须有calssmethod装饰器并且除了类以外没有其他参数的方法
    def tearDownClass(cls):
        print("测试类之后运行")
    # setUp函数：初始化环境（执行每条用例之前，都要执行setUp函数下面的代码，每次都要执行）
    # 前置条件。测试方法之前自动运行setup里面的代码，比如在接口自动化中需要先登录的接口就需要频繁获取cookie，这样很不方便，所以就可以把获取cookie的方法写在setup里面
    def setUp(self):
        print("用例执行前置条件")
    # tearDown函数：清洗环境（执行每条用例之后，都要执行tearDown函数下面的代码，每次都要执行)
    # 后置条件。测试方法之后自动运行teardown里面的代码，比如在接口自动化中清理跑完一条case在数据库里产生的垃圾数据就可以写在teardown里面
    def tearDown(self):
        print("用例执行后置条件")
    # 3、类内的方法必须以test开头，比如testAdd或者test_Add
    def testAdd(self):  # test method names begin with 'test'
        # 4、断言：assertEqual用来断言预期结果和实际结果是否一致。当然unittest还包含很多其他断言方法，后面统一介绍
        self.assertEqual((1 + 2), 3)
        self.assertEqual(0 + 1, 1)
        print("我是第一个方法")
    # 测试用例
    def testMultiply(self):
        self.assertEqual((0 * 10), 0)
        self.assertEqual((5 * 8), 40)
        print("我是第二个方法")


if __name__ == '__main__':
    # unittest.main()是运行主函数
    unittest.main(verbosity=2)

看一下运行结果，一目了然，哈哈
在这里插入图片描述

9、运行方式
1）第一种直接右键运行
在这里插入图片描述
2）第二种命令行运行
unittest 模块可以通过命令行运行模块、类和独立测试方法的测试:
python -m unittest test_unittest
python -m unittest test_unittest.TestClass
python -m unittest test_unittest.TestClass.testAdd

同样的，测试模块可以通过文件路径指定，这也是我常用的一种方式，我们下面就以这种方式执行
我的目录：在这里插入图片描述

在pycharm下面的Terminal使用命令行python -m unittest test_unittest/t1.py
在这里插入图片描述
在运行测试时，你可以通过添加 -v 参数获取更详细（更多的冗余）的信息：
python -m unittest -v test_module
当运行时不包含参数，开始探索性测试：
python -m unittest
用于获取命令行选项列表：
python -m unittest -h
10、测试套件TestSuit(也叫测试集)：
1）第一种往测试套件添加测试用例的方式

import unittest
# 导入t1模块的类
from test_unittest.t1 import IntegerArithmeticTestCase

# TestSuite这个类代表一个测试用例或测试套件的集合，该类描述了一个可以被test runner执行的接口，通过它可以执行任何测试，运行一个TestSuite就相当于将测试套件迭代，然后执行每一个测试
suite = unittest.TestSuite()
# IntegerArithmeticTestCase下的测试用例
cases= [IntegerArithmeticTestCase('testAdd'),
        IntegerArithmeticTestCase('testMultiply')]

# 往套件里添加测试用例   注意：是addTests，不是addTest，addTest是添加一条测试用例
suite.addTests(cases)
# 运行，生成测试报告，我们先生成txt格式的，使用unittest自带的TextTestRunner生成测试报告（文本格式，不推荐使用）
with open('demo.txt','w',encoding='utf-8') as f:
    # 初始化runner  runner可以理解为运行器
    runner = unittest.TextTestRunner(f)
    # run()方法是TextTestRunner主要的公共接口，需要一个TestSuite或者TestCase实例作为参数
    runner.run(suite)

运行，会在当前目录下（也就是和t2同一目录）自动生成demo.txt文件，如果存在，不会重新生成，会覆盖之前的内容
在这里插入图片描述
看到生成demo.txt文件，两个…就代表两条测试用例通过
我们在故意改错一个看看结果，把40改为4

在运行看一下结果

可以看到果然是覆盖，没有忽悠你们，哈哈。F代表失败，失败的原因会在下面显示出来
2）第二种往测试套件添加测试用例的方式，其实和第一种差不多只不过是在unittest.TestSuite()中添加一个tests参数，值为测试用例列表：unittest.TestSuite(tests=cases)

import unittest
# 导入t1模块的类
from test_unittest.t1 import IntegerArithmeticTestCase

# IntegerArithmeticTestCase下的测试用例
cases= [IntegerArithmeticTestCase('testAdd'),
        IntegerArithmeticTestCase('testMultiply')]

#  创建测试套件的同时，直接往测试套件里面添加测试用例，省去suite.addTests(cases)
#  如果写上tests参数，那么它必须是一个可迭代对象，用来创建套件的
suite = unittest.TestSuite(tests=cases)

# 运行，生成测试报告，我们先生成txt格式的，使用unittest自带的TextTestRunner生成测试报告（文本格式，不推荐使用）
with open('demo.txt','w',encoding='utf-8') as f:
    # 初始化runner  runner可以理解为运行器
    runner = unittest.TextTestRunner(f)
    # run()方法是TextTestRunner主要的公共接口，需要一个TestSuite或者TestCase实例作为参数
    runner.run(suite)

我们运行试一下
在这里插入图片描述
同样的也能得到测试结果

3）我们来看一下第三种加载测试用例的方法：TestLoader()方法

import unittest
# 导入t1模块的类
from test_unittest import t1
from test_unittest.t1 import IntegerArithmeticTestCase

# IntegerArithmeticTestCase下的测试用例
# cases= [IntegerArithmeticTestCase('testAdd'),
#        IntegerArithmeticTestCase('testMultiply')]

# TestLoader用来加载测试用例的
# 我们可以根据模块加载，也可以根据测试类加载，自己定义规则，让他自动发现
loader = unittest.TestLoader()
# 根据测试类去加载测试用例
cases1 = loader.loadTestsFromTestCase(IntegerArithmeticTestCase)

# 根据模块去加载测试用例
# cases2 = loader.loadTestsFromModule(t1)

suite = unittest.TestSuite()
suite.addTests(cases1)
# suite.addTests(cases2)

# 运行，生成测试报告，我们先生成txt格式的，使用unittest自带的TextTestRunner生成测试报告（文本格式，不推荐使用）
with open('demo.txt','w',encoding='utf-8') as f:
    # 初始化runner  runner可以理解为运行器
    runner = unittest.TextTestRunner(f)
    # run()方法是TextTestRunner主要的公共接口，需要一个TestSuite或者TestCase实例作为参数
    runner.run(suite)

import unittest
# 导入t1模块的类
from test_unittest import t1
from test_unittest.t1 import IntegerArithmeticTestCase

# IntegerArithmeticTestCase下的测试用例
# cases= [IntegerArithmeticTestCase('testAdd'),
#        IntegerArithmeticTestCase('testMultiply')]

# TestLoader用来加载测试用例的
# 我们可以根据模块加载，也可以根据测试类加载，自己定义规则，让他自动发现
loader = unittest.TestLoader()
# 根据测试类去加载测试用例
# cases1 = loader.loadTestsFromTestCase(IntegerArithmeticTestCase)

# 根据模块去加载测试用例
cases2 = loader.loadTestsFromModule(t1)

suite = unittest.TestSuite()
# suite.addTests(cases1)
suite.addTests(cases2)

# 运行，生成测试报告，我们先生成txt格式的，使用unittest自带的TextTestRunner生成测试报告（文本格式，不推荐使用）
with open('demo.txt','w',encoding='utf-8') as f:
    # 初始化runner  runner可以理解为运行器
    runner = unittest.TextTestRunner(f)
    # run()方法是TextTestRunner主要的公共接口，需要一个TestSuite或者TestCase实例作为参数
    runner.run(suite)

4）自动化发现测试用例：discover方法

import os
import unittest


suite = unittest.TestSuite()
# TestLoader用来加载测试用例的
# 我们可以根据模块加载，也可以根据测试类加载，自己定义规则，让他自动发现
loader = unittest.TestLoader()

start_dir = os.path.dirname(os.path.abspath(__file__))
# 自动发现测试用例的方法  从指定的start_dir（起始目录）递归查找所有子目录下的测试模块，并返回一个TestSuite对象。只有符合pattern模式匹配的测试文件才会被加载。模块名称必须有效才能被加载。
suite1 = loader.discover(start_dir)
# 运行，生成测试报告，我们先生成txt格式的，使用unittest自带的TextTestRunner生成测试报告（文本格式，不推荐使用）
with open('demo.txt','w',encoding='utf-8') as f:
    # 初始化runner  runner可以理解为运行器
    runner = unittest.TextTestRunner(f, verbosity=2)
    # run()方法是TextTestRunner主要的公共接口，需要一个TestSuite或者TestCase实例作为参数
    runner.run(suite1)

目前这样写完是可以运行的，但是不能自定发现测试用例，也不能生成测试报告，这是为什么呢？因为discover方法，我们先看一下discover方法的参数：discover(start_dir,pattern=’test*.py’,top_level_dir=None)
start_dir参数：start_dir可以是一个模块名，也可以是一个目录，是必传参数
pattern参数：pattern没有被特意存储为loader的属性，这样包就可以自行查找；就是因为这个参数的值必须是以test开头的模块才能被自动发现
top_level_dir参数：top_level_dir被存储，top_level_dir=None，默认为None 不用管
看完discover的几个参数和值我们就知道为啥没有自动加载到测试用例了，所以我们吧t1模块改为test1.py在运行

import os
import unittest


suite = unittest.TestSuite()
# TestLoader用来加载测试用例的
# 我们可以根据模块加载，也可以根据测试类加载，自己定义规则，让他自动发现
loader = unittest.TestLoader()

start_dir = os.path.dirname(os.path.abspath(__file__))
# 自动发现测试用例的方法  从指定的start_dir（起始目录）递归查找所有子目录下的测试模块，并返回一个TestSuite对象。只有符合pattern模式匹配的测试文件才会被加载。模块名称必须有效才能被加载。
suite1 = loader.discover(start_dir)
# 运行，生成测试报告，我们先生成txt格式的，使用unittest自带的TextTestRunner生成测试报告（文本格式，不推荐使用）
with open('demo.txt','w',encoding='utf-8') as f:
    # 初始化runner  runner可以理解为运行器
    runner = unittest.TextTestRunner(f, verbosity=2)
    # run()方法是TextTestRunner主要的公共接口，需要一个TestSuite或者TestCase实例作为参数
    runner.run(suite1)

看结果，是能自动发现测试用例并能生成报告的
在这里插入图片描述
还有一个小问题，我们看一下第一行代码，根本就没用到，所以说用discover方法自动生成用例是不用初始化suite的，小伙伴们可以自己去掉第一行代码执行一遍，就知道根本没啥用，小技巧，大经验，哈哈哈

11、前面我们执行结果报告是不是太丑了，哈哈，我们接下来学习一下HTMLtestrunner，首先我们先安装一下HTMLtestrunner，由于现在从官网下载的是早期Python2的，现在很多小伙伴都是用的Python3，所以需要修改一下HTMLtestrunner的源码，怎么修改这里就不过多的说了，其实目前来说学习怎么修改用处不是很大，我把修改后的可以发给大家，有需要的，下方可以加我微信，私发你哦
首先我们看一下如何把我修改后的HTMLtestrunner放在自己的lib目录下
在这里插入图片描述

import os
import unittest
# 1、首先导入HTMLTestRunner,注意：HTMLTestRunnerHh是我修改后的，其中Hh是为了区分一下，随便起的名字，哈哈
from HTMLTestRunnerHh import HTMLTestRunner

loader = unittest.TestLoader()
start_dir = os.path.dirname(os.path.abspath(__file__))
suite1 = loader.discover(start_dir)
with open('demo.html','wb',encoding='utf-8') as f:
    # 2、我们把unittest里面的TextTestRunner替换成HTMLTestRunner
    runner = HTMLTestRunner(f, verbosity=2)
    # run()方法是TextTestRunner主要的公共接口，需要一个TestSuite或者TestCase实例作为参数
    runner.run(suite1)

运行看一下结果：
在这里插入图片描述
呀，报错了，莫慌，看原因是说这个字符集的问题，因为是HTML报告嘛，所以我们把encoding='utf-8’去掉就好了
去掉之后运行

是这样的，我们点击右上角的浏览器图标。自己想要用什么浏览器打开直接就点击对应的图标就行，我是习惯用谷歌，这里就拿谷歌演示一下
在这里插入图片描述
这报告不就好看多了嘛，而且很直观的就可以看出，作者最新改动了一下源码，改成条形图或者饼状图统计的了（得意），其中红色失败，绿色通过，我们再来看一次失败的结果

失败的用例会说明失败的原因，很详细，能快速准确的定位问题。
最后我们看一下HTMLTestRunner()几个参数的用法

import os
import unittest
# 1、首先导入HTMLTestRunner,注意：HTMLTestRunnerHh是我修改后的，其中Hh是为了区分一下，随便起的名字，哈哈
from HTMLTestRunnerHh import HTMLTestRunner

loader = unittest.TestLoader()
start_dir = os.path.dirname(os.path.abspath(__file__))
suite1 = loader.discover(start_dir)
with open('demo.html','wb') as f:
    # 2、我们把unittest里面的TextTestRunner替换成HTMLTestRunner
    # 3、HTMLTestRunner参数，我们看一下源码可知需要的参数 HTMLTestRunner(stream= verbosity=2,title=None,description=None,tester=None)
    # stream= : 输入流 verbosity=2: 不说了 前面写过，可以往前翻翻，title=None:默认None 就是测试报告的标题的名字，description=None:默认None，描述测试报告的，tester=None：测试人是谁
    runner = HTMLTestRunner(f, verbosity=2,title='浩浩的测试报告',description='浩浩是单身狗',tester='浩浩')
    # run()方法是TextTestRunner主要的公共接口，需要一个TestSuite或者TestCase实例作为参数
    runner.run(suite1)