[python] python单元测试经验总结

python写单元大多数都会用到unittest和mock，测试代码覆盖率都会用到coverage，最后再用nose把所有的东西都串起来，这样每次出版本，都能把整个项目的单元测试都运行一遍。

Unittest

unittest就不详细介绍了，注意几点：

• 测试类继承unittest.TestCase
• 测试类、测试方法名字最好以test开头，很多工具能根据名字来自动运行，很方便
• 测试类里面的setUp/tearDown会在每个case执行之前/之后执行，setUpClass/tearDownClass加上@classmethod在整个测试类开始和结束的时候执行
• 测试文件的main函数里面加上unittest.main()，就可以直接用python命令运行了

Mock

单元测试里面比较精髓的就是mock了，介绍几种常见的场景：

1. Mock一个函数。其实有好几种方法，个人比较推荐下面这种，看上去很清晰：

def multiple(a, b):
    return a*b


class TestProducer(unittest.TestCase):
    def setUp(self):
        self.calculator = Calculator()

    @mock.patch('multiple')
    def test_multiple(self, mock_multiple):
        mock_multiple.return_value = 3
        self.assertEqual(multiple(8, 14), 3)

2. Mock一个对象里面的方法

class Calculator(object):
    def add(self, a, b):
        return a+b
 
 
class TestProducer(unittest.TestCase):
    def setUp(self):
        self.calculator = Calculator()
 
    @mock.patch.object(Calculator, 'add')
    def test_add(self, mock_add):
        mock_add.return_value = 3
        self.assertEqual(self.calculator.add(8, 14), 3)

3. 让Mock的函数每次被调用返回不同的值，而1,2中的方法每次调用都会返回同样的值

class TestProducer(unittest.TestCase):
    @mock.patch.object(Calculator, 'add')
    def test_effect(self, mock_add):
        mock_add.side_effect = [1, 2, 3]
        self.assertEqual(self.calculator.add(8, 14), 1)
        self.assertEqual(self.calculator.add(8, 14), 2)
        self.assertEqual(self.calculator.add(8, 14), 3)

4. 让Mock的函数抛出exception

def is_error(self):
    try:
        os.mkdir("11")
        return False
    except Exception as e:
        return True   

 
class TestProducer(unittest.TestCase):
    @mock.patch('os.mkdir')
    def test_exception(self, mock_mkdir):
        mock_mkdir.side_effect = Exception
        self.assertEqual(self.calculator.is_error(), True)

5. Mock多个函数，主要是注意顺序

    @mock.patch.object(Calculator, 'add')
    @mock.patch('test_unit.multiple')
    def test_both(self, mock_multiple, mock_add):
        mock_add.return_value = 1
        mock_multiple.return_value = 2
        self.assertEqual(self.calculator.add(8, 14), 1)
        self.assertEqual(multiple(8, 14), 2)

Coverage

打命令coverage加测试文件，就可以得到覆盖率，可以生成html格式的报告，每次运行一个文件都会生成一个.coverage文件，需要将combine所有结果才能得到一个完整的报告。

具体的命令参数参看：http://nedbatchelder.com/code/coverage/cmd.html

更加有用的是配置文件，参看：http://nedbatchelder.com/code/coverage/config.html

配置文件中最有用的功能就是可以不测某些行的覆盖率，例如：

[report]
exclude_lines =
    # 只要在某一行加上注释“# pragma: no cover”这一行就会被忽略
    pragma: no cover

    # 忽略掉main函数
    if __name__ == .__main__.:

Nose

Nose可以将所有的单元测试文件一次全部执行，并且提供了coverage的插件，能够统计整体的覆盖率。

Nose会扫描目标目录，如果发现目录名以“test”或者“Test”开头，则递归地进去扫描，并自动运行所有发现的以“test”或者“Test”开头的测试文件。

另外Nose增加了报级别的setup和teardown，只需将他们放到__init__.py文件中即可。

Nose命令的执行，最简单的就是nosetest后面加上你的所有测试文件或者测试文件所在的目录，一些运行参数参看：http://nose.readthedocs.org/en/latest/usage.html

Nose的参数里面以"--cover"开头的都是coverage相关的，但是我发现并没有办法是用coverage的配置文件，需要手动安装一下nose-cov，然后用“--cov-config”来指定配置文件，其他参数参看：https://pypi.python.org/pypi/nose-cov

我的项目因为测试文件比分散，并且有些并没有以test开头，所以比较麻烦，只能写了一个脚本，把这些都串起来：

import os
import subprocess

######################################################################
# 需要测试覆盖率的文件或者目录
cover_list = [
    'src/sample/analyzer/unpacker/src/emulator.py',
    'src/sample/analyzer/unpacker/src/emulator_manager.py',
    'src/sample/analyzer/unpacker/src/unpacker_analyzer.py',
    'src/sample/analyzer/bitvalue/src/confparser.py',
    'src/sample/analyzer/bitvalue/src/trunk.py',
]

# 测试用例所在的文件或者目录，如果测试文件没有以test开头，则必须制定文件名
ut_list = [
    'src/sample/analyzer/unpacker/ut',
    'src/sample/analyzer/bitvalue/ut/ut_main.py'
]
######################################################################

PRODUCTION_HOME = os.environ.get("PRODUCTION_HOME", "../..")


def get_command():
    command = [
        'nosetests',
        '--with-cov',
        '--cover-erase',
        '--cov-report', 'html',
        '--cov-config', 'cover.config',
    ]

    for cover in cover_list:
        command.append('--cov')
        command.append(os.path.join(PRODUCTION_HOME, cover))

    for ut in ut_list:
        command.append(os.path.join(PRODUCTION_HOME, ut))

    return command


if __name__ == '__main__':
    command = get_command()
    print command

    os.chdir(PRODUCTION_HOME)
    proc = subprocess.Popen(command, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)

    output, error = proc.communicate()
    return_code = proc.poll()

    print output
    print error
    print return_code