测试: 入门指南

• 介绍
• 环境
• 创建测试
• 运行测试
  • 并行运行测试

介绍

Laravel 在构建时就考虑到了测试。实际上Laravel 默认就支持使用 PHPUnit 进行测试，并且已经为您的应用程序设置好了一个 phpunit.xml 文件。该框架还附带了一些方便的辅助函数，让你可以更直观的测试你的应用。

默认情况下，你的项目 tests 目录中包含两个子目录：Feature 和 Unit。单元测试（Unit）是针对你的代码中非常少，而且相对独立的一部分代码来进行的测试。实际上，大部分单元测试都是针对单个方法进行的。在您的 Unit 测试目录中进行测试不会启动您的 Laravel 应用程序，因此无法访问您的应用程序的数据库或其他框架服务。

功能测试（Feature）是针对大面积代码进行的测试，包括多个对象如何交互，甚至是对 JSON 端点的完整 HTTP 请求。通常，大多数测试应该是功能测试。这些功能测试可以保证您的系统运行正常。

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

环境

在运行测试时，由于在 phpunit.xml 文件中定义的 环境变量，Laravel 会自动将环境变量设置为 testing。 Laravel 还在测试时自动配置会话和缓存到 array 驱动程序，这意味着在测试期间不会保留任何会话或缓存数据。

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

<code>.env.testing</code> 环境配置文件

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

<code>CreatesApplication</code> Trait

Laravel 包含一个 CreatesApplication Trait，该 Trait 应用于应用程序的 TestCase 类。该 Trait 包含一个 createApplication 方法，该方法在运行测试之前会引导 Laravel 应用程序。重要的是，应将此特性保留在其原始位置，因为某些功能（例如 Laravel 的并行测试功能）依赖于它。

创建测试

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

php artisan make:test UserTest

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

php artisan make:test UserTest --unit

技巧：可以使用 Stub 定制 来自定义测试。

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

<?php

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;

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

注意：如果您在测试类中定义自己的 setUp 或 tearDown 方法，请务必在父类上调用各自的 parent::setUp() 或 parent::tearDown() 方法。

运行测试

正如前面提到的，编写测试后，可以使用 phpunit 命令来执行测试：

./vendor/bin/phpunit

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

php artisan test

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

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

并行运行测试

默认情况下，Laravel 和 PHPUnit 在测试执行时，是在单进程中安照先后顺序执行。但是，通过多个进程同时运行测试，可以大大减少运行测试所需的时间。首先，在执行 test Artisan 命令时，请加入 --parallel 选项：

php artisan test --parallel

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

php artisan test --parallel --processes=4

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

并行测试和数据库

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;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        ParallelTesting::setUpProcess(function ($token) {
            // ...
        });

        ParallelTesting::setUpTestCase(function ($token, $testCase) {
            // ...
        });

        // Executed when a test database is created...
        ParallelTesting::setUpTestDatabase(function ($database, $token) {
            Artisan::call('db:seed');
        });

        ParallelTesting::tearDownTestCase(function ($token, $testCase) {
            // ...
        });

        ParallelTesting::tearDownProcess(function ($token) {
            // ...
        });
    }
}

访问并行测试令牌

如果您想从应用程序的测试代码中的任何其他位置访问当前的并行进程 token，则可以使用 token 方法。该令牌是单个测试过程的唯一整数标识符，可用于在并行测试过程中划分资源。例如，Laravel 自动将此令牌附加到每个并行测试进程创建的测试数据库的末尾：

$token = ParallelTesting::token();