← Заметки и статьи о Laravel PHP

25 июня 2015 перевод

Интеграционное тестирование в Laravel 5.1: Фабрики моделей

При тестировании кода часто приходится создавать тестовые записи одной или нескольких моделей. Вы могли использовать нечто такое:

$post = new Post;
$post->title = 'Fake Blog Post Title';
$post->body = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam lorem erat, luctus at diam sed, dapibus facilisis purus. In laoreet enim nunc, ut pretium arcu scelerisque in. Nunc eu cursus nibh. Etiam pulvinar vulputate libero sed molestie. In condimentum varius faucibus. Vestibulum non blandit sapien, quis tincidunt augue. Aliquam congue sapien eget mattis sagittis.';
$post->save();

Такой код посреди теста уже выглядит ужасным. Но что, если нужно создать несколько тестовых записей? Сделать их отличающимися друг от друга? Способ выше не подходит.

Фабрика

Если вы использовали TestDummy или Faktory, то вам, наверное, уже знакомы «фабрики» для создания тестовых записей для тестирования.

Эти библиотеки делают создание тестовых записей очень простым. Вы просто указываете им класс, объекты которого нужно получить и заполнить тестовыми данными.

Стоит обратить внимание на то, что не обязательно указывать и заполнять все поля модели. Вы можете указать лишь те, которые необходимы в контексте тестирования.

Чтобы узнать больше о том, как работают фабрики, вы можете обратиться к статье Adam Wathan's.

Пример

Давайте посмотрим на пример фабрики в Laravel 5.1:

// app/database/ModelFactory.php
$factory->define(AppPost::class, function () {
    return [
        'title' => 'My Awesome Post',
        'body' => 'The Body'
    ];
});

Вы указали фабрике, что каждый раз при запросе из неё класса AppPost она должна отдавать объект с заданными атрибутами. Достаточно просто.

Получение объекта из фабрики

Для получения объекта можно воспользоваться методом make():

$post = factory(AppPost::class)->make();

dd($post->toArray());
/* Возвратит:
array:2 [
  "title" => "My Awesome Post"
  "body" => "The Body"
]
*/

Создание нескольких объектов

Для создания нескольких объектов достаточно задать количество вторым аргументом:

$posts = factory(AppPost::class, 3)->make();

Готово. Теперь у вас есть коллекция объектов класса AppPost.

dd($posts->toArray());

/* Возвратит:
array:3 [
  0 => array:2 [
    "title" => "My Awesome Post"
    "body" => "The Body"
  ]
  1 => array:2 [
    "title" => "My Awesome Post"
    "body" => "The Body"
  ]
  2 => array:2 [
    "title" => "My Awesome Post"
    "body" => "The Body"
  ]
]
*/

Используем Faker

Вы, наверное, обратили внимание, что у всех объектов класса AppPost одни и те же атрибуты.

Для генерации случайных тестовых атрибутов можно воспользоваться библиотекой Faker. Она полезна как для тестирования, так и для заполнения базы данных тестовыми значениями.

Faker теперь встроен в Laravel 5.1:

$factory->define(AppPost::class, function ($faker) {
    return [
        'title' => $faker->sentence,
        'body' => $faker->paragraph
    ];
});

Теперь каждый раз при создании новой записи фабрика будет заполнять её случайными данными.

$posts = factory(AppPost::class, 3)->make();

dd($posts->toArray());

/* Возвратит:
array:3 [
  0 => array:2 [
    "title" => "Ea quis animi ex eius in aut."
    "body" => "Animi velit rerum corrupti quod nam consequuntur. Eius mollitia ut voluptatum laborum quod ex est. Id et aut aut molestias distinctio illo."
  ]
  1 => array:2 [
    "title" => "Illo quod doloribus placeat."
    "body" => "Ea dolorem eligendi modi sit. Facilis incidunt et sequi velit quia. Ab ipsa dicta dolor doloribus."
  ]
  2 => array:2 [
    "title" => "Quod qui ea et quo."
    "body" => "Iure atque vel rerum perspiciatis voluptatem eligendi provident molestiae. Porro aut est accusamus aut. Tempora quisquam ea delectus nihil hic quidem alias velit. Necessitatibus et illum quo culpa ad sint."
  ]
]
*/

Сохранение в базе данных

Для сохранения созданных через фабрику объектов в базу данных достаточно воспользоваться методом create():

factory(AppPost::class, 20)->create();

Готово. Теперь в вашей базе данных 20 новых записей.

Несколько примеров

Использование в тестах:

<?php
...
class PostRepositoryTest extends TestCase
{
    public function test_it_paginates()
    {
        factory(AppPost::class, 50)->create();

        $thisPage = (new AppPostRepository)->paginate();

        $this->assertEquals(20, $thisPage->count());
    }
}

Фабрики хороши для интеграционных тестов, но они также подходят для небольших функциональных или юнит тестов.

В тесте выше мы проверяем, что наша пагинация работает корректно и возвращает 20 записей.

А вот пример небольшого интеграционного теста:

<?php
...
class PostListPageTest extends TestCase
{
    public function test_list_page_paginates()
    {
        factory(AppPost::class, 50)->create();

        $this->visit('/posts')
            ->see('Next Page');
    }
}

Здесь мы проверяем появление кнопки «Next Page» на нашей странице при срабатывании пагинации.

Изменение отдельных моделей фабрики

Что, если нам необходимо, чтобы атрибуты конкретной модели были такими, как нам нужно для теста?

Достаточно добавить массив аргументов методам make() или create():

$user = factory(AppPost::class)->make([
    'title' => 'THE GREATEST POST',
]);

Группировка моделей в фабрике

Мы также можем сгруппировать различные типы моделей. Например, у нас будут записи с длинным текстом и коротким. Для этого можно воспользоваться методом defineAs():

$factory->defineAs(AppPost::class, 'short-post', function ($faker) {
    return [
        'title' => $faker->sentence,
        'body' => $faker->paragraph
    ];
});

$factory->defineAs(AppPost::class, 'long-post', function ($faker) {
    return [
        'title' => $faker->sentence,
        'body' => implode("

", $faker->paragraphs(10))
    ];
});

Или вы можете расширить базовый тип изменённым:

$factory->define(AppPost::class, function ($faker) {
    return [
        'title' => $faker->sentence,
        'body' => $faker->paragraph
    ];
});

$factory->defineAs(AppPost::class, 'long-post', function ($faker) use ($factory) {
    $post = $factory->raw('AppPost');

    return array_merge($post, ['body' => implode("

", $faker->paragraphs(5))]);
});

Добавление связей к моделям

Тут всё просто благодаря магии коллекций Laravel:

$posts = factory('AppPost', 3)
    ->create()
    ->each(function($post) {
        $post->relatedItems()->save(factory('AppItem')->make());
    });

Заключение

Фабрики моделей давно были мощным средством тестирования и заполнения базы тестовыми данными. Теперь они встроены в фреймворк, что делает процесс тестирования проще.

Продолжение следует...

Источник: https://mattstauffer.co/blog/better-integration-testing-in-laravel-5.1-model-factories

Плюсануть
Поделиться
Отправить