数据库测试

• 介绍
  • 在每个测试后重置数据库
• 模型工厂
• 运行填充器
• 可用断言

介绍

Laravel 提供了多种有用的工具和断言，使您更容易测试基于数据库的应用程序。此外，Laravel 模型工厂和填充器使得使用应用程序的 Eloquent 模型和关系创建测试数据库记录变得轻而易举。我们将在以下文档中讨论所有这些强大的功能。

在每个测试后重置数据库

在进一步讨论之前，让我们讨论如何在每个测试后重置数据库，以便前一个测试的数据不会干扰后续测试。Laravel 包含的 Illuminate\Foundation\Testing\RefreshDatabase 特性将为您处理此事。只需在测试类中使用该特性：

Pest

<?php

use Illuminate\Foundation\Testing\RefreshDatabase;

uses(RefreshDatabase::class);

test('基本示例', function () {
    $response = $this->get('/');

    // ...
});

PHPUnit

<?php

namespace Tests\Feature;

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

class ExampleTest extends TestCase
{
    use RefreshDatabase;

    /**
     * 一个基本的功能测试示例。
     */
    public function test_basic_example(): void
    {
        $response = $this->get('/');

        // ...
    }
}

Illuminate\Foundation\Testing\RefreshDatabase 特性不会在您的架构是最新的情况下迁移数据库。相反，它只会在数据库事务中执行测试。因此，未使用此特性的测试用例添加到数据库的任何记录可能仍然存在于数据库中。

如果您希望完全重置数据库，可以使用 Illuminate\Foundation\Testing\DatabaseMigrations 或 Illuminate\Foundation\Testing\DatabaseTruncation 特性。然而，这两种选项的速度都明显慢于 RefreshDatabase 特性。

模型工厂

在测试时，您可能需要在执行测试之前向数据库插入一些记录。Laravel 允许您使用 模型工厂 为每个 Eloquent 模型 定义一组默认属性，而不是在创建测试数据时手动指定每一列的值。

要了解有关创建和利用模型工厂以创建模型的更多信息，请查阅完整的 模型工厂文档。一旦您定义了模型工厂，您可以在测试中利用该工厂创建模型：

Pest

use App\Models\User;

test('模型可以被实例化', function () {
    $user = User::factory()->create();

    // ...
});

PHPUnit

use App\Models\User;

public function test_models_can_be_instantiated(): void
{
    $user = User::factory()->create();

    // ...
}

运行填充器

如果您希望在功能测试期间使用 数据库填充器 填充数据库，可以调用 seed 方法。默认情况下，seed 方法将执行 DatabaseSeeder，该填充器应执行您所有其他的填充器。或者，您可以将特定的填充器类名传递给 seed 方法：

Pest

<?php

use Database\Seeders\OrderStatusSeeder;
use Database\Seeders\TransactionStatusSeeder;
use Illuminate\Foundation\Testing\RefreshDatabase;

uses(RefreshDatabase::class);

test('订单可以被创建', function () {
    // 运行 DatabaseSeeder...
    $this->seed();

    // 运行特定的填充器...
    $this->seed(OrderStatusSeeder::class);

    // ...

    // 运行特定填充器的数组...
    $this->seed([
        OrderStatusSeeder::class,
        TransactionStatusSeeder::class,
        // ...
    ]);
});

PHPUnit

<?php

namespace Tests\Feature;

use Database\Seeders\OrderStatusSeeder;
use Database\Seeders\TransactionStatusSeeder;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    use RefreshDatabase;

    /**
     * 测试创建新订单。
     */
    public function test_orders_can_be_created(): void
    {
        // 运行 DatabaseSeeder...
        $this->seed();

        // 运行特定的填充器...
        $this->seed(OrderStatusSeeder::class);

        // ...

        // 运行特定填充器的数组...
        $this->seed([
            OrderStatusSeeder::class,
            TransactionStatusSeeder::class,
            // ...
        ]);
    }
}

或者，您可以指示 Laravel 在每个使用 RefreshDatabase 特性的测试之前自动填充数据库。您可以通过在基测试类中定义 $seed 属性来实现这一点：

<?php

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    /**
     * 指示默认填充器是否应在每个测试之前运行。
     *
     * @var bool
     */
    protected $seed = true;
}

当 $seed 属性为 true 时，测试将在每个使用 RefreshDatabase 特性的测试之前运行 Database\Seeders\DatabaseSeeder 类。然而，您可以通过在测试类中定义 $seeder 属性来指定应执行的特定填充器：

use Database\Seeders\OrderStatusSeeder;

/**
 * 在每个测试之前运行特定填充器。
 *
 * @var string
 */
protected $seeder = OrderStatusSeeder::class;

可用断言

Laravel 为您的 Pest 或 PHPUnit 功能测试提供了几种数据库断言。我们将在下面讨论每个断言。

assertDatabaseCount

断言数据库中的某个表包含给定数量的记录：

$this->assertDatabaseCount('users', 5);

assertDatabaseEmpty

断言数据库中的某个表没有记录：

$this->assertDatabaseEmpty('users');

assertDatabaseHas

断言数据库中的某个表包含与给定键/值查询约束匹配的记录：

$this->assertDatabaseHas('users', [
    'email' => 'sally@example.com',
]);

assertDatabaseMissing

断言数据库中的某个表不包含与给定键/值查询约束匹配的记录：

$this->assertDatabaseMissing('users', [
    'email' => 'sally@example.com',
]);

assertSoftDeleted

assertSoftDeleted 方法可用于断言给定的 Eloquent 模型已被“软删除”：

$this->assertSoftDeleted($user);

assertNotSoftDeleted

assertNotSoftDeleted 方法可用于断言给定的 Eloquent 模型未被“软删除”：

$this->assertNotSoftDeleted($user);

assertModelExists

断言给定模型在数据库中存在：

use App\Models\User;

$user = User::factory()->create();

$this->assertModelExists($user);

assertModelMissing

断言给定模型在数据库中不存在：

use App\Models\User;

$user = User::factory()->create();

$user->delete();

$this->assertModelMissing($user);

expectsDatabaseQueryCount

expectsDatabaseQueryCount 方法可以在测试开始时调用，以指定您期望在测试期间运行的数据库查询总数。如果实际执行的查询数量与此期望不完全匹配，测试将失败：

$this->expectsDatabaseQueryCount(5);

// 测试...