Docker 中的 PHP 函数代码覆盖率测试

引言

代码覆盖率是衡量测试用例对代码进行测试能力的指标。对于 PHP 应用程序,有多种工具可以计算代码覆盖率,例如 PHPUnit 和 Xdebug。在这篇文章中,我们将演示如何在 Docker 容器中使用 PHPUnit 和 Xdebug 来设置 PHP 函数代码覆盖率测试。

先决条件

  • Docker 已安装
  • PHP 已安装
  • PHPUnit 已安装

设置 Docker 容器

FROM php:8.1-apache

RUN docker-php-ext-install xdebug

COPY . /var/www/html/

CMD ["apache2-foreground"]

此 Dockerfile 创建了一个基于 PHP 8.1 和 Apache Web 服务器的容器。它还安装了用于代码覆盖的 Xdebug 扩展。

在 Docker 中运行容器

1

2

3

docker build -t php-app .

docker run -it --rm -p 8080:80 php-app

设置 PHPUnit 测试

在应用程序的根目录中创建 phpunit.xml 文件:

1

2

3

4

5

6

7

8

9

<?xml version="1.0" encoding="UTF-8"?>

<phpunit bootstrap="vendor/autoload.php"

         colors="true">

  <testsuites>

    <testsuite name="Application Test Suite">

      <directory>tests/</directory>

    </testsuite>

  </testsuites>

</phpunit>

此文件配置了 PHPUnit 的运行时选项和测试目录。

生成代码覆盖率报告

要使用 Xdebug 生成代码覆盖率报告,请在 PHPUnit 命令中添加以下选项:

1

--coverage-html=coverage

此选项将在 coverage 目录中生成 HTML 代码覆盖率报告。

运行测试

现在,您可以使用以下命令运行带有代码覆盖率测试的 PHPUnit:

1

docker exec -it php-app php vendor/bin/phpunit --coverage-html=coverage

实战案例

假设我们有一个简单的 PHP 函数 sum:

1

2

3

function sum($a, $b) {

  return $a + $b;

}

我们可以编写一个 PHPUnit 测试用例来测试 sum 函数:

1

2

3

4

5

class SumTest extends PHPUnit\Framework\TestCase {

  public function testSum() {

    $this->assertEquals(10, sum(5, 5));

  }

}

运行包含代码覆盖率测试的 PHPUnit 后,我们可以查看 coverage/index.html 报告。这将显示 sum 函数的行覆盖率和函数调用覆盖率。

相关文章