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

Большинство тестов на одну и ту же функциональность сильно похожи друг на друга. Особенно в части начальной подготовки данных. В прошлом уроке каждый тест начинался со строчки: stack = []. Ещё не дублирование, но уже шаг в эту сторону. Как правило, реальные тесты сложнее и включают в себя большую подготовительную работу.

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

  • compact
  • select
  • flatten
  • и другие

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

def test_compact():
    # Подготовим коллекцию coll
    coll = ['One', true, 3, [1, 'hexlet', [0]], 'cat', {}, '', [], false]

    # Используем coll для тестирования
    result = compact(coll)
    assert result == # тут ожидаемое значение

Теперь представьте, что таких тестов несколько десятков (в реальности их сотни). Код начнёт кочевать из одного места в другое, порождая всё больше и больше одинакового кода.

Самый простой способ избежать этого — вынести определение коллекции на уровень модуля:

coll = ['One', true, 3, [1, 'hexlet', [0]], 'cat', {}, '', [], false]

def test_compact():
    result = compact(coll)
    assert result == # тут ожидаемое значение

Это простое решение убирает ненужное дублирование. Однако учтите, оно работает только в рамках одного модуля. Подобную коллекцию всё равно придётся определять в каждом тестовом модуле. И в нашем случае это скорее плюс, а не минус.

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

from funcy import select

coll = [1, 2, 3]

def test_select:
    result = select(even, coll)  # even функция-предикат, проверяющая чётность
    assert result == [2]

Тест выше сломается, если мы добавим в нашу коллекцию еще одно чётное число. А коллекцию почти наверняка придётся расширять при добавлении новых тестов (для этой же или других функций).

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

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

>>> from datetime import datetime
>>> now = datetime.now()
>>> def test_foo():
...     print(now)
>>> def test_bar():
...     print(now)
>>> test_foo()
2021-05-19 14:09:12.068421
>>> test_bar()
2021-05-19 14:09:12.068421

В выводе две идентичные даты. Подвох тут в том, что файл загружается в память ровно один раз. Это значит, что весь код, определённый на уровне файла, тоже выполняется один раз. В примере переменная now определится до запуска всех тестов, и только затем Pytest начнёт выполнять тесты. И с каждым последующим тестом отставание значения переменной now от текущего реального значения "сейчас" будет всё дальше и дальше.

Почему это может быть проблемой? Код, который работает с понятием "сейчас", может рассчитывать на то, что "сейчас" это почти моментальный снимок данного момента времени. Но в примере выше, сейчас начинает отставать от реального сейчас и чем больше тестов и чем они сложнее, тем большее отставание.

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

import pytest

# Запускается перед каждым тестом
@pytest.fixture
def current_time():
    return datetime.now()


# Pytest сам прокидывает результат вызова функции там где она указана в аргументе
# Имя аргумента совпадает с именем фикстуры
def test_foo(current_time):
    print(current_time)


def test_bar(current_time):
    print(current_time)

# Видно, что время изменилось
# 2021-05-19 14:46:14.109220
# 2021-05-19 14:46:14.110206

@pytest.fixture – декоратор, который добавляет произвольную функцию в процесс выполнения тестов. Фикстура выполняется перед теми тестами, в которых ее запросили через аргументы функции. Важно что имя аргумента совпадает с именем фикстуры.

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

import pytest

@pytest.fixture(scope="module", autouse=True)
def before_all():
    # делаем что-то перед тестами
    yield  # выполняем тесты
    # завершаем тесты

autouse=True приводит к запуску фикстуры в любом случае, независимо от того, запрашивает ли ее какой-то тест. scope="module" указывает на необходимость запускать ее ровно один раз на уровне модуля.


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

  1. Pytest Fixtures

<span class="translation_missing" title="translation missing: ru.web.courses.lessons.mentors.mentor_avatars">Mentor Avatars</span>

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

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

Ошибки, сложный материал, вопросы >
Нашли опечатку или неточность?

Выделите текст, нажмите ctrl + enter и отправьте его нам. В течение нескольких дней мы исправим ошибку или улучшим формулировку.

Что-то не получается или материал кажется сложным?

Загляните в раздел «Обсуждение»:

  • задайте вопрос. Вы быстрее справитесь с трудностями и прокачаете навык постановки правильных вопросов, что пригодится и в учёбе, и в работе программистом;
  • расскажите о своих впечатлениях. Если курс слишком сложный, подробный отзыв поможет нам сделать его лучше;
  • изучите вопросы других учеников и ответы на них. Это база знаний, которой можно и нужно пользоваться.
Об обучении на Хекслете

Для полного доступа к курсу нужна профессиональная подписка

Профессиональная подписка откроет полный доступ ко всем курсам, упражнениям и урокам Хекслета, проектам и пожизненный доступ к теории пройденных уроков. Подписку можно отменить в любой момент.

Получить доступ
120
курсов
900
упражнения
2000+
часов теории
3200
тестов

Открыть доступ

Курсы программирования для новичков и опытных разработчиков. Начните обучение бесплатно.

  • 120 курсов, 2000+ часов теории
  • 900 практических заданий в браузере
  • 360 000 студентов

Отправляя форму, вы соглашаетесь c «Политикой конфиденциальности» и «Условиями оказания услуг».

Наши выпускники работают в компаниях:

Логотип компании Альфа Банк
Логотип компании Rambler
Логотип компании Bookmate
Логотип компании Botmother

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

С нуля до разработчика. Возвращаем деньги, если не удалось найти работу.

Иконка программы Python-разработчик
Профессия

Python-разработчик

Разработка веб-приложений на Django
28 июля 8 месяцев

Есть вопрос или хотите участвовать в обсуждении?

Зарегистрируйтесь или войдите в свой аккаунт

Отправляя форму, вы соглашаетесь c «Политикой конфиденциальности» и «Условиями оказания услуг».