aiogram/tests/test_utils/test_i18n.py
Alex Root Junior f4ce4431f9
Migrate to hatchling (#1095)
* Migrate to hatchling instead of poetry, ruff instead of flake8

* Migrate to hatchling instead of poetry, ruff instead of flake8

* Update tests suite

* venv?

* -m venv?

* Change dependencies

* Remove venv

* Change mypy config

* Added changelog

* Mark uvloop incompatible with pypy

* Update release script

* Use internal caching for dependencies

* Re-disable cov branches

* Added contributing guide
2023-01-12 02:49:58 +02:00

206 lines
7.4 KiB
Python

from typing import Any, Dict
import pytest
from aiogram import Dispatcher
from aiogram.fsm.context import FSMContext
from aiogram.fsm.storage.base import StorageKey
from aiogram.fsm.storage.memory import MemoryStorage
from aiogram.types import Update, User
from aiogram.utils.i18n import (
ConstI18nMiddleware,
FSMI18nMiddleware,
I18n,
SimpleI18nMiddleware,
)
from aiogram.utils.i18n.context import get_i18n, gettext, lazy_gettext
from tests.conftest import DATA_DIR
from tests.mocked_bot import MockedBot
@pytest.fixture(name="i18n")
def i18n_fixture() -> I18n:
return I18n(path=DATA_DIR / "locales")
class TestI18nCore:
def test_init(self, i18n: I18n):
assert set(i18n.available_locales) == {"en", "uk"}
def test_reload(self, i18n: I18n):
i18n.reload()
assert set(i18n.available_locales) == {"en", "uk"}
def test_current_locale(self, i18n: I18n):
assert i18n.current_locale == "en"
i18n.current_locale = "uk"
assert i18n.current_locale == "uk"
assert i18n.ctx_locale.get() == "uk"
def test_use_locale(self, i18n: I18n):
assert i18n.current_locale == "en"
with i18n.use_locale("uk"):
assert i18n.current_locale == "uk"
with i18n.use_locale("it"):
assert i18n.current_locale == "it"
assert i18n.current_locale == "uk"
assert i18n.current_locale == "en"
def test_get_i18n(self, i18n: I18n):
with pytest.raises(LookupError):
get_i18n()
with i18n.context():
assert get_i18n() == i18n
@pytest.mark.parametrize(
"locale,case,result",
[
[None, {"singular": "test"}, "test"],
[None, {"singular": "test", "locale": "uk"}, "тест"],
["en", {"singular": "test", "locale": "uk"}, "тест"],
["uk", {"singular": "test", "locale": "uk"}, "тест"],
["uk", {"singular": "test"}, "тест"],
["it", {"singular": "test"}, "test"],
[None, {"singular": "test", "n": 2}, "test"],
[None, {"singular": "test", "n": 2, "locale": "uk"}, "тест"],
["en", {"singular": "test", "n": 2, "locale": "uk"}, "тест"],
["uk", {"singular": "test", "n": 2, "locale": "uk"}, "тест"],
["uk", {"singular": "test", "n": 2}, "тест"],
["it", {"singular": "test", "n": 2}, "test"],
[None, {"singular": "test", "plural": "test2", "n": 2}, "test2"],
[None, {"singular": "test", "plural": "test2", "n": 2, "locale": "uk"}, "test2"],
["en", {"singular": "test", "plural": "test2", "n": 2, "locale": "uk"}, "test2"],
["uk", {"singular": "test", "plural": "test2", "n": 2, "locale": "uk"}, "test2"],
["uk", {"singular": "test", "plural": "test2", "n": 2}, "test2"],
["it", {"singular": "test", "plural": "test2", "n": 2}, "test2"],
],
)
def test_gettext(self, i18n: I18n, locale: str, case: Dict[str, Any], result: str):
if locale is not None:
i18n.current_locale = locale
with i18n.context():
assert i18n.gettext(**case) == result
assert str(i18n.lazy_gettext(**case)) == result
assert gettext(**case) == result
assert str(lazy_gettext(**case)) == result
async def next_call(event, data):
assert "i18n" in data
assert "i18n_middleware" in data
return gettext("test")
class TestSimpleI18nMiddleware:
@pytest.mark.parametrize(
"event_from_user,result",
[
[None, "test"],
[User(id=42, is_bot=False, language_code="uk", first_name="Test"), "тест"],
[User(id=42, is_bot=False, language_code="it", first_name="Test"), "test"],
],
)
async def test_middleware(self, i18n: I18n, event_from_user, result):
middleware = SimpleI18nMiddleware(i18n=i18n)
result = await middleware(
next_call,
Update(update_id=42),
{"event_from_user": event_from_user},
)
assert result == result
async def test_setup(self, i18n: I18n):
dp = Dispatcher()
middleware = SimpleI18nMiddleware(i18n=i18n)
middleware.setup(router=dp)
assert middleware in dp.message.outer_middleware
assert middleware in dp.callback_query.outer_middleware
async def test_setup_exclude(self, i18n: I18n):
dp = Dispatcher()
middleware = SimpleI18nMiddleware(i18n=i18n)
middleware.setup(router=dp, exclude={"message"})
assert middleware not in dp.update.outer_middleware
assert middleware not in dp.message.outer_middleware
assert middleware in dp.callback_query.outer_middleware
async def test_get_unknown_locale(self, i18n: I18n):
dp = Dispatcher()
middleware = SimpleI18nMiddleware(i18n=i18n)
middleware.setup(router=dp)
locale = await middleware.get_locale(
None,
{
"event_from_user": User(
id=42,
is_bot=False,
first_name="Test",
language_code="unknown",
)
},
)
assert locale == i18n.default_locale
async def test_custom_keys(self, i18n: I18n):
async def handler(event, data):
return data
middleware = SimpleI18nMiddleware(
i18n=i18n, i18n_key="translator", middleware_key="middleware"
)
context: dict[str, Any] = await middleware(handler, None, {})
assert "translator" in context
assert context["translator"] == i18n
assert "middleware" in context
assert context["middleware"] == middleware
class TestConstI18nMiddleware:
async def test_middleware(self, i18n: I18n):
middleware = ConstI18nMiddleware(i18n=i18n, locale="uk")
result = await middleware(
next_call,
Update(update_id=42),
{
"event_from_user": User(
id=42, is_bot=False, language_code="it", first_name="Test"
),
},
)
assert result == "тест"
class TestFSMI18nMiddleware:
async def test_middleware(self, i18n: I18n, bot: MockedBot, extra):
middleware = FSMI18nMiddleware(i18n=i18n)
storage = MemoryStorage()
state = FSMContext(
bot=bot, storage=storage, key=StorageKey(user_id=42, chat_id=42, bot_id=bot.id)
)
data = {
"event_from_user": User(id=42, is_bot=False, language_code="it", first_name="Test"),
"state": state,
}
result = await middleware(next_call, Update(update_id=42), data)
assert result == "test"
await middleware.set_locale(state, "uk")
assert i18n.current_locale == "uk"
result = await middleware(next_call, Update(update_id=42), data)
assert result == "тест"
async def test_without_state(self, i18n: I18n, bot: MockedBot, extra):
middleware = FSMI18nMiddleware(i18n=i18n)
data = {
"event_from_user": User(id=42, is_bot=False, language_code="it", first_name="Test"),
}
result = await middleware(next_call, Update(update_id=42), data)
assert i18n.current_locale == "en"
assert result == "test"
assert i18n.current_locale == "en"
result = await middleware(next_call, Update(update_id=42), data)
assert i18n.current_locale == "en"