Что такое monkeypatch в PyTest и какие задачи им решают?

1️⃣ Как кратко ответить

Monkeypatch в PyTest — это механизм, позволяющий временно изменять или подменять поведение объектов, модулей или функций в тестах. Это полезно для изоляции тестируемого кода от внешних зависимостей, таких как сетевые запросы или доступ к базе данных, что позволяет тестировать код в контролируемой среде.

2️⃣ Подробное объяснение темы

Monkeypatch — это техника, используемая в тестировании для временного изменения или подмены поведения объектов, функций или модулей. В контексте PyTest, monkeypatch предоставляет удобный способ модифицировать поведение кода во время выполнения тестов. Это особенно полезно, когда необходимо изолировать тестируемый код от внешних зависимостей, таких как API, базы данных или файловая система.

Зачем это нужно?

1. Изоляция тестов: Позволяет тестировать код без необходимости взаимодействия с внешними системами, что делает тесты более быстрыми и надежными.
2. Контроль над окружением: Позволяет задавать определенные условия или состояния, которые могут быть труднодостижимы в реальной среде.
3. Упрощение тестирования: Устраняет необходимость в сложной настройке тестового окружения.

Как это работает?

Monkeypatch в PyTest реализуется через фикстуру monkeypatch, которая предоставляется самим PyTest. Эта фикстура позволяет временно изменять атрибуты объектов, заменять функции или модули, а также изменять переменные окружения.

Пример использования

Рассмотрим пример, где мы хотим протестировать функцию, которая делает HTTP-запрос. Вместо реального запроса мы подменим функцию, чтобы она возвращала заранее определенный результат.

import requests
​
def fetch_data(url):
    response = requests.get(url)
    return response.json()
​
def test_fetch_data(monkeypatch):
    # Определяем фейковую функцию, которая будет подменять requests.get
    def mock_get(url):
        class MockResponse:
            def json(self):
                return {"key": "value"}
​
        return MockResponse()
​
    # Используем monkeypatch для замены requests.get на mock_get
    monkeypatch.setattr(requests, "get", mock_get)
​
    # Теперь вызов fetch_data будет использовать mock_get вместо requests.get
    result = fetch_data("http://example.com")
​
    # Проверяем, что результат соответствует ожидаемому
    assert result == {"key": "value"}

Подробный разбор кода

• Импортируем модуль requests: Это стандартный модуль для выполнения HTTP-запросов в Python.

• Определяем функцию fetch_data: Эта функция принимает URL и возвращает JSON-ответ от HTTP-запроса.

• Определяем тестовую функцию test_fetch_data: В этой функции мы используем фикстуру monkeypatch.

• Создаем mock_get: Это фейковая функция, которая будет подменять requests.get. Она возвращает объект MockResponse, который имеет метод json, возвращающий заранее определенный словарь.

• Используем monkeypatch.setattr: Эта строка заменяет requests.get на нашу фейковую функцию mock_get.

• Вызываем fetch_data: Теперь, когда fetch_data вызывает requests.get, на самом деле вызывается mock_get.

• Проверяем результат: Убеждаемся, что результат вызова fetch_data соответствует ожидаемому значению.

Monkeypatching позволяет тестировать код в изолированной и контролируемой среде, что делает тесты более надежными и предсказуемыми.