单元测试自动化-unittest基本介绍

查看所有的unittest的成员

import unittest
# dir() 查看所有成员
print(dir(unittest))

# ['BaseTestSuite', 'FunctionTestCase', 'IsolatedAsyncioTestCase', 'SkipTest', 'TestCase', 'TestLoader', 'TestProgram', 'TestResult', 'TestSuite', 'TextTestResult', 'TextTestRunner', '_TextTestResult', '__all__', '__builtins__', '__cached__', '__dir__', '__doc__', '__file__', '__getattr__', '__loader__', '__name__', '__package__', '__path__', '__spec__', '__unittest', 'addModuleCleanup', 'case', 'defaultTestLoader', 'expectedFailure', 'findTestCases', 'getTestCaseNames', 'installHandler', 'load_tests', 'loader', 'main', 'makeSuite', 'registerResult', 'removeHandler', 'removeResult', 'result', 'runner', 'signals', 'skip', 'skipIf', 'skipUnless', 'suite', 'util']

上面的代码中，我们就引入了Unittest模块， 同时可以通过打印发现Unittest框架中内置了大量的工具成员。这些工具成员中除了以下5个以外，其他的都不怎么常用。

  • TestCase（测试用例）

    是unittest中最重要的一个类，用于编写测试用例类，是所有测试用例类的父类，实现了测试用例的基本代码。

  • TestSuite（测试套件、测试集）

    可以把多个TestCase组织、打包集成到一个测试集中一起执行，TestSuite可以实现多个测试用例的执行。

  • TextTestRunner（测试运行器）

    TestSuite本身不具备执行的功能，所以使用TextTestRunner执行测试套件和输出测试结果。

  • TestLoader（测试加载器）

    用于加载测试用例TestCase，并生成测试套件TestSuite，实现自动从代码中加载大量测试用例到测试套件中。

  • TestFixture（测试脚手架）

    所谓的测试脚手架就是为了开展一项或多项测试所需要进行的准备工作，以及所有相关的清理操作。测试脚手架实际上会在执行一些测试代码之前与之后，让我们编写一些初始化和销毁的代码。

测试用例的编写

测试用例-TestCase

前面讲到TestCase就是提供给我们编写测试用例的测试代码的，那么怎么编写一个测试用例？需要4个步骤即可。

  1. 导入unittest模块

    import unittest

  2. 定义测试用例类

    import unittest
class 测试用例类名(unittest.TestCase): # 所有的测试用例类都必须直接或者间接继承unittest.TestCase.
    """测试用例"""
    pass

  3. 定义测试用例方法（此处的测试用例方法，就是上面所说的测试用例设计方法中的一行信息的测试代码）

    import unittest
class 测试用例类名(unittest.TestCase):
    """测试用例"""
    # ....
    def test_测试方法名(参数):  # 测试方法必须以test开头或test_开头
        pass
    # ....

  4. 执行测试用例

    unittest.main()

在实际工作中，我们肯定是在项目中进行测试代码的编写或单独编写一个测试项目，但是我们现在刚开始学习，所以我们可以先编写一个例子代码，对其进行测试，以达到学习的目的。

unittest_01_测试用例的编写.py，代码：

import unittest

# 被测试的代码单元
def add(x,y):
    return x+y

class FuncTest(unittest.TestCase):
    """测试用例"""
    def test_01(self):
        print(add(10, 20))

    def test_02(self):
        print(add("hello", "world"))

    # def test_03(self):
    #     print(add("hello", 20))

# 因为pycharm本身内置了执行unittest的功能，所以不适用以下代码也能执行，但是终端下或者使用其他的代码编辑器时，则需要加上。
if __name__ == '__main__':
    unittest.main()

测试套件-TestSuite & 测试运行器-TextTestRunner

前面我们将到测试套件，主要用于把多个测试用例类打包集成到一个测试集中一起执行。工作中，一个项目往往需要编写非常多的测试用例，而那么多的测试用例也不可能只编写在一个文件中，此时就需要使用测试套件了。2个步骤：

  1. 通过unittest.TestSuite实例化测试套件对象

    suite = unittest.TestSuite()

  2. 通过addTest方法添加测试用例

    • 添加测试用例方法

      # 添加测试用例方法
suite.addtest(测试用例类名("测试用例方法名"))

# 批量添加测试用例方法
test_data = (测试用例类名("测试用例方法名1"), 测试用例类名("测试用例方法名2"))
suite.addtests(test_data)

    • 添加测试用例类(一次性添加测试用例的所有test_方法)

      # 添加测试用例类
suite.addtest(unittest.makeSuite(测试用例类名))

# 批量添加测试用例类
test_data = (unittest.makeSuite(测试用例类名1),  unittest.makeSuite(测试用例类名2))
suite.addTests(test_data)

unittest_02_测试套件的基本使用.py，代码：

import unittest

# 导入unittest_01_测试用例的编写的代码
import unittest_01_测试用例的编写 as unittest_01

# 创建一个unittest 的实例化测试套件对象
suite = unittest.TestSuite()

# # 添加单个测试用例方法
# suite.addTest(unittest_01.FuncTest("test_01"))
# suite.addTest(unittest_01.FuncTest("test_02"))

# # 批量添加测试用例方法
# test_data = (unittest_01.FuncTest("test_01"),unittest_01.FuncTest("test_02"))
# suite.addTests(test_data)

# # 添加单个测试用例类
# suite.addTest(unittest.makeSuite(unittest_01.FuncTest))

# 批量多个测试用例类
test_data = (unittest.makeSuite(unittest_01.FuncTest),unittest.makeSuite(unittest_01.FuncTest))
suite.addTests(test_data)



# 运行方法
if __name__ == '__main__':
	# 实例化运行器对象
    runner = unittest.TextTestRunner()
	# 通过run方法执行测试
    runner.run(suite)

TestSuite的作用仅仅是把多个测试用例打包集成到一块，但是并没有提供批量执行测试用例的方法，所以我们需要使用TextTestRunner了。

测试加载器-TestLoader

前面说过，用于加载测试用例TestCase，并生成测试套件TestSuite，实现自动从代码中加载大量测试用例到测试套件中。2个步骤：

  • 实例化unittest.TestLoader对象

    loader = unittest.TestLoader()

  • 使用discover方法自动搜索指定目录下指定文件格式的python模块，并把查找到的测试用例组装打包集成到测试组件作为返回值。

    loader.discover(目录路径, pattern="文件名格式")

    注意：pattern支持*号表示0到多个字符。

unittest_04_测试加载器基本使用.py，代码：

import unittest
loader = unittest.TestLoader()
# 在当前目录下，搜索以unittest开头作为文件名的所有python文件，并把文件中的测试用例类打包集成到测试套件中
suite =loader.discover("./", pattern="unittest*.py")

if __name__ == '__main__':
    runner = unittest.TextTestRunner()
    runner.run(suite)

测试脚手架-TestFixture

前面提到，测试脚手架会在执行一些测试代码之前与之后，让我们编写一些初始化和销毁的代码，主要分三个级别：

  • 方法级别：在方法执行前与执行后都提供自动调用的实例方法

    setUp和tearDown

  • 类级别：在类执行前与执行后都提供自动调用的类方法，不管类中有多少方法，只执行一次。

    setUpClass和tearDownClass

  • 模块级别：在模块执行前与执行后都提供自动调用的函数，不管模块中有多少类或方法，只执行一次。

    setUpModule和tearDownModule

方法级别的脚手架

在测试用例类中提供了2个固定名字的实例方法（setUp与tearDown），用于完成方法执行前与执行后的操作。

unittest_05_测试脚手架_方法级别的脚手架.py，代码：

import unittest

# 被测试的代码单元
def add(x,y):
    return x+y

class AddTest(unittest.TestCase):
    """测试用例"""
    def setUp(self):
        print("每个方法执行前都会执行一遍setUp实例方法，用于完成通用的前置操作或初始化工作")

    def tearDown(self):
        print("每个方法执行后都会执行一遍tearDown实例方法，用于完成通用的后置操作或销毁工作")

    def test_01(self):
        print(add(10, 20))

    def test_03(self):
        print(add("hello", 20))


# 因为pycharm本身内置了执行unittest的功能，所以不适用以下代码也能执行，但是终端下或者使用其他的代码编辑器时，则需要加上。
if __name__ == '__main__':
    unittest.main()
类级别的脚手架

在测试用例类中提供了2个固定名字的类方法（setUpClass与tearDownClass），用于完成类执行前与执行后的操作。

unittest_06_测试脚手架_类级别的脚手架.py，代码：

import unittest

# 被测试的代码单元
def add(x,y):
    return x+y

class AddTest(unittest.TestCase):
    """测试用例"""
	# 注意：类级别的脚手架的方法名，固定是setUpClass与tearDownClass,都是类方法
    @classmethod
    def setUpClass(cls):
        print("当前类执行前都会执行一遍setUpClass类方法，用于完成通用的前置操作或初始化工作")

    @classmethod
    def tearDownClass(cls):
        print("当前类执行后都会执行一遍tearDownClass类方法，用于完成通用的后置操作或销毁工作")

    def test_01(self):
        print(add(10, 20))

    def test_03(self):
        print(add("hello", 20))


# 因为pycharm本身内置了执行unittest的功能，所以不适用以下代码也能执行，但是终端下或者使用其他的代码编辑器时，则需要加上。
if __name__ == '__main__':
    unittest.main()
模块级别的脚手架

在测试用例类中提供了2个固定名字的函数（setUpModule与tearDownModule），用于完成类执行前与执行后的操作。

unittest_07_测试脚手架_模块级别的脚手架.py，代码：

import unittest


def setUpModule():
    print("当前模块执行前都会执行一遍setUpModule函数，用于完成通用的前置操作或初始化工作")


def tearDownModule():
    print("当前模块执行前都会执行一遍tearDownModule函数，用于完成通用的前置操作或初始化工作")


# 被测试的代码单元
def add(x, y):
    return x + y


class AddTest1(unittest.TestCase):
    """测试用例"""

    @classmethod
    def setUpClass(cls):
        print("当前类执行前都会执行一遍setUpClass类方法，用于完成通用的前置操作或初始化工作")

    @classmethod
    def tearDownClass(cls):
        print("当前类执行后都会执行一遍tearDownClass类方法，用于完成通用的后置操作或销毁工作")

    def test_01(self):
        print(add(10, 20))


class AddTest2(unittest.TestCase):
    """测试用例"""

    @classmethod
    def setUpClass(cls):
        print("当前类执行前都会执行一遍setUp方法，用于完成通用的前置操作或初始化工作")

    @classmethod
    def tearDownClass(cls):
        print("当前类执行后都会执行一遍tearDown方法，用于完成通用的后置操作或销毁工作")

    def test_03(self):
        print(add("hello", 20))


# 因为pycharm本身内置了执行unittest的功能，所以不适用以下代码也能执行，但是终端下或者使用其他的代码编辑器时，则需要加上。
if __name__ == '__main__':
    unittest.main()

生成HTML格式测试报告(很少使用，基本不使用)

使用HTMLTestRunner模块可以直接生成HTML格式的报告。HTMLTestRunner是一个不再维护的第三方的模块，通过pip工具安装不了，只能下载后手动导入。

HTMLTestRunner官网：http://tungwaiyip.info/software/HTMLTestRunner.html

HTMLTestRunner下载：http://tungwaiyip.info/software/HTMLTestRunner_0_8_2/HTMLTestRunner.py

因为HTMLTestRunner是python2模块的，所以在python3.x以后需要做些修改才可以使用
打印HTML格式的测试报告，unittest_08_打印HTML格式的测试报告.py，代码：

import unittest
from HTMLTestRunner import HTMLTestRunner
import unittest_01_测试用例的编写 as unittest_01

suite = unittest.TestSuite()

test_data = (unittest.makeSuite(unittest_01.FuncTest),  unittest.makeSuite(unittest_01.FuncTest))
suite.addTests(test_data)

if __name__ == '__main__':
    # 生成html报告
    with open("test_report.html", "wb") as file:
        runner = HTMLTestRunner(
            stream=file,
            title="单元测试的HTML格式报告",
            description="python单元测试报告",
            tester="墨落"
        )
        runner.run(suite)

单元测试自动化-断言

断言(assertion)是一种在程序中的判断测试用例执行结果是否符合预期结果的方式，所以断言也被称之为“期望”。当程序执行到断言的位置时，对应的断言应该为真。若断言不为真时，程序会中止执行，并给出错误信息。

unittest中常用的断言方法（加粗为重要方法）：

断言方法 断言描述
assertEqual(arg1, arg2, msg=None) 验证arg1=arg2，不等则fail
assertNotEqual(arg1, arg2, msg=None) 验证arg1 != arg2, 相等则fail
assertTrue(expr, msg=None) 验证expr是true，如果为false，则fail
assertFalse(expr,msg=None) 验证expr是false，如果为true，则fail
assertIs(arg1, arg2, msg=None) 验证arg1、arg2是同一个对象，不是则fail
assertIsNot(arg1, arg2, msg=None) 验证arg1、arg2不是同一个对象，是则fail
assertIsNone(expr, msg=None) 验证expr是None，不是则fail
assertIsNotNone(expr, msg=None) 验证expr不是None，是则fail
assertIn(arg1, arg2, msg=None) 验证arg1是arg2的子串，不是则fail
assertNotIn(arg1, arg2, msg=None) 验证arg1不是arg2的子串，是则fail
assertIsInstance(obj, cls, msg=None) 验证obj是cls的实例，不是则fail
assertNotIsInstance(obj, cls, msg=None) 验证obj不是cls的实例，是则fail
posted @ 2024-09-16 10:45  布丁家的苏苏  Views(17)  Comments(0)    收藏  举报