test: 使用 pytest-mock 重构测试

Author: st1020

pyproject.toml

@@ -68,6 +68,7 @@ dev-dependencies = [
     "tomlkit>=0.13",
     # test
     "pytest>=8",
+    "pytest-mock>=3",
     "pytest-xdist>=3",
     "pytest-cov>=5",
 ]

tests/test_adapter/test_adapter.py

@@ -30,7 +30,6 @@ def test_adapter_raise_error(bot: Bot) -> None:
     class TestAdapter(Adapter[Event[Any], None]):
         @override
         async def run(self) -> None:
-            """运行适配器。"""
             self.bot.exit()
             raise RuntimeError
 

tests/test_bot.py

@@ -1,18 +1,20 @@
+from pytest_mock import MockerFixture
+
 from alicebot import Bot
 
 
-def test_bot_restart() -> None:
-    flag = False
+def test_bot_restart(mocker: MockerFixture) -> None:
+    mock = mocker.AsyncMock()
 
     async def bot_run_hook(bot: Bot) -> None:
-        nonlocal flag
-        if flag:
+        if mock.called:
             bot.exit()
             return
+        await mock()
         bot.restart()
-        flag = True
 
     bot = Bot()
+    spy = mocker.spy(bot, "restart")
     bot.bot_run_hook(bot_run_hook)
     bot.run()
-    assert flag
+    spy.assert_called_once()

tests/test_dependencies.py

@@ -5,6 +5,7 @@
 from typing_extensions import Self
 
 import pytest
+from pytest_mock import MockerFixture
 
 from alicebot.dependencies import Depends, solve_dependencies
 
@@ -70,14 +71,9 @@ class Dependent:
 
 
 @pytest.mark.anyio
-async def test_depends_context_manager() -> None:
-    enter_flag = False
-    exit_flag = False
-
+async def test_depends_context_manager(mocker: MockerFixture) -> None:
     class DepA:
         def __enter__(self) -> Self:
-            nonlocal enter_flag
-            enter_flag = True
             return self
 
         def __exit__(
@@ -86,8 +82,7 @@ def __exit__(
             _exc_value: Optional[BaseException],
             _traceback: Optional[TracebackType],
         ) -> None:
-            nonlocal exit_flag
-            exit_flag = True
+            pass
 
     class DepB:
         a: DepA = Depends()
@@ -96,6 +91,9 @@ class Dependent:
         a: DepA = Depends()
         b: DepB = Depends()
 
+    enter_spy = mocker.spy(DepA, "__enter__")
+    exit_spy = mocker.spy(DepA, "__exit__")
+
     obj = None
 
     async with AsyncExitStack() as stack:
@@ -110,17 +108,14 @@ class Dependent:
     assert isinstance(obj.a, DepA)
     assert isinstance(obj.b, DepB)
     assert obj.b.a is obj.a
+    enter_spy.assert_called_once()
+    exit_spy.assert_called_once()
 
 
 @pytest.mark.anyio
-async def test_depends_async_context_manager() -> None:
-    enter_flag = False
-    exit_flag = False
-
+async def test_depends_async_context_manager(mocker: MockerFixture) -> None:
     class DepA:
         async def __aenter__(self) -> Self:
-            nonlocal enter_flag
-            enter_flag = True
             return self
 
         async def __aexit__(
@@ -129,8 +124,7 @@ async def __aexit__(
             _exc_value: Optional[BaseException],
             _traceback: Optional[TracebackType],
         ) -> None:
-            nonlocal exit_flag
-            exit_flag = True
+            pass
 
     class DepB:
         a: DepA = Depends()
@@ -139,6 +133,9 @@ class Dependent:
         a: DepA = Depends()
         b: DepB = Depends()
 
+    aenter_spy = mocker.spy(DepA, "__aenter__")
+    aexit_spy = mocker.spy(DepA, "__aexit__")
+
     obj = None
 
     async with AsyncExitStack() as stack:
@@ -153,23 +150,20 @@ class Dependent:
     assert isinstance(obj.a, DepA)
     assert isinstance(obj.b, DepB)
     assert obj.b.a is obj.a
-
-    assert enter_flag
-    assert exit_flag
+    aenter_spy.assert_called_once()
+    aexit_spy.assert_called_once()
 
 
 @pytest.mark.anyio
-async def test_depends_generator() -> None:
-    enter_flag = False
-    exit_flag = False
+async def test_depends_generator(mocker: MockerFixture) -> None:
+    mock = mocker.MagicMock()
 
     class DepA: ...
 
     def dep_a() -> Generator[DepA, None, None]:
-        nonlocal enter_flag, exit_flag
-        enter_flag = True
+        mock("enter")
         yield DepA()
-        exit_flag = True
+        mock("exit")
 
     class DepB:
         a = Depends(dep_a)
@@ -192,23 +186,19 @@ class Dependent:
     assert isinstance(obj.a, DepA)
     assert isinstance(obj.b, DepB)
     assert obj.b.a is obj.a
-
-    assert enter_flag
-    assert exit_flag
+    assert mock.call_args_list == [mocker.call("enter"), mocker.call("exit")]
 
 
 @pytest.mark.anyio
-async def test_depends_async_generator() -> None:
-    enter_flag = False
-    exit_flag = False
+async def test_depends_async_generator(mocker: MockerFixture) -> None:
+    mock = mocker.AsyncMock()
 
     class DepA: ...
 
     async def dep_a() -> AsyncGenerator[DepA, None]:
-        nonlocal enter_flag, exit_flag
-        enter_flag = True
+        await mock("enter")
         yield DepA()
-        exit_flag = True
+        await mock("exit")
 
     class DepB:
         a = Depends(dep_a)
@@ -231,9 +221,7 @@ class Dependent:
     assert isinstance(obj.a, DepA)
     assert isinstance(obj.b, DepB)
     assert obj.b.a is obj.a
-
-    assert enter_flag
-    assert exit_flag
+    assert mock.call_args_list == [mocker.call("enter"), mocker.call("exit")]
 
 
 @pytest.mark.anyio

tests/test_hook.py

@@ -1,123 +1,54 @@
-from typing import Any
+from typing import Any, Callable
 
 from fake_adapter import FakeAdapter, FakeMessageEvent
 
 from alicebot import Adapter, Bot, Event
 
 
-def test_bot_run_hook() -> None:  # noqa: PLR0915
-    bot_run_hook_flag = False
-    bot_exit_hook_flag = False
-    adapter_startup_hook_flag = False
-    adapter_run_hook_flag = False
-    adapter_shutdown_hook_flag = False
-    event_preprocessor_hook_flag = False
-    event_postprocessor_hook_flag = False
+def test_bot_run_hook() -> None:
+    hook_call_list: list[Callable[..., Any]] = []
+    bot = Bot()
 
+    @bot.bot_run_hook
     async def bot_run_hook(_bot: Bot) -> None:
-        nonlocal bot_run_hook_flag
-        bot_run_hook_flag = True
-
-        assert bot_run_hook_flag
-        assert not bot_exit_hook_flag
-        assert not adapter_startup_hook_flag
-        assert not adapter_run_hook_flag
-        assert not adapter_shutdown_hook_flag
-        assert not event_preprocessor_hook_flag
-        assert not event_postprocessor_hook_flag
+        hook_call_list.append(bot_run_hook)
 
+    @bot.bot_exit_hook
     async def bot_exit_hook(_bot: Bot) -> None:
-        nonlocal bot_exit_hook_flag
-        bot_exit_hook_flag = True
-
-        assert bot_run_hook_flag
-        assert bot_exit_hook_flag
-        assert adapter_startup_hook_flag
-        assert adapter_run_hook_flag
-        assert adapter_shutdown_hook_flag
-        assert event_preprocessor_hook_flag
-        assert event_postprocessor_hook_flag
+        hook_call_list.append(bot_exit_hook)
 
+    @bot.adapter_startup_hook
     async def adapter_startup_hook(_adapter: Adapter[Any, Any]) -> None:
-        nonlocal adapter_startup_hook_flag
-        adapter_startup_hook_flag = True
-
-        assert bot_run_hook_flag
-        assert not bot_exit_hook_flag
-        assert adapter_startup_hook_flag
-        assert not adapter_run_hook_flag
-        assert not adapter_shutdown_hook_flag
-        assert not event_preprocessor_hook_flag
-        assert not event_postprocessor_hook_flag
+        hook_call_list.append(adapter_startup_hook)
 
+    @bot.adapter_run_hook
     async def adapter_run_hook(_adapter: Adapter[Any, Any]) -> None:
-        nonlocal adapter_run_hook_flag
-        adapter_run_hook_flag = True
-
-        assert bot_run_hook_flag
-        assert not bot_exit_hook_flag
-        assert adapter_startup_hook_flag
-        assert adapter_run_hook_flag
-        assert not adapter_shutdown_hook_flag
-        assert not event_preprocessor_hook_flag
-        assert not event_postprocessor_hook_flag
+        hook_call_list.append(adapter_run_hook)
 
+    @bot.adapter_shutdown_hook
     async def adapter_shutdown_hook(_adapter: Adapter[Any, Any]) -> None:
-        nonlocal adapter_shutdown_hook_flag
-        adapter_shutdown_hook_flag = True
-
-        assert bot_run_hook_flag
-        assert not bot_exit_hook_flag
-        assert adapter_startup_hook_flag
-        assert adapter_run_hook_flag
-        assert adapter_shutdown_hook_flag
-        assert event_preprocessor_hook_flag
-        assert event_postprocessor_hook_flag
+        hook_call_list.append(adapter_shutdown_hook)
 
+    @bot.event_preprocessor_hook
     async def event_preprocessor_hook(_event: Event[Any]) -> None:
-        nonlocal event_preprocessor_hook_flag
-        event_preprocessor_hook_flag = True
-
-        assert bot_run_hook_flag
-        assert not bot_exit_hook_flag
-        assert adapter_startup_hook_flag
-        assert adapter_run_hook_flag
-        assert not adapter_shutdown_hook_flag
-        assert event_preprocessor_hook_flag
-        assert not event_postprocessor_hook_flag
+        hook_call_list.append(event_preprocessor_hook)
 
+    @bot.event_postprocessor_hook
     async def event_postprocessor_hook(_event: Event[Any]) -> None:
-        nonlocal event_postprocessor_hook_flag
-        event_postprocessor_hook_flag = True
-
-        assert bot_run_hook_flag
-        assert not bot_exit_hook_flag
-        assert adapter_startup_hook_flag
-        assert adapter_run_hook_flag
-        assert not adapter_shutdown_hook_flag
-        assert event_preprocessor_hook_flag
-        assert event_postprocessor_hook_flag
-
-    bot = Bot()
-
-    bot.bot_run_hook(bot_run_hook)
-    bot.bot_exit_hook(bot_exit_hook)
-    bot.adapter_startup_hook(adapter_startup_hook)
-    bot.adapter_run_hook(adapter_run_hook)
-    bot.adapter_shutdown_hook(adapter_shutdown_hook)
-    bot.event_preprocessor_hook(event_preprocessor_hook)
-    bot.event_postprocessor_hook(event_postprocessor_hook)
+        hook_call_list.append(event_postprocessor_hook)
 
     FakeAdapter.set_event_factories(
         lambda self: FakeMessageEvent(adapter=self, type="message")
     )
     bot.load_adapters(FakeAdapter)
     bot.run()
 
-    assert bot_run_hook_flag
-    assert bot_exit_hook_flag
-    assert adapter_startup_hook_flag
-    assert adapter_run_hook_flag
-    assert adapter_shutdown_hook_flag
-    assert event_preprocessor_hook_flag
-    assert event_postprocessor_hook_flag
+    assert hook_call_list == [
+        bot_run_hook,
+        adapter_startup_hook,
+        adapter_run_hook,
+        event_preprocessor_hook,
+        event_postprocessor_hook,
+        adapter_shutdown_hook,
+        bot_exit_hook,
+    ]