Ассерт нескольких вызовов mock-методов в Python

Быстрый ответ

Для проверки последовательности и правильности вызовов метода-заглушки с определёнными аргументами используйте метод mock.assert_has_calls. Ниже приведен пример его использования:

from unittest.mock import Mock, call

mock_obj = Mock()

# Использование метода-заглушки
mock_obj.method('call1')
mock_obj.method('call2')

# Проверка порядка вызовов: 'call1' должен быть перед 'call2'
mock_obj.assert_has_calls([call.method('call1'), call.method('call2')])

Данный код подтверждает, что вызовы метода-заглушки были произведены сначала с аргументом 'call1', затем — 'call2'. Если последовательность вызовов неверная, будет выброшено исключение AssertionError.

Разбор метода assert_has_calls

assert_has_calls из библиотеки 'unittest.mock' используется для надёжной проверки последовательности вызовов метода-заглушки. Этот метод принимает в качестве аргумента список вызовов (call), где каждый элемент содержит информацию о вызове метода и его аргументах.

Особенности использования assert_has_calls таковы:

• Порядок вызовов важен по умолчанию.
• Для игнорирования порядка вызовов используйте параметр any_order=True.
• Повторяющиеся вызовы также учитываются.
• assert_any_call позволяет проверить наличие хотя бы одного вызова без учёта порядка.

Обработка вызовов в неопределённом порядке

Если порядок вызовов не важен, используйте параметр any_order=True:

# Порядок вызовов не имеет значения
mock_obj.assert_has_calls([
    call.method('call2'),
    call.method('call1')
], any_order=True)

Изучение вызовов с помощью call_args_list

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

expected_args = [('call1',), ('call2',)]
actual_args = [c.args for c in mock_obj.method.call_args_list]
assert expected_args == actual_args  # Проверяем, что аргументы вызовов соответствуют ожидаемым

Подсчёт вызовов с call_count

Для проверки количество выполненных вызовов используйте 'call_count'. Это свойство отображает общее число вызовов метода-заглушки:

assert mock_obj.method.call_count == 2  # Ожидаемое количество вызовов – 2

Используя call_args_list и call_count вместе, вы можете полностью контролировать вызовы метода-заглушки.

Баланс между тестированием и дизайном кода

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

Визуализация

Можно рассматривать процесс как концерт, где вызовы методов-заглушек — это музыканты, играющие в определённом порядке, создающие гармоничную мелодию.

Дирижёр (🎩): "Готовы? Начнём..."

Первая Скрипка (🎻) – "Исполнение A"
   🎶 А – А – А 🎶  (первая нота)

Вторая Скрипка (🎻) – "Исполнение B"
   🎶 В – В – В 🎶  (вторая нота)

Третья Скрипка (🎻) – "Исполнение C"
   🎶 С – С – С 🎶  (третья нота)

Рассмотрим последовательность исполнения нот А, В, С как аналог последовательности правильных вызовов методов-заглушек.

Формирование стратегии тестирования

Выполняя работу с assert_has_calls, важно разработать эффективную стратегию тестирования:

• Необходимо ли проверять каждый вызов детально, или достаточно проверки общей работы функционала?
• Не перегружены ли тесты излишним числом проверок, делающих их сложными для поддержки?
• Если тесты становятся сложными для поддержки, стоит пересмотреть подход к созданию методов-заглушек.

Нюансы тестирования с использованием заглушек

Существуют общие рекомендации по тестированию с использованием методов-заглушек:

• Не следует сосредотачиваться на проверке большого количества конкретных вызовов. Сосредоточьтесь на важных моментах.
• Если изменения в реализации не влияют на общую функциональность, они не должны вызывать ошибки в тестах.
• Использование большого количества методов-заглушек может привести к некорректным результатам тестирования.

Рекомендации для эффективного тестирования

Для достижения наибольшей эффективности тестирования:

• Код должен быть качественным с самого начала, что упростит работу с методами-заглушками.
• Используйте return_value и side_effect для моделирования различных сценариев поведения объектов-заглушек.
• Комбинируйте модульные тесты с интеграционными для проверки корректной работы всей системы в целом.

Полезные материалы

1. unittest.mock — библиотека методов-заглушек в Python 3.12.2 — официальная документация с подробным описанием библиотеки.
2. Гайд по использованию методов-заглушек для улучшения модульных тестов.
3. pytest и методы-заглушки — практическое руководство по использованию методов-заглушек в pytest.
4. Medium: юнит-тестирование на Python с применением методов-заглушек.
5. Описание метода assert_has_calls в официальной документации Python.
6. Использование return_value и side_effect.