使用 PHP 代码覆盖工具提高测试效率

使用 PHPUnit 进行 PHP 代码覆盖

简介

代码覆盖是一种测试技术，它测量程序中执行的代码行数。这有助于识别未测试的代码路径和潜在的错误。PHPUnit 是一个流行的 PHP 测试框架，它提供了内置的代码覆盖工具。

安装 PHPUnit

要安装 PHPUnit，请使用 Composer：

composer global require "phpunit/phpunit:^9"

配置 PHPUnit

要在项目中配置 PHPUnit，请创建一个名为 phpunit.xml 的配置文件并添加以下内容：

<phpunit>
    <testsuites>
        <testsuite name="MyTestSuite">
            <directory>tests</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">src</directory>
        </whitelist>
    </filter>
    <logging>
        <log type="coverage-html" target="build/coverage" />
    </logging>
</phpunit>

运行代码覆盖

要生成代码覆盖报告，请运行以下命令：

phpunit --coverage-html build/coverage

解释代码覆盖报告

生成的报告将显示一个交互式 HTML 界面。

覆盖率：表示执行的代码行数占总代码行数的百分比。

覆盖的类和方法：列出所有已覆盖的类和方法。

未覆盖的代码：突出显示未执行的代码行。

实战案例

考虑以下 PHP 类：

class Calculator
{
    public function add(int $a, int $b): int
    {
        return $a + $b;
    }
}

要对其进行测试，我们创建一个测试用例：

class CalculatorTest extends PHPUnit_Framework_TestCase
{
    public function testAdd()
    {
        $calculator = new Calculator();
        $this->assertEquals(3, $calculator->add(1, 2));
    }
}

运行 PHPUnit，生成代码覆盖报告后，可以看到以下结果：

.......                                  6 / 6 (100%)

Time: 0 seconds, Memory: 4.00 MB

OK (1 test, 1 assertion)

该报告表明所有代码都已覆盖(100%)。