聊聊 Python 代码覆盖率工具 - Coverage

单元测试代码覆盖率作为一种度量方式，可以计算单元测试用例对于被测代码的覆盖程度，即：被执行的代码数量和代码总数量的比值、统计代码覆盖率；经常在单元测试后再进行，Python 项目最常使用的代码覆盖率统计工具：Coverage 可以为测试结果提供评判依据

一、安装 Coverage 依赖同样是使用 pip 安装

# 安装 Coverage 依赖
pip3 install coverage

Coverage 官方提供了 2 种方式，用于统计代码覆盖率，分别是：Coverage 命令行、Coverage API 

更详细的介绍可以参考官方文档：https://coverage.readthedocs.io/en/latest/

二. 实战一下

首先用 Python 编写一段简单被测代码如下：

# 被测代码 
# main.py
def get_level(cource):
    """
    自定义的方法
    :param cource:成绩
    :return:
    """
    if cource >= 90:
        return "优秀"
    elif cource >= 80:
        return "良好"
    elif cource >= 60:
        return "合格"
    elif cource >= 40:
        return "不合格"
    else:
        return "差"

根据上面的被测方法编写单元测试用例，这里使用 Python 自带的 unitte st  依赖库来编写 2 个简单的测试用例并且特意只 覆盖到了上面 方法的  2 个分支，即：优秀和良好

# 单元测试 
# test_get_level.py 
import unittest

from main import *


class GetLevel(unittest.TestCase):

    def test_get_level1(self):
        self.assertEquals(get_level(90), "优秀")

    def test_get_level2(self):
        self.assertEquals(get_level(80), "良好")


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

右键运行单元测试，会发现两个测试用例都是通过的接下来分别使用 Coverage 命令和 API 在本地生成代码覆盖率统计报告

1、在项目根目录下，运行 coverage run 命令，生成 .coverage 文件，搜集被测试源代码覆盖率的信息

# 1、搜集被测代码覆盖率信息，保存到 .coverage 文件中
coverage run test_get_level.py

# 2、生成覆盖率统计结果报告
coverage html -d coverage_result

然后使用 coverage html -d  命令在同级目录下生成代码覆盖率统计报告

用浏览器打开统计报告文件夹中的 index.html 文件， 其中：

statements ：代码总行数，不包含空行和注释行、missing ：未执行的代码行数、coverage ：代码覆盖率

点击 test_get_level.py 文件，可以非常直观地查看到哪些代码执行了哪些代码没有被执行

2、使用 Coverage API生成代码覆盖率统计报告更方便、只需要使用查找测试套件并运行进行分析、保存、展示即可

# 使用 API 生成代码覆盖率统计报告
# exec_api.py
import coverage
import unittest
# 实例化一个对象
cov = coverage.coverage()
cov.start()

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

# 结束分析
cov.stop()
# 结果保存
cov.save()
# 命令行模式展示结果
cov.report()
# 生成HTML覆盖率报告
cov.html_report(directory='result_html')