✨ allow call api raise exception

Author: yanyongyu

nonebug/mixin/call_api/__init__.py

@@ -132,23 +132,32 @@ def should_call_api(
         self,
         api: str,
         data: Dict[str, Any],
-        result: Any,
+        result: Optional[Any] = None,
+        exception: Optional[Exception] = None,
         adapter: Optional["Adapter"] = None,
     ) -> Api:
-        model = Api(name=api, data=data, result=result, adapter=adapter)
+        model = Api(
+            name=api, data=data, result=result, exception=exception, adapter=adapter
+        )
         self.wait_list.put(model)
         return model
 
     def should_call_send(
         self,
         event: "Event",
         message: Union[str, "Message", "MessageSegment"],
-        result: Any,
+        result: Optional[Any] = None,
+        exception: Optional[Exception] = None,
         bot: Optional["Bot"] = None,
         **kwargs: Any,
     ) -> Send:
         model = Send(
-            event=event, message=message, kwargs=kwargs, result=result, bot=bot
+            event=event,
+            message=message,
+            kwargs=kwargs,
+            result=result,
+            exception=exception,
+            bot=bot,
         )
         self.wait_list.put(model)
         return model
@@ -171,6 +180,9 @@ def got_call_api(self, adapter: "Adapter", api: str, **data: Any) -> Any:
             pytest.fail(
                 f"Application got api call {api} with adapter {adapter} but expected {model.adapter}"
             )
+
+        if model.exception is not None:
+            raise model.exception
         return model.result
 
     def got_call_send(
@@ -203,6 +215,9 @@ def got_call_send(
             pytest.fail(
                 f"Application got send call with bot {bot} but expected {model.bot}"
             )
+
+        if model.exception is not None:
+            raise model.exception
         return model.result
 
     @contextlib.contextmanager

nonebug/mixin/call_api/model.py

@@ -15,6 +15,7 @@ class Api(Model):
     name: str
     data: Dict[str, Any]
     result: Any
+    exception: Optional[Exception]
     adapter: Optional["Adapter"]
 
 
@@ -24,4 +25,5 @@ class Send(Model):
     message: Union[str, "Message", "MessageSegment"]
     kwargs: Dict[str, Any]
     result: Any
+    exception: Optional[Exception]
     bot: Optional["Bot"]

tests/conftest.py

@@ -5,8 +5,8 @@
 import nonebot
 from nonebot.plugin import Plugin
 
-from nonebug.fixture import *
 from nonebug import NONEBOT_INIT_KWARGS
+from nonebug.fixture import nonebug_app, nonebug_init
 
 
 def pytest_configure(config: pytest.Config) -> None:

tests/test_call_api.py

@@ -80,7 +80,7 @@ class FakeBot(Bot):
 
 
 @pytest.mark.asyncio
-async def test_got_call(app: App):
+async def test_got_call_api(app: App):
     async with app.test_api() as ctx:
         adapter = ctx.create_adapter()
         bot = ctx.create_bot(self_id="test", adapter=adapter)
@@ -92,6 +92,23 @@ async def test_got_call(app: App):
 
     assert "test" not in get_bots()
 
+    async with app.test_api() as ctx:
+        adapter = ctx.create_adapter()
+        bot = ctx.create_bot(self_id="test", adapter=adapter)
+        assert "test" in get_bots()
+        api = ctx.should_call_api(
+            "test", {"key": "value"}, exception=RuntimeError(), adapter=adapter
+        )
+        with pytest.raises(RuntimeError):
+            result = await bot.call_api("test", key="value")
+
+        assert ctx.wait_list.empty()
+
+    assert "test" not in get_bots()
+
+
+@pytest.mark.asyncio
+async def test_got_call_send(app: App):
     async with app.test_api() as ctx:
         bot = ctx.create_bot(self_id="test")
         assert "test" in get_bots()
@@ -102,3 +119,17 @@ async def test_got_call(app: App):
         assert result == "result"
 
     assert "test" not in get_bots()
+
+    async with app.test_api() as ctx:
+        bot = ctx.create_bot(self_id="test")
+        assert "test" in get_bots()
+        event = make_fake_event()()
+        api = ctx.should_call_send(
+            event, "test", exception=RuntimeError(), bot=bot, key="value"
+        )
+        with pytest.raises(RuntimeError):
+            result = await bot.send(event, "test", key="value")
+
+        assert ctx.wait_list.empty()
+
+    assert "test" not in get_bots()