Как протестировать процесс вывода post с помощью phpunit?

Содержание

Вопрос или проблема
Ответ или решение
Теория
Пример
Применение
Заключение

Вопрос или проблема

Мне нравится знать, как тестировать HTML-вывод поста. Так же, как WP выводил бы его на фронтенде в реальности.

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

Пока в своем поиске я нашел только руководства о том, как создать пост в юнит-тестировании, но не о том, как на самом деле проводить тесты на нем.

В своем тесте вы можете создать пост, начать буферизацию вывода с помощью ob_start(), как обычно, вывести содержимое поста, получить буфер вывода в вашу переменную с помощью ob_end_clean().

Теперь вы можете обработать строку реального вывода поста и сравнить ее с ожидаемым значением.

Ответ или решение

Теория

Тестирование HTML-вывода поста в WordPress требует понимания нескольких ключевых аспектов. Основная задача — симулировать обработку контента поста так, как это происходит на фронтенде, включая такие специфические элементы, как кеширование oEmbed. Суть заключается в контроле за тем, чтобы реальный процесс генерации HTML-вывода поста соответствовал ожиданиям, и был протестирован на возможные изменения или сбои.

WP, или WordPress, для генерации HTML использует свой собственный цикл и набор хуков, таких как the_content, для фильтрации и окончательной обработки вывода. Это значит, что любой тест должен учитывать эти механизмы фильтрации и синтаксические преобразования, происходящие внутри двигательной установки WP. Кроме того, следует учитывать, что кеширование oEmbed выполняется WP только тогда, когда оно связано с конкретным постом, таким образом тестирование этих элементов требует создания поста и определения его ID.

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

Пример

Для начала тестирования вы можете использовать следующие шаги:

Создание поста: Используйте методы WordPress, такие как wp_insert_post(), чтобы создать новый экземпляр поста в тестовой среде.
Запуск буферизации вывода: Прежде чем вызывать вывод контента поста, активируйте буферизацию вывода функцией ob_start(). Это позволит захватить весь HTML-вывод до его передачи в браузер.
Вывод и захват содержимого: Используйте функцию the_content(), чтобы обработать содержимое поста. После этого завершите буферизацию с помощью ob_end_clean() и сохраните результат в переменной.
Сравнение с ожидаемым результатом: Убедитесь, что полученный HTML соответствует ожидаемому результату, используя метод assertEquals() из PHPUnit для сравнения двух строк.

Применение

Теперь мы рассмотрим более конкретный пример того, как это может быть реализовано на практике:

class PostOutputTest extends WP_UnitTestCase {

    public function test_post_content_output() {
        // Создаем пост с заранее заданным содержимым
        $post_id = $this->factory->post->create([
            'post_content' => 'Тестовое содержимое с oEmbed объектом: '
        ]);

        // Проверяем, что пост успешно создан
        $this->assertNotEmpty($post_id);

        // Устанавливаем глобальную переменную $post, как это делается в WordPress
        global $post;
        $post = get_post($post_id);

        // Начинаем буферизацию вывода
        ob_start();

        // Вызываем вывод контента поста
        the_content();

        // Останавливаем буферизацию и получаем результат
        $output = ob_get_clean();

        // Определяем ожидаемый результат (например, на основе ранее известного формата)
        $expected_output = '<p>Тестовое содержимое с oEmbed объектом: <iframe src="https://www.youtube.com/embed/dQw4w9WgXcQ" allowfullscreen></iframe></p>';

        // Сравниваем полученный HTML с ожидаемым
        $this->assertEquals($expected_output, trim($output));
    }
}

Этот тест создает пост с конкретным контентом, который включает oEmbed код, и после захвата вывода сравнивает его с заранее определённым ожидаемым результатом. Такой подход гарантирует, что ваш тест охватывает реальную обработку контента WordPress, включая фильтры и кэширование oEmbed.

Заключение

Тестирование HTML-вывода поста в WordPress с использованием PHPUnit требует тщательной настройки тестовой среды и понимания внутренних механизмов системы. Правильная эксплуатация буферизации вывода и глобальных переменных WordPress позволяет убедиться в том, что ваш код работает надежно в реальных условиях. Такой подход не только помогает отладить текущие процессы, но и обеспечивает устойчивость системы к будущим изменениям. Кроме того, это способствует уверенности в том, что пользовательский интерфейс сайта остается неизменным при обновлениях и изменениях функционала.