데이터베이스 테스트

• 소개
  • 각 테스트 후 데이터베이스 재설정
• 모델 팩토리
• 시더 실행
• 사용 가능한 어서션

소개

Laravel은 데이터베이스 기반 애플리케이션을 테스트하기 쉽게 해주는 다양한 유용한 도구와 어서션을 제공합니다. 또한, Laravel 모델 팩토리와 시더를 사용하면 애플리케이션의 Eloquent 모델과 관계를 활용하여 테스트용 데이터베이스 레코드를 쉽게 만들 수 있습니다. 우리는 다음 문서에서 이러한 강력한 기능들에 대해 모두 다룰 것입니다.

각 테스트 후 데이터베이스 재설정

좀 더 진행하기 전에, 이전 테스트의 데이터가 이후 테스트에 영향을 미치지 않도록 각 테스트 후 데이터베이스를 재설정하는 방법을 논의하겠습니다. Laravel에 포함된 Illuminate\Foundation\Testing\RefreshDatabase 트레이트가 이 작업을 대신 처리해줍니다. 테스트 클래스에서 단순히 이 트레이트를 사용하면 됩니다:

php tab=Pest
<?php

use Illuminate\Foundation\Testing\RefreshDatabase;

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

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

    // ...
});

php tab=PHPUnit
<?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 특성보다 상당히 느립니다。

모델 공장

테스트를 수행할 때는 테스트를 실행하기 전에 데이터베이스에 몇 개의 레코드를 삽입해야 할 수 있습니다. 이 테스트 데이터를 생성할 때 각 열의 값을 수동으로 지정하는 대신， Laravel 을 사용하면 model factories 를 사용하여 Eloquent models 각각에 대한 기본 속성 집합을 정의할 수 있습니다。

모델 팩토리를 만들고 활용하여 모델을 만드는 방법에 대해 자세히 알아보려면 전체 모델 팩토리 문서 를 참조하세요. 모델 팩토리를 정의하면 테스트 내에서 팩토리를 활용하여 모델을 만들 수 있습니다：

php tab=Pest
use App\Models\User;

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

    // ...
});

php tab=PHPUnit
use App\Models\User;

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

    // ...
}

시더 실행하기

기능 테스트 중에 데이터베이스 시더를 사용하여 데이터베이스를 채우고 싶다면, seed 메서드를 호출할 수 있습니다. 기본적으로, seed 메서드는 DatabaseSeeder를 실행하며, 이는 다른 모든 시더를 실행해야 합니다. 또는 특정 시더 클래스 이름을 seed 메서드에 전달할 수도 있습니다:

php tab=Pest
<?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 tab=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;

    /**
     * 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,
            // ...
        ]);
    }
}

또는 Laravel에게 RefreshDatabase 트레이트를 사용하는 각 테스트 전에 자동으로 데이터베이스를 시드하도록 지시할 수 있습니다. 이는 기본 테스트 클래스에 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 특성을 사용하는 각 테스트 전에 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);

// Test...