Как реализовать end-to-end-тестирование telegram-бота
Каждый, кто когда-либо писал telegram-ботов, задавался вопросом: «А как их тестировать?» Сложно найти однозначный ответ. Например, при написании тестов для веб-приложений и API можно воспользоваться тестовым клиентом DRF или FastAPI: просто пишешь запрос и делаешь assert на полученный ответ. Мне захотелось получить подобный функционал и для тестирования telegram-бота.
Привет, Хабр. Я Михаил Выборный, python-разработчик, backend-developer в облачном провайдере beeline cloud. В этой статье я хочу поделиться опытом написания автоматизированных end-to-end-тестов без эмуляции Telegram Bot API, но с использованием тестовых аккаунтов. Мы зайдем в изолированное тестовое пространство Telegram, создадим тестового бота, подготовим фикстуру для запуска нашего приложения и напишем авторизацию для тестовых клиентов.
По ходу статьи я буду использовать инструменты следующих библиотек:
Python Telegram Bot — для написания бота (сокращенно PTB);
Pytest — для организации тестов;
Anyio — для асинхронных тестов и фикстур;
Pyrogram — для отправки тестовых сообщений;
asyncio.Event — для оповещения о получении ожидаемых сообщений и предотвращения излишних ожиданий;
contexlib — для удобного синтаксиса написания контекстных менеджеров.
Статья написана на примере реализации несложного бота для хранения фотографий и отправки их в ответ при запросе. Вы можете посмотреть исходный код приложения и тестов на GitHub. Ниже я использую короткие выдержки из официальной документации Telegram на английском — к ним даю пояснения на русском своими словами.
Альтернативы
Перед тем как что-то писать самому, я пытался найти готовое решение и был уверен, что Google мне поможет. Но оказалось, что готового оптимального решения просто не существует. Здесь я кратко перечислю то, что мне удалось найти и почему это не подошло.
PTB Test
Aiogram Tests
подходит для тестирования ботов, написанных только на aiogram
реализует unit-тестирование через Mock-объекты (без интеграции Telegram Bot API)
Все тест-кейсы описываются как вызов конкретных handler-ов, из-за чего нет возможности протестировать их поведения целиком — от отправки пользователем сообщения до получения ответа. К примеру, непонятно, как тестировать фильтрацию входящих сообщений и их распределение по различным handler-ам и т. п.
Tg Integration
также не поддерживается
тянет устаревшие зависимости (pyrogram < 2.0.0 typing-extensions < 4.0.0)
практически отсутствует документация
Перед тем как начать. Регистрация APP
Предположим, наш бот уже готов и мы переходим к тестированию. Для этого мы подготовим необходимые инструменты, чтобы написание самих тестов было кратким и понятным. Отправить сообщение, получить ответ, проверить его. Да, придется потратить время, чтобы реализовать вспомогательные фикстуры по регистрации клиентов и обработки входящих сообщений. Но, заморочившись однажды, мы сможем писать сами тесты всего в несколько строк. Их будет легко обновлять и поддерживать.
Отправлять тестовые сообщения мы будем с помощью Pyrogram. Для этого нужно зарегистрировать будущее клиентское приложение.
