Плохие и хорошие практики тестирования — PHP: Автоматическое тестирование

Тесты, как и любой другой код, можно писать по-разному, в том числе очень плохо. Помимо каких-то общих практик и стандартов кодирования у тестов есть свои особенности, о которых надо знать. В этом уроке мы пройдёмся по некоторым из них.

Взаимное влияние тестов

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

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

<?php

class SomeTest extends TestCase
{
    private $user;

    public function testOne(): void
    {
        $this->user = ['name' => 'Vasya'];
    }

    public function testTwo(): void
    {
        // Используется пользователь, которого создал другой тест!
        // Этот тест зависит от того, как работает предыдущий тест,
        // и не может работать без последовательного запуска обоих тестов.
        $this->user['name'] = 'Petya';
    }
}

Особенно часто такая ситуация возникает в тестах, активно взаимодействующих с внешней средой: базой данных или файловой системой. Тестирование побочных эффектов имеет свои хитрости и рассматривается в курсе по продвинутому тестированию.

Условные конструкции в тесте

<?php

class SomeTest extends TestCase
{
    public function testSomething(): void
    {
        if (/* что-нибудь */) {
        // Выполняем код одним способом
        // Проверка может быть тут
        } else {
        // Выполняем код другим способом
        // Проверка может быть тут
        }
        // Проверка может быть тут
    }
}

Любое ветвление внутри тестов это фактически несколько тестов в рамках одного теста. От этого надо избавляться и никогда так не писать.

Тест вне тестов

Задача setUp — готовить данные и среду для тестирования, а задача test — вызывать код, который тестируется, и проводить проверки. Но иногда разработчики переусердствуют:

<?php

class SomeTest extends TestCase
{
    private $result;

    public setUp(): void
    {
        // Вызывается тестируемый код. Это противоречит идее setUp
        $this->result = sum(5, 9);
    }

    public function testSum(): void
    {
        $this->assertEquals(14, $this->result);
    }
}

В этом примере тестируемый код вызывается в setUp. Такой подход усложняет анализ тестов, так как переворачивает всё с ног на голову.

Слишком сильная детализация

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

<?php

class SomeTest extends TestCase
{
    public function testAge(): void
    {
        $user = ['name' => 'Mark', 'age' => 28];

        // Тут код, добавляющий пользователя в базу данных
        $this->assertEquals(28, $user['age']);
    }

    public function testName(): void
    {
        $user = ['name' => 'Mark', 'age' => 28];
        // Тут код, добавляющий пользователя в базу данных

        $this->assertEquals('Mark', $user['name']);
    }
}

Чаще всего, единственным результатом такого разделения будет большее количество кода и усложнение рефакторинга в будущем, когда кода станет по-настоящему много.

Код с тестами писать дольше, чем код без тестов

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

• Тесты влияют на дизайн кода. Они помогают выявить неудачные решения намного раньше.
• Подготовка входных данных может занимать значительное время. С тестами это нужно сделать один раз.
• Проверка результата работы кода может быть сложной и разнообразной. Тесты позволяют об этом не думать, они сами проверяют, что всё хорошо, включая пограничные случаи.
• Если в проекте тесты пишутся регулярно, то проще и быстрее делать рефакторинг, так как не придётся проверять вручную другие части кода.
• Тесты снижают уровень стресса.

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

1. Начинаем писать тесты правильно

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

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