python 测试覆盖率

测试覆盖

率在测试中，为了度量产品质量，代码覆盖率被作为一种测试结果的评判依据，在Python代码中用来分析代码覆盖率的工具当属Coverage。代码覆盖率是由特定的测试套件覆盖被测源代码的程度来度量，Coverage是一种用于统计Python代码覆盖率的工具，通过它可以检测测试代码的有效性，即测试case对被测代码的覆盖率几何。

Coverage不仅支持分支覆盖率统计，还可以生成HTML/XML报告。并且XML报告可以结合Jenkins和Sonar集成工具一起使用。

Coverage官方文档：http://coverage.readthedocs.org/en/latest/

安装

Coverage作为Python的一个第三方库，使用时需要先安装，使用pip命令进行安装。

安装命令：

pip install coverage

coverage有两种使用方法，一种是在命令行中使用，一种是调用API使用。方便控制部分需要测试的代码。

基本命令参数

命令使用文档：http://coverage.readthedocs.org/en/latest/cmd.html

命令常用参数：

• run – 运行Python程序并收集执行数据

• report – 报告覆盖率结果

• html – 生成HTML文件，内容含覆盖率结果列表

• json – 生成JSON文件，内容含覆盖率结果

• xml – 生成XML报告文件，内容含覆盖率结果

• erase – 清除之前收集的覆盖率数据

• combine – 合并多个数据文件

• debug – 获取调试信息

可以使用help命令查看帮助：coverage help

使用

在使用coverage时，基本需要两步运行，第一步运行源代码，收集被测试的源代码覆盖率的信息，第二步生成代码覆盖率的信息报告。

使用pytest写测试脚本时运行命令：

coverage run -m pytest + 测试脚本文件

使用unittest 写测试本时运行命令：

coverage run + 测试脚本文件

生成报告

查看报告有两种方式，一种是在当前命令行模式下查看，一种是生成HTML报告文件查看。

命令行模式下查看

根据运行代码后生成的.coverage文件，使用report参数可在命令行模式下查看覆盖率统计结果。

使用命令：

coverage report

结果展示中的字段含义：

• tmts：语句总数

• Miss：未执行到的语句数

• Cover：覆盖率，计算公式 Cover=(Stmts-Miss)/Stmts

生成HTML报告文件

使用命令生成HTML报告：

coverage html -d covhtml

其中参数-d是指定生成的html所在的文件夹名，如果不写 -d 之后的参数，默认在当前文件夹下创建covhtml文件

命令执行完成后会生成一个cov.html文件。

各字段说明：

• Stmts 总的有效代码行数（不包含空行和注释行）

• Miss 未执行的代码行数（不包含空行和注释行）

• Branch 总分支数

• BrMiss 未执行的分支数

• Cover 代码覆盖率

• Missing 未执行的代码部分在源文件中行号

以执行的测试原文件命名的文件，可以高亮显示覆盖和未覆盖的代码。

调用API使用

调用API使用文档：http://coverage.readthedocs.org/en/latest/api.html

在python代码中通过调用coverage模块执行代码生成代码覆盖率的统计结果。使用方法也非常简单，如下示例：

if__name__ == "__main__":
　　# 实例化对象
　　cov = coverage.coverage
　　# 开始分析
　　cov.start
　　suite = unittest.defaultTestLoader.discover(os.getcwd, "test.py")
　　unittest.TextTestRunner.run(suite)
　　# 结束分析
　　cov.stop
　　# 结果保存
　　cov.save
　　# 命令行模式展示结果
　　cov.report
　　# 生成HTML覆盖率报告
　　cov.html_report(directory= 'covhtml')