Как протестировать логирование в Python с использованием мок-объектов и фикстур?

Тестирование логирования в Python с использованием мок-объектов и фикстур - важная часть обеспечения надежности и правильности работы приложения. Вот как это можно сделать:

Основные подходы:

• Мокирование логгера: Заменяем стандартный логгер мок-объектом, позволяющим перехватывать вызовы и проверять их параметры.
• Использование `logging.handlers.StringIOHandler`: Перехватываем логи в строку и проверяем ее содержимое.
• Фикстуры pytest: Создаем фикстуры для удобного управления логгером и анализа логов в тестах.

Пример с использованием `unittest.mock` и `logging.handlers.StringIOHandler` (без pytest, демонстрирует основные принципы):

import unittest
import logging
import logging.handlers
from unittest.mock import patch

class MyClass:
    def __init__(self, logger=None):
        self.logger = logger or logging.getLogger(__name__)

    def do_something(self, value):
        self.logger.info(f"Doing something with value: {value}")
        if value < 0:
            self.logger.error("Value cannot be negative")
            return False
        return True


class TestMyClass(unittest.TestCase):
    def test_do_something_logs_info(self):
        # Создаем обработчик, который пишет в строку
        log_stream = logging.handlers.StringIOHandler()
        logger = logging.getLogger('test_logger') # Используем отдельный logger, чтобы избежать влияния на глобальный
        logger.setLevel(logging.INFO)
        logger.addHandler(log_stream)


        # Инстанцируем класс, передавая ему logger
        my_object = MyClass(logger=logger)
        my_object.do_something(10)

        # Проверяем, что в лог было записано ожидаемое сообщение
        self.assertIn("Doing something with value: 10", log_stream.getvalue())

    def test_do_something_logs_error_when_negative(self):
        log_stream = logging.handlers.StringIOHandler()
        logger = logging.getLogger('test_logger_error')
        logger.setLevel(logging.ERROR) #устанавливаем уровень логирования, иначе INFO не будет писать в ERROR
        logger.addHandler(log_stream)

        my_object = MyClass(logger=logger)
        my_object.do_something(-5)

        self.assertIn("Value cannot be negative", log_stream.getvalue())


if __name__ == '__main__':
    unittest.main()

  

Пример с использованием `pytest` и `caplog`:

import logging
import pytest

class MyClass:
    def __init__(self, logger=None):
        self.logger = logger or logging.getLogger(__name__)

    def do_something(self, value):
        self.logger.info(f"Doing something with value: {value}")
        if value < 0:
            self.logger.error("Value cannot be negative")
            return False
        return True


def test_do_something_logs_info(caplog):
    caplog.set_level(logging.INFO)
    my_object = MyClass()
    my_object.do_something(10)
    assert "Doing something with value: 10" in caplog.text

def test_do_something_logs_error_when_negative(caplog):
    caplog.set_level(logging.ERROR)
    my_object = MyClass()
    my_object.do_something(-5)
    assert "Value cannot be negative" in caplog.text
  

Пояснения:

• `caplog` - это встроенная фикстура pytest, позволяющая перехватывать логи.
• `caplog.set_level(logging.INFO)` устанавливает уровень логирования для теста. Важно помнить, что если логгер по умолчанию настроен на уровень выше, чем установленный в тесте, сообщения не будут перехвачены.
• `caplog.text` содержит все логи, сгенерированные во время теста.

Плюсы использования моков и фикстур:

• Изоляция: Тесты не зависят от реальной конфигурации логирования.
• Контроль: Можно точно контролировать, какие сообщения логируются и с каким уровнем.
• Скорость: Тесты выполняются быстрее, так как не требуется писать логи в файл или базу данных.
• Простота анализа: Легко проверить, что логирование происходит правильно, и при необходимости отлаживать тесты.

Рекомендации:

• Используйте фикстуры `pytest` для удобства и повторного использования кода.
• Убедитесь, что уровень логирования в тестах соответствует ожидаемым сообщениям.
• Пишите информативные утверждения (assert), чтобы при сбое теста было понятно, что пошло не так.
• Разделяйте тесты на логические блоки, чтобы облегчить отладку.