Qtest测试之道 基于 php-code-coverage 的增量代码覆盖率实现

360Qtest团队 · 2019年08月06日 · 最后由 Tuziba 回复于 2020年07月13日 · 115 次阅读

前言

代码覆盖率作为一个指导性指标,可以一定程度上反应测试的完备程度,虽然 100% 覆盖的代码并不意味着 100% 无 bug 的应用,但是较高的覆盖率一般情况下也意味着更少的 bug。近期笔者参与的一个项目代码量不断膨胀,但是自动化测试还不够完备,单纯依赖人工测试很容易出现旧功能受影响或测试遗漏的情况。为了降低测试对人力的消耗,尝试引入自动化测试对部分功能进行覆盖,并用增量代码覆盖率统计查看是否有测试点遗漏。这篇文章主要讲一个增量代码覆盖率的实现。

实现说明

这里简单说明下 PHP 增量代码覆盖率统计功能的实现方式,供感兴趣的同学参考

环境依赖

  1. xdebug: php 插件,用于收集覆盖率信息
  2. git: 利用 git diff 获取增量代码信息
  3. php-code-coverage: phpunit 下的一个库,用于从 xdebug 收集的覆盖率信息中生成覆盖率统计报告,支持 xml、html 等多种格式。本文基于 6.0.7 改造以支持增量覆盖率统计,利用 1.和 2.中获取的信息生成增量覆盖率统计报告

具体实现说明如下:
1. xdebug 安装
首先下载插件,xdebug 官方下载地址:http://xdebug.org.cn/download.php
然后根据操作系统的差异,windows 根据当前系统位数、php 版本以及是否线程安全,下载编译好的.dll 文件;linux 系统则需要下载源码后使用 phpize 编译成.so 文件
然后在 php.ini 文件中指明插件的位置,并启用覆盖率收集功能如下所示:

shell
# xdebug插件位置
zend_extension ="/you/path/to/xdebug"
# 启用覆盖率功能
xdebug.coverage_enable = 1

使用php -m, 回显结果中出现 Xdebug,则表示安装成功

2. 覆盖率信息收集
在项目入口文件中通过检查传入系是否存在 trigger,来决定是否启动覆盖率信息收集,以常见的 nginx+php 项目举例实现方式如下:

1. 通过 php.ini 的 auto_prepend_file 配置加载覆盖率收集文件
2. 通过 nginx 检查 cookie 中是否存在 trigger,来决定是否通过 fastcgi_param 向 php 传递 trigger(随意命名,比如 XDEBUG_COVERAGE_START)
3. php 的 auto_prepend_file 的 $_SERVER 中如果检查到存在 trigger,则开启覆盖率收集

```php
<?php
xdebug_start_code_coverage(XDEBUG_CC_UNUSED | XDEBUG_CC_DEAD_CODE);

register_shutdown_function(function () {
$coverageData = xdebug_get_code_coverage();
xdebug_stop_code_coverage();

file_put_contents( DIR . '/../data/coverage_'.uniqid().'.json', json_encode($coverageData));
});

```
3. 增量代码信息获取
使用 git diff $(git describe --tags --abbrev=0 $commit_id) $commit_id 获取当前 $commit_id 到最近一个版本之间的代码增量信息 (与具体业务相关),利用正则解析,将所有的增量信息解析为类似覆盖率信息的文件:

{
    "/you/path/to/code.php": {
        "1": 1,
        "2": 1,
        "3": 1
    }
}

4. 生成覆盖率报告
调整 php-code-coverage,在其基础上增加传入步骤 3 中产生的增量代码信息,最后生成带有增量覆盖率信息的报告

至此就可以在一轮自动化 + 手工测试完成后,生成对应的覆盖率报告信息.

共收到 1 条回复 时间 点赞

增量代码信息获取这一步有点看不懂,可以详细的说一下嘛?

需要 登录 后方可回复, 如果你还没有账号请点击这里 注册