Python单元测试unittest - 单元测试框架

2023-07-20 21:36:40

一、unittest简介

　　unitest单元测试框架最初是有JUnit的启发，它支持测试自动化，共享测试的设置和关闭代码，将测试聚合到集合中，以及测试与报告框架的独立性。

二、unittest相关概念

TestFixture:表示测试一个或多个测试的时候，需要的一些相关动作，比如，创建临时或代理数据库，目录或启动服务器进程。测试代码的这种工作环境称为夹具。
TestCase（测试用例）:就是测试的各个单元，他检查对特定输入集的特定响应，unitest提供了一个基类，TestCase用于创建新的测试用例。
TestSuite（测试套件）:多个测试用例集合在一起。测试用例实例根据他们测试的功能组合在一起，unittest为此提供了一个机制:测试套件。
TestRunner:执行测试用例的，测试的结果会保存至TestResult实例中，包括运行了多少测试用例，成功了多少，失败了多少等信息。
TestLoader()：可用于自动创建测试套件并使用单个测试填充它的过程。
运行各种测试用例的顺序是通过根据字符串的内置顺序对测试函数名称进行排序调用。

三、断言方法表

检查并报告故障

    assertEqual(a, b)            a == b

    assertNotEqual(a, b)        a != b

    assertTrue(x)                bool(x) is True

    assertFalse(x)                bool(x) is False

    assertIs(a, b)                a is b                    3.1

    assertIsNot(a, b)            a is not b                3.1

    assertIsNone(x)                x is None                3.1

    assertIsNotNone(x)            x is not None            3.1

    assertIn(a, b)                a in b                    3.1

    assertNotIn(a, b)            a not in b                3.1

    assertIsInstance(a, b)        isinstance(a, b)        3.2

    assertNotIsInstance(a, b)    not isinstance(a, b)    3.2

检查异常、警告、日志消息生成

    assertRaises(exc, fun, *args, **kwds)    fun(*args, **kwds)提高EXC

    assertRaisesRegex(exc, r, fun, *args, **kwds)    fun(*args, **kwds)提出exc 并且消息匹配正则表达式r    3.1

    assertWarns(warn, fun, *args, **kwds)    fun(*args, **kwds)提出警告    3.2

    assertWarnsRegex(warn, r, fun, *args, **kwds)    fun(*args, **kwds)提出警告 和消息的正则表达式匹配ř    3.2

    assertLogs(logger, level)    该with块 以最低级别登录记录器    3.4

四、示例

import unittest

class TestStringMethods(unittest.TestCase):

    def test_upper(self):

        self.assertEqual('foo'.upper(), 'FOO')

    def test_isupper(self):

        self.assertTrue('FOO'.isupper())

        self.assertFalse('FOO'.islower())

    def test_split(self):

        s = "Hello World"

        self.assertEqual(s.split(), ['Hello', 'World'])

        with self.assertRaises(TypeError):

            s.split(2)

if __name__ == '__main__':

    unittest.main()

首先通过unittest.TestCase子类创建测试用例
通过以test开头的三个方法
assertEqual()检查预期结果
assertTrue()或assertFalse()核实情况
assertRaises()验证是否引发了特定异常
使用这些方法代替assert语句，以便测试运行器可以累积所有测试结果并生成报告

setUp():在每个测试用例执行之前执行
tearDown():在每个测试用例执行之后执行

五、运行测试用例

unittest.main()提供了测试脚本的命令行界面
python BaseExample.py -v 传入-v标志来运行具有更多详细信息的测试用例

python -m unittest test_module1 test_module2
python -m unittest test_module.TestClass
python -m unittest test_module.TestClass.test_method

六、生成测试报告

# coding=utf-8

import unittest

import HtmlTestRunner

class TestSuiteExample(unittest.TestCase):

    def test_equal(self):

        s = "Hello"

        self.assertEqual(s, "Hello")

    def test_upper(self):

        s = "FOO"

        self.assertEqual('FOO', s)

    def test_lower(self):

        s = "foo"

        self.assertTrue(s.islower())

if __name__ == '__main__':

    # 创建一个测试集合

    f = open('./test_suite_example.html')

    test_suite = unittest.TestSuite()

    loader = unittest.TestLoader()

    # 向测试套件中添加测试用例

    # test_suite.addTest(test=TestSuiteExample("test_equal"))

    # 使用loader添加所有的测试方法

    tests = loader.loadTestsFromTestCase(TestSuiteExample)

    test_suite.addTests(tests=tests)

    # 打开文件，用于生成html

    runner = HtmlTestRunner.HTMLTestRunner(output="D:/python/")

    runner.run(test_suite)

HtmlTestRunner 需要单独安装

pip install html-testRunner==1.0.3

向套件中添加测试用例使用addTest()和addTests()

addTest(test)

    Add a TestCase or TestSuite to the suite.

addTests(tests)

    Add all the tests from an iterable of TestCase and TestSuite instances to this test suite.

    This is equivalent to iterating over tests, calling addTest() for each element.

七、跳过测试和预期的失败

unittest支持跳过单个测试甚至整个测试类，它支持将测试标记为"预期失败",但不应该视为TestResult失败

import sys

import unittest

class MyTestCase(unittest.TestCase):

    @unittest.skip("跳过测试")

    def test_nothing(self):

        self.fail("没有发生")

    @unittest.skipIf(1 > 0, "如果真，则跳过")

    def test_format(self):

        self.assertTrue(1 < 0)

    @unittest.skipUnless(sys.platform.startswith("win"),"requires Windows")

    def test_upper(self):

        s = "hh"

        self.assertEqual('HH',s.upper())

if __name__ == '__main__':

    unittest.main()

八、TestCase(测试用例)

TestCase类的实例表示unittest中最小的测试单元，此类旨在用作基类，具体的测试有气子类实现，此类实现测试运行期所需的接口以允许其驱动测试

setUp()：调用准备测试夹具的方法，在调用测试方法之前立即调用它。
tearDown(): 调用测试方法后立即调用此方法并记录结果。即使测试方法引发了异常，也会调用此方法。
setUpClass():运行测试类中所有测试方法之前调用，必须装饰为@classmethod
tearDownClass():已经运行测试类中所有的测试方法才会调用，必须装饰@classmethod
run():运行测试，将结果收集到结果对象中，结果对象不会返回给run()调用者
skipTest():跳过此测试方法

九、TestSuite(分组测试)

此类表示各个测试用例和测试套件的集合，该类提供了测试运行器所需的接口，以允许他像其他任何测试用例一样运行

addTest():添加一个TestCase或TestSuite到套件
addTests():将可迭代的TestCase或TestSuite实例中所有测试添加到测试套件中
run():运行与此套件关联的测试

十、TestLoader(加载和运行测试)

TestLoader类被用于创建TestSuite从模块或类中。通常，不需要创建此类的实例，unittest模块提供了一个可以共享的实例unittest.defaultTestLoader()

loadTestsFromTestCase(testCaseClass):从testCaseClase中返回一个包含所有测试用例的suite
loadTestsFromModule(module):从提供的module中返回一个包含所有测试用例的suite，此方法在模块中所有派生来自TestCase的类，并为每个TestCase子类创建实例
loadTestsFromName(name, module=None)
loadTestFromNames(names, module=None)

十一、TestResult

此类用于编译有关哪些测试成功以及哪些测试失败的信息

一个TestResult对象存储一组测试结果，有以下属性：

errors:包含2元组TestCase实例和包含格式化回溯的字符串的列表。每个元组代表一个引发意外异常的测试。
failures:包含2元组TestCase实例和包含格式化回溯的字符串的列表
skipped:包含2元组TestCase实例和字符串的列表，其中包含跳过测试的原因。

十二、其他

unittest.defaultTestLoader：TestLoader要共享的类的实例。如果不需要自定义，TestLoader则可以使用此实例而不是重复创建新实例。

unittest.main：一个命令行程序，它从模块加载一组测试并运行它们; 这主要是为了使测试模块可以方便地执行

码农公寓