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

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

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)
    {
        $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.

Перегляд сайту

Клієнт підтримує багато операцій, які можна зробити у реальному браузері:

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);

Виконання 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());
}

Ствердження пошукових роботів

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

Стверджує, що заданий cелектор (не) співпадає як мінімум з одним елементом у відповіді.

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

Стверджує, що перший елемент, що співпадає з заданим селектором, (не) містить очікуваний текст.

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

Ствердження 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 = '')

Стверджує, що імʼя транспорту для заданого сповіщення не таке саме як і заданий текст.