Python之单元测试使用的一点心得

  在文章Python之学会测试，让开发更加高效（一）中，笔者初次介绍了如何在Python中使用unittest框架来进行单元测试，并使用coverage模块来计算代码测试覆盖率。本文将就笔者近段时间使用单元测试的一点经验，来分享如何更好地使用单元测试来提升我们代码的规范性和高效性。
  本文将会介绍如下内容:

1. 使用coverage模块计算代码测试覆盖率
2. 使用coverage api计算代码测试覆盖率
3. coverage配置文件的使用
4. coverage badge的生成

  本文使用的Python项目结构如下图所示：

其中func_add.py为本项目使用Python开发的代码文件，代码如下:

# -*- coding: utf-8 -*-

# 根据传入数据类型不同，实现相加功能
def add(a, b):
    if isinstance(a, str) and isinstance(b, str):
        return a + '+' + b
    elif isinstance(a, list) and isinstance(b, list):
        return a + b
    elif isinstance(a, (int, float)) and isinstance(b, (int, float)):
        return a + b
    else:
        return None

使用的第三方模块为coverage==6.3.2和coverage-badge==1.1.0。

使用coverage模块计算代码测试覆盖率

  在文章Python之学会测试，让开发更加高效（一）中已经介绍了coverage模块的使用，这里将会再次讲述它的使用，使得本文更有完整性。
  test_func_add.py脚本为单元测试脚本，其主要功能为对func_add.py中的add函数的各种可能的情形进行测试，保证代码测试覆盖率，完整代码如下:

# -*- coding: utf-8 -*-
import unittest

from func_add import add


class TestAdd(unittest.TestCase):
    def setUp(self):
        pass

    def test_add_case1(self):
        a = "Hello"
        b = "World"
        res = add(a, b)
        print(res)
        self.assertEqual(res, "Hello+World")

    def test_add_case2(self):
        a = 1
        b = 2
        res = add(a, b)
        print(res)
        self.assertEqual(res, 3)

    def test_add_case3(self):
        a = [1, 2]
        b = [3]
        res = add(a, b)
        print(res)
        self.assertEqual(res, [1, 2, 3])

    def test_add_case4(self):
        a = 2
        b = "3"
        res = add(a, b)
        print(None)
        self.assertEqual(res, None)


if __name__ == '__main__':

    # 部分用例测试
    # 构造一个容器用来存放我们的测试用例
    suite = unittest.TestSuite()
    # 添加类中的测试用例
    suite.addTest(TestAdd('test_add_case1'))
    suite.addTest(TestAdd('test_add_case2'))
    suite.addTest(TestAdd('test_add_case3'))
    suite.addTest(TestAdd('test_add_case4'))
    run = unittest.TextTestRunner()
    run.run(suite)

运行命令coverage run test_func_add.py，输出结果如下:

Hello+World
.3
.[1, 2, 3]
.None
.
----------------------------------------------------------------------
Ran 4 tests in 0.002s

OK

同时会生成.coverage文件。再运行命令coverage html会生成htmlconv文件夹，在浏览器中打开其中的index.html即可看到代码测试覆盖率报告，如下图:

使用coverage api计算代码测试覆盖率

  coverage模块也提供了API方式方便我们用代码来实现上述的代码测试覆盖率计算，完整代码如下：（test_coverage_api.py）：

# -*- coding: utf-8 -*-
import coverage
import unittest

if __name__ == '__main__':

    cov = coverage.Coverage()
    cov.start()

    # 测试套件
    suite = unittest.defaultTestLoader.discover("./", "test_func_add.py")
    unittest.TextTestRunner().run(suite)

    cov.stop()
    cov.save()

    cov.html_report(directory='test_func_add')

在代码的最后，html_report函数可以指定输出目录。值得一提的是，coverage API的灵活度还是可以的，本文只演示了其中一部分功能。

coverage配置文件的使用

  coverage模块提供了配置文件（一般为.coveragerc文件），来方便我们更好、更高效地使用它。比如我们在进行代码单元测试的时候，需要排除掉部分代码，这时的配置文件可以参考如下:

[run]
omit =
    # omit anything in a .local directory anywhere
    */.local/*
    # omit everything in /usr
    /usr/*
    # omit this single file
    utils/tirefire.py

coverage badge的生成

  有时我们往往会在别人的项目中看到readme文件的第一行会提供代码测试覆盖率的徽章，这样做的目的是使得读者能一目了然地知道这个项目的代码测试覆盖率，因此，coverage徽章（badge）的生成还是挺有用的。
  在Python中，coverage-badge模块可以方便快速地生成coverage徽章，操作命令也很方便，我们只需要在运行coverage模块的命令后（需要生成.coverage文件），再运行coverage-badge -o coverage.svg即可。
  笔者的该项目的coverage badge如下图：

总结

  本项目已上传至Github，网址为：https://github.com/percent4/unittest_example。
  笔者才疏学浅，在写文章的时候难免会有不足之处，敬请读者谅解。后续笔者会持续关注测试这块的相关知识，有机会再分享，感谢大家阅读~