全网最牛逼，接口自动化测试-Unittest自动化测试框架实战详解，整理精品教程

一、前言

1、UintTest是python内置的单元测试框架，具备编写用例、组织用例、执行用例、输出报告等自动化框架的条件

2、UintTest单元测试框架不仅适用于单元测试，还可以适用WEB自动化测试、接口自动化测试的开发与执行。用处还是比较广的

UintTest框架重要的概念
1、使用UintTest前需要了解该框架的四个概念，即Test Case、Test Suite、Test Fixture、Test Runner

二、简单运用

• 概念：UnitTest框架是专门用来进行执行代码测试的框架

• 使用UnitTest框架原因：
  1、能够组织多个用例去执行
  2、提供丰富的断言方法
  3、提供丰富的日志与测试结果

• 核心要素
  1、TestCase 测试用例
  2、TestSuite 测试组（多个测试用例合到一起）
  3、TextTestRunner文本执行
  4、Fixture 测试用例加头尾

三、TestCase测试用例

# TestCase 
import unittest

def add(x, y):
    return x + y
    # 错误显示
    # return x / y

class Testcase_01(unittest.TestCase):
    """测试用例"""
    def test_01(self):  # 测试方法必须以test开头
        print(add(1,1))
        # 错误显示
        # print(add(1,0))
    # def test_02(self):
	#	...
    # def test_03(self):
	#	...
if __name__ == '__main__':
    unittest.main()

# 正确结果：
.
2
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK
# 错误结果：
E
======================================================================
ERROR: test_01 (__main__.Testcase_01)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "C:/Users/x1c/Desktop/untitled/mocktest.py", line 8, in test_01
    print(add(1,0))
  File "C:/Users/x1c/Desktop/untitled/mocktest.py", line 4, in add
    return x / y
ZeroDivisionError: division by zero

----------------------------------------------------------------------
Ran 1 test in 0.000s

FAILED (errors=1)

四、TestSuite多条测试用例集合在一起

import unittest

# 导包
import unittest


def add(a, b):
    return a + b


# 继承unittest.TestCase类
   


class TestCase01(unittest.TestCase):
       # 在每条用例执行前执行
       def setUp(self):
           print("setUp")
    
       # 在每条用例执行后执行
       def tearDown(self):
           print("tearDown")
    
       # 方法名必须以test开头
       def testcase_01(self):
           print("testcase_01")
           print("1 + 1 = ", add(1, 1))
           # self.assertEqual(2, add(1, 2))
    
       def testcase_02(self):
           print("testcase_02")
           print("2 + 2 = ", add(2, 2))
    
       def testcase_03(self):
           print("testcase_03")
           print("3 + 3 = ", add(3, 3))
    
    
   class TestCase02(unittest.TestCase):
       # 方法名必须以test开头
       def testcase_01(self):
           print("TestCase02_testcase_01")
    
       def testcase_02(self):
           print("TestCase02_testcase_02")
    
       def testcase_03(self):
           print("TestCase02_testcase_03")

   # 实例化TestSuite类
   suite = unittest.TestSuite()
   # 以测试用例类里的每一个方法为单位添加
   # suite.addTest(TestCase01("testcase_01"))
   # suite.addTest(TestCase01("testcase_02"))
   # suite.addTest(TestCase02("testcase_02"))
    
   # 以测试用例类为单位添加
   suite.addTest(unittest.makeSuite(TestCase01))
   suite.addTest(unittest.makeSuite(TestCase02))
    
   runner = unittest.TextTestRunner()
   runner.run(suite)

五、夹具Fixture 测试用例方法前后执行功能

说明：是一个概述，对一个测试用例环境的搭建和销毁就是一个Fixture

使用：
1.初始化(搭建)：def setUp(self) --> 首先执行
(setUp:此方法继承于unittest.TestCase)
2.结束(销毁): def tearDown(self) --> 最后执行
(tearDown:此方法继承于unittest.TestCase)

提示：
1. 必须继承unittest.TestCase类，setUp、tearDown才是一个Fixture；
2. setUp：一般做初始化工作，比如：实例化浏览器、浏览器最大化、隐式等待设置
3. tearDown：一般做结束工作，比如：退出登录、关闭浏览器
4. 如果一个测试类有多个test开头方法，则每个方法执行之前都会运行setUp、结束时运行tearDown

1、案例

# 导包
import unittest


def add(a, b):
    return a + b


# 继承unittest.TestCase类
class TestCase01(unittest.TestCase):
    # 在每条用例执行前执行
    def setUp(self):
        print("setUp")

    # 在每条用例执行后执行
    def tearDown(self):
        print("tearDown")

    # 方法名必须以test开头
    def testcase_01(self):
        print("testcase_01")
        print("1 + 1 = ", add(1, 1))
        # self.assertEqual(2, add(1, 2))

    def testcase_02(self):
        print("testcase_02")
        print("2 + 2 = ", add(2, 2))

    def testcase_03(self):
        print("testcase_03")
        print("3 + 3 = ", add(3, 3))


class TestCase02(unittest.TestCase):
    # 方法名必须以test开头
    def testcase_01(self):
        print("TestCase02_testcase_01")

    def testcase_02(self):
        print("TestCase02_testcase_02")

    def testcase_03(self):
        print("TestCase02_testcase_03")


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

结果：
......
setUp
----------------------------------------------------------------------
testcase_01
Ran 6 tests in 0.001s
1 + 1 =  2

tearDown
OK
setUp
testcase_02
2 + 2 =  4
tearDown
setUp
testcase_03
3 + 3 =  6
tearDown
TestCase02_testcase_01
TestCase02_testcase_02
TestCase02_testcase_03

六、defaultTestLoader 测试多个文件

# 某个目录下存在多个测试文件，命名规范，如test1.py test2.py  可以写成test*.py
suite = unittest.defaultTestLoader.discover('测试用例.py路径', pattern='*.py')

# 创建测试运行环境
runner = unittest.TextTestRunner()
# 运行测试
runner.run(suite)

七、defaultTestLoader与TestSuite区别

TestSuite可以添加TestCase中所有test开头的方法和添加指定的test开头方法;
defaultTestLoader搜索指定目录下指定开头.py文件，并添加TestCase内所有test开头的方法，不能指定添加方法;

提示：defaultTestLoader属于TestSuite另一种实现方式；

八、unittest 中用于 skip 跳过 test method, test class,的相关装饰器

可以使用unitest.skip装饰器族跳过test method或者test class,这些装饰器包括:
① @unittest.skip(reason):无条件跳过测试，reason描述为什么跳过测试
② @unittest.skipif(conditition,reason):condititon为true时跳过测试
③ @unittest.skipunless(condition,reason):condition不是true时跳过测试

class MyTestCase(unittest.TestCase):

  @unittest.skip("demonstrating skipping")
  def test_nothing(self):
    self.fail("shouldn't happen")
  # 判断条件, 条件成立不执行，4<5就不会执行
  @unittest.skipIf(6<5,"not supported in this library version")
  def test_format(self):
    # Tests that work for only a certain version of the library.
    pass

  @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
  def test_windows_support(self):
    # windows specific testing code
    pass

@unittest.skip("showing class skipping")
class MySkippedTestCase(unittest.TestCase):
  def test_not_run(self):
    pass

九、断言

预期结果与测试后结果对比

• 基本布尔型断言(掌握常用即可)

断言方法	断言描述
assertEqual(arg1, arg2, msg=None)	验证arg1=arg2，不等则fail 【掌握】
assertNotEqual(arg1, arg2, msg=Non	验证arg1 != arg2, 相等则fail
assertTrue(expr, msg=None)	验证expr是true，如果为false，则fail
assertFalse(expr,msg=None)	验证expr是false，如果为true，则fail
assertIsNone(expr, msg=None)	验证expr是None，不是则fail
assertIsNotNone(expr, msg=None)	验证expr不是None，是则fail
assertIn(arg1, arg2, msg=None)	验证arg1是arg2的子串，不是则fail【掌握】

import unittest


def add(a, b):
    return a + b


# 继承unittest.TestCase类
class TestCase01(unittest.TestCase):
    # 方法名必须以test开头
    def testcase_01(self):
        print("testcase_01")
        print("1 + 1 = ", add(1, 1))
        try:
        # 判断args1与args2
            self.assertEqual(2, add(1, 2))
        except AssertionError as e:
            print("报错信息", e)
            raise

    def testcase_02(self):
        print("testcase_02")
        print("2 + 2 = ", add(2, 2))
        try:
        # 判断args1 in args2是否成立，正确则True，否则为False
            self.assertIn('124', '123456')
        except AssertionError as e:
            print(e)
            raise

    def testcase_03(self):
        print("testcase_03")
        print("3 + 3 = ", add(3, 3))


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

# 结果：
testcase_01
FF.
1 + 1 =  2
报错信息 2 != 3
======================================================================
testcase_02
FAIL: testcase_01 (__main__.TestCase01)
2 + 2 =  4
----------------------------------------------------------------------
'124' not found in '123456'
Traceback (most recent call last):
testcase_03
  File "C:/Users/x1c/Desktop/untitled/mocktest.py", line 15, in testcase_01
3 + 3 =  6
    self.assertEqual(2, add(1, 2))
AssertionError: 2 != 3

======================================================================
FAIL: testcase_02 (__main__.TestCase01)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "C:/Users/x1c/Desktop/untitled/mocktest.py", line 24, in testcase_02
    self.assertIn('124', '123456')
AssertionError: '124' not found in '123456'

----------------------------------------------------------------------
Ran 3 tests in 0.001s

FAILED (failures=2)

十、生成测试报告HTML格式

from demo6_unittest_testcase import TestCase01
from tools.HTMLTestRunner import HTMLTestRunner # 导入测试报告文件
import unittest

# 使用suite导入测试用例
# suite = unittest.TestSuite()
# suite.addTest(unittest.makeSuite(TestCase01))

# 使用discover导入测试用例
discover = unittest.defaultTestLoader.discover("./cases", pattern='*.py')

with open("./reports/haha.html", "wb") as f:
    h = HTMLTestRunner(stream=f, title="测试报告", description="windows chrome")
    h.run(discover)

十一、完整的接口测试用例

一条完整的测试接口用例需要包含：
数据准备：准备测试数据，可手工准备，也可使用代码准备（通常涉及数据库操作）

环境检查：如果手工准备的数据，连接数据库进行环境检查会使用例更健壮

发送请求：发送接口请求

响应断言/数据库断言：响应断言后，还需要进行数据库断言，以确保接口数据库操作的正确性

数据清理：如果接口有更数据库操作，断言结束后需要还原更改

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

# 数据准备
NOT_EXIST_USER = 'admin'
EXIST_USER = 'cccccc'


class TestUserReg(unittest.TestCase):
    url = 'http://192.168.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_开头

测试集嵌套

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)

十三、生成测试报告

1、生成文本报告

import unittest

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

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

2、生成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="KK").run(suite)
f.close()

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

十四、总结

作为单元测试的框架， unittest 也是可以对程序最小模块的一种敏捷化的测试。在自动化测试中，必须需要知道所使用语言的单元测试框架

利用单元测试框架，创建一个类，该类继承unittest的TestCase，这样可以把每个case看成是一个最小的单元， 由测试容器组织起来，同时引入测试报告

---