在 Laravel 中开始使用并行测试和代码覆盖率

发布时间:作者:

Getting Started With Parallel Testing and Code Coverage in Laravel image

让我们快速浏览一下设置,开始进行并行测试,并设置代码覆盖率报告来分析我们测试了多少代码。

我个人喜欢通过 XDebug 使用 HTML 报告,因为我喜欢在开发功能时可视化逐行覆盖率。

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

设置

自从 Laravel v8.25 以来,Artisan 在 Laravel 中正式支持并行测试。让我们通过设置一个新的 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

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

HTML 覆盖率报告

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

以上代码是来自默认 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 安装一起提供的文件来改进覆盖率报告。

Paul Redmond photo

Laravel 新闻的专栏作家。全栈 Web 开发人员和作者。

Cube

Laravel 新闻通讯

加入 40,000 多名其他开发人员,永不错过新的技巧、教程等。

Laravel Forge logo

Laravel Forge

轻松创建和管理您的服务器,并在几秒钟内部署您的 Laravel 应用程序。

Laravel Forge
Tinkerwell logo

Tinkerwell

Laravel 开发人员必备的代码运行器。使用 AI、自动完成功能和对本地和生产环境的即时反馈进行调试。

Tinkerwell
No Compromises logo

不妥协

Joel 和 Aaron,两位来自不妥协播客的经验丰富的开发人员,现在可以为您的 Laravel 项目聘用。 ⬧ 固定费率为每月 7500 美元。 ⬧ 无需冗长的销售流程。 ⬧ 无需合同。 ⬧ 100% 退款保证。

不妥协
Kirschbaum logo

Kirschbaum

提供创新和稳定性,确保您的 Web 应用程序取得成功。

Kirschbaum
Shift logo

Shift

正在运行旧版本的 Laravel?即时、自动的 Laravel 升级和代码现代化,让您的应用程序焕然一新。

Shift
Bacancy logo

Bacancy

仅需每月 2500 美元,即可为您的项目配备经验丰富的 Laravel 开发人员,拥有 4-6 年的经验。获得 160 小时的专业知识和 15 天的无风险试用期。立即安排通话!

Bacancy
Lucky Media logo

Lucky Media

立即获得 Lucky - Laravel 开发的理想选择,拥有十多年的经验!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar:Laravel 电子商务

Laravel 的电子商务。一个开源软件包,将现代无头电子商务功能的强大功能引入 Laravel。

Lunar:Laravel 电子商务
LaraJobs logo

LaraJobs

官方的 Laravel 招聘网站

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit:Laravel SaaS 启动套件

SaaSykit 是一个 Laravel SaaS 启动套件,包含运行现代 SaaS 所需的所有功能。支付、美观结账、管理面板、用户仪表板、身份验证、即用型组件、统计数据、博客、文档等等。

SaaSykit:Laravel SaaS 启动套件
Rector logo

Rector

您无缝升级 Laravel、降低成本和加速创新的合作伙伴,帮助企业取得成功。

Rector
MongoDB logo

MongoDB

通过 MongoDB 和 Laravel 的强大集成来增强您的 PHP 应用程序,使开发人员能够轻松高效地构建应用程序。支持事务、搜索、分析和移动用例,同时使用熟悉的 Eloquent API。了解 MongoDB 灵活、现代的数据库如何改变您的 Laravel 应用程序。

MongoDB
Maska is a Simple Zero-dependency Input Mask Library image

Maska 是一个简单的零依赖项输入掩码库

阅读文章
Add Swagger UI to Your Laravel Application image

将 Swagger UI 添加到您的 Laravel 应用程序

阅读文章
Assert the Exact JSON Structure of a Response in Laravel 11.19 image

在 Laravel 11.19 中断言响应的准确 JSON 结构

阅读文章
Build SSH Apps with PHP and Laravel Prompts image

使用 PHP 和 Laravel 提示构建 SSH 应用程序

阅读文章
Building fast, fuzzy site search with Laravel and Typesense image

使用 Laravel 和 Typesense 构建快速、模糊的网站搜索

阅读文章
Add Comments to your Laravel Application with the Commenter Package image

使用 Commenter 软件包在您的 Laravel 应用程序中添加评论

阅读文章