httpserver: fix query_string type

csernazs · csernazs · commit 71de7ef4bd1d · 2019-07-26T13:35:31.000+02:00
In werzeug the requets.query_string is a bytes object so expecting a string in the RequestMatcher breaks the query_string matching functionality. Users can provide a bytes object but in this case they will break the official API. In order to not break the API, an implicit conversion is added which converts the string object to bytes. Accepting bytes is also added in case the user does not want this implicit behavior. Fixes #16
diff --git a/pytest_httpserver/httpserver.py b/pytest_httpserver/httpserver.py
@@ -136,7 +136,9 @@ class RequestMatcher:
         by default, see `data_encoding`) or a bytes object.
     :param data_encoding: the encoding used for data parameter if data is a string.
     :param headers: dictionary of the headers of the request to be matched
-    :param query_string: the http query string starting with ``?``, such as ``?username=user``
+    :param query_string: the http query string, after ``?``, such as ``username=user``.
+        If string is specified it will be encoded to bytes with the encode method of
+        the string.
     """
 
     def __init__(
@@ -146,9 +148,12 @@ def __init__(
             data: Union[str, bytes, None] = None,
             data_encoding: str = "utf-8",
             headers: Optional[Mapping[str, str]] = None,
-            query_string: Optional[str] = None,
+            query_string: Union[None, bytes, str] = None,
             header_value_matcher: Optional[HeaderValueMatcher] = None):
 
+        if query_string is not None and not isinstance(query_string, (str, bytes)):
+            raise TypeError("query_string must be a string, or a bytes-like object")
+
         self.uri = uri
         self.method = method
         self.query_string = query_string
@@ -206,7 +211,15 @@ def difference(self, request: Request) -> list:
         if self.method != METHOD_ALL and self.method != request.method:
             retval.append(("method", request.method, self.method))
 
-        if self.query_string is not None and self.query_string != request.query_string:
+        if self.query_string is not None:
+            if isinstance(self.query_string, str):
+                query_string = self.query_string.encode()
+            elif isinstance(self.query_string, bytes):
+                query_string = self.query_string
+            else:
+                raise TypeError("query_string must be a string, or a bytes-like object")
+
+        if self.query_string is not None and query_string != request.query_string:
             retval.append(("query_string", request.query_string, self.query_string))
 
         request_headers = {}
diff --git a/releasenotes/notes/fix-16-query-string-c989bee73733a325.yaml b/releasenotes/notes/fix-16-query-string-c989bee73733a325.yaml
@@ -0,0 +1,6 @@
+---
+issues:
+  - |
+    Fixed issue \#16 by converting string object passed as query_string
+    to bytes which is the type of the query string in werkzeug, and also allowing
+    bytes as the parameter.
diff --git a/tests/test_querystring.py b/tests/test_querystring.py
@@ -0,0 +1,23 @@
+import requests
+from pytest import approx, raises
+
+from pytest_httpserver import HTTPServer
+
+
+def test_querystring_str(httpserver: HTTPServer):
+    httpserver.expect_request("/foobar", query_string="foo=bar", method="GET").respond_with_data(
+        "example_response"
+    )
+    response = requests.get(httpserver.url_for("/foobar?foo=bar"))
+    httpserver.check_assertions()
+    assert response.text == "example_response"
+    assert response.status_code == 200
+
+def test_querystring_bytes(httpserver: HTTPServer):
+    httpserver.expect_request("/foobar", query_string=b"foo=bar", method="GET").respond_with_data(
+        "example_response"
+    )
+    response = requests.get(httpserver.url_for("/foobar?foo=bar"))
+    httpserver.check_assertions()
+    assert response.text == "example_response"
+    assert response.status_code == 200
