Raise custom error types for assertion checks (#174)

* Raise custom error types for assertion checks

* Fail fast in assert_all_called

Author: lundberg

respx/mocks.py

@@ -7,7 +7,7 @@
 import httpx
 from httpcore import AsyncIteratorByteStream, IteratorByteStream
 
-from .models import PassThrough
+from .models import AllMockedAssertionError, PassThrough
 from .transports import TryTransport
 
 if TYPE_CHECKING:
@@ -105,33 +105,33 @@ def restart(cls) -> None:
     @classmethod
     def handler(cls, httpx_request):
         httpx_response = None
-        error = None
+        assertion_error = None
         for router in cls.routers:
             try:
                 httpx_response = router.handler(httpx_request)
-            except AssertionError as e:
-                error = e.args[0]
+            except AllMockedAssertionError as error:
+                assertion_error = error
                 continue
             else:
                 break
-        else:
-            assert httpx_response, error
+        if assertion_error and not httpx_response:
+            raise assertion_error
         return httpx_response
 
     @classmethod
     async def async_handler(cls, httpx_request):
         httpx_response = None
-        error = None
+        assertion_error = None
         for router in cls.routers:
             try:
                 httpx_response = await router.async_handler(httpx_request)
-            except AssertionError as e:
-                error = e.args[0]
+            except AllMockedAssertionError as error:
+                assertion_error = error
                 continue
             else:
                 break
-        else:
-            assert httpx_response, error
+        if assertion_error and not httpx_response:
+            raise assertion_error
         return httpx_response
 
     @classmethod

respx/models.py

@@ -483,6 +483,14 @@ def pop(self, name, default=...):
             return default
 
 
+class AllMockedAssertionError(AssertionError):
+    pass
+
+
+class AllCalledAssertionError(AssertionError):
+    pass
+
+
 class SideEffectError(Exception):
     def __init__(self, route: Route, origin: Exception) -> None:
         self.route = route

respx/router.py

@@ -21,6 +21,8 @@
 
 from .mocks import Mocker
 from .models import (
+    AllCalledAssertionError,
+    AllMockedAssertionError,
     CallList,
     PassThrough,
     ResolvedRoute,
@@ -97,9 +99,8 @@ def reset(self) -> None:
             route.reset()
 
     def assert_all_called(self) -> None:
-        assert all(
-            (route.called for route in self.routes)
-        ), "RESPX: some mocked requests were not called!"
+        if any(not route.called for route in self.routes):
+            raise AllCalledAssertionError("RESPX: some routes were not called!")
 
     def __getitem__(self, name: str) -> Route:
         return self.routes[name]
@@ -238,7 +239,8 @@ def resolver(self, request: httpx.Request) -> Generator[ResolvedRoute, None, Non
 
             if resolved.route is None:
                 # Assert we always get a route match, if check is enabled
-                assert not self._assert_all_mocked, f"RESPX: {request!r} not mocked!"
+                if self._assert_all_mocked:
+                    raise AllMockedAssertionError(f"RESPX: {request!r} not mocked!")
 
                 # Auto mock a successful empty response
                 resolved.response = httpx.Response(200)

tests/test_mock.py

@@ -7,10 +7,9 @@
 import respx
 from respx import ASGIHandler, WSGIHandler
 from respx.mocks import Mocker
+from respx.models import AllCalledAssertionError, AllMockedAssertionError
 from respx.router import MockRouter
 
-# from respx.transports import MockTransport
-
 
 @pytest.mark.asyncio
 @respx.mock
@@ -112,7 +111,7 @@ def test(respx_mock):
         assert respx.calls.call_count == 0
         assert respx_mock.calls.call_count == 1
 
-        with pytest.raises(AssertionError, match="not mocked"):
+        with pytest.raises(AllMockedAssertionError):
             httpx.post("https://foo.bar/")
 
     assert respx.calls.call_count == 0
@@ -139,7 +138,7 @@ async def test(respx_mock):
         assert respx.calls.call_count == 0
         assert respx_mock.calls.call_count == 1
 
-        with pytest.raises(AssertionError, match="not mocked"):
+        with pytest.raises(AllMockedAssertionError):
             httpx.post("https://foo.bar/")
 
     assert respx.calls.call_count == 0
@@ -415,7 +414,7 @@ async def test_start_stop(client):
 @pytest.mark.parametrize(
     "assert_all_called,do_post,raises",
     [
-        (True, False, pytest.raises(AssertionError)),
+        (True, False, pytest.raises(AllCalledAssertionError)),
         (True, True, does_not_raise()),
         (False, True, does_not_raise()),
         (False, False, does_not_raise()),
@@ -438,7 +437,7 @@ async def test_assert_all_called(client, assert_all_called, do_post, raises):
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
     "assert_all_mocked,raises",
-    [(True, pytest.raises(AssertionError)), (False, does_not_raise())],
+    [(True, pytest.raises(AllMockedAssertionError)), (False, does_not_raise())],
 )
 async def test_assert_all_mocked(client, assert_all_mocked, raises):
     with raises:
@@ -574,7 +573,7 @@ def test(respx_mock):
                 client.get("https://pass-through/")
             assert pass_route.call_count == 1
 
-            with pytest.raises(AssertionError, match="not mocked"):
+            with pytest.raises(AllMockedAssertionError):
                 client.get("https://not-mocked/")
 
     with respx.mock(using="httpx"):  # extra registered router
@@ -615,7 +614,7 @@ async def content():
                 await client.get("https://pass-through/")
             assert pass_route.call_count == 1
 
-            with pytest.raises(AssertionError, match="not mocked"):
+            with pytest.raises(AllMockedAssertionError):
                 await client.get("https://not-mocked/")
 
     async with respx.mock(using="httpx"):  # extra registered router

tests/test_router.py

@@ -5,7 +5,7 @@
 import pytest
 
 from respx import Route, Router
-from respx.models import PassThrough, RouteList
+from respx.models import AllMockedAssertionError, PassThrough, RouteList
 from respx.patterns import Host, M, Method
 
 
@@ -14,10 +14,10 @@ async def test_empty_router():
     router = Router()
 
     request = httpx.Request("GET", "https://example.org/")
-    with pytest.raises(AssertionError, match="not mocked"):
+    with pytest.raises(AllMockedAssertionError):
         router.resolve(request)
 
-    with pytest.raises(AssertionError, match="not mocked"):
+    with pytest.raises(AllMockedAssertionError):
         await router.aresolve(request)
 
 

tests/test_transports.py

@@ -3,7 +3,7 @@
 import httpx
 import pytest
 
-from respx.models import PassThrough
+from respx.models import AllCalledAssertionError, PassThrough
 from respx.router import Router
 from respx.transports import MockTransport
 
@@ -59,7 +59,7 @@ async def test_transport_assertions():
         transport = MockTransport(router=router)
         assert len(w) == 1
 
-    with pytest.raises(AssertionError, match="were not called"):
+    with pytest.raises(AllCalledAssertionError):
         async with httpx.AsyncClient(transport=transport) as client:
             response = await client.get(url)
             assert response.status_code == 404