测试：入门指南

简介
环境
创建测试
运行测试
配置缓存

简介

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 命令来运行你的测试。

环境

运行测试时，由于 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 目录中：

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 命令：

PestPHPUnit

php

<?php

test('基础示例', 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 运行它们：

PestPHPUnit

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 包作为“开发”依赖项安装。然后，在执行 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 会自动将此令牌附加到每个并行测试进程创建的测试数据库的末尾：

php

$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：

PestPHPUnit

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;

    // ...
}

测试：入门指南 ​

简介 ​

环境 ​

.env.testing 环境文件 ​

创建测试 ​

运行测试 ​

并行运行测试 ​

并行测试与数据库 ​

并行测试钩子 ​

访问并行测试令牌 ​

报告测试覆盖率 ​

强制执行最低覆盖率阈值 ​

分析测试 ​

配置缓存 ​

测试：入门指南

简介

环境

`.env.testing` 环境文件

创建测试

运行测试

并行运行测试

并行测试与数据库

并行测试钩子

访问并行测试令牌

报告测试覆盖率

强制执行最低覆盖率阈值

分析测试

配置缓存