Python覆盖率框架Coverage初探

布满荆棘的人生 2023-10-08 17:34 28阅读 0赞

### 探索背景 ###

前几天，突然有人在我司覆盖率用户群中，提出个问题，有没有Python版的覆盖率接入方法（我司主要是java），负责的同学发给他一个文档。我想着java版的覆盖率原理了解起来有一定难度，python版的了解起来对我来说相对容易些，所以决定去一探究竟。

### 背景知识补充 ###

1、什么是覆盖率

测试过程中提到的覆盖率，指的是已测试的内容，占待测内容的百分比，在一定程度上反应测试的完整程度。

覆盖率有可以根据要衡量的对象细分很多种，比如接口覆盖率、分支覆盖率、行覆盖率等等

2、做覆盖率有什么用处

根据我以往的经验，覆盖率的好处是可以将测试的完整性量化，可以作为补充测试的手段，也可以在一定程度上佐证测试结果的可靠性。

### Coverage库 ###

下面将介绍Coverage两类主要使用场景：单元测试、功能/自动化测试，对应着Coverage库两种使用方式。

### 单元测试 ###

1、触发

单元测试使用Coverage命令执行测试单元测试脚本的方式来触发

![在这里插入图片描述][0cc8b3933e3744d494fba99515c64c61.png]

图片中

1表示一段待测方法；

2表示对待测方法发起两次调用；

3表示使用coverage命令触发测试执行，并记录覆盖率；

4表示页面化展示覆盖率结果；

5表示将覆盖率结果导出成html格式报告；

6表示产出的覆盖率报告

![在这里插入图片描述][9fbf0a8ee591421d84511ac07bd9d785.png]

如图是最终的报告结果

2、排除

上述结果如果放到实际工作中会给测试同学产生一些困扰。比如，raise BaseException这种代码在测试过程中由于出现概率极低、很难构造等原因可以无需覆盖，这种代码是希望覆盖率统计时给过滤掉的；

还有一些测试代码也是无需覆盖的，也应该过滤掉。诸如此类，实际工作中会有覆盖范围排除的诉求，下面看下如何使用。

在测试目录的统一级（如上述例子就是coverageTest.py所在位置），新建一个.coveragerc文件，里面加上如下配置：

[report]
    exclude_lines =
    raise BaseException
    def noNeed

![在这里插入图片描述][b5a36411daf844cebeeacdde00eb7f63.png]

这样就可以将不需要的抛异常和测试方法排除掉了，更多用法见文末官方文档。

到这里，就可以根据覆盖率结果来补充测试case，提高覆盖率了。

### 功能/自动化测试 ###

为什么将功能和自动化归为一类呢，是因为这两种都不是运行脚本就可以统计的，而是要在工程运行的过程中，通过手动或自动的方式触发工程代码执行，然后在收集覆盖率数据，接下来以Django项目为例介绍下如何使用（通用于其他wsgi服务器工程）。

1、修改wsgi.py文件，更改服务启动逻辑

![在这里插入图片描述][6647b08dcb554010aebc86c428f24462.png]

2、启动服务

python manage.py runserver

最简单启动方式，实际可根据自身情况加参数

3、触发工程代码执行，本次实践编写了一个接口去调用

![在这里插入图片描述][9a8f6daee17a4ad8bf02c002ba42143d.png]

4、收集覆盖率coverage erase（清除覆盖率数据，避免干扰）

coverage combine（合并覆盖率数据，可以将多线程的覆盖率结果做合并，实际应用场景很多）

coverage report （页面化展示覆盖率报告，方便查看是否有覆盖率产生）

coverage html （导出html格式报告）

![在这里插入图片描述][fefb3b0a94494e4ea3275810f261e2e8.png]

结果如图，出现了很多python库的覆盖率数据，实际只有圈中的文件是我关心的。这个时候就要用到另一种排除参数omit了。

介绍一下omit和刚刚的排除方式exclude\_lines的区别。通过字面意思理解，exclude\_lines是排除行，是将正则等方式匹配到的关键字所在行给排除掉。

omit是将文件排除。一个是行级别排除，一个是文件级别排除。

最终配置如图

![在这里插入图片描述][97c970f32b4b4e46b6c7ac964474e5de.png]

解释一下其他的参数：branch = true 表示开启分支覆盖率采集parallel = true表示开启多线程采集覆盖率omit 表示要排除的文件，中间用英文,隔开

踩过的坑：

要划定覆盖范围尽量使用omit工程中的配置文件.coveragerc有些文章说要放在wsgi.py同级目录下，亲测后发现会导致配置失效，要放到manage.py下（可能和我启动方式有关，因为我使用manage.py启动的，如果用wsgi文件启动，放到wsgi统计下应该是对的）

在项目运行过程中一般同级不到覆盖率，要通过关闭工程的方式来统计，比如CONTROL+C或kill -2，才会确保生成覆盖率数据。

最后看下最终的覆盖率结果。

![在这里插入图片描述][8b26d770662e4755809d68f6a132c646.png]

branch和partial分别代表这总分支数和覆盖的分支数

![在这里插入图片描述][ac5cae7496c94413a5f359910008d9a2.png]

以上就是对于coverage的初步探索，文中涉及的用法和命令，参考官方文档说明更详细，推荐去看官方文档。关于实现的原理还在了解过程中，有感兴趣的小伙伴可以一块探讨，文中错误的地方感谢大家纠正。

附参考文档  
coverage官方文档:coverage.readthedocs.io/en/latest/i…  
使用Coverage分析WSGI项目的代码覆率:segmentfault.com/a/119000000…  
本文实验工程开源地址:github.com/testshiling…

**最后：** 下方这份完整的软件测试视频学习教程已经整理上传完成，朋友们如果需要可以自行免费领取 `【保证100%免费】`  
![在这里插入图片描述][ed4627a964d644e285a28f9b5dd81dae.png_pic_center]

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你!  
![在这里插入图片描述][b960161d38074fed96baf6932ad02407.gif_pic_center]

[0cc8b3933e3744d494fba99515c64c61.png]: https://img-blog.csdnimg.cn/0cc8b3933e3744d494fba99515c64c61.png
[9fbf0a8ee591421d84511ac07bd9d785.png]: https://img-blog.csdnimg.cn/9fbf0a8ee591421d84511ac07bd9d785.png
[b5a36411daf844cebeeacdde00eb7f63.png]: https://img-blog.csdnimg.cn/b5a36411daf844cebeeacdde00eb7f63.png
[6647b08dcb554010aebc86c428f24462.png]: https://img-blog.csdnimg.cn/6647b08dcb554010aebc86c428f24462.png
[9a8f6daee17a4ad8bf02c002ba42143d.png]: https://img-blog.csdnimg.cn/9a8f6daee17a4ad8bf02c002ba42143d.png
[fefb3b0a94494e4ea3275810f261e2e8.png]: https://img-blog.csdnimg.cn/fefb3b0a94494e4ea3275810f261e2e8.png
[97c970f32b4b4e46b6c7ac964474e5de.png]: https://img-blog.csdnimg.cn/97c970f32b4b4e46b6c7ac964474e5de.png
[8b26d770662e4755809d68f6a132c646.png]: https://img-blog.csdnimg.cn/8b26d770662e4755809d68f6a132c646.png
[ac5cae7496c94413a5f359910008d9a2.png]: https://img-blog.csdnimg.cn/ac5cae7496c94413a5f359910008d9a2.png
[ed4627a964d644e285a28f9b5dd81dae.png_pic_center]: https://img-blog.csdnimg.cn/ed4627a964d644e285a28f9b5dd81dae.png#pic_center
[b960161d38074fed96baf6932ad02407.gif_pic_center]: https://img-blog.csdnimg.cn/b960161d38074fed96baf6932ad02407.gif#pic_center