Логотип Хекслета

Java: Автоматическое тестирование

Теория: Фикстуры

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

// Для тестирования подобной функции желательно взять HTML-код, близкий к реальному.
// Он хоть и не гарантирует работоспособности функции, но по крайней мере даёт хорошее разнообразие по структуре документа.
// HTML взят из нашего проекта cv.hexlet.io
var html = """
<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>""";

var links = HtmlParser.extractLinks(html);
System.out.println(links); // => ['/resumes/1', '/users/6']

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

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

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

import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class HtmlParserTest {

    @Test
    public void testExtractLinks() throws Exception {
        // HTML находится в файле withLinks.html в директории src/test/resources/fixtures
        // При чтении текстовых файлов, в конце может добавляться пустая строка
        // Она удаляется с помощью метода `trim`, если нужно
        var path = Paths.get("src/test/resources/fixtures/withLinks.html");
        var html = Files.readString(path).trim();

        // Теперь с HTML удобно работать и он не загромождает тесты.
        var links = HtmlParser.extractLinks(html);
        assertEquals(List.of("/resumes/1", "/users/6"), links);
    }
}

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

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

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

tree src/tests/resoutces/fixtures

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

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

// Где-то в тестах или в хуках
var path1 = Paths.get("src/test/resources/fixtures/withLinks.html");
var html = Files.readString(path1).trim();

var path2 = Paths.get("src/test/resources/fixtures/data.json");
var json = Files.readString(path2).trim();

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

import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class HtmlParserTest {

    private static Path getFixturePath(String fileName) {
        return Paths.get("src", "test", "resources", "fixtures", fileName)
            .toAbsolutePath().normalize();
    }

    private static String readFixture(String fileName) throws Exception {
        var path = getFixturePath(fileName);
        return Files.readString(path).trim();
    }

    @Test
    public void testExtractLinks() throws Exception {

        var html = readFixture("withLinks.html");
        var links = HtmlParser.extractLinks(html);
        assertEquals(List.of("/resumes/1", "/users/6"), links);
    }
}

Само чтение файлов нужно выполнять либо внутри тестов, либо внутри хуков, например @BeforeAll или @BeforeEach. Так JUnit сможет контролировать происходящие процессы

Рекомендуемые программы

Навигация
Теория
Тесты
Упражнение