Examples how to test your bot

[sazarkin]

Hello!
Thanks for awesome library.

I am trying to write tests for my bot, and not sure how to do it right. I've searched the docs but found nothing.

Do you have some examples?

[uwinx]

My $0.01 on testing.
Tests are a huge topic to discuss. Proper tests require flexible architecture, otherwise you may have to mock a lot of stuff.
There are different types of tests and bots are not something different to add unit tests.

[sazarkin]

Well, I was thinking there is something to help me create telegram updates with different messages, to pass to my dispatcher. Testing each handler separatly also can work, but I am using state features, and not sure how to setup it. For me any examples will help a lot.

[aragentum]

@sazarkin try to use pytest + pytest-asyncio, in this case, code will be look something like this:

bot\__main__.py

from bot.handlers import echo_handler

...

if __name__ == '__main__':
    echo_handler.setup(dp)
    executor.start_polling(dp, skip_updates=True)

bot\handlers\echo_handler.py

from aiogram import types, Dispatcher


async def echo(message: types.Message):
    await message.answer(message.text)

def setup(dp: Dispatcher):
    dp.register_message_handler(echo)

bot\tests\handlers\test_echo_handler.py

import pytest

from unittest.mock import AsyncMock
from bot.handlers.echo_handler import echo


@pytest.mark.asyncio
async def test_echo_handler():
    text_mock = "test123"
    message_mock = AsyncMock(text=text_mock)
    await echo(message=message_mock)
    message_mock.answer.assert_called_with(text_mock)

[OCCCAS]

For testing I use aiogram_tests library.
You can find it in GitHub or PyPi, but it works only with aiogram3, but for aiogram2 you can use aiogram_unittest it works with unittest and pytest. aiogram_untitest on GitHub, on PyPi

[Hudrolax]

I can test different handlers, but I don't know how to test routers' logic. I mean how I can send a mocked message with a defined router (routers' chain) end to assert an answer from some handler?

[LabAsim]

Currently, aiogram_tests is broken. I have found a fork that does work with aiogram 3.3.0.
https://github.com/Like6po/aiogram_tests