データベースのテスト (Database Testing)

• Introduction
  • 各テスト後のデータベースのリセット
• モデルファクトリー
• シーダーの実行
• 利用可能なアサーション

導入 (Introduction)

Laravel は、データベース駆動型アプリケーションのテストを容易にするさまざまな便利なツールとアサーションを提供します。さらに、Laravel モデル ファクトリとシーダーにより、アプリケーションの Eloquent モデルとリレーションシップを使用してテスト データベース レコードを簡単に作成できます。これらの強力な機能については、次のドキュメントで説明します。

各テスト後のデータベースのリセット

さらに先に進む前に、前のテストのデータが後続のテストに干渉しないように、各テストの後にデータベースをリセットする方法について説明します。 Laravel に含まれる Illuminate\Foundation\Testing\RefreshDatabase トレイトがこれを処理します。テストクラスでトレイトを使用するだけです。

<?php

use Illuminate\Foundation\Testing\RefreshDatabase;

pest()->use(RefreshDatabase::class);

test('basic example', function () {
    $response = $this->get('/');

    // ...
});

<?php

namespace Tests\Feature;

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

class ExampleTest extends TestCase
{
    use RefreshDatabase;

    /**
     * A basic functional test example.
     */
    public function test_basic_example(): void
    {
        $response = $this->get('/');

        // ...
    }
}

スキーマが最新の場合、Illuminate\Foundation\Testing\RefreshDatabase トレイトはデータベースを移行しません。代わりに、データベース トランザクション内でのみテストが実行されます。したがって、この特性を使用しないテスト ケースによってデータベースに追加されたレコードは、データベース内にまだ存在する可能性があります。

データベースを完全にリセットしたい場合は、代わりに Illuminate\Foundation\Testing\DatabaseMigrations または Illuminate\Foundation\Testing\DatabaseTruncation 特性を使用できます。ただし、これらのオプションは両方とも、RefreshDatabase 特性よりも大幅に遅くなります。

モデルファクトリー (Model Factories)

テストする場合、テストを実行する前にデータベースにいくつかのレコードを挿入する必要がある場合があります。このテストデータを作成するときに各列の値を手動で指定する代わりに、Laravel では、モデル工場 を使用して、Eloquent モデル ごとにデフォルト属性のセットを定義できます。

モデルを作成するためのモデル ファクトリの作成と利用の詳細については、完全な モデルファクトリーのドキュメント を参照してください。モデル ファクトリを定義したら、テスト内でそのファクトリを利用してモデルを作成できます。

use App\Models\User;

test('models can be instantiated', function () {
    $user = User::factory()->create();

    // ...
});

use App\Models\User;

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

    // ...
}

シーダーの実行 (Running Seeders)

機能テスト中に データベースシーダー を使用してデータベースにデータを入力する場合は、seed メソッドを呼び出すことができます。デフォルトでは、seed メソッドは DatabaseSeeder を実行し、これにより他のすべてのシーダーが実行されます。あるいは、特定のシーダー クラス名を seed メソッドに渡します。

<?php

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

pest()->use(RefreshDatabase::class);

test('orders can be created', function () {
    // Run the DatabaseSeeder...
    $this->seed();

    // Run a specific seeder...
    $this->seed(OrderStatusSeeder::class);

    // ...

    // Run an array of specific seeders...
    $this->seed([
        OrderStatusSeeder::class,
        TransactionStatusSeeder::class,
        // ...
    ]);
});

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

    /**
     * Test creating a new order.
     */
    public function test_orders_can_be_created(): void
    {
        // Run the DatabaseSeeder...
        $this->seed();

        // Run a specific seeder...
        $this->seed(OrderStatusSeeder::class);

        // ...

        // Run an array of specific seeders...
        $this->seed([
            OrderStatusSeeder::class,
            TransactionStatusSeeder::class,
            // ...
        ]);
    }
}

あるいは、RefreshDatabase トレイトを使用する各テストの前にデータベースを自動的にシードするように Laravel に指示することもできます。これを行うには、基本テスト クラスで $seed プロパティを定義します。

<?php

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    /**
     * Indicates whether the default seeder should run before each test.
     *
     * @var bool
     */
    protected $seed = true;
}

$seed プロパティが true の場合、テストは RefreshDatabase トレイトを使用する各テストの前に Database\Seeders\DatabaseSeeder クラスを実行します。ただし、テスト クラスで $seeder プロパティを定義することで、実行する特定のシーダーを指定できます。

use Database\Seeders\OrderStatusSeeder;

/**
 * Run a specific seeder before each test.
 *
 * @var string
 */
protected $seeder = OrderStatusSeeder::class;

利用可能なアサーション (Available Assertions)

Laravel は、Pest または PHPUnit 機能テスト用にいくつかのデータベース アサーションを提供します。これらの各主張については、以下で説明します。

アサートデータベース数

データベース内のテーブルに指定された数のレコードが含まれていることをアサートします。

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

アサートデータベース空

データベース内のテーブルにレコードが含まれていないことをアサートします。

$this->assertDatabaseEmpty('users');

データベースにアサートがある

データベース内のテーブルに、指定されたキー/値クエリ制約に一致するレコードが含まれていることをアサートします。

$this->assertDatabaseHas('users', [
    'email' => '[email protected]',
]);

アサートデータベースが見つかりません

データベース内のテーブルに、指定されたキー/値クエリ制約に一致するレコードが含まれていないことをアサートします。

$this->assertDatabaseMissing('users', [
    'email' => '[email protected]',
]);

アサートソフト削除済み

assertSoftDeleted メソッドは、特定の Eloquent モデルが「論理的に削除された」ことをアサートするために使用できます。

$this->assertSoftDeleted($user);

アサートノットソフト削除済み

assertNotSoftDeleted メソッドは、特定の Eloquent モデルが「論理的に削除」されていないことをアサートするために使用できます。

$this->assertNotSoftDeleted($user);

assertModelExists

指定されたモデルまたはモデルのコレクションがデータベースに存在することをアサートします。

use App\Models\User;

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

$this->assertModelExists($user);

アサートモデルが見つかりません

指定されたモデルまたはモデルのコレクションがデータベースに存在しないことをアサートします。

use App\Models\User;

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

$user->delete();

$this->assertModelMissing($user);

ExpectsDatabaseQueryCount

expectsDatabaseQueryCount メソッドは、テスト中に実行されることが予想されるデータベース クエリの総数を指定するために、テストの開始時に呼び出すことができます。実際に実行されたクエリの数がこの予想と正確に一致しない場合、テストは失敗します。

$this->expectsDatabaseQueryCount(5);

// Test...