Skip to content

测试:入门

介绍

Laravel 是以测试为核心构建的。实际上,支持使用 PestPHPUnit 进行测试的功能是开箱即用的,并且应用程序中已经设置了 phpunit.xml 文件。该框架还提供了方便的辅助方法,使您能够直观地测试您的应用程序。

默认情况下,您的应用程序的 tests 目录包含两个目录:FeatureUnit。单元测试是专注于代码中非常小、孤立部分的测试。实际上,大多数单元测试可能只关注单个方法。您在“Unit”测试目录中的测试不会启动您的 Laravel 应用程序,因此无法访问您的应用程序的数据库或其他框架服务。

功能测试可能会测试您代码的更大部分,包括多个对象之间的交互,甚至是对 JSON 端点的完整 HTTP 请求。通常,您的大多数测试应该是功能测试。这些类型的测试提供了对您的系统整体功能的最大信心。

FeatureUnit 测试目录中提供了一个 ExampleTest.php 文件。在安装新的 Laravel 应用程序后,执行 vendor/bin/pestvendor/bin/phpunitphp 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
lightbulb

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

生成测试后,您可以像往常一样使用 Pest 或 PHPUnit 定义测试。要运行您的测试,请从终端执行 vendor/bin/pestvendor/bin/phpunitphp 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);
    }
}
exclamation

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

运行测试

如前所述,一旦您编写了测试,您可以使用 pestphpunit 运行它们:

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

除了 pestphpunit 命令外,您还可以使用 test Artisan 命令来运行您的测试。Artisan 测试运行器提供详细的测试报告,以便于开发和调试:

shell
php artisan test

可以传递给 pestphpunit 命令的任何参数也可以传递给 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
exclamation

在并行运行测试时,一些 Pest / PHPUnit 选项(例如 --do-not-cache-result)可能不可用。

并行测试和数据库

只要您配置了主数据库连接,Laravel 会自动处理为每个并行进程创建和迁移测试数据库。测试数据库将以唯一的进程标记作为后缀。例如,如果您有两个并行测试进程,Laravel 将创建并使用 your_db_test_1your_db_test_2 测试数据库。

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

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

并行测试钩子

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

使用 ParallelTesting facade,您可以指定在进程或测试用例的 setUptearDown 中执行的代码。给定的闭包接收 $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();

报告测试覆盖率

exclamation

此功能需要 XdebugPCOV

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

shell
php artisan test --coverage

强制最低覆盖率阈值

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

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

测试性能分析

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

shell
php artisan test --profile