测试：入门

• 简介
• 环境
• 创建测试
• 运行测试
  • 并行运行测试
  • 报告测试覆盖率
  • 分析测试

简介

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 驱动程序，以便在测试期间不会持久化任何会话或缓存数据。

您可以根据需要自由定义其他测试环境配置值。可以在您的应用程序的 phpunit.xml 文件中配置 testing 环境变量，但在运行测试之前，请确保使用 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

生成测试后，您就可以像往常一样使用 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);
    }
}

运行测试

如前所述，编写测试后，可以使用 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 包安装为“dev”依赖项。然后，在执行 test Artisan 命令时包含 --parallel 选项

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

默认情况下，Laravel 会创建与机器上的可用 CPU 内核数量相同的进程。但是，您可以使用 --processes 选项调整进程数

php artisan test --parallel --processes=4

并行测试和数据库

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

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

php artisan test --parallel --recreate-databases

并行测试钩子

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

使用 ParallelTesting 门面，您可以指定在进程或测试用例的 setUp 和 tearDown 中执行的代码。给定的闭包接收 $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) {
            // ...
        });
 
        // Executed when a test database is created...
        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();

报告测试覆盖率

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

php artisan test --coverage

强制执行最低覆盖率阈值

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

php artisan test --coverage --min=80.3

分析测试

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

php artisan test --profile