Merge pull request #158 from Colin-b/feature/add_more_info

Enhance assertion failure messages

CHANGELOG.md

@@ -5,6 +5,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Assertion failure message in case of unmatched responses is now linking documentation on how to deactivate the check.
+- Assertion failure message in case of unmatched requests is now linking documentation on how to deactivate the check.
+
+### Fixed
+- Assertion failure message in case of unmatched requests at teardown is now describing requests in a more user-friendly way.
+- Assertion failure message in case of unmatched requests at teardown is now prefixing requests with `- ` to highlight the fact that this is a list, preventing misapprehension in case only one element exists.
+- Assertion failure message in case of unmatched responses at teardown is now prefixing responses with `- ` to highlight the fact that this is a list, preventing misapprehension in case only one element exists.
+- TimeoutException message issued in case of unmatched request is now prefixing available responses with `- ` to highlight the fact that this is a list, preventing misapprehension in case only one element exists.
 
 ## [0.31.2] - 2024-09-23
 ### Fixed

README.md

@@ -639,7 +639,7 @@ Refer to [available options](#available-options) for an exhaustive list of optio
 ```python
 import pytest
 
-@pytest.mark.httpx_mock(assert_all_responses_were_requested=True)
+@pytest.mark.httpx_mock(assert_all_responses_were_requested=False)
 def test_something(httpx_mock):
     ...
 ```
@@ -676,7 +676,7 @@ This option can be useful if you add responses using shared fixtures.
 ```python
 import pytest
 
-@pytest.mark.httpx_mock(assert_all_responses_were_requested=True)
+@pytest.mark.httpx_mock(assert_all_responses_were_requested=False)
 def test_fewer_requests_than_expected(httpx_mock):
     # Even if this response never received a corresponding request, the test will not fail at teardown
     httpx_mock.add_response()

pytest_httpx/_httpx_internals.py

@@ -1,10 +1,5 @@
 import base64
-from typing import (
-    Union,
-    Dict,
-    Tuple,
-    Optional,
-)
+from typing import Union, Optional
 from collections.abc import Sequence, Iterable, AsyncIterator, Iterator
 
 import httpcore

pytest_httpx/_httpx_mock.py

@@ -202,7 +202,7 @@ def _explain_that_no_response_was_found(
 
         message = f"No response can be found for {RequestDescription(real_transport, request, matchers)}"
 
-        matchers_description = "\n".join([str(matcher) for matcher in matchers])
+        matchers_description = "\n".join([f"- {matcher}" for matcher in matchers])
         if matchers_description:
             message += f" amongst:\n{matchers_description}"
 
@@ -290,17 +290,29 @@ def _assert_options(self, options: HTTPXMockOptions) -> None:
                 matcher for matcher, _ in self._callbacks if not matcher.nb_calls
             ]
             matchers_description = "\n".join(
-                [str(matcher) for matcher in callbacks_not_executed]
+                [f"- {matcher}" for matcher in callbacks_not_executed]
             )
 
-            assert (
-                not callbacks_not_executed
-            ), f"The following responses are mocked but not requested:\n{matchers_description}"
+            assert not callbacks_not_executed, (
+                "The following responses are mocked but not requested:\n"
+                f"{matchers_description}\n"
+                "\n"
+                "If this is on purpose, refer to https://github.com/Colin-b/pytest_httpx/blob/master/README.md#allow-to-register-more-responses-than-what-will-be-requested"
+            )
 
         if options.assert_all_requests_were_expected:
-            assert (
-                not self._requests_not_matched
-            ), f"The following requests were not expected:\n{self._requests_not_matched}"
+            requests_description = "\n".join(
+                [
+                    f"- {request.method} request on {request.url}"
+                    for request in self._requests_not_matched
+                ]
+            )
+            assert not self._requests_not_matched, (
+                f"The following requests were not expected:\n"
+                f"{requests_description}\n"
+                "\n"
+                "If this is on purpose, refer to https://github.com/Colin-b/pytest_httpx/blob/master/README.md#allow-to-not-register-responses-for-every-request"
+            )
 
 
 def _unread(response: httpx.Response) -> httpx.Response: