Зарегистрируйтесь для доступа к 15+ бесплатным курсам по программированию с тренажером

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

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

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

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

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

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

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

Затем тоже самое делаем для всех остальных функций:

def test_select():
    # Точно такая же коллекция, получилось дублирование
    coll = ['One', True, 3, [1, 'hexlet', [0]], 'cat', {}, '', [], False]

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

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

# Создание коллекции теперь описано в одном месте сразу для всех функций
coll = ['One', True, 3, [1, 'hexlet', [0]], 'cat', {}, '', [], False]

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

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

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

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

import pytest

# Создаем фикстуру
# Запускается перед каждым тестом
@pytest.fixture
def coll(): # имя фикстуры выбирается произвольно
    return ['One', True, 3, [1, 'hexlet', [0]], 'cat', {}, '', [], False]

# Pytest сам прокидывает результат вызова функции там, где она указана в аргументе.
# Имя параметра совпадает с именем фикстуры
def test_compact(coll):
    result = compact(coll)
    assert result == # тут ожидаемое значение

# Не важно, что предыдущий тест сделал с коллекцией.
# Здесь она будет новая, так как pytest вызывает coll() заново
def test_select(coll):
    result = select(coll, ...)
    assert result == # тут ожидаемое значение

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

Теперь другой пример. Представьте себе код, в котором идет работа с текущим временем:

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 от текущего реального значения "сейчас" будет всё дальше и дальше:

  1. Pytest загружает файлы с тестами в память
  2. Переменная now заполняется датой, которая была текущая на момент выполнения этого куска кода
  3. Pytest начинает выполнение тестов с использованием той даты, которая была получена на предыдущем шаге. Эта дата уже не текущая

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

import pytest

@pytest.fixture
def current_time():
    return datetime.now()

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

https://replit.com/@hexlet/python-testing-fixtures

Когда не стоит использовать фикстуры

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


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

  1. Pytest Fixtures

Аватары экспертов Хекслета

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

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

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

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

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

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

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

Об обучении на Хекслете

Для полного доступа к курсу нужен базовый план

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

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

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

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

  • 130 курсов, 2000+ часов теории
  • 900 практических заданий в браузере
  • 360 000 студентов
Даю согласие на обработку персональных данных, соглашаюсь с «Политикой конфиденциальности» и «Условиями оказания услуг»

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

Логотип компании Альфа Банк
Логотип компании Aviasales
Логотип компании Yandex
Логотип компании Tinkoff
Рекомендуемые программы

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

Иконка программы Python-разработчик
Профессия
Разработка веб-приложений на Django
1 июня 10 месяцев

Используйте Хекслет по максимуму!

  • Задавайте вопросы по уроку
  • Проверяйте знания в квизах
  • Проходите практику прямо в браузере
  • Отслеживайте свой прогресс

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

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