Подготовка данных — PHP: Автоматическое тестирование

Большинство тестов на одну и ту же функциональность сильно похожи друг на друга, особенно в части начальной подготовки данных. Например, в прошлом уроке каждый тест начинался со строчки: Stack\make(). Это еще не дублирование, но уже шаг в эту сторону. Как правило, реальные тесты устроены сложнее и включают в себя большую подготовительную работу.

Допустим, мы разрабатываем библиотеку functional-php и хотим протестировать ее функции для обработки коллекций:

• filter
• every
• zip
• и другие

Для работы этих функций нужна заранее подготовленная коллекция. Проще всего придумать одну, которая подойдет для тестирования большинства или даже всех функций:

<?php

$coll = ['One', true, 3, 10, 'cat', [], '', 10, false];

Осталось найти место для определения этой коллекции. Для решения подобных задач в тестовых фреймворках используются хуки — специальные методы, вызываемые фреймворком на определенные события. Самый распространенный среди них — метод setUp(). Он автоматически вызывается перед каждым тестом:

<?php

namespace Hexlet\Phpunit\Tests;

use PHPUnit\Framework\TestCase;
use Hexlet\Phpunit\Functional;

class FunctionalTest extends TestCase
{
    // Так определяется переменная на уровне класса
    // Ее называют свойством
    // Здесь private закрывает переменную от внешнего доступа
    private $coll;

    // Метод ничего не возвращает
    public function setUp(): void
    {
        // Так к переменной происходит доступ внутри класса
        // В этом случае — запись данных
        $this->coll = ['One', true, 3, 10, 'cat', [], '', 10, false];
    }

    public function testFilter(): void
    {
        // Здесь идет обращение к свойству
        Functional\filter($this->coll, fn($element) => is_numeric($element));
    }

    public function testZip(): void
    {
        // Здесь идет обращение к свойству
        $coll2 = [/* Здесь другая коллекция конкретно для данного теста */];
        $result = Functional\zip($this->coll, $coll2);
        $expected = /* Здесь то, что ожидаем */;
        $this->assertEquals($expected, $result);
    }
}

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

Для выполнения кода после тестов используется метод tearDown(). У него такой же принцип работы, но вызывается он не до, а после каждого теста.

Сами хуки принадлежат конкретному классу. Другими словами, если в тестах есть несколько классов, то определенные в одном классе хуки не вызываются для тестов других классов.

Дополнительные материалы

1. Фикстуры