Автоматический сброс базы данных перед каждым тестом

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

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

1

$ composer require --dev dama/doctrine-test-bundle

Теперь, включите его как расширание PHPUnit:

1
2
3
4
5
6
7
8

<!-- phpunit.xml.dist -->
<phpunit>
    <!-- ... -->

    <extensions>
        <extension class="DAMA\DoctrineTestBundle\PHPUnit\PHPUnitExtension"/>
    </extensions>
</phpunit>

Вот и все! Этот пакет использует умный фокус: он начинает транзакцию базы данных перед каждым тестом и автоматически сбрасывает ее после окончания теста, чтобы отменить все изменения. Прочтите больше в документации DAMADoctrineTestBundle.

Загрузка фикстур фиктивных данных

Вместо использования реальных данных из базы данных производства, в базе данных тестов часто используются ложные или фиктивные данные. Это обычно называется "фикстурными данными" и Doctrine предоставляет библиотеку дла их загрузки и создания. Установите ее:

1

$ composer require --dev doctrine/doctrine-fixtures-bundle

Затем, используйте команду make:fixtures пакета SymfonyMakerBundle, чтобы сгенерирувать пустой класс фикстуры:

1
2
3
4

$ php bin/console make:fixtures

Имя класса фикстур для создания (например, AppFixtures):
> ProductFixture

Затем вы изменяете этот класс, чтобы загружать новые сущности в базу данных. Например, чтобы загрузить объекты Product в Doctrine, используйте:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// src/DataFixtures/ProductFixture.php
namespace App\DataFixtures;

use App\Entity\Product;
use Doctrine\Bundle\FixturesBundle\Fixture;
use Doctrine\Persistence\ObjectManager;

class ProductFixture extends Fixture
{
    public function load(ObjectManager $manager): void
    {
        $product = new Product();
        $product->setName('Priceless widget');
        $product->setPrice(14.50);
        $product->setDescription('Ok, I guess it *does* have a price');
        $manager->persist($product);

        // добавить больше продуктов

        $manager->flush();
    }
}

Очистите базу данных и перезагрузите все классы фикстур с помощью:

1

$ php bin/console doctrine:fixtures:load

Чтобы узнать больше, прочтите документацию DoctrineFixturesBundle.

Несколько запросов в одном тесте

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

Во-первых, вы можете вызвать клиентский метод
disableReboot(), чтобы сбросить настройки ядра вместо его перезагрузки. На практике Symfony будет вызывать метод reset() каждого сервиса, помеченного тегом kernel.reset. Однако при этом также очищается токен безопасности, отсоединяются сущности Doctrine и т.д.

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

// src/Kernel.php
namespace App;

use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Kernel as BaseKernel;

class Kernel extends BaseKernel implements CompilerPassInterface
{
    use MicroKernelTrait;

    // ...

    protected function process(ContainerBuilder $container): void
    {
        if ('test' === $this->environment) {
            // prevents the security token to be cleared
            $container->getDefinition('security.token_storage')->clearTag('kernel.reset');

            // prevents Doctrine entities to be detached
            $container->getDefinition('doctrine')->clearTag('kernel.reset');

            // ...
        }
    }
}

Просмотр сайта

Клиент поддерживает множество операций, которые можно сделать в реальном браузере:

1
2
3
4
5
6

$client->back();
$client->forward();
$client->reload();

// очищает все куки и историю
$client->restart();

Перенаправление

Когда запрос возвращает ответ перенаправления, клиент не следует ему автоматически. Вы можете исследовать ответ и форсировать перенаправление после этого методом followRedirect():

1

$crawler = $client->followRedirect();

Если вы хотите, чтобы клиент автоматически следовал всем перенаправлениям, вы можете форсировать их, вызвав метод followRedirects() до выполнения запроса:

1

$client->followRedirects();

Если вы передадите false методу followRedirects(), перенаправления больше учитываться не будут:

1

$client->followRedirects(false);

Вход пользователей в систему (аутентификация)

Когда вы хотите добавить тесты приложения к защищенной странице, вам нужно для начала выполнить "вход" в качестве пользователя. Выполнение необходимых шагов - таких как отправка формы входа в систему - делает тест очень медленным. По этой причине, Symfony предоставляет метод loginUser(), чтобы симулировать вход в систему в ваших функциональных тестах.

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

После загрузки пользователей в вашу базу данных, используйте хранилище пользователей, чтобы извлечь этого пользователя и используйте $client->loginUser(), чтобы сымитириовать запрос входа в систему:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

// tests/Controller/ProfileControllerTest.php
namespace App\Tests\Controller;

use App\Repository\UserRepository;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

class ProfileControllerTest extends WebTestCase
{
    // ...

    public function testVisitingWhileLoggedIn(): void
    {
        $client = static::createClient();
        $userRepository = static::getContainer()->get(UserRepository::class);

        // извлечь тестового пользователя
        $testUser = $userRepository->findOneByEmail('john.doe@example.com');

        // симулировать вход $testUser в систему
        $client->loginUser($testUser);

        // тестировать, например, страницу профиля
        $client->request('GET', '/profile');
        $this->assertResponseIsSuccessful();
        $this->assertSelectorTextContains('h1', 'Hello John!');
    }
}

Вы можете передать любой экземпляр UserInterface методу loginUser(). Этот метод создает специальный объект TestBrowserToken и хранит его в сессии тестового клиента. Если вам необходимо определить пользовательские
атрибуты в этом токене, вы можете использовать аргумент tokenAttributes метода loginUser().

Выполнение AJAX-запросов

Клиент предоставляет метод xmlHttpRequest(), который имеет те же аргументы, что и метод request() и является сокращением, чтобы делать AJAX-запросы:

1
2

// требуемый заголовок HTTP_X_REQUESTED_WITH добавляется автоматически
$client->xmlHttpRequest('POST', '/submit', ['name' => 'Fabien']);

Отправка пользовательских заголовков

Если ваше приложение ведет себя в соответствии с некоторыми HTTP-заголовками, передайте их в качестве второго аргумента createClient():

1
2
3
4

$client = static::createClient([], [
    'HTTP_HOST'       => 'en.example.com',
    'HTTP_USER_AGENT' => 'MySuperBrowser/1.0',
]);

Вы также можете переопределить HTTP-заголовки для каждого запроса:

1
2
3
4

$client->request('GET', '/', [], [], [
    'HTTP_HOST'       => 'en.example.com',
    'HTTP_USER_AGENT' => 'MySuperBrowser/1.0',
]);

Отчет об исключениях

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

1

$client->catchExceptions(false);

Доступ к внутренним объектам

Если вы используете клиента, чтобы тестировать ваше приложение, вы можете захотеть получить доступ ко мнутренним объектам клиента:

1
2

$history = $client->getHistory();
$cookieJar = $client->getCookieJar();

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14

// экземпляр запроса HttpKernel
$request = $client->getRequest();

// экземпляр запроса BrowserKit
$request = $client->getInternalRequest();

// экземпляр ответа HttpKernel
$response = $client->getResponse();

// экземпляр ответа BrowserKit
$response = $client->getInternalResponse();

// экземпляр Crawler
$crawler = $client->getCrawler();

Доступ к данным профилировщика

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

Чтобы получить профилировщика для последнего запроса, сделайте следующее:

1
2
3
4
5
6
7

// включает профилировщика для всех следующих запросов
$client->enableProfiler();

$crawler = $client->request('GET', '/profiler');

// получает профиль
$profile = $client->getProfile();

Чтобы узнать особые детали использования профилироващика внутри теста, см. статью Как использовать профилировщик в функциональном тесте.

Нажатие на ссылки

Используйте метод clickLink(), чтобы нажать на первую ссылку, содержащую заданный текст (или первое кликабельное сообщение с атрибутом alt):

1
2
3
4

$client = static::createClient();
$client->request('GET', '/post/hello-world');

$client->clickLink('Click here');

Если вам нужно получить доступ к объекту Link, который предоставляет полезные методы, относящиеся к ссылками (такие как getMethod() и getUri()), используйте вместо этого метод Crawler::selectLink():

1
2
3
4
5
6
7
8

$client = static::createClient();
$crawler = $client->request('GET', '/post/hello-world');

$link = $crawler->selectLink('Click here')->link();
// ...

// используйте click(), если вы хотите нажать на выбранную ссылку
$client->click($link);

Отправка форм

Используйте метод submitForm(), чтобы отправить форму, содержащую данную кнопку:

1
2
3
4
5
6

$client = static::createClient();
$client->request('GET', '/post/hello-world');

$crawler = $client->submitForm('Add comment', [
    'comment_form[content]' => '...',
]);

Первый аргумент submitForm() - текстовое содержание, id, value или name любого <button> или <input type="submit">, добавленного в форму. Второй необязательный аргумент испоьзуется для переопределения значений полей формы по умолчанию.

Если вам нужно получить доступ к объекту Form, который предоставляет полезные методы специально для форм (такие как getUri(), getValues() и getFields()), используйте вместо этого метод Crawler::selectButton():

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

$client = static::createClient();
$crawler = $client->request('GET', '/post/hello-world');

// выбрать кнопку
$buttonCrawlerNode = $crawler->selectButton('submit');

// извлечь объект Формы для формы, принадлежашей этой кнопке
$form = $buttonCrawlerNode->form();

// установить значения в объекте формы
$form['my_form[name]'] = 'Fabien';
$form['my_form[subject]'] = 'Symfony rocks!';

// отправить объект Формы
$client->submit($form);

// по желанию, вы можете объединить 2 последних шага, передав массив значений
// поля при отправке формы:
$client->submit($form, [
    'my_form[name]'    => 'Fabien',
    'my_form[subject]' => 'Symfony rocks!',
]);

В зависимости от типа формы, вы можете использовать разные методы, чтобы заполнить ввод:

1
2
3
4
5
6
7
8
9
10
11
12

// выбирает опцию или радио-кнопку
$form['my_form[country]']->select('France');

// отмечает чекбокс
$form['my_form[like_symfony]']->tick();

// загружает файл
$form['my_form[photo]']->upload('/path/to/lucas.jpg');

// В случае загрузки нескольких файлов
$form['my_form[field][0]']->upload('/path/to/lucas.jpg');
$form['my_form[field][1]']->upload('/path/to/lisa.jpg');

1
2

$client->submit($form, [], ['HTTP_ACCEPT_LANGUAGE' => 'es']);
$client->submitForm($button, [], 'POST', ['HTTP_ACCEPT_LANGUAGE' => 'es']);

Утверждения ответов

assertResponseIsSuccessful(string $message = '')

Утверждает, что ответ был успешен (HTTP-статус 2xx).

assertResponseStatusCodeSame(int $expectedCode, string $message = '')

Утверждает конкретный HTTP статус-код.

assertResponseRedirects(string $expectedLocation = null, int $expectedCode = null, string $message = '')

Утверждает, что ответ - это ответ перенаправления (по желанию, вы можете проверить целевую локацию и статус-код).

assertResponseHasHeader(string $headerName, string $message = '')/assertResponseNotHasHeader(string $headerName, string $message = '')

Утверждает, что заданный заголовок - (не) доступен в ответе.

assertResponseHeaderSame(string $headerName, string $expectedValue, string $message = '')/assertResponseHeaderNotSame(string $headerName, string $expectedValue, string $message = '')

Утверждает, что заданный заголовок (не) содержит ожидаемого значение в ответе.

assertResponseHasCookie(string $name, string $path = '/', string $domain = null, string $message = '')/assertResponseNotHasCookie(string $name, string $path = '/', string $domain = null, string $message = '')

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

assertResponseCookieValueSame(string $name, string $expectedValue, string $path = '/', string $domain = null, string $message = '')

Утверждает, что заданный куки существует и устаналивает ожидаемое значение.

assertResponseFormatSame(?string $expectedFormat, string $message = '')

Утверждает, что формат возвращенного методом getFormat() ответа такой же, как и ожидаемое значение.

assertResponseIsUnprocessable(string $message = '')

Утверждает, что ответ невозможно обработать (HTTP-статус 422)

Утверждения запросов

assertRequestAttributeValueSame(string $name, string $expectedValue, string $message = '')

Утверждает, что заданный атрибут запроса установлен в ожидаемом значении.

assertRouteSame($expectedRoute, array $parameters = [], string $message = '')

Утверждает ответ, сопосталвенный с заданным маршрутом и, по желанию, параметры маршрута.

Утверждения браузера

assertBrowserHasCookie(string $name, string $path = '/', string $domain = null, string $message = '')/assertBrowserNotHasCookie(string $name, string $path = '/', string $domain = null, string $message = '')

Утверждает, что Клиент теста (не) имеет установленного заданного куки (что означает, что куки был установлен любым запросом в тесте).

assertBrowserCookieValueSame(string $name, string $expectedValue, string $path = '/', string $domain = null, string $message = '')

Утверждает, что заданный куки в тестовом Клиенте установлен в ожидвемом значении.

assertThatForClient(Constraint $constraint, string $message = '')

Утверждает заданное Ограничение в Клиенте. Полезно для использования пользовательских утверждений так же, как и встроенных убеждений (т.е. без передачи Клиенту в качестве аргумента):

1
2
3
4
5

// добавьте этот метод в некоторый пользовательский класс, импортированный в ваши тесты
protected static function assertMyOwnCustomAssert(): void
{
    self::assertThatForClient(new SomeCustomConstraint());
}

Утверждения Crawler

assertSelectorExists(string $selector, string $message = '')/assertSelectorNotExists(string $selector, string $message = '')

Утверждает, что заданный cелектор (не) совпадает как минимум с одним элементом в ответе.

assertSelectorCount(int $expectedCount, string $selector, string $message = '')

Утверждает, что ожидаемое количество элементов селектора находится в ответе.

assertSelectorTextContains(string $selector, string $text, string $message = '')/assertSelectorTextNotContains(string $selector, string $text, string $message = '')

Утверждает, что первый элемент, совпадающий с заданным селектором (не) содержит ожидаемый текст.

assertSelectorTextSame(string $selector, string $text, string $message = '')

Утверждает, что содержание первого элемента, совпадающего с заданным селектором (не) равняется ожидаемому тексту.

assertSelectorTextSame(string $selector, string $text, string $message = '')

Утверждает, что содержание первого элемента, соответствующего заданному
селектору, равно ожидаемому тексту

assertAnySelectorTextSame(string $selector, string $text, string $message = '')

Утверждает, что любой элемент, соответствующий заданному селектору, равен
ожидаемому тексту.

assertPageTitleSame(string $expectedTitle, string $message = '')

Утверждает, что элемент <title> равен заданному заголовку.

assertPageTitleContains(string $expectedTitle, string $message = '')

Утверждает, что элемент <title> содержит заданный заголовок.

assertInputValueSame(string $fieldName, string $expectedValue, string $message = '')/assertInputValueNotSame(string $fieldName, string $expectedValue, string $message = '')

Утверждает, что значение ввода формы с заданным именем (не) равняется ожидаемому значению.

assertCheckboxChecked(string $fieldName, string $message = '')/assertCheckboxNotChecked(string $fieldName, string $message = '')

Утверждает, что чекбокс с заданным именем (не) отмечен.

assertFormValue(string $formSelector, string $fieldName, string $value, string $message = '')/assertNoFormValue(string $formSelector, string $fieldName, string $message = '')

Утверждает, что значение поля первой формы, совпадающей с заданным селектором (не) равняется ожидаемому значению.

Утверждения Mailer

assertEmailCount(int $count, string $transport = null, string $message = '')

Утверждает, что было отправлено ожидаемо количество электронных писем.

assertQueuedEmailCount(int $count, string $transport = null, string $message = '')

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

assertEmailIsQueued(MessageEvent $event, string $message = '')/assertEmailIsNotQueued(MessageEvent $event, string $message = '')

Утверждает, что заданное событие почтовой программы (не) в очереди. Используйте getMailerEvent(int $index = 0, string $transport = null), чтобы извлечь событие почтовой программы по индексу.

assertEmailAttachmentCount(RawMessage $email, int $count, string $message = '')

Утверждает, что заданное электронное письмо имеет ожидаемое количество вложений. Используйте getMailerMessage(int $index = 0, string $transport = null), чтобы извлечь конкретное письмо по индексу.

assertEmailTextBodyContains(RawMessage $email, string $text, string $message = '')/assertEmailTextBodyNotContains(RawMessage $email, string $text, string $message = '')

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

assertEmailHtmlBodyContains(RawMessage $email, string $text, string $message = '')/assertEmailHtmlBodyNotContains(RawMessage $email, string $text, string $message = '')

Утверждает, что HTML-тело заданного письма (не) содержит ожидаемый текст.

assertEmailHasHeader(RawMessage $email, string $headerName, string $message = '')/assertEmailNotHasHeader(RawMessage $email, string $headerName, string $message = '')

Утверждает, что заданное письмо (не) имеет ожидаемого установленного заголовка.

assertEmailHeaderSame(RawMessage $email, string $headerName, string $expectedValue, string $message = '')/assertEmailHeaderNotSame(RawMessage $email, string $headerName, string $expectedValue, string $message = '')

Утверждает, что заданное письмо (не) имеет ожидаемого заголовка, установленного в ожидаемое значение.

assertEmailAddressContains(RawMessage $email, string $headerName, string $expectedValue, string $message = '')

Утверждает, что заданный заголовок адреса равняется ожидаемому адресу электронной почты. Это утверждение нормализует адреса вроде Jane Smith <jane@example.com> в jane@example.com.

assertEmailSubjectContains(RawMessage $email, string $expectedValue, string $message = '')/assertEmailSubjectNotContains(RawMessage $email, string $expectedValue, string $message = '')

Утверждает, что тема заданного письма содержит (не содержит) ожидаемую тему.

Утверждения Notifier

assertNotificationCount(int $count, string $transportName = null, string $message = '')

Утверждает, что заданное количество уведомлений было создано (всего или для заданного транспорта).

assertQueuedNotificationCount(int $count, string $transportName = null, string $message = '')

Утверждает, что заданное количество уведомлений находится в очереди (всего или для заданного транспорта).

assertNotificationIsQueued(MessageEvent $event, string $message = '')

Утверждает, что заданное уведомление находится в очереди.

assertNotificationIsNotQueued(MessageEvent $event, string $message = '')

Утверждает, что заданное уведомление не находится в очереди.

assertNotificationSubjectContains(MessageInterface $notification, string $text, string $message = '')

Утверждает, что заданный текст включен в субъект заданного уведомления.

assertNotificationSubjectNotContains(MessageInterface $notification, string $text, string $message = '')

Утверждает, что заданный текст не включен в субъект заданного уведомления.

assertNotificationTransportIsEqual(MessageInterface $notification, string $transportName, string $message = '')

Утверждает, что имя транспорта заданного уведомления совпадает с заданным текстом.

assertNotificationTransportIsNotEqual(MessageInterface $notification, string $transportName, string $message = '')

Утверждает, что имя транспорта заданного уведомления не совпадает с заданным текстом.

Утверждения HttpClient

assertHttpClientRequest(string $expectedUrl, string $expectedMethod = 'GET', string|array $expectedBody = null, array $expectedHeaders = [], string $httpClientId = 'http_client')

Утверждает, что заданный URL был вызван с использованием, если указано,
заданного тела метода и заголовков. По умолчанию проверка выполняется на HttpClient, но вы также можете передать определенный идентификатор HttpClient. (Проверка будет успешной, если запрос был вызван несколько раз).

assertNotHttpClientRequest(string $unexpectedUrl, string $expectedMethod = 'GET', string $httpClientId = 'http_client')

Утверждает, что данный URL не был вызван с помощью GET или указанного метода.
По умолчанию проверка выполняется на HttpClient, но вы также можете передать определенный идентификатор HttpClient.

assertHttpClientRequestCount(int $count, string $httpClientId = 'http_client')

Утверждает, что заданное количество запросов было сделано к HttpClient.
По умолчанию проверяется HttpClient, но вы также можете передать определенный идентификатор HttpClient.