快速入门

引言

Laravel 的构建考虑了测试。事实上，它开箱即用地支持 Pest 和 PHPUnit，并且已为您设置好了一个 phpunit.xml 文件。该框架还附带了方便的辅助方法，让您能够以富有表现力的方式测试您的应用程序。

默认情况下，您的应用程序的 tests 目录包含两个子目录：Feature 和 Unit。单元测试（Unit tests）是专注于代码中非常小、隔离的部分的测试。实际上，大多数单元测试可能都只专注于一个方法。Unit 测试目录中的测试不会启动您的 Laravel 应用程序，因此无法访问您的应用程序的数据库或其他框架服务。

功能测试（Feature tests）可以测试代码的更大一部分，包括多个对象如何相互交互，甚至是到 JSON 端点的完整 HTTP 请求。通常，您的大部分测试都应该是功能测试。这类测试能够为您提供最高的信心，确保您的整个系统按预期运行。

在 Feature 和 Unit 测试目录中都提供了一个 ExampleTest.php 文件。安装新的 Laravel 应用程序后，执行 vendor/bin/pest、vendor/bin/phpunit 或 php artisan test 命令来运行您的测试。

环境

运行测试时，由于 phpunit.xml 文件中定义了环境变量，Laravel 会自动将配置环境设置为 testing。Laravel 还会自动将会话和缓存配置为 array 驱动程序，这样在测试时不会持久化任何会话或缓存数据。

您可以根据需要自由定义其他测试环境配置值。testing 环境变量可以在应用程序的 phpunit.xml 文件中配置，但请确保在运行测试之前使用 config:clear Artisan 命令清除配置缓存！

.env.testing 环境文件

此外，您可以在项目的根目录中创建一个 .env.testing 文件。当运行 Pest 和 PHPUnit 测试或执行带有 --env=testing 选项的 Artisan 命令时，将使用此文件代替 .env 文件。

创建测试

要创建新的测试用例，请使用 make:test Artisan 命令。默认情况下，测试将放置在 tests/Feature 目录中：

php artisan make:test UserTest

如果您想在 tests/Unit 目录中创建测试，可以在执行 make:test 命令时使用 --unit 选项：

php artisan make:test UserTest --unit

测试存根（test stubs）可以使用 stub publishing 进行自定义。

测试生成后，您可以像使用 Pest 或 PHPUnit 一样正常定义测试。要运行您的测试，请在终端中执行 vendor/bin/pest、vendor/bin/phpunit 或 php artisan test 命令：

<?php
 
test('basic', function () {
    expect(true)->toBeTrue();
});

<?php

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic test example.
     */
    public function test_basic_test(): void
    {
        $this->assertTrue(true);
    }
}

如果您在测试类中定义自己的 setUp / tearDown 方法，请务必调用父类上相应的 parent::setUp() / parent::tearDown() 方法。通常，您应该在自己的 setUp 方法开始时调用 parent::setUp()，并在 tearDown 方法结束时调用 parent::tearDown()。

运行测试

如前所述，一旦您编写了测试，就可以使用 pest 或 phpunit 运行它们：

./vendor/bin/pest

./vendor/bin/phpunit

除了 pest 或 phpunit 命令之外，您还可以使用 test Artisan 命令来运行您的测试。Artisan 测试运行器提供了详细的测试报告，以方便开发和调试：

php artisan test

任何可以传递给 pest 或 phpunit 命令的参数也可以传递给 Artisan test 命令：

php artisan test --testsuite=Feature --stop-on-failure

并行运行测试

默认情况下，Laravel 和 Pest / PHPUnit 在单个进程中按顺序执行您的测试。但是，您可以通过在多个进程中同时运行测试来大大减少运行测试所需的时间。要开始使用，您应该安装 brianium/paratest Composer 包作为 “开发” 依赖项。然后，在执行 test Artisan 命令时包含 --parallel 选项：

composer require brianium/paratest --dev
 
php artisan test --parallel

默认情况下，Laravel 将创建与您机器上可用 CPU 核心数量一样多的进程。但是，您可以使用 --processes 选项调整进程数量：

php artisan test --parallel --processes=4

在并行运行测试时，某些 Pest / PHPUnit 选项（例如 --do-not-cache-result）可能不可用。

并行测试和数据库

只要您配置了主数据库连接，Laravel 就会自动为每个运行测试的并行进程创建和迁移一个测试数据库。测试数据库将附加一个唯一的进程标记（process token）。例如，如果您有两个并行测试进程，Laravel 将创建并使用 your_db_test_1 和 your_db_test_2 测试数据库。

默认情况下，测试数据库在对 test Artisan 命令的调用之间会持久存在，以便后续的 test 调用可以再次使用它们。但是，您可以使用 --recreate-databases 选项重新创建它们：

php artisan test --parallel --recreate-databases

并行测试钩子

有时，您可能需要准备应用程序测试使用的某些资源，以便它们可以被多个测试进程安全地使用。

使用 ParallelTesting facade，您可以指定在进程或测试用例的 setUp 和 tearDown 期间执行的代码。给定的闭包（closures）会接收 $token 和 $testCase 变量，其中分别包含进程标记和当前测试用例：

<?php
 
namespace App\Providers;
 
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\ParallelTesting;
use Illuminate\Support\ServiceProvider;
use PHPUnit\Framework\TestCase;
 
class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        ParallelTesting::setUpProcess(function (int $token) {
            // ...
        });
 
        ParallelTesting::setUpTestCase(function (int $token, TestCase $testCase) {
            // ...
        });
 
        // 在创建测试数据库时执行...
        ParallelTesting::setUpTestDatabase(function (string $database, int $token) {
            Artisan::call('db:seed');
        });
 
        ParallelTesting::tearDownTestCase(function (int $token, TestCase $testCase) {
            // ...
        });
 
        ParallelTesting::tearDownProcess(function (int $token) {
            // ...
        });
    }
}

访问并行测试Token

如果您想从应用程序测试代码中的任何其他位置访问当前的并行进程 “标记”（token），可以使用 token 方法。此标记是单个测试进程的唯一字符串标识符，可用于跨并行测试进程对资源进行分段。例如，Laravel 会自动将此标记附加到每个并行测试进程创建的测试数据库末尾：

$token = ParallelTesting::token();

报告测试覆盖率

此功能需要 Xdebug 或 PCOV。

运行应用程序测试时，您可能希望确定测试用例是否确实覆盖了应用程序代码，以及运行测试时使用了多少应用程序代码。为此，您可以在调用 test 命令时提供 --coverage 选项：

php artisan test --coverage

强制执行最低覆盖率阈值

您可以使用 --min 选项为您的应用程序定义最低测试覆盖率阈值。如果未达到此阈值，测试套件将失败：

php artisan test --coverage --min=80.3

分析测试

Artisan 测试运行器还包含一个方便的机制，用于列出应用程序中最慢的测试。使用 --profile 选项调用 test 命令，将显示您最慢的十个测试列表，让您轻松调查哪些测试可以改进以加快您的测试套件：

php artisan test --profile

Eloquent工厂

HTTP 测试