1 Установка
Пакет Enlighten устанавливается в проект Laravel с помощью менеджера зависимостей Composer
composer require styde/enlighten --dev
Полная информация по установке проекта доступна по ссылке:
https://github.com/StydeNet/enlighten
Помимо установки самого пакета, необходимо создать дополнитульную базу данных для вашего проекта. Подключение к базе осуществляется в файле config/database.php. После чего необходимо выполнить миграции.
2 Создание тестов
Enlighten тесно интегрирован с системой тестирования Laravel.
По умолчанию каталог тестов приложения содержит два каталога: Feature и Unit.
Feature, функциональное тестирование.
Тесты функций могут тестировать большую часть кода и даже полный HTTP-запрос к конечной точке JSON. Как правило, большинство тестов приложения должны быть функциональными. Эти типы тестов обеспечивают максимальную уверенность в том, что система в целом работает должным образом.
Unit, модульное тестирование.
Модульные тесты - это тесты, которые фокусируются на очень небольшой изолированной части кода. Тесты из каталога «Unit» не загружают приложение Laravel и, следовательно, не могут получить доступ к базе данных вашего приложения или другим службам фреймворка.
Итак, создаём функциональный тест
php artisan make:test AccountTest
После чего в папке tests/Feature появится файл AccountTest.php
В одном классе тестов может быть несколько функций с тестами, название функции должно начинаться с префикса "test_", например "test_get" или "test_post".
Вносим следующие изменения в файл AccountTest.php:
namespace Tests\Feature;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Tests\TestCase;
/**
* @description Информация по пользовательскому аккаунту. Модель Account
*/
class AccountTest extends TestCase
{
/**
* @description Аккаунт авторизованного пользователя
* @method get
* @return void
*/
public function test_get()
{
$response = $this->get('/account?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...');
$response->assertStatus(200);
}
/**
* @description Обновление аккаунта пользователя
* @method post
* @return void
*/
public function test_post()
{
$response = $this->post('/account?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...');
$response->assertStatus(200);
}
}
Обратите внимание на PHPdoc-блок @description, который мы прописали для метода и для всего класса. Enlighten будет его использовать для описания группы тестов (@description класса) и функции теста (@description метода).
3 Конфигурирование enlighten
Настройки для Enlighten хранятся в файле config/enlighten.php.
Группировать тесты по категориям можно в с помощью элемента массива modules:
'modules' => [
[
'name' => 'Пользователи',
'classes' => ['*User*','*Register*', '*Account*'],
'routes' => ['users/*'],
],
[
'name' => 'Другие модули',
'classes' => ['*'],
],
]
Таким образом мы получили категории Пользователи и Другие модули. В каждой категории находялся группы (классы) тестов. В каждой группе - функция теста.
Т.к. мы создавали функциональный тест, в Enlighten меню всё это находится в разделе Features.
Раздел Features выглядит так:
4 Тесты и результаты тестов
После того как тесты созданы и конфигурирование Enlighten-а настроено, можно приступать к тестированию.
Перед запуском тестов, необходимо почистить кэш конфига. Запустить тесты можно командой
php artisan enlighten
При этом успешные тесты сохраняются в базу данных Enlighten-a.
Подробную информацию (документацию проекта) по тестам и группам тестов, с учётом PHPdoc-блоков, можно получить по адресу:
http://localhost:8000/enlighten
Чтобы получить полную информацию по тесту, заново его проходить не требутеся. Для этого достаточно перейти по определённой ссыкле.
Так выглядит один из тестов группы Account (класса AccountTest.php)
Если response теста вовзращает не JSON, а view(), то возвращается примерно такой ответ:
Так же имеется возможность экспортировать тесты в html-файлы, с помощью команды
php artisan enlighten:exportПо сути, это та же документация, но доступна без сервера.