Фикстуры — PHP: Продвинутое тестирование

Представьте себе функцию, которая принимает на вход HTML в виде строки, извлекает из него все ссылки и возвращает как массив:

<?php

// Для тестирования подобной функции, желательно взять HTML-код, близкий к реальному.
// Он хоть и не гарантирует работоспособности функции, но по крайней мере даёт хорошее разнообразие по структуре документа.
// HTML взят из нашего проекта cv.hexlet.io
$html = <<<EOT
<div class="card mb-3"><div class="card-body"><div class="d-flex flex-column flex-sm-row">
<div class="d-flex flex-column mr-4"><div class="text-muted text-center mb-3">
<div class="h2 mb-0 font-weight-lighter">1</div><div class="small">Ответ</div></div>
<div class="text-muted text-center mb-3"><div class="h2 mb-0 font-weight-lighter">7</div>
<div class="small">Просмотров</div></div></div><div><h5 class="card-title">
<a href="/resumes/1">Backend Software Engineer</a></h5><div class="card-text">
<p>Программист-самоучка, избравший путь постоянного самосовершенствования.
Ценю красивый и лаконичный код, люблю функциональное программирование
(великая троица <code>map</code>, <code>filter</code>, <code>reduce</code>).</p>
<p>Использую JS, Ruby, PHP, Python, Elixir, Clojure в разной степени мастерства.</p>
<p>Восхищаюсь семейством LISP-языков, пишу свой интерпретатор LISP на Elixir.
В настоящий момент углубляюсь в ОС Unix, чтобы в дальнейшем улучшить навыки DevOps.</p>
</div><div class="text-right small"><span class="mr-3 text-muted">12 дней</span>
<a href="/users/6">Улугбек Туйчиев</a></div></div></div></div></div>
EOT;

$links = extractLinks($html);
print_r($links);
// => ['/resumes/1', '/users/6']

Кусок HTML в начале теста выглядит страшно. Он большой и состоит из нагромождения тегов. Конечно, можно постараться и отформатировать его, но это будет ручная работа. Для любого редактора это просто строка в PHP. Но дело не только в форматировании, у такого способа работы с большими кусками данных есть и другие недостатки:

• При обновлениях очень легко допустить ошибку, которую сложно обнаружить визуально. Редактор ничем не сможет помочь.
• Чем больше таких данных в тестах, тем сложнее их читать и отделять логику от самих данных.

Было бы гораздо удобнее, если бы HTML хранился как обычный HTML в своём собственном файле. Это несложно сделать. В таком случае тест будет выглядеть так:

<?php

class SomeTest extends TestCase
{
    public function testExtractLinks()
    {
        // HTML находится в файле withLinks.html в директории fixtures
        // При чтении текстовых файлов, в конце может добавляться пустая строка
        // Она удаляется с помощью метода `trim`, если нужно
        // __DIR__ – директория, в которой находится данный файл с тестами
        $html = file_get_contents(__DIR__ . "/../fixtures/withLinks.html");
        // Теперь с HTML удобно работать и он не загромождает тесты.
        $links = extractLinks($html);
        $this->assertEquals(['/resumes/1', '/users/6'], $links);
    }
}

Данные, которые нужны во время запуска тестов, называются фикстурами. Это не обязательно текстовые данные. Фикстурами могут быть картинки, JSON и XML-файлы, записи в базе данных и многое другое. Иногда частью фикстур может быть и код, но это довольно редкая ситуация. Подобные фикстуры нужны при тестировании различных анализаторов кода, таких как Psalm или PHPStan.

Обычно фикстуры хранятся в отдельных файлах в своей директории. Например можно создать директорию fixtures внутри tests. Затем они читаются и по необходимости используются в тестах.

Воображаемый пример:

tree tests/fixtures

├── after.ini
├── after.json
├── after.yml
├── before.ini
├── before.json
├── before.yml
└── result.txt

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

<?php

// Где-то в тестах или в хуках
$html = file_get_contents(__DIR__ . "/../fixtures/withLinks.html");
$json = file_get_contents(__DIR__ . "/../fixtures/somethingElse.json");

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

<?php

public function getFixtureFullPath($fixtureName)
{
    $parts = [__DIR__, 'fixtures', $fixtureName];
    return realpath(implode('/', $parts));
}

// Само чтение файлов нужно выполнять либо внутри тестов, либо внутри setUp()
$pathToHtml = $this->getFixtureFullPath('withLinks.html');
$pathToJson = $this->getFixtureFullPath('somethingElse.json');

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

<?php

// Сравнивает строку с содержимым файла
$this->assertStringEqualsFile($pathToHtml, $someHtml);

// Сравнение json файлов
$this->assertJsonFileEqualsJsonFile('path/to/fixture/file', 'path/to/actual/file');

// Сравнение json файла с json
$this->assertJsonStringEqualsJsonFile(
    'path/to/fixture/file', json_encode(['Mascot' => 'ux'])
);

---

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты

Об обучении на Хекслете

• Статья «Как учиться и справляться с негативными мыслями»
• Статья «Ловушки обучения»
• Статья «Сложные простые задачи по программированию»
• Вебинар «Как самостоятельно учиться»