在使用代理类时如何解决PHP单元测试中的覆盖率报告偏差问题？

php

2024-04-02 09:37:44

PHP单元测试：使用代理类时生成准确的覆盖率报告

引言

在PHP中使用生成代理类的AOP包时，生成覆盖率报告通常会遇到一个问题，那就是报告的是代理类的覆盖率，而不是原始类的。这可能会导致误导性的报告，并妨碍准确评估代码的测试覆盖率。

问题：代理类带来的覆盖率报告偏差

在使用AOP包时，原始类会被代理类替换。这会导致PHPUnit加载代理类路径，从而生成的是代理类的覆盖率报告，而不是原始类的报告。

解决方案：自定义测试执行器

要解决此问题，我们可以重写测试执行者，在执行测试之前将原始类路径添加到Composer类映射中。

创建自定义测试执行器：
创建一个自定义的测试执行者，覆盖run方法。在此方法中，在执行测试之前，将原始类路径添加到Composer类映射中。
在phpunit.xml中使用自定义执行器：
在phpunit.xml文件中，使用runner属性指定自定义测试执行器。
生成覆盖率报告：
使用--coverage-text或--coverage-html选项生成覆盖率报告。

示例代码：自定义测试执行器

class CustomTestRunner extends \PHPUnit\TextUI\TestRunner
{
    public function run(array $arguments = [])
    {
        // 在Composer类映射中添加原始类路径
        $classMap = \Composer\Autoload\ClassLoader::getDefault()->getClassMap();
        foreach ($classMap as $originalClass => $filePath) {
            // 代理类路径格式：runtime/container/proxy/$originalClass.proxy.php
            $proxyPath = str_replace('.php', '.proxy.php', $filePath);
            if (file_exists($proxyPath)) {
                $classMap[$originalClass] = $proxyPath;
            }
        }

        // 执行测试
        return parent::run($arguments);
    }
}

示例代码：`phpunit.xml`

<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/4.8/phpunit.xsd"
         backupGlobals="false"
         backupStaticAttributes="false">
    <testsuites>
        <testsuite name="MyTestSuite">
            <directory>tests</directory>
        </testsuite>
    </testsuites>
    <listeners>
        <listener class="CustomTestRunner" file="./CustomTestRunner.php"/>
    </listeners>
</phpunit>