Spatie Pest Plugin Route Testing - 最佳实践教程

1. 项目介绍

spatie/pest-plugin-route-testing 是一个为 Laravel 应用程序设计的开源包，它可以帮助开发者轻松测试所有 GET 路由。在典型的 Laravel 应用中，有许多页面可以被用户访问，忘记测试其中的某些页面是很常见的情况。这个包简化了这一过程，确保你的应用中每个 GET 路由都能正常工作。

2. 项目快速启动

首先，确保你已经安装了 Laravel 和 Pest 测试框架。以下是如何安装 spatie/pest-plugin-route-testing 的步骤：

composer require spatie/pest-plugin-route-testing

在你的 Pest 测试文件中，你可以使用以下代码来测试所有 GET 路由：

use function Spatie\RouteTesting\routeTesting;

routeTesting('all GET routes')->assertSuccessful();

这段代码会测试应用中的所有 GET 路由，并确保它们返回 200 HTTP 状态码。

3. 应用案例和最佳实践

测试特定路由

如果你想测试特定的路由，可以使用 include 方法。支持通配符匹配。例如，以下代码会测试所有以 blog 开头的路由：

routeTesting('all blog routes')->include('blog*')->assertSuccessful();

排除特定路由

如果你想要排除某些路由，可以使用 exclude 方法。例如，以下代码会测试所有路由，除了那些以 admin 开头的路由：

routeTesting('all blog routes')->exclude('admin*')->assertSuccessful();

绑定路由模型

如果你的路由中有模型绑定，这个包会默认跳过这些路由的测试。如果你想测试这些路由，可以使用 bind 方法来提供模型实例：

use App\Models\User;

routeTesting('all blog routes')->bind('user', User::factory()->create())->assertSuccessful();

忽略缺失模型绑定的路由

如果你不希望在输出中显示由于缺失模型绑定而跳过的测试，可以使用 ignoreRoutesWithMissingBindings 方法：

routeTesting('all blog routes')->ignoreRoutesWithMissingBindings()->assertSuccessful();

执行自定义代码

你可以在测试之前使用 setUp 方法来执行自定义代码，例如，在测试前登录用户：

routeTesting('all admin routes')->setUp(function () {
    $user = User::factory()->create();
    $this->actingAs($user);
    // 可选地，你还可以绑定模型
    $this->bind('user', $user);
})->include('admin*')->assertSuccessful();

4. 典型生态项目

spatie/pest-plugin-route-testing 是 spatie 组织下的一个项目，他们提供了许多高质量的 Laravel 相关包。以下是一些典型的生态项目：

• spatie/laravel-permission: 一个为 Laravel 设计的权限管理系统。
• spatie/laravel-query-builder: 一个构建复杂查询的 fluent 查询构建器。
• spatie/laravel-activitylog: 一个用于记录用户操作的日志库。

通过使用这些项目，你可以更好地管理和扩展你的 Laravel 应用程序。