Тестирование · База данных

Введение

Laravel предлагает множество полезных инструментов, чтобы упростить тестирование приложений, использующих базу данных. Фабрики моделей (factory) и наполнители (seeders) позволяют безболезненно создавать записи тестовой базы данных с использованием моделей и отношений Eloquent вашего приложения. Мы обсудим все эти мощные функции в текущей документации.

Сброс базы данных после каждого теста

Прежде чем продолжить, давайте обсудим, как сбрасывать вашу базу данных после каждого из ваших тестов, чтобы данные из предыдущего теста не мешали последующим тестам. Включенный в Laravel трейт Illuminate\Foundation\Testing\RefreshDatabase позаботится об этом за вас. Просто используйте трейт в своем тестовом классе:

<?php

use Illuminate\Foundation\Testing\RefreshDatabase;

uses(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.

Фабрики моделей

При тестировании может возникнуть необходимость вставить несколько записей в вашу базу данных перед выполнением теста. Вместо ручного указания значения каждого столбца при создании тестовых данных 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();

    // ...
}

Запуск наполнителей (seed, seeders)

Если вы хотите использовать наполнители базы данных для наполнения вашей базы данных во время функционального тестирования, то вы можете вызвать метод seed. По умолчанию метод seed будет запускать DatabaseSeeder, который должен запускать все другие ваши наполнители. Как вариант, вы можете передать конкретное имя класса-наполнителя методу seed:

<?php

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

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

В качестве альтернативы, вы можете указать 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, тогда класс Database\Seeders\DatabaseSeeder будет запускаться перед каждым тестом, который использует трейт RefreshDatabase. Однако, вы можете указать конкретный наполнитель, который должен выполняться, определив свойство $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);

// Test...