Merge pull request Colin-b#23 from Colin-b/develop

Release 0.5.0

Author: Colin-b

CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2020-07-31
+### Changed
+- requires [`pytest`](https://docs.pytest.org/en/latest/) 6.
+- `assert_and_reset` mock method has been renamed to `reset` and now takes a boolean parameter to specify if assertion should be performed.
+
+### Added
+- It is now possible to disable the assertion that all registered responses were requested thanks to the `assert_all_responses_were_requested` fixture. Refer to documentation for more details.
+
+### Removed
+- It is not possible to provide an URL encoded response anymore by providing a dictionary in `data` parameter.
+
 ## [0.4.0] - 2020-06-05
 ### Changed
 - `httpx_mock` [`pytest`](https://docs.pytest.org/en/latest/) fixture does not need to be explicitly imported anymore (many thanks to [`Thomas LÉVEIL`](https://github.com/thomasleveil)).
@@ -73,7 +84,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - First release, should be considered as unstable for now as design might change.
 
-[Unreleased]: https://github.com/Colin-b/pytest_httpx/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/Colin-b/pytest_httpx/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.2.1...v0.3.0
 [0.2.1]: https://github.com/Colin-b/pytest_httpx/compare/v0.2.0...v0.2.1

README.md

@@ -5,7 +5,7 @@
 <a href="https://travis-ci.com/Colin-b/pytest_httpx"><img alt="Build status" src="https://api.travis-ci.com/Colin-b/pytest_httpx.svg?branch=master"></a>
 <a href="https://travis-ci.com/Colin-b/pytest_httpx"><img alt="Coverage" src="https://img.shields.io/badge/coverage-100%25-brightgreen"></a>
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
-<a href="https://travis-ci.com/Colin-b/pytest_httpx"><img alt="Number of tests" src="https://img.shields.io/badge/tests-72 passed-blue"></a>
+<a href="https://travis-ci.com/Colin-b/pytest_httpx"><img alt="Number of tests" src="https://img.shields.io/badge/tests-79 passed-blue"></a>
 <a href="https://pypi.org/project/pytest-httpx/"><img alt="Number of downloads" src="https://img.shields.io/pypi/dm/pytest_httpx"></a>
 </p>
 
@@ -30,7 +30,6 @@ Once installed, `httpx_mock` [`pytest`](https://docs.pytest.org/en/latest/) fixt
 
 You can register responses for both sync and async [`HTTPX`](https://www.python-httpx.org) requests.
 
-
 ```python
 import pytest
 import httpx
@@ -53,6 +52,16 @@ async def test_something_async(httpx_mock):
 
 If all registered responses are not sent back during test execution, the test case will fail at teardown.
 
+This behavior can be disabled thanks to the `assert_all_responses_were_requested` fixture:
+
+```python
+import pytest
+
+@pytest.fixture
+def assert_all_responses_were_requested() -> bool:
+    return False
+```
+
 Default response is a HTTP/1.1 200 (OK) without any body.
 
 ### How response is selected
@@ -208,9 +217,38 @@ def test_bytes_body(httpx_mock: HTTPXMock):
 
 ```
 
+### Reply by streaming data
+
+Use `data` parameter to stream chunks that you specify.
+As long as your data is an iterable it will stream your data.
+
+```python
+import httpx
+import pytest
+from pytest_httpx import HTTPXMock
+
+
+def test_sync_streaming(httpx_mock: HTTPXMock):
+    httpx_mock.add_response(data=[b"part 1", b"part 2"])
+
+    with httpx.Client() as client:
+        with client.stream(method="GET", url="http://test_url") as response:
+            assert list(response.iter_raw()) == [b"part 1", b"part 2"]
+
+
+@pytest.mark.asyncio
+async def test_async_streaming(httpx_mock: HTTPXMock):
+    httpx_mock.add_response(data=[b"part 1", b"part 2"])
+
+    async with httpx.AsyncClient() as client:
+        async with client.stream(method="GET", url="http://test_url") as response:
+            assert list(response.iter_raw()) == [b"part 1", b"part 2"]
+    
+```
+
 ### Add multipart response
 
-Use `data` parameter as a dictionary or `files` parameter (or both) to send multipart response.
+Use `files` parameter (and optionally `data` parameter as a dictionary) to send multipart response.
 
 You can specify `boundary` parameter to specify the multipart boundary to use.
 
@@ -298,6 +336,16 @@ Callback should expect at least two parameters:
 
 If all callbacks are not executed during test execution, the test case will fail at teardown.
 
+This behavior can be disabled thanks to the `assert_all_responses_were_requested` fixture:
+
+```python
+import pytest
+
+@pytest.fixture
+def assert_all_responses_were_requested() -> bool:
+    return False
+```
+
 ### Dynamic responses
 
 Callback should return a httpcore response (as a tuple), you can use `pytest_httpx.to_response` function to create such a tuple.

pytest_httpx/__init__.py

@@ -1,16 +1,26 @@
 import httpx
 import pytest
 
-from pytest_httpx._httpx_mock import HTTPXMock, to_response, _PytestSyncTransport, _PytestAsyncTransport
+from pytest_httpx._httpx_mock import (
+    HTTPXMock,
+    to_response,
+    _PytestSyncTransport,
+    _PytestAsyncTransport,
+)
 from pytest_httpx.version import __version__
 
 
 @pytest.fixture
-def httpx_mock(monkeypatch) -> HTTPXMock:
+def assert_all_responses_were_requested() -> bool:
+    return True
+
+
+@pytest.fixture
+def httpx_mock(monkeypatch, assert_all_responses_were_requested: bool) -> HTTPXMock:
     mock = HTTPXMock()
     # Mock synchronous requests
     monkeypatch.setattr(
-        httpx.Client, "transport_for_url", lambda self, url: _PytestSyncTransport(mock),
+        httpx.Client, "transport_for_url", lambda self, url: _PytestSyncTransport(mock)
     )
     # Mock asynchronous requests
     monkeypatch.setattr(
@@ -19,4 +29,4 @@ def httpx_mock(monkeypatch) -> HTTPXMock:
         lambda self, url: _PytestAsyncTransport(mock),
     )
     yield mock
-    mock.assert_and_reset()
+    mock.reset(assert_all_responses_were_requested)

pytest_httpx/_httpx_internals.py

@@ -0,0 +1,46 @@
+from typing import Union, Any, Iterator, AsyncIterator
+from json import dumps
+
+import httpcore
+
+
+class ByteStream(httpcore.AsyncByteStream, httpcore.SyncByteStream):
+    def __init__(self, data: bytes):
+        httpcore.AsyncByteStream.__init__(self)
+        httpcore.SyncByteStream.__init__(self)
+        self.data = data
+
+    def __iter__(self) -> Iterator[bytes]:
+        yield self.data
+
+    async def __aiter__(self) -> AsyncIterator[bytes]:
+        yield self.data
+
+
+class IteratorStream(httpcore.AsyncByteStream, httpcore.SyncByteStream):
+    def __init__(self, iterator):
+        httpcore.AsyncByteStream.__init__(self, aiterator=iterator)
+        httpcore.SyncByteStream.__init__(self, iterator=iterator)
+
+
+def stream(
+    data, files, json: Any, boundary: bytes
+) -> Union[httpcore.AsyncByteStream, httpcore.SyncByteStream]:
+    if files:
+        # TODO Get rid of this internal import
+        # import is performed at runtime when needed to reduce impact of internal changes in httpx
+        from httpx._content_streams import MultipartStream
+
+        return MultipartStream(data=data or {}, files=files, boundary=boundary)
+
+    if json is not None:
+        data = dumps(json).encode("utf-8")
+    elif isinstance(data, str):
+        data = data.encode("utf-8")
+    elif data is None:
+        data = b""
+
+    if isinstance(data, bytes):
+        return ByteStream(data)
+
+    return IteratorStream(data)

pytest_httpx/_httpx_mock.py

@@ -3,10 +3,8 @@
 
 import httpcore
 import httpx
-import pytest
 
-# TODO Stop using internals from httpx, see https://github.com/encode/httpx/issues/872
-from httpx._content_streams import encode
+from pytest_httpx._httpx_internals import stream
 
 
 # Those types are internally defined within httpcore._types
@@ -125,7 +123,8 @@ def add_response(
         :param files: Multipart files.
         :param json: HTTP body of the response (if JSON should be used as content type) if data is not provided.
         :param boundary: Multipart boundary if files is provided.
-        :param url: Full URL identifying the request(s) to match. Can be a str, a re.Pattern instance or a httpx.URL instance.
+        :param url: Full URL identifying the request(s) to match.
+        Can be a str, a re.Pattern instance or a httpx.URL instance.
         :param method: HTTP method identifying the request(s) to match.
         :param match_headers: HTTP headers identifying the request(s) to match. Must be a dictionary.
         :param match_content: Full HTTP body identifying the request(s) to match. Must be bytes.
@@ -144,7 +143,8 @@ def add_callback(self, callback: Callable, **matchers):
          * request: The received httpx.Request.
          * timeout: The timeout linked to the request.
         It should return a valid httpcore response tuple, you can use pytest_httpx.to_response function to create one.
-        :param url: Full URL identifying the request(s) to match. Can be a str, a re.Pattern instance or a httpx.URL instance.
+        :param url: Full URL identifying the request(s) to match.
+        Can be a str, a re.Pattern instance or a httpx.URL instance.
         :param method: HTTP method identifying the request(s) to match.
         :param match_headers: HTTP headers identifying the request(s) to match. Must be a dictionary.
         :param match_content: Full HTTP body identifying the request(s) to match. Must be bytes.
@@ -223,7 +223,8 @@ def get_requests(self, **matchers) -> List[httpx.Request]:
         """
         Return all requests sent that match (empty list if no requests were matched).
 
-        :param url: Full URL identifying the requests to retrieve. Can be a str, a re.Pattern instance or a httpx.URL instance.
+        :param url: Full URL identifying the requests to retrieve.
+        Can be a str, a re.Pattern instance or a httpx.URL instance.
         :param method: HTTP method identifying the requests to retrieve. Must be a upper cased string value.
         :param match_headers: HTTP headers identifying the requests to retrieve. Must be a dictionary.
         :param match_content: Full HTTP body identifying the requests to retrieve. Must be bytes.
@@ -235,7 +236,8 @@ def get_request(self, **matchers) -> Optional[httpx.Request]:
         """
         Return the single request that match (or None).
 
-        :param url: Full URL identifying the request to retrieve. Can be a str, a re.Pattern instance or a httpx.URL instance.
+        :param url: Full URL identifying the request to retrieve.
+        Can be a str, a re.Pattern instance or a httpx.URL instance.
         :param method: HTTP method identifying the request to retrieve. Must be a upper cased string value.
         :param match_headers: HTTP headers identifying the request to retrieve. Must be a dictionary.
         :param match_content: Full HTTP body identifying the request to retrieve. Must be bytes.
@@ -247,27 +249,31 @@ def get_request(self, **matchers) -> Optional[httpx.Request]:
         ), f"More than one request ({len(requests)}) matched, use get_requests instead."
         return requests[0] if requests else None
 
-    def assert_and_reset(self):
-        self._assert_responses_sent()
-        self._assert_callbacks_executed()
+    def reset(self, assert_all_responses_were_requested: bool):
+        responses_not_called = self._reset_responses()
+        callbacks_not_executed = self._reset_callbacks()
 
-    def _assert_responses_sent(self):
+        if assert_all_responses_were_requested:
+            assert (
+                not responses_not_called
+            ), f"The following responses are mocked but not requested: {responses_not_called}"
+            assert (
+                not callbacks_not_executed
+            ), f"The following callbacks are registered but not executed: {callbacks_not_executed}"
+
+    def _reset_responses(self):
         responses_not_called = [
             response for matcher, response in self._responses if not matcher.nb_calls
         ]
         self._responses.clear()
-        assert (
-            not responses_not_called
-        ), f"The following responses are mocked but not requested: {responses_not_called}"
+        return responses_not_called
 
-    def _assert_callbacks_executed(self):
+    def _reset_callbacks(self):
         callbacks_not_executed = [
             callback for matcher, callback in self._callbacks if not matcher.nb_calls
         ]
         self._callbacks.clear()
-        assert (
-            not callbacks_not_executed
-        ), f"The following callbacks are registered but not executed: {callbacks_not_executed}"
+        return callbacks_not_executed
 
 
 class _PytestSyncTransport(httpcore.SyncHTTPTransport):
@@ -311,12 +317,10 @@ def to_response(
     :param json: HTTP body of the response (if JSON should be used as content type) if data is not provided.
     :param boundary: Multipart boundary if files is provided.
     """
-    return (
-        http_version.encode(),
-        status_code,
-        b"",
+    headers = (
         [(header.encode(), value.encode()) for header, value in headers.items()]
         if headers
-        else [],
-        encode(data=data, files=files, json=json, boundary=boundary),
+        else []
     )
+    body = stream(data=data, files=files, json=json, boundary=boundary)
+    return (http_version.encode(), status_code, b"", headers, body)

pytest_httpx/version.py

@@ -3,4 +3,4 @@
 # Major should be incremented in case there is a breaking change. (eg: 2.5.8 -> 3.0.0)
 # Minor should be incremented in case there is an enhancement. (eg: 2.5.8 -> 2.6.0)
 # Patch should be incremented in case there is a bug fix. (eg: 2.5.8 -> 2.5.9)
-__version__ = "0.4.0"
+__version__ = "0.5.0"

setup.py

@@ -35,12 +35,12 @@
     ],
     keywords=["pytest", "testing", "mock", "httpx"],
     packages=find_packages(exclude=["tests*"]),
-    entry_points={'pytest11': ['pytest_httpx = pytest_httpx']},
-    install_requires=["httpx==0.13.*", "pytest>=5.4.*,<6.*"],
+    entry_points={"pytest11": ["pytest_httpx = pytest_httpx"]},
+    install_requires=["httpx==0.13.*", "pytest==6.*"],
     extras_require={
         "testing": [
             # Used to run async test functions
-            "pytest-asyncio==0.12.*",
+            "pytest-asyncio==0.14.*",
             # Used to check coverage
             "pytest-cov==2.*",
         ]