Python之单元测试模块unittest

一、单元测试定义：

单元测试是用来对一个模块、一个函数或者一个类来进行正确性检验的测试工作。

举例说明：对函数abs()，我们可以编写出以下几个测试用例

• 正数，比如1、1.2、0.99，期待返回值与输入相同；
• 输入负数，比如-1、-1.2、-0.99，期待返回值与输入相反；
• 输入0，期待返回0；
• 输入非数值类型，比如None、[]、{}，期待抛出TypeError。

把上面的测试用例放到一个测试模块里，就是一个完整的单元测试。
　　如果单元测试通过，说明我们测试的这个函数能够正常工作。如果单元测试不通过，要么函数有bug，要么测试条件输入不正确，总之，需要修复使单元测试能够通过。
　　单元测试通过后有什么意义呢？如果我们对abs()函数代码做了修改，只需要再跑一遍单元测试，如果通过，说明我们的修改不会对abs()函数原有的行为造成影响，如果测试不通过，说明我们的修改与原有行为不一致，要么修改代码，要么修改测试。
　　这种以测试为驱动的开发模式最大的好处就是确保一个程序模块的行为符合我们设计的测试用例。在将来修改的时候，可以极大程度地保证该模块行为仍然是正确的。

二、单元测试类的编写

• 编写单元测试时，我们需要编写一个测试类，从unittest.TestCase继承。
• 以test开头的方法就是测试方法，不以test开头的方法不被认为是测试方法，测试的时候不会被执行。
• 对每一类测试都需要编写一个test_xxx()方法。由于unittest.TestCase提供了很多内置的条件判断，我们只需要调用这些方法就可以断言输出是否是我们所期望的。

我们来编写一个Dict类，这个类的行为和dict一致。为这个类编写一个单元测试。

# 导入单元测试模块
import unittest

# 自定义一个Dict类，继承dict
class Dict(dict):

    # 初始化Dict，调用父类的init方法
    def __init__(self, **kw):
        super().__init__(**kw)

    def __getattr__(self, key):
        try:
            return self[key]
        except KeyError:
            raise AttributeError(r"'Dict' object has no attribute '%s'" % key)

    def __setattr__(self, key, value):
        self[key] = value

# 编写单元测试时，我们需要编写一个测试类，从unittest.TestCase继承
class TestDict(unittest.TestCase):
    """
    以test开头的方法就是测试方法，不以test开头的方法
    不被认为是测试方法，测试的时候不会被执行。
    """
    # 可以在单元测试中编写两个特殊的setUp()和tearDown()方法。
    # 这两个方法会分别在每调用一个测试方法的前后分别被执行。
    def setUp(self):
        print("setup....")

    def tearDown(self):
        print("teardown.....")

    # 类的初始化测试方法
    def test_init(self):
        d = Dict(a=1, b='test')
        self.assertEqual(d.a, 1)
        self.assertEqual(d.b, 'test')
        self.assertTrue(isinstance(d, dict))

    # 字典的key测试
    def test_key(self):
        d = Dict()
        d['key'] = 'value'
        self.assertEqual(d.key, 'value')

    # 字典的属性访问测试
    def test_attr(self):
        d = Dict()
        d.key = 'value'
        self.assertTrue('key' in d)
        self.assertEqual(d['key'], 'value')

    # 通过d['empty']访问不存在的key时，抛出KeyError错误
    def test_keyerror(self):
        d = Dict()
        with self.assertRaises(KeyError):
            value = d['empty']

    # 通过d.empty访问不存在的key时，抛出AttributeError错误
    def test_attrerror(self):
        d = Dict()
        with self.assertRaises(AttributeError):
            value = d.empty

if __name__ == '__main__':
    unittest.main()  # 执行测试单元测试

最常用的断言就是assertEqual()：
elf.assertEqual(abs(-1), 1) # 断言函数返回的结果与1相等
另一种重要的断言就是期待抛出指定类型的Error，比如通过d['empty']访问不存在的key时，断言会抛出KeyError：
with self.assertRaises(KeyError):
　　value = d['empty']
通过d.empty访问不存在的key时，我们期待抛出AttributeError：
with self.assertRaises(AttributeError):
　　value = d.empty

运行单元测试的两种钩子方法：
1、编写好单元测试，我们就可以运行单元测试。最简单的运行方式是在mydict_test.py的最后加上两行代码：
if __name__ == '__main__':
　　unittest.main()
2、另一种方法是在命令行通过参数-m unittest直接运行单元测试:python3 -m unittest mydict_test/mydict_test.py xx.py
这是推荐的做法，因为这样可以一次批量运行很多单元测试，并且，有很多工具可以自动来运行这些单元测试。

setUp与tearDown方法
　　可以在单元测试中编写两个特殊的setUp()和tearDown()方法。这两个方法会分别在每调用一个测试方法的前后分别被执行。
　　setUp()和tearDown()方法有什么用呢？设想你的测试需要启动一个数据库，这时，就可以在setUp()方法中连接数据库，在tearDown()方法中关闭数据库，这样，不必在每个测试方法中重复相同的代码。

三、单元测试小示例：

对自定义的Student类的单元测试：

import unittest

class Student(object):
    def __init__(self, name, score):
        self.name = name
        self.score = score

    def get_grade(self):
        if self.score > 100 or self.score < 0:
            raise ValueError('invalid value: %s' % self.score)
        if 60<=self.score<80:
            return 'B'
        if 80<=self.score <= 100:
            return 'A'
        return 'C'

class TestStudent(unittest.TestCase):

    def test_80_to_100(self):
        s1 = Student('Bart', 80)
        s2 = Student('Lisa', 100)
        self.assertEqual(s1.get_grade(), 'A')
        self.assertEqual(s2.get_grade(), 'A')

    def test_60_to_80(self):
        s1 = Student('Bart', 60)
        s2 = Student('Lisa', 79)
        self.assertEqual(s1.get_grade(), 'B')
        self.assertEqual(s2.get_grade(), 'B')

    def test_0_to_60(self):
        s1 = Student('Bart', 0)
        s2 = Student('Lisa', 59)
        self.assertEqual(s1.get_grade(), 'C')
        self.assertEqual(s2.get_grade(), 'C')

    def test_invalid(self):
        s1 = Student('Bart', -1)
        s2 = Student('Lisa', 101)
        with self.assertRaises(ValueError):
            s1.get_grade()
        with self.assertRaises(ValueError):
            s2.get_grade()

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

四、通过HTMLTestRunner将测试结果输出为html文件

注意：不能用pycharm的unittest模式运行，否则无法生成报告。 直接运行代码。
附python3的HTMLTestRunner.py

import unittest
import HTMLTestRunner

"自测类Student和测试类TestStudent代码同上"

if __name__ == '__main__':
    # 创建一个测试集合
    test_suite = unittest.TestSuite()
    #  测试套件中添加单个测试用例
    # test_suite.addTest(TestStudent('test_80_to_100'))
    #  使用makeSuite方法添加所有的测试方法
    test_suite.addTest(unittest.makeSuite(TestStudent))
    # 指定报告放的文件，注意模式一定是wb模式
    fr = open('res.html','wb')
    report = HTMLTestRunner.HTMLTestRunner(stream=fr,title='测试报告',description='测试报告详情')
    report.run(test_suite)

终端执行完py文件后可以在目录中看到多了res.html文件，这就是输出的html结果 屏幕快照 2018-12-23 下午5.00.02.png

五、通过xmlrunner模块将单元测试结果XML格式输出

注意：不能用pycharm的unittest模式运行，否则无法生成报告。 直接运行代码。

import unittest
import xmlrunner

"自测类Student和测试类TestStudent代码同上"

if __name__ == '__main__':
    # 创建一个测试集合
    test_suite = unittest.TestSuite()
    #  测试套件中添加测试用例
    # test_suite.addTest(TestStudent('test_80_to_100'))
    #  使用makeSuite方法添加所有的测试方法
    test_suite.addTest(unittest.makeSuite(TestStudent))
    # 指定报告放的目录
    runner = xmlrunner.XMLTestRunner(output="report")
    # 运行单元测试
    runner.run(test_suite)

终端执行完py文件后可以在目录中看到多了这么个文件，这就是输出的xml结果