7 days of WordPress plugins, themes & templates - for free!* Unlimited asset downloads! Start 7-Day Free Trial
Advertisement
  1. Code
  2. PHP

Тестирование контроллеров в Laravel

Scroll to top
Read Time: 17 mins

Russian (Pусский) translation by Sergey Zhuk (you can also view the original English article)

Тестирование контроллеров - не самая легкая штука в мире. Или если перефразировать, то тестировать их трудно до тех пор, пока не станет понятно, что нужно тестировать.

Нужно ли в тестах контроллеров проверять текст на странице? Стоит ли затрагивать базу данных? Стоит ли проверять наличие переменных в файлах отображений? Если это ваш первый раз, когда вы собираетесь тестировать контроллеры, то все эти вопросы могут легко возникнуть у вас. Разрешите вам помочь.

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

Процесс тестирования контроллеров может быть разделен на три части.

  • Изоляция: мокаем все зависимости (возможно и включая View).
  • Вызов: выполняем нужный метод контроллера.
  • Проверка: Выполнение утверждений, что состояние было установлено должным образом.

Hello World в тестировании контроллеров

Лучше всего разобраться в этих вещая, изучая примеры. Рассмотрим "hello world" в тестировании контроллеров Laravel.

Laravel использует несколько компонентов Symfony, чтобы облегчить процесс тестирования маршрутов и представлений, включая HttpKernel, DomCrawler и BrowserKit. Вот почему нужно, чтобы ваши PHPUnit тесты были унаследованы не от PHPUnit\_Framework\_TestCase, а от TestCase. Не беспокойтесь, Laravel попревшему их использует, но при этом расширяет, чтобы можно было настроить приложение Laravel для тестирования, а так же предоставить большое разнообразие методов-хелперов для проверки утверждений. Подробнее об этом в ближайшее время.

В примере кода выше мы делаем GET запрос к /posts, или localhost:8000/posts. Предполагая, что эта строчка кода была использована на свежей установке Laravel, Symfony генерирует исключение NotFoundHttpException. Попробуйте сами, выполнив phpunit из командной строки.

На человеческом языке это означает: "Эй, я попробовал сделать запрос к этому маршруту, но у тебя, дурак, там ничего не зарегистрировано!".

Как вы можете себе представить, такой тип запроса будет очень распространенным, так что имеет смысл предоставить для него собственный метод, такой как $this-> call(). И в самом деле у Laravel есть такой! Это означает, что предыдущий пример можно переписать следующим образом:

Перегрузка — это ваш друг

Хотя мы и будем придерживаться базового функционала в этой главе, но в моих личных проектов я делаю шаг дальше, и определяю такие методы, как $this-> get(), $this-> post(), и др. Благодаря перегрузки PHP для этого требуется добавить один единственный метод в класс app/tests/TestCase.php.

Теперь вы можете использовать $this->get('posts') и получить точно такой же результат, как и в предыдущих двух примерах. Как было замечено выше, продолжим работать дальше с базовым функционалом фреймворка.

Чтобы заставить эти тесты выполняться, нам всего лишь нужно подготовить нужный маршрут.

Повторный запуск phpunit в этот раз вернет нам зеленый цвет.


Хелперы подтверждений Laravel

Чаще всего вы будете писать тесты, которые будут проверять, что контролер передает определенные переменные в файл отображения. Например, метод index контроллера PostsController должен передать переменную $posts в соответствующее отображение, верно? Чтобы таким образом в отображении можно было перебрать все посты и отобразить их на странице. Это очень важный тест, который следовало бы написать!

Если это является довольно распространенной задачей, то почему бы Laravel не предоставить для этого соответствующую проверку утверждения? Конечно, это так. И конечно же Laravel предоставит.

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

  • assertViewHas
  • assertResponseOk
  • assertRedirectedTo
  • assertRedirectedToRoute
  • assertRedirectedToAction
  • assertSessionHas
  • assertSessionHasErrors

Следующие примеры вызывают GET /posts и проверяют, что файл отображения получает переменную $posts.

Совет: когда заходит вопрос о форматировании, я предпочитаю оставлять пустую строку между проверкой утверждения теста и кодом, который подготавливает состояние.

assertViewHas является просто синтаксическим сахаром и анализирует объект ответа, который был возвращен из метода $this->call(), проверяя, что данные, связанные с отображением, содержат переменную posts.

При исследовании содержимого объекта ответа, есть два основных варианта.

  • $response->getOriginalContent(): возвращает оригинальный контент, или возвращенный из View. Так же можно воспользоваться свойством original напрямую, вместо вызова метода getOriginalContent.
  • $response->getContent(): возвращает отрисованный вывод. Если из маршрута возвращается экземпляр View, то getContent() вернет HTML. Это может быть полезно для проверок структуры DOM, таких как "в отображении должна содержаться строка".

Представим, что маршрут posts имеет следующее содержимое:

Если мы выполним phpunit, то получим полезное сообщение о нашем следующем шаге.

Чтобы тесты выполнились, нам просто нужно получить посты и передать их в отображение.

Важно заметить одну вещь, что этот код проверяет лишь только то, что переменная $posts была передана в отображение. Он не проверяет само ее значение. Метод assertViewHas принимает дополнительный второй аргумент, чтобы проверить как значение переменной, так и ее существование.

В этом модифицированном примере, несмотря на то что, переменная $posts была передана в отображение, она равна foo, соответственно тесты не выполнятся. В такой ситуации лучше не проверять на определенное значение, а вместо этого проверять что объект является экземпляром класса Illuminate\Database\Eloquent\Collection. Как нам это реализовать? У PHPUnit есть полезный метод assertInstanceOf, как раз подходящий под наши нужды.

Теперь мы проверяем, что переменная $posts, переданная контроллером должна обязательно быть экземпляром класса Illuminate\Database\Eloquent\Collection. Отлично.


Мокаем базу данных.

Однако до сих пор есть одна вопиющая проблема с нашими тестами. Вы уже поняли какая?

Для каждого теста выполняется SQL запрос к базе данных. Хотя для некоторых видов тестирования (приемочное и интеграционное) это может быть и нужно, но для простого тестирования контроллеров, это только снизит производительность.

На данный момент я уже наверно просверлил вам череп. Мы не заинтересованы в тестировании возможности Eloquent доставать записи из базы. У него есть свои собственные тесты. Тэйлор знает свою работу! Давайте не будем тратить время и силы, повторяя те же тесты.

Вместо этого лучше замокать базу данных, и просто убедиться, что соответствующие методы вызываются с нужными аргументами. Или другими словами, нужно убедиться что метод Post::all() никогда не будет вызван и не затронет базу данных. Мы знаем, что он работает и он не нуждается в тестах.

Эта секция будет полностью зависеть от библиотеки Mockery. Пожалуйста, просмотрите эту главу из моей книги, если вы еще не знакомы с ней.

Необходимый рефакторинг

К сожалению мы написали свой код так, что его практически невозможно тестировать.

Именно поэтому считается плохой практикой делать прямые вызовы к методам Eloquent прямо из контроллеров. Не путайте фасады в Laravel, которые в целях тестирования могут быть заменены на моки (Queue::shouldReceive()), с моделями Eloquent. Решением является инъекция уровня абстракции базы данных в контроллер через конструктор. А это потребует небольшого рефакторинга.

Внимание: расположение логики внутри колбэков маршрутов может быть полезно для мелких проектов и API, но при этом создает большие проблемы при тестировании. Для приложений более-менее серьезных размеров использоуйте контроллеры.

Зарегистрируем новый ресурс, заменив маршрут posts на следующий:

... создадим необходимый для работы ресурса контроллер с помощью Artisan.

Теперь вместо того, чтобы напрямую ссылаться на модель Post, встроем эту зависимость через конструктор контроллер. Вот сокращенный пример, в котором пропущены все restful методы за исключением одного, который мы в настоящее время рассматриваем в тестировании.

Обратите внимание что лучше указать тип интерфейса, чем ссылаться на саму модель Eloquent. Но всему свое время! Давайте работать дальше.

Это гораздо лучший способ организации кода. Так как модель теперь встроена как зависимость, мы теперь можем подменить ее замоканной версией для тестирования. Вот пример того, как это можно сделать:

Ключевое преимущество такого подхода в том, что к базе данных не будет сделано ни одного запроса. Вместо этого, используя Mockery, мы просто проверяем что метод all у модели был вызван.

К сожалению если вы решили отказаться от кодирования на основе интерфейсов, и вместо этого встроете модель Post в контроллер, то из-за статики, могут быть проблемы при использовании Mockery. Именно поэтому мы заменяем как Post, так и Eloquent классы в конструкторе теста, до загрузки их оригинальных верси1. Таким образом у нас появляется возможность задать ожидания в тестах. Минусом такого подхода является то, что мы не можем обратится к любому из существующим методов с помощью Mockery, используя makePartial().

IoC контейнер

Контейнер зависимостей Laravel во много раз упрощает процесс встраивания зависимостей в ваши классы. Каждый раз, когда запрашивается контроллер, он достается из контейнера зависимостей. Таким образом когда нам нужно объявить, что мок-версию Post следует использовать для тестирования, мы всего лишь должны предоставить Laravel соответствующий экземпляр Post, который следует использовать.

Рассматривайте этот код как, "Эй Laravel, когда тебе нужен экземпляр Post, используй мою замоканную версию". Так как app наследуется от Container, то у нас есть доступ ко всем методам контейнера.

После создания экземпляра контроллера Laravel использует возможности отражения PHP для чтения подсказок типов и встраивает все зависимости для вас сам. Именно так! Не нужно делать для этого привязку в самом контейнере, он все сделает автоматически!


Редиректы

Еще одна проверка, которую вы постоянно будете использовать, это проверка что пользователь был перенаправлен в нужное место, возможно с добавлением нового поста в базу данных. Как мы можем это сделать?

Предполагая, что мы следуем restfull, то чтобы добавить новый пост, мы должны сделать POST запрос к коллекции или posts (не путать метод запроса POST с именем ресурса).

Затем нам нужно всего лишь воспользоваться другой проверкой утверждения Laravel - assertRedirectedToRoute.

Совет: когда в Laravel регистрируется ресурс (Route::resource()), то фреймворк автоматически регистрируется все необходимые маршруты. Можете выполнить php artisan routes, если вы вдруг забыли имена этих маршрутов.

Вы так же возможно захотите проверить, что супреглобальная переменная $_POST была передана методу create. Хотя в действительности мы физически и не отправляем форму, мы попрежнему можем реализовать это с помощью метода Input::replace(), который позволяет подделать этот массив. Вот пример измененного теста, который использует метод Mockery with(), чтобы проверить аргументы, переданные в метод с помощью shouldReceive.


Пути

Еще одна вещь, которую мы не рассмотрели в тестах - это валиация. Есть два различных сценария в методе store, в зависимости от того, прошла валидация успешно или нет:

  1. Возвращаемся назад к форме "Create Post" и показываем ошибки валидации.
  2. Перенаправляем на коллекцию или на одноименный маршрут, posts.index.

Лучше всего, когда каждый тест затрагивает свой отдельный сценарий.

Первый будет для неуспешной валидации.

Код выше явно определяет какие ошибки должны существовать. Кроме того, можно опустить аргумент assertSessionHasErrors, в этом случае будет просто проверка, что пресутствовали сообщения (что редирект включает в себя withErrors($errors)).

Теперь тест, который проверяет успешную валидацию.

Код для этих обоих тестов может выглядеть следующим образом:

Обратите внимание, как Validator встраивается прямо в контроллер? В общем рекомендовал бы вынести это в абстракцию в виде сервиса. Таким образом, вы сможете тестировать валидацию изолированно от любых контроллеров или маршрутов. Тем не менее давайте оставим для простоты все как есть. Единственное на что стоит обратить внимание, что в действительности мы не мокаем Validator, хотя безусловно можно сделать и это. Так как этот класс является фасадом, то его легко можно подменить замоканной версией, через метод shouldReceive без необходимости инъекции через конструктор. Win!

Время от время вы станете замечать, то метод, который нужно замокать, должен возвращать объект, самого себя. К счастью, с Mockery это легко сделать, нужно только лишь создать анонимную заглушку, и передать массив, который представляет собой имя метода и значение ответа соответственно. Например так:

мы подготовляем объект, который содержит метод fails() и возвращает true.


Репозитории

Для оптимальной гибкости, вместо того, чтобы создать прямую связь между контроллер и ORM, как Eloquent, лучше работать с интерфейсами. Значительным преимуществом такого подхода является, что вам возможно необходимо будет сменить Eloquent на Mongo или Redis, что при таком подходе потребует изменения лишь одной строчки кода. И более того, контроллер даже не будет затронут.

Репозитории представляют уровень доступа к данным в вашем приложении.

Как может выглядеть интерфейс для работы с уровнем базы данных для модели Post? Начнем.

Его конечно же можно будет расширить, но мы добавим необходимый минимум методов: all, find и create. Обратите внимание что интерфейсы репозиториев располагаются в app/repositories. Так как эта папка по умолчанию не используется при автозагрузке, то нам необходимо обновить файл composer.json.

Когда новый класс добавляется в директорию, не забывайте запускать composer dump-autoload -o. Флаг -o (optimize) является необязательным, но рекомендуется его постоянно использовать,

Если вы попытаетесь встроить этот интерфейс в ваш контроллер, то Laravel этого не позволит сделать. Продолжаем; попробуем и посмотрим, что получится. Вот измененный PostController, который был обновлен на использование инъекции интерфейса, вместо простой Eloquent модели Post.

Если запустите сервер и посмотрите вывод, то встретите страницу с ошибкой, которая сообщает что "PostRepositoryInterface is not instantiable."

Not InstantiableNot InstantiableNot Instantiable

Если задуматься, то понятно почему фреймворк ругается на это! Laravel умен, но не умеет читать мысли. Ему нужно указать какую именно реализацию интереса следует использовать внутри контроллера.

Сейчас давайте добавим эту привязку в app/routes.php. Затем воспользуемся сервис провайдерами для расположения подобного рода логики.

Перефразируем этот вызов функции как "Laravel, детка, когда тебе потребуется экземпляр PostRepositoryInterface, я хочу, чтобы ты использовал EloquentPostRepository."

app/repositories/EloquentPostRepository просто будет оберткой над Eloquent, которая реализует PostRepositoryInterface. Таким образом, мы не ограничиваем API (или любую другую реализацию) на интерпретацию Eloquent; мы можем назвать методы как захотим.

Некоторые из вас могут возразить, что модель Post следует встроить в эту реализацию для целей тестирования. Если вы согласны, то просто встройте ее через конструктор как обычно.

Это все, что нужно сделать! Обновляем браузер, и все снова работает. Только теперь ваше приложение гораздо лучше структурировано, и контроллер более не привязан к Eloquent.

Представим что через несколько месяцев спустя, ваш босс приходит к вам и говорит, что вам нужно заменить Eloquent на Redis. Отлично, так как мы организовали наше приложение для подобного рода изменений, все что будет нужно - это создать новую реилизацию app/repositories/RedisPostRepository.

И обновить привязку:

Теперь мгновенно в контролере будет использоваться Redis. Вы обратили внимание что app/controllers/PostsController.php даже не затрагивался нами. В этом то и вся прелесть!


Структура

Пока что в этом уроке, наша организация была не самой лучшей. Привязки контейнера в файле routes.php? Все репозитории сгруппированы вместе в одной директории? Конечно такой подход может работать вначале, но очень скоро окажется, что это никак не масштабируется.

В заключительной части статьи, мы изменим наш код в сторону PSR, и используем сервис провайдеров для регистрации наших привязок в контейнере.

PSR-0 определяет обязательные требования, которые должны соблюдаться для автозагрузчика.

Автозагрузчик PSR-0 может быть зарегистрирован через Composer, с помощью объекта psr-0.

Синтаксис сперва может показаться непонятным. Тоже самое было и для меня. Простым способом расшифровать "Way": "app/lib/" будет подумать про себя "базовая папка для пространства имен Way находится в app/lib". Конечно же замените здесь мою фамилию на название вашего собственного проекта. Структура папок при этом должна быть следующей:

  • app/
    • lib/
    • Way/

Затем вместе группирования всех репозиториев в папке repositories, более элегантным решением будет сгруппировать их по категориям в различные папки, вроде этого:

  • app/
    • lib/
    • Way/
      • Storage/
      • Post/
        • PostRepositoryInterface.php
        • EloquentPostRepository.php

Важно, что мы придерживаемся этого соглашения именования файлов и папок, если мы хотим чтобы автозагрузчик работал так, как ожидалось. Единственная вещь, которая осталась - это обновить пространства имен для PostRepositoryInterface и EloquentPostRepository.

И реализация:

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

Сервис провайдеры - это не более чем загрузчики классов, которые могут делать все, что вам нужно: зарегистрировать привязку, обработать событие, импортировать файл маршрутов и прочее.

Laravel автоматически вызовет метод register() у сервис провайдера.

Чтобы дать знать Laravel о новом сервис провайдере, необходимо добавить его в файл app/config/app.php в массив providers.

Отлично; теперь у нас есть отдельный файл для регистрации новых привязок.

Обновляем тесты

Имея в виду нашу новую структуру, теперь вместо того чтобы мокать саму модель Eloquent, мы можем замокать PostRepositoryInterface. Вот пример одного из таких тестов:

Однако мы можем улучшить и это. Очевидно, что каждый метод PostsControllerTest потребует замоканную версию репозитория. Таким образом гораздо лучше будет выделить эту отдельную подготовительную работу в свой собственный метод следующим образом:

Неплохо, да?

Теперь вы даже можете использовать моки с моделью Eloquent. Это позволит выполнить следующее:

За кулисами будет замокан PostRepositoryInterface и обновлена привязка в контейнере. Вы уже не сможете получить код гораздо проще, чем этот!

Чтобы получить возможность использовать подобного рода синтаксис, нужно обновить модель Post, а еще лучше BaseModel, от которой наследуются все Eloquent модели. Вот примере этого:

Если вы сможете справиться с внутренним диалогом "Должен ли я встраивать тестовую логику в боевой код", то обнаружите, что это позволяет сделать тесты гораздо более читабельными.

Хорошо, не правда ли? Надеюсь, эта статья не была слишком нудной. Главное что стоит подчерпнуть из этой статьи - это организация ваших репозиториев таким образом, чтобы можно было их легко мокать и встраивать в ваши контроллеры. В результате использования такого подхода, ваши тесты будут выполняться молниеносно!

Эта статья — отрывок из моей предстоящей книги Laravel Testing Decoded. Оставайтесь со мной до ее выпуска в мае 2013 г.!

Advertisement
Did you find this post useful?
Want a weekly email summary?
Subscribe below and we’ll send you a weekly email summary of all new Code tutorials. Never miss out on learning about the next big thing.
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.