Python接口测试实战3（下）- unittest测试框架

Posted 2023-01-30 一个处女座的测试

本节内容

• unittest简介
• 用例编写
• 用例组织及运行
• 生成测试报告

unitttest简介

参考：unittest官方文档 翻译版

为什么要使用unittest？
在编写接口自动化用例时，我们一般针对一个接口建立一个.py文件，一条测试用例封装为一个函数（方法），但是在批量执行的过程中，如果其中一条出错，后面的用例就无法执行。使用测试框架可以互不影响的用例执行及更灵活的执行控制

unittest特点

• python自带的单元测试框架，无需安装
• 用例执行互不干扰
• 提供不同范围的setUp(测试准备)和tearDown(测试清理)方法
• 提供丰富的断言方法
• 可以通过discover批量执行所有模块的用例
• 可以通过TestSuite(测试集)灵活的组织用例

unittest几大组成部分

• TestCase: 用例对象，编写测试用例时要继承该类，以具有TestCase的属性和方法
• TestSuite: 测试集或测试套件，测试用例的集合，用来组织用例，支持嵌套
• TestLoader: 用例加载器，用于向TestSuite中添加用例
• TextTestRunner: 用例执行器（输出文本结果），一般以TestSuite为单位执行用例
• TestResult: 测试结果

用例编写#

1. 新建一个test_开头（必须）的.py文件，如test_user_login.py
2. 导入unittest
3. 编写一个Test开头（必须）的类，并继承unittest.TestCase，做为测试类
4. 在类中编写一个test_开头（必须）的方法，作为用例

test_user_login.py # 文件必须test_开头

import unittest  # 导入unittest
import requests

class TestUserLogin(unittest.TestCase):  # 类必须Test开头，继承TestCase才能识别为用例类
    url = 'http://115.28.108.130:5000/api/user/login/'
    
    def test_user_login_normal(self):   # 一条测试用例，必须test_开头
        data = "name": "张三", "password": "123456"
        res = requests.post(url=self.url, data=data)
        self.assertIn('登录成功', res.text)  # 断言
        
    def test_user_login_password_wrong(self):
        data = "name": "张三", "password": "1234567"
        res = requests.post(url=self.url, data=data)
        self.assertIn('登录失败', res.text)  # 断言


if __name__ == '__main__':  # 如果是直接从当前模块执行（非别的模块调用本模块）
	unittest.main(verbosity=2)    # 运行本测试类所有用例,verbosity为结果显示级别

用例执行顺序：并非按书写顺序执行，而是按用例名ascii码先后顺序执行

用例断言
unittest提供了丰富的断言方法，常用为以下几种：

• 判断相等
  • assertEqual(a,b)/assertNotEqual(a,b): 断言值是否相等
  • assertIs(a,b)/assertIsNot(a,b): 断言是否同一对象（内存地址一样）
  • assertListEqual(list1, list2)/assertItemNotEqual(list1, list2): 断言列表是否相等
  • assertDictEqual(dict1, dict2)/assertDictNotEqual(dict1, dict2): 断言字典是否相等
• 是否为空
  • assertIsNone(a)/assertIsNotNone(a)
• 判断真假
  • assertTrue(a)/assertFalse(a)
• 是否包含
  • assertIn(a,b)/assertNotIn(a,b) # b中是否包含a
• 大小判断
  • assertGreater(a,b)/assertLess(a,b) : 断言a>b / 断言a<b
  • assertGreaterEqual(a,b)/assertLessEqual: 断言a>=b / 断言a<=b
• 类型判断
  • assertIsInstance(a,dict)/assertNotIsInstance(a,list) # 断言a为字典 / 断言a非列表

示例：

import unittest

case = unittest.TestCase()
case.assertEqual(1,2.0/2) # 通过1=2.0/2
case.assertEqual(1, True) # 通过
case.assertIs(1.0, 2.0/2) # 失败，不是同一对象
case.assertListEqual([1,2],[1,2]) # 通过（顺序要一致）
case.assertDictEqual("a":1,"b":2,"b":2,"a":1) # 通过，字典本无序
case.assertIsNone() # 失败
case.assertFalse() # 通过，空字典为False
case.assertIn("h","hello") # 通过
case.assertGreater(3,2) # 通过，3>2
case.assertIsInstance("a":1, dict) # 通过

断言是unittest.TestCase的一种方法，通过断言判断用例是否通过（Pass/Fail)

Test Fixtures(用例包裹方法)
Test Fixtures即setUp（用例准备）及tearDown（测试清理）方法，用于分别在测试前及测试后执行

按照不同的作用范围分为：

• setUp()/tearDown(): 每个用例执行前/后执行一次
• setUpClass()/tearDownClass(): 每个测试类加载时/结束时执行一次
• setUpMoudle()/tearDownMoudle(): 每个测试模块（一个py文件为一个模块）加载/结束时执行一次

import unittest

def setUpModule():    # 当前模块执行前只执行一次
    print('=== setUpModule ===')

def tearDownModule(): # 当前模块执行后只执行一次
    print('=== tearDownModule ===')

class TestClass1(unittest.TestCase):
    @classmethod          # 声明为类方法（必须）
    def setUpClass(cls):  # 类方法，注意后面是cls，整个类只执行一次
        print('--- setUpClass ---')

    @classmethod
    def tearDownClass(cls):  
        print('--- tearDownClass ---')
        
    def setUp(self):  # 该类中每个测试用例执行一次
        print('... setUp ...')
        
    def tearDown(self):
        print('... tearDown ...')
        
    def test_a(self):  # 测试用例
        print("a")
        
    def test_B(self): # 大写B的ascii比小写a靠前，会比test_a先执行
        print("B")

class TestClass2(unittest.TestCase):  # 该模块另一个测试类
    def test_A(self):
        print("A")

if __name__ == '__main__':
    unittest.main()

执行结果:

=== setUpModule ===
--- setUpClass ---
... setUp ...
B
... tearDown ...
... setUp ...
a
... tearDown ...
--- tearDownClass ---
A
=== tearDownModule ===
...
----------------------------------------------------------------------
Ran 3 tests in 0.001s

OK

完整的接口测试用例
一条完整的测试接口用例需要包含：

1. 数据准备：准备测试数据，可手工准备，也可使用代码准备（通常涉及数据库操作）
2. 环境检查：如果手工准备的数据，连接数据库进行环境检查会使用例更健壮
3. 发送请求：发送接口请求
4. 响应断言/数据库断言：响应断言后，还需要进行数据库断言，以确保接口数据库操作的正确性
5. 数据清理：如果接口有更数据库操作，断言结束后需要还原更改

test_user_reg.py

import unittest
import requests
from db import *   # 导入db.py文件，源码见上篇

# 数据准备
NOT_EXIST_USER = '范冰冰'
EXIST_USER = '张三'


class TestUserReg(unittest.TestCase):
    url = 'http://127.0.0.1:5000/api/user/reg/'
    
    def test_user_reg_normal(self):
        # 环境检查
        if check_user(NOT_EXIST_USER):
            del_user(NOT_EXIST_USER)
        
        # 发送请求
        data = 'name': NOT_EXIST_USER, 'password': '123456'
        res = requests.post(url=self.url, json=data)
        
        # 期望响应结果，注意字典格式和json格式的区别（如果有true/false/null要转化为字典格式）
        except_res = 
                        "code": "100000",
                        "msg": "成功",
                        "data": 
                                    "name": NOT_EXIST_USER,
                                    "password": "e10adc3949ba59abbe56e057f20f883e"
                                
                      
        
        # 响应断言（整体断言）
        self.assertDictEqual(res.json(), except_res)
        
        # 数据库断言
        self.assertTrue(check_user(NOT_EXIST_USER))
        
        # 环境清理（由于注册接口向数据库写入了用户信息）
        del_user(NOT_EXIST_USER)
        
    def test_user_reg_exist(self):
         # 环境检查
        if not check_user(EXIST_USER):
            add_user(EXIST_USER)
        
        # 发送请求
        data = 'name': EXIST_USER, 'password': '123456'
        res = requests.post(url=self.url, json=data)
        
        # 期望响应结果，注意字典格式和json格式的区别（如果有true/false/null要转化为字典格式）
        except_res = 
                        "code": "100001",
                        "msg": "失败，用户已存在",
                        "data": 
                                    "name": EXIST_USER,
                                    "password": "e10adc3949ba59abbe56e057f20f883e"
                                
                      
        
        # 响应断言（整体断言）
        self.assertDictEqual(res.json(), except_res)
        
        # 数据库断言(没有注册成功，数据库没有添加新用户)
        
        # 环境清理（无需清理）
        
if __name__ == '__main__':
    unittest.main(verbosity=2)   # 运行所有用例

用例组织及运行

除了使用unittest.main()运行整个测试类之外，我们还可以通过TestSuite来灵活的组织要运行的测试集

1. 新建TestSuite并添加测试用例

import unittest
from test_user_login import TestUserLogin  
from test_user_reg import TestUserReg # 从上面两个例子里导入测试类

suite = unittest.TestSuite()
suite.addTest(TestUserLogin('test_user_login_normal')) # 添加单个用例
suite.addTests([TestUserReg('test_user_reg_normal'),TestUserReg('test_user_reg_exist')]) # 添加多个用例

# 运行测试集
unittest.TextTestRunner(verbosity=2).run(suite)  # verbosity显示级别，运行顺序为添加到suite中的顺序

2、使用makeSuite来制作用例集

import unittest
from test_user_login import TestUserLogin

suite1 = unittest.makeSuite(TestUserLogin, 'test_user_login_normal') # 使用测试类的单条用例制作测试集
suite2 = unittest.makeSuite(TestUserLogin) # 使用整个测试类制作测试集合(包含该测试类所有用例)

unittest.TextTestRunner(verbosity=2).run(suite1)

3、使用TestLoader（用例加载器）生成测试集

improt unittest
from test_user_login import TestUserLogin

suite = unittest.TestLoader().loadTestsFromTestCase(TestUserLogin) # 加载该测试类所有用例并生成测试集

unittest.TextTestRunner(verbosity=2).run(suite)

4、使用discover（用例发现）遍历所有的用例

import unittest

suite = unittest.defaultTestLoader.discover("./")  # 遍历当前目录及子包中所有test_*.py中所有unittest用例
unittest.TextTestRunner(verbosity=2).run(suite)

注意：

• 子目录中需要包含__init__.py文件，及应为的Python包
• 所有用例因为test_*.py,包含测试类应以Test开头，并继承unittest.TestCase, 用例应以test_开头

5、测试集嵌套

import unittest
from test_user_login import TestUserLogin

suite1 = unittest.TestSuite()
suite1.addTest(TestUserLogin('test_user_login_normal'))

suite2 = makeSuite(TestUserLogin, 'test_user_login_password_wrong')

suite = unittest.TestSuite([suite1, suite2])  # 将两个测试集组合为一个

unittest.TextTestRunner(verbosity=2).run(suite)

生成测试报告

生成文本报告

import unittest

suite = unittest.defaultTestLoader.discover("./")

# 输出测试结果到文本文件
with open("result.txt","w") as f:
    unittest.TextTestRunner(stream=f,verbosity=2).run(suite) # 将输出流stream输出到文件

生成HTML报告

1. 下载HTMLTestRunnerCN
2. 解压并将解压包中python3x文件夹下的htmlTestRunnerCN.py拷贝到项目目录
3. 在目录下新建脚本run_all.py

import unittest
from HTMLTestReportCN import HTMLTestRunner

suite = unittest.defaultTestLoader.discover("./")

f = open("report.html", 'wb') # 二进制写格式打开要生成的报告文件
HTMLTestRunner(stream=f,title="Api Test",description="测试描述",runner="卡卡").run(suite)
f.close()

1. 运行脚本，会在当前文件夹下生成report.html，用浏览器打开即可