Laravel 13.x 中文文档

主题

测试：入门 ​

简介 ​

Laravel 是以测试为理念构建的。事实上，对使用 Pest 和 PHPUnit 进行测试的支持是开箱即用的，并且已经为您的应用程序设置了 phpunit.xml 文件。该框架还附带了方便的辅助方法，允许您表达性地测试您的应用程序。

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

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

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

环境 ​

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

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

.env.testing 环境文件 ​

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

创建测试 ​

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

shell
php artisan make:test UserTest

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

shell
php artisan make:test UserTest --unit

NOTE

可以使用存根发布自定义测试存根。

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

php
<?php

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

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本测试示例。
     */
    public function test_basic_test(): void
    {
        $this->assertTrue(true);
    }
}

WARNING

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

运行测试 ​

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

shell
./vendor/bin/pest
shell
./vendor/bin/phpunit

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

shell
php artisan test

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

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

并行运行测试 ​

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

shell
composer require brianium/paratest --dev

php artisan test --parallel

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

shell
php artisan test --parallel --processes=4

WARNING

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

并行测试和数据库 ​

只要您配置了主数据库连接，Laravel 就会自动处理为运行测试的每个并行进程创建和迁移测试数据库。测试数据库将以后缀进程令牌命名，每个进程唯一。例如，如果您有两个并行测试进程，Laravel 将创建并使用 your_db_test_1 和 your_db_test_2 测试数据库。

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

shell
php artisan test --parallel --recreate-databases

并行测试钩子 ​

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

使用 ParallelTesting 门面，您可以指定在进程或测试用例的 setUp 和 tearDown 时执行的代码。给定的闭包接收 $token 和 $testCase 变量，分别包含进程令牌和当前测试用例：

php
<?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
{
    /**
     * 引导任何应用程序服务。
     */
    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 方法。此令牌是单个测试进程的唯一字符串标识符，可用于在并行测试进程之间分割资源。例如，Laravel 自动将此令牌附加到每个并行测试进程创建的测试数据库末尾：

$token = ParallelTesting::token();

报告测试覆盖率 ​

WARNING

此功能需要 Xdebug 或 PCOV。

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

shell
php artisan test --coverage

强制最低覆盖率阈值 ​

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

shell
php artisan test --coverage --min=80.3

分析测试 ​

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

shell
php artisan test --profile

配置缓存 ​

运行测试时，Laravel 为每个单独的测试方法引导应用程序。如果没有缓存的配置文件，则必须在测试开始时加载应用程序中的每个配置文件。要构建一次配置并在单次运行的所有测试中重用，可以使用 Illuminate\Foundation\Testing\WithCachedConfig trait：

php
<?php

use Illuminate\Foundation\Testing\WithCachedConfig;

pest()->use(WithCachedConfig::class);

// ...
php
<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\WithCachedConfig;
use Tests\TestCase;

class ConfigTest extends TestCase
{
    use WithCachedConfig;

    // ...
}