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

Release 0.10.1

Author: Colin-b

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.10.1] - 2020-11-25
+### Fixed
+- Order of different parameters does not matters anymore for URL matching. It does however still matter for a same parameter.
+
 ## [0.10.0] - 2020-10-06
 ### Added
 - Document how to assert that no requests were issued.
@@ -119,7 +123,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.10.0...HEAD
+[Unreleased]: https://github.com/Colin-b/pytest_httpx/compare/v0.10.1...HEAD
+[0.10.1]: https://github.com/Colin-b/pytest_httpx/compare/v0.10.0...v0.10.1
 [0.10.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.9.0...v0.10.0
 [0.9.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.8.0...v0.9.0
 [0.8.0]: https://github.com/Colin-b/pytest_httpx/compare/v0.7.0...v0.8.0

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-131 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-135 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>
 
@@ -82,17 +82,19 @@ You can add criteria so that response will be sent only in case of a more specif
 
 Matching is performed on the full URL, query parameters included.
 
+Order of parameters in the query string does not matter, however order of values do matter if the same parameter is provided more than once.
+
 ```python
 import httpx
 from pytest_httpx import HTTPXMock
 
 
 def test_url(httpx_mock: HTTPXMock):
-    httpx_mock.add_response(url="http://test_url")
+    httpx_mock.add_response(url="http://test_url?a=1&b=2")
 
     with httpx.Client() as client:
-        response1 = client.delete("http://test_url")
-        response2 = client.get("http://test_url")
+        response1 = client.delete("http://test_url?a=1&b=2")
+        response2 = client.get("http://test_url?b=2&a=1")
 ```
 
 #### Matching on HTTP method

pytest_httpx/_httpx_mock.py

@@ -1,5 +1,6 @@
 import re
 from typing import List, Union, Optional, Callable, Tuple, Pattern, Any
+from urllib.parse import parse_qs
 
 import httpcore
 import httpx
@@ -35,7 +36,7 @@ def __init__(
         match_content: bytes = None,
     ):
         self.nb_calls = 0
-        self.url = url
+        self.url = httpx.URL(url) if url and isinstance(url, str) else url
         self.method = method.upper() if method else method
         self.headers = match_headers
         self.content = match_content
@@ -58,10 +59,15 @@ def _url_match(self, request: httpx.Request) -> bool:
         ):
             return self.url.match(str(request.url)) is not None
 
-        if isinstance(self.url, httpx.URL):
-            return self.url == request.url
+        # Compare query parameters apart as order of parameters should not matter
+        request_qs = parse_qs(request.url.query)
+        qs = parse_qs(self.url.query)
 
-        return self.url == str(request.url)
+        # Remove the query parameters from the original URL to compare everything besides query parameters
+        request_url = request.url.copy_with(query=None)
+        url = self.url.copy_with(query=None)
+
+        return (request_qs == qs) and (url == request_url)
 
     def _method_match(self, request: httpx.Request) -> bool:
         if not self.method:

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.10.0"
+__version__ = "0.10.1"

tests/test_httpx_async.py

@@ -41,6 +41,19 @@ async def test_url_matching(httpx_mock: HTTPXMock):
         assert response.content == b""
 
 
+@pytest.mark.asyncio
+async def test_url_query_string_matching(httpx_mock: HTTPXMock):
+    httpx_mock.add_response(url="http://test_url?a=1&b=2")
+
+    async with httpx.AsyncClient() as client:
+        response = await client.post("http://test_url?a=1&b=2")
+        assert response.content == b""
+
+        # Parameters order should not matter
+        response = await client.get("http://test_url?b=2&a=1")
+        assert response.content == b""
+
+
 @pytest.mark.asyncio
 async def test_url_not_matching(httpx_mock: HTTPXMock):
     httpx_mock.add_response(url="http://test_url")
@@ -58,6 +71,24 @@ async def test_url_not_matching(httpx_mock: HTTPXMock):
     httpx_mock.reset(assert_all_responses_were_requested=False)
 
 
+@pytest.mark.asyncio
+async def test_url_query_string_not_matching(httpx_mock: HTTPXMock):
+    httpx_mock.add_response(url="http://test_url?a=1&a=2")
+
+    async with httpx.AsyncClient() as client:
+        with pytest.raises(httpx.TimeoutException) as exception_info:
+            # Same parameter order matters as it corresponds to a list on server side
+            await client.get("http://test_url?a=2&a=1")
+        assert (
+            str(exception_info.value)
+            == """No response can be found for GET request on http://test_url?a=2&a=1 amongst:
+Match all requests on http://test_url?a=1&a=2"""
+        )
+
+    # Clean up responses to avoid assertion failure
+    httpx_mock.reset(assert_all_responses_were_requested=False)
+
+
 @pytest.mark.asyncio
 async def test_method_matching(httpx_mock: HTTPXMock):
     httpx_mock.add_response(method="get")

tests/test_httpx_sync.py

@@ -38,6 +38,18 @@ def test_url_matching(httpx_mock: HTTPXMock):
         assert response.content == b""
 
 
+def test_url_query_string_matching(httpx_mock: HTTPXMock):
+    httpx_mock.add_response(url="http://test_url?a=1&b=2")
+
+    with httpx.Client() as client:
+        response = client.post("http://test_url?a=1&b=2")
+        assert response.content == b""
+
+        # Parameters order should not matter
+        response = client.get("http://test_url?b=2&a=1")
+        assert response.content == b""
+
+
 def test_url_not_matching(httpx_mock: HTTPXMock):
     httpx_mock.add_response(url="http://test_url")
 
@@ -54,6 +66,23 @@ def test_url_not_matching(httpx_mock: HTTPXMock):
     httpx_mock.reset(assert_all_responses_were_requested=False)
 
 
+def test_url_query_string_not_matching(httpx_mock: HTTPXMock):
+    httpx_mock.add_response(url="http://test_url?a=1&a=2")
+
+    with httpx.Client() as client:
+        with pytest.raises(httpx.TimeoutException) as exception_info:
+            # Same parameter order matters as it corresponds to a list on server side
+            client.get("http://test_url?a=2&a=1")
+        assert (
+            str(exception_info.value)
+            == """No response can be found for GET request on http://test_url?a=2&a=1 amongst:
+Match all requests on http://test_url?a=1&a=2"""
+        )
+
+    # Clean up responses to avoid assertion failure
+    httpx_mock.reset(assert_all_responses_were_requested=False)
+
+
 def test_method_matching(httpx_mock: HTTPXMock):
     httpx_mock.add_response(method="get")