数据库测试

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

简介

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

每次测试后重置数据库

在进一步深入之前，让我们讨论一下如何在每次测试后重置数据库，以便前一个测试的数据不会干扰后续测试。Laravel 自带的 Illuminate\Foundation\Testing\RefreshDatabase trait 将为你处理这个问题。只需在你的测试类中使用该 trait：

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 trait 不会迁移你的数据库。相反，它只会在数据库事务中执行测试。因此，未使用此 trait 的测试用例添加到数据库中的任何记录可能仍然存在于数据库中。

如果你想完全重置数据库，你可以改用 Illuminate\Foundation\Testing\DatabaseMigrations 或 Illuminate\Foundation\Testing\DatabaseTruncation trait。但是，这两个选项都比 RefreshDatabase trait 慢得多。

模型工厂

在测试时，你可能需要在执行测试之前向数据库中插入一些记录。与其在创建测试数据时手动指定每个列的值，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 trait 的每个测试之前自动填充数据库。你可以通过在基础测试类中添加 Seed 属性来实现这一点：

<?php

namespace Tests;

use Illuminate\Foundation\Testing\Attributes\Seed;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

#[Seed]
abstract class TestCase extends BaseTestCase
{
}

当存在 Seed 属性时，测试将在每个使用 RefreshDatabase trait 的测试之前运行 Database\Seeders\DatabaseSeeder 类。但是，你可以通过在你的测试类上使用 Seeder 属性来指定应该执行的特定填充器：

<?php

namespace Tests\Feature;

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

#[Seeder(OrderStatusSeeder::class)]
class OrderTest extends TestCase
{
    use RefreshDatabase;

    // ...
}

可用的断言

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);

// 测试...