csernazs
commented
1 month ago hi @WillMorrisonEnspi ,
I think this behavior is consistent. I may misunderstood your issue, but here's my view:
- when you specify string, pytest-httpserver expects a quoted string so that will be compared with
==after encoding. - when you specify a dict or MultiDict, then this will be quoted by pytest-httpserver so then it will be compared.
This behaviour is partially documented (and unfortunatelly missing from the built html doc, that will be fixed):
String matching: https://github.com/csernazs/pytest-httpserver/blob/master/pytest_httpserver/httpserver.py#L188
Mapping matching: https://github.com/csernazs/pytest-httpserver/blob/master/pytest_httpserver/httpserver.py#L188
Also, there's a howto about this: https://pytest-httpserver.readthedocs.io/en/latest/howto.html#matching-query-parameters
Here, you specified an already quoted value in the dict, so it got double-quoted in pytest-httpserver:
httpserver.expect_request("/test", query_string={"foo": "bar%20baz"}).respond_with_data("OK")Here, you specified an unquoted string, which then did't match with the quoted one sent by requests as server compares it with ==.
httpserver.expect_request("/test", query_string="foo=bar baz").respond_with_data("OK")pytest-httpserver provides you an API to define your own query matcher, so the first failed case can be solved by this:
class MyQueryStringMatcher(QueryMatcher):
def __init__(self, expected_string: str):
parsed = urllib.parse.parse_qsl(expected_string) # Parse query string into key-value pairs
self._encoded_query_string = urllib.parse.urlencode(parsed, quote_via=urllib.parse.quote)
def get_comparing_values(self, request_query_string: bytes) -> tuple:
return (self._encoded_query_string, request_query_string.decode("utf-8"))
def test_query_string_with_spaces_string_fails(httpserver: HTTPServer):
httpserver.expect_request("/test", query_string=MyQueryStringMatcher("foo=bar baz")).respond_with_data("OK")
url = httpserver.url_for("/test") + "?foo=bar baz"
requests.get(url)
httpserver.check_assertions()The other case can be solved by this:
class QuotedDictMatcher(MappingQueryMatcher):
def __init__(self, query_dict: dict[str, str]):
unquoted_dict = {k: urllib.parse.unquote(v) for k, v in query_dict.items()}
super().__init__(unquoted_dict)
def test_query_string_is_encoded_dict_fails(httpserver: HTTPServer):
httpserver.expect_request("/test", query_string=QuotedDictMatcher({"foo": "bar%20baz"})).respond_with_data("OK")
url = httpserver.url_for("/test") + "?foo=bar baz"
requests.get(url)
httpserver.check_assertions()
Changing querystring matcher in pytest-httpserver to handle your case would be an API breaking, and it would break the current cases.
Zsolt
WillMorrisonEnspi
It seems like the type (string vs dict) of
query_stringaffects the behaviour of the resulting matcher when the query string in the request has percent-encoding. Specifically, a string typed argument toquery_stringmust match exactly the query string in the request. However, a dict typed argument toquery_stringmust match the request's query string after unquoting.Reproduced with pytest-httpserver version 1.1.0
test file:
Output: