Laravel中的并行测试和代码覆盖入门

2023-06-01 00:00:00 并行 覆盖 入门

让我们快速完成设置以开始并行测试并设置代码覆盖率报告以分析我们测试了多少代码。

我个人通过 XDebug 挖掘 HTML 报告,因为我喜欢在开发功能时逐行可视化覆盖范围:

XDebug.png

我还将在本教程中向您展示如何快速设置 HTML 报告以及在新项目上设置并行测试。

设置

自Laravel v8.25起,Laravel 与 Artisan 正式支持并行测试。让我们通过设置一个新的 Laravel 项目并逐步完成安装 Paratest 和配置我们的报告的过程来设置并行测试和覆盖率报告。

在新项目中并行运行测试并不能帮助加快我们的测试运行;

但是,随着测试的增长,您会注意到性能提高。

首先,创建一个新的 Laravel 应用程序,我们将对其进行版本控制,以便我们可以在设置过程中看到更改。

laravel new parallel-demo --git

该laravel命令创建我们的项目并提交代码,因此我们获得了全新安装和单个提交。


要在 PHPUnit 中使用 Laravel 的--parallel标志,我们必须安装ParaTest。Laravel 使这变得简单,当我们第一次运行测试时提示我们这样做:

php artisan test --parallel
 
Running tests in parallel requires "brianium/paratest". Do you wish to install it as a dev dependency? (yes/no) [no]:
> yes
Using version ^6.6 for brianium/paratest
./composer.json has been updated
# ...
ParaTest v6.6.4 upon PHPUnit 9.5.25 #StandWithUkraine
 
..                                                                  2 / 2 (100%)
 
Time: 00:00.300, Memory: 22.00 MB
 
OK (2 tests, 2 assertions)

Paratest 现在已正确安装,我们可以继续运行覆盖率测试和配置 HTML 报告。


覆盖报告

另一个有用的测试标志是--coverage,它向终端输出一个漂亮的基于文本的版本:

php artisan test --parallel --coverage
ERROR  Code coverage driver not available. Did you set Xdebug's coverage mode?

根据您本地的 PHP 设置,您可能会收到上述错误消息,提示您设置 Xdebug 的覆盖模式。

我们不会详细介绍设置代码覆盖工具,但有几个选项可用。

我不介意使用 Xdebug 3 的覆盖范围,因为我经常在开发中使用 Xdebug 进行调试。


要使覆盖工作正常,您需要查看 Xdebug 模式来覆盖:

XDEBUG_MODE=coverage php artisan test --parallel --coverage

运行上述命令后,您应该会在覆盖率报告中看到类似的内容:

覆盖率报告.png


HTML 覆盖率报告

虽然基于文本的覆盖率很有帮助,但我喜欢使用 HTML 覆盖率报告来可视化被覆盖和未被覆盖的代码行。它们以绿色和红色突出显示:

HTML覆盖率报告.png

上面的代码是默认 Laravel 安装的示例,我会让你决定是否要测试/覆盖 Laravel 附带的代码。我认为我更愿意忽略最初生成的文件,而只关注我添加到应用程序中的代码。


添加 HTML 报告相当简单。

打开phpunit.xml文件,找到<coverage/>并添加<report/>标签:

<coverage processUncoveredFiles="true">
    <include>
        <directory suffix=".php">./app</directory>
    </include>
    <report>
        <html outputDirectory="tests/Coverage/html"/>
    </report>
</coverage>

您可以将覆盖范围放在您想要的任何位置,但您可能希望忽略版本控制中生成的文件。

也许您可以使用coverage/项目根目录中的文件夹,将其放在 中的某个位置storage,或者将其嵌入到tests/上面的文件夹中。

这个选择由你!

使用上面的路径示例,将以下内容添加到您的.gitignore文件中:

# ...
tests/Coverage/

当您使用覆盖率运行测试时,它将生成一个 HTML 报告。然后,您可以

tests/Coverage/html/index.html

在浏览器中打开该文件以查看报告。

有了这个,你应该有一个很好的设置来并行运行测试和配置 HTML 报告,以便在开发中轻松可视化覆盖率!

虽然我们设置了并行测试和覆盖率报告,但我们可以通过忽略默认 Laravel 安装附带的文件来改进覆盖率报告。


转:

https://laravel-news.com/parallel-testing-and-code-coverage

相关文章