Как сделать автотестирование плагинов WordPress на PHP

Автоматическое тестирование плагинов WordPress — важный этап в разработке, позволяющий гарантировать стабильность и качество кода. В этой статье рассмотрим, как настроить автотесты для ваших плагинов на PHP, используя инструменты, которые хорошо интегрируются с WordPress. Это снизит количество ошибок при обновлениях и упростит поддержку вашего продукта.

Почему автотестирование плагинов WordPress важно

Плагины — это расширения WordPress, которые могут влиять на работу сайта. Ошибка в коде плагина может привести к сбоям, снижению производительности или уязвимостям. Автоматические тесты позволяют:

• Раннее выявлять ошибки и баги;
• Обеспечить совместимость с новыми версиями WordPress;
• Упростить рефакторинг и добавление новых функций;
• Поддерживать качество кода при работе в команде.

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

Инструменты для автотестирования плагинов на PHP

Для тестирования плагинов WordPress чаще всего используют PHPUnit — стандартный фреймворк для юнит-тестирования в PHP. Для интеграционного тестирования и эмуляции окружения WordPress применяют WP_Mock или Brain Monkey. Рассмотрим их по порядку.

PHPUnit

PHPUnit позволяет писать тесты для ваших функций и классов. Важно настроить его вместе со средой WordPress. Для этого можно использовать Clearfy Pro, который помогает оптимизировать код плагина и подготовить его к тестированию.

WP_Mock и Brain Monkey

Эти библиотеки позволяют подменять функции WordPress в тестах, что удобно для юнит-тестов без загрузки всей CMS. Brain Monkey более современный и поддерживаемый, он основан на PHPUnit и Mockery.

Настройка окружения для автотестирования плагина

Для начала создайте структуру папок в вашем плагине:

my-plugin/  ├── tests/  │   ├── test-sample.php  ├── my-plugin.php  ├── composer.json

Добавьте PHPUnit и Brain Monkey через Composer:

composer require --dev phpunit/phpunit brain/monkey

В файле tests/bootstrap.php подключите автозагрузчик и инициализируйте Brain Monkey:

<?php
require_once __DIR__ . '/../vendor/autoload.php';
use Brain\Monkey;

Monkey\setUp();
// Дополнительная инициализация

register_shutdown_function(function() {
    Monkey\tearDown();
});

Пример простого теста плагина с Brain Monkey

Предположим, в вашем плагине есть функция wpkit_get_option(), которая оборачивает вызов get_option() WordPress и возвращает значение с дефолтом.

<?php
function wpkit_get_option($name, $default = '') {
    $value = get_option($name);
    return $value !== false ? $value : $default;
}

Напишем тест для этой функции:

<?php
use Brain\Monkey;
use Brain\Monkey\Expectation;
use PHPUnit\Framework\TestCase;

class WPKitGetOptionTest extends TestCase {

    protected function setUp(): void {
        parent::setUp();
        Monkey\setUp();
    }

    protected function tearDown(): void {
        Monkey\tearDown();
        parent::tearDown();
    }

    public function testReturnsValueFromGetOption() {
        
        Monkey\Functions\expect('get_option')
            ->once()
            ->with('some_option')
            ->andReturn('value');

        $result = wpkit_get_option('some_option', 'default');
        $this->assertEquals('value', $result);
    }

    public function testReturnsDefaultWhenOptionFalse() {
        Monkey\Functions\expect('get_option')
            ->once()
            ->with('nonexistent_option')
            ->andReturn(false);

        $result = wpkit_get_option('nonexistent_option', 'default');
        $this->assertEquals('default', $result);
    }
}

Такой подход позволяет тестировать логику без загрузки WordPress.

Интеграционное тестирование с WP-CLI и WP_UnitTestCase

Для более глубоких тестов, которые требуют полной загрузки WordPress, используйте класс WP_UnitTestCase, входящий в стандартный пакет тестирования WordPress. Эти тесты запускаются через WP-CLI и используют тестовую среду базы данных.

Для начала установите тестовое окружение WordPress по инструкции на официальном сайте. Затем создайте тесты в папке tests плагина, расширяя WP_UnitTestCase.

Пример интеграционного теста

<?php
class WPKitIntegrationTest extends WP_UnitTestCase {

    public function testOptionSavedCorrectly() {
        update_option('wpkit_test_option', 'test_value');
        $value = get_option('wpkit_test_option');
        $this->assertEquals('test_value', $value);
    }
}

Запускать такие тесты удобно через команду:

wp test plugin my-plugin

Советы и рекомендации по автотестированию плагинов WordPress

Для успешного тестирования плагинов придерживайтесь следующих советов:

• Пишите тесты параллельно с разработкой функций — так ошибки выявляются раньше.
• Разделяйте логику и вызовы WordPress, чтобы легче было писать юнит-тесты.
• Используйте мок-объекты и библиотеки типа Brain Monkey для изоляции кода.
• Настройте CI/CD (например, GitHub Actions) для автоматического запуска тестов при коммитах.
• Следите за обновлениями WordPress и тестируйте совместимость.

Заключение по теме автотестирования плагинов

Автотестирование — это неотъемлемая часть профессиональной разработки плагинов WordPress. Оно позволяет экономить время и ресурсы, а также обеспечивает стабильность и безопасность вашего продукта. Используйте связку PHPUnit и Brain Monkey для юнит-тестов и WP_UnitTestCase для интеграционных тестов, чтобы покрыть все аспекты функционала.

Если хотите ускорить оптимизацию и подготовку плагина к тестированию, рекомендуем обратить внимание на Clearfy Pro — удобный инструмент для работы с кодом и настройками WordPress.