python单元测试：unittest

1 unittest 简介

unittest是python内置的用于测试代码的模块，无需安装， 使用简单方便。

unittest case的运行流程：

写好一个完整的TestCase
多个TestCase 由TestLoder被加载到TestSuite里面, TestSuite也可以嵌套TestSuite
由TextTestRunner来执行TestSuite，测试的结果保存在TextTestResult中
TestFixture指的是环境准备和恢复
unittest中最核心的部分是：TestFixture、TestCase、TestSuite、TestRunner

2 Test Fixture

用于测试环境的准备和恢复还原, 一般用到下面几个函数。

• setUp()：准备环境，执行每个测试用例的前置条件
• tearDown()：环境还原，执行每个测试用例的后置条件
• setUpClass()：必须使用@classmethod装饰器，所有case执行的前置条件，只运行一次
• tearDownClass()：必须使用@classmethod装饰器，所有case运行完后只运行一次

3 Test Case

TestCase的实例是最小的可测试单元。 testcase 是由unittest的TestCase类的实例表示的。要编写自己的测试用例必须继承TestCase类,或者使用FunctionTestCase。且Testcase类提供了各种assert的方法来检测预期结果和实际结果。

• 参数verbosity可以控制错误报告的详细程度：默认为1。0，表示不输出每一个用例的执行结果；2表示详细的执行报告结果。
• Verbosity=1情况下成功是 .，失败是 F，出错是 E，跳过是 S
• 测试的执行跟方法的顺序没有关系, 默认按字母顺序
• 每个测试方法均以 test 开头
• Verbosity=2情况下会打印测试的注释

被测代码，demo.py文件

#!/usr/bin/python
# -*- coding: utf-8 -*-

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

def minus(a, b):
    return a-b

测试case， test_demo_class.py文件

#!/usr/bin/python
# -*- coding: utf-8 -*-

import unittest
from demo import add, minus


class TestDemo(unittest.TestCase):
    """Test mathfuc.py"""

    @classmethod
    def setUpClass(cls):
        print ("this setupclass() method only called once.\n")

    @classmethod
    def tearDownClass(cls):
        print ("this teardownclass() method only called once too.\n")

    def setUp(self):
        print ("do something before test : prepare environment.\n")

    def tearDown(self):
        print ("do something after test : clean up.\n")

    def test_add(self):
        """Test method add(a, b)"""
        self.assertEqual(3, add(1, 2))
        self.assertNotEqual(3, add(2, 2))

    def test_minus(self):
        """Test method minus(a, b)"""
        self.assertEqual(1, minus(3, 2))
        self.assertNotEqual(1, minus(3, 2))

    @unittest.skip("do't run as not ready")
    def test_minus_with_skip(self):
        """Test method minus(a, b)"""
        self.assertEqual(1, minus(3, 2))
        self.assertNotEqual(1, minus(3, 2))


if __name__ == '__main__':
    # verbosity=*：默认是1；设为0，则不输出每一个用例的执行结果；2-输出详细的执行结果
    unittest.main(verbosity=1)

unittest.main(): 使用她可以方便的将一个单元测试模块变为可直接运行的测试脚本，main()方法使用TestLoader类来搜索所有包含在该模块中以“test”命名开头的测试方法，并自动执行他们。执行方法的默认顺序是：根据ASCII码的顺序加载测试用例，数字与字母的顺序为：0-9，A-Z，a-z。所以以A开头的测试用例方法会优先执行，以a开头会后执行。
unittest.skip(): 装饰器，当运行用例时，有些用例可能不想执行等，可用装饰器暂时屏蔽该条测试用例。一种常见的用法就是比如说想调试某一个测试用例，想先屏蔽其他用例就可以用装饰器屏蔽。

• @unittest.skip(reason): skip(reason)装饰器：无条件跳过装饰的测试，并说明跳过测试的原因。
• @unittest.skipIf(reason): skipIf(condition,reason)装饰器：条件为真时，跳过装饰的测试，并说明跳过测试的原因。
• @unittest.skipUnless(reason): skipUnless(condition,reason)装饰器：条件为假时，跳过装饰的测试，并说明跳过测试的原因。
• @unittest.expectedFailure(): expectedFailure()测试标记为失败。

4 常用断言

assert*(): 一些断言方法：在执行测试用例的过程中，最终用例是否执行通过，是通过判断测试得到的实际结果和预期结果是否相等决定的。

• assertEqual(a,b，[msg=‘测试失败时打印的信息’]):断言a和b是否相等，相等则测试用例通过。
• assertNotEqual(a,b，[msg=‘测试失败时打印的信息’]):断言a和b是否相等，不相等则测试用例通过。
• assertTrue(x，[msg=‘测试失败时打印的信息’])：断言x是否True，是True则测试用例通过。
• assertFalse(x，[msg=‘测试失败时打印的信息’])：断言x是否False，是False则测试用例通过。
• assertIs(a,b，[msg=‘测试失败时打印的信息’]):断言a是否是b，是则测试用例通过。
• assertNotIs(a,b，[msg=‘测试失败时打印的信息’]):断言a是否是b，不是则测试用例通过。
• assertIsNone(x，[msg=‘测试失败时打印的信息’])：断言x是否None，是None则测试用例通过。
• assertIsNotNone(x，[msg=‘测试失败时打印的信息’])：断言x是否None，不是None则测试用例通过。
• assertIn(a,b，[msg=‘测试失败时打印的信息’])：断言a是否在b中，在b中则测试用例通过。
• assertNotIn(a,b，[msg=‘测试失败时打印的信息’])：断言a是否在b中，不在b中则测试用例通过。
• assertIsInstance(a,b，[msg=‘测试失败时打印的信息’])：断言a是是b的一个实例，是则测试用例通过。
• assertNotIsInstance(a,b，[msg=‘测试失败时打印的信息’])：断言a是是b的一个实例，不是则测试用例通过。

5 Test Suite与Test Loder

unittest框架的TestSuite()类是用来创建测试套件的。

• 一般通过addTest()或者addTests()向suite中添加。case的执行顺序与添加到Suite中的顺序是一致的

TestLoadder用来加载TestCase到TestSuite中。

• loadTestsFrom*()方法从各个地方寻找testcase，创建实例，然后addTestSuite，再返回一个TestSuite实例
• defaultTestLoader() 与 TestLoader()功能差不多，复用原有实例

unittest.TestLoader().loadTestsFromTestCase(testCaseClass)
unittest.TestLoader().loadTestsFromModule(module)
unittest.TestLoader().loadTestsFromName(name,module=None)
unittest.TestLoader().loadTestsFromNames(names,module=None)
unittest.TestLoader().discover()

unittest.TextTextRunner(): unittest框架的TextTextRunner()类，通过该类下面的run()方法来运行suite所组装的测试用例，入参为suite测试套件。

• run(): run()方法是运行测试套件的测试用例，入参为suite测试套件。

实例如下， test_demo_module.py文件

#!/usr/bin/python
# -*- coding: utf-8 -*-
import sys
import HTMLReport
import unittest
import test_demo_class
from test_demo_class import TestDemo


if __name__ == '__main__':
    paras = sys.argv[1:]
    args = paras[0]
    report = paras[1]

    suite = unittest.TestSuite()
    if args == 'test':
        tests = [TestDemo("test_minus"), TestDemo("test_add"), TestDemo("test_minus_with_skip")]
        suite.addTests(tests)
    elif args == 'tests':
        suite.addTest(TestDemo("test_minus"))
        suite.addTest(TestDemo("test_add"))
        suite.addTest(TestDemo("test_minus_with_skip"))
    elif args == 'class':
        suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestDemo))
    elif args == 'module':
        suite.addTests(unittest.TestLoader().loadTestsFromModule(test_demo_class))
    elif args == 'mix':
        suite.addTests(unittest.TestLoader().loadTestsFromName('test_demo_class.TestDemo.test_minus'))
    elif args == 'mixs':
        suite.addTests(unittest.TestLoader().loadTestsFromNames(['test_demo_class.TestDemo.test_minus', 'test_demo_class.TestDemo', 'test_demo_class']))
    elif args == 'discover':
        suite.addTests(unittest.TestLoader().discover('.', 'test_*.py', top_level_dir=None))

    if report == 'terminal':
        runner = unittest.TextTestRunner(verbosity=1)
        runner.run(suite)
    elif report == 'txt':
        with open('ut_log.txt', 'a') as fp:
            runner = unittest.TextTestRunner(stream=fp, verbosity=1)
            runner.run(suite)
    elif report == 'html':
        runner = HTMLReport.TestRunner(report_file_name='test',
                               output_path='report',
                               title='测试报告',
                               description='测试描述',
                               sequential_execution=True
                               )
        runner.run(suite)

6 Testing Report

终端报告： 如上terminal 分支
TXT报告： 如上txt 分支，当前目录会生成ut_log.txt文件
HTML 报告：如上html 分支，终端上打印运行信息同时会在当前目录生成report文件夹， 文件夹下有test.html和test.log文件 更多见Python 单元测试 - HTML report

参考文章：

1. Python 单元测试 - unittest
2. python之Unittest模块学习
3. python_unittest详解
4. Python+unittest UI自动化