fix: fix User-Agent header overriding the passed one

schemathesis · Oct 3, 2020 · d80402f · d80402f
1 parent 512dff4
commit d80402f
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 6 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -15,6 +15,7 @@ Changelog
 
 **Fixed**
 
+- Fix ``User-Agent`` header overriding the passed one. `#757`_
 - Default ``User-Agent`` header in ``Case.call``. `#717`_
 - Status of individual interactions in VCR cassettes. Before this change, all statuses were taken from the overall test outcome,
   rather than from the check results for a particular response. `#695`_
@@ -1378,6 +1379,7 @@ Deprecated
 .. _0.2.0: https://github.com/schemathesis/schemathesis/compare/v0.1.0...v0.2.0
 
 .. _#768: https://github.com/schemathesis/schemathesis/issues/768
+.. _#757: https://github.com/schemathesis/schemathesis/issues/757
 .. _#748: https://github.com/schemathesis/schemathesis/issues/748
 .. _#738: https://github.com/schemathesis/schemathesis/issues/738
 .. _#734: https://github.com/schemathesis/schemathesis/issues/734

diff --git a/src/schemathesis/loaders.py b/src/schemathesis/loaders.py
@@ -60,7 +60,9 @@ def from_uri(
     **kwargs: Any,
 ) -> BaseOpenAPISchema:
     """Load a remote resource and parse to schema instance."""
-    kwargs.setdefault("headers", {}).setdefault("User-Agent", USER_AGENT)
+    headers = kwargs.setdefault("headers", {})
+    if "user-agent" not in {header.lower() for header in headers}:
+        kwargs["headers"]["User-Agent"] = USER_AGENT
     response = requests.get(uri, **kwargs)
     try:
         response.raise_for_status()
@@ -192,7 +194,9 @@ def from_wsgi(
     validate_schema: bool = True,
     **kwargs: Any,
 ) -> BaseOpenAPISchema:
-    kwargs.setdefault("headers", {}).setdefault("User-Agent", USER_AGENT)
+    headers = kwargs.setdefault("headers", {})
+    if "user-agent" not in {header.lower() for header in headers}:
+        kwargs["headers"]["User-Agent"] = USER_AGENT
     client = Client(app, WSGIResponse)
     response = client.get(schema_path, **kwargs)
     # Raising exception to provide unified behavior
@@ -259,7 +263,9 @@ def from_asgi(
     validate_schema: bool = True,
     **kwargs: Any,
 ) -> BaseOpenAPISchema:
-    kwargs.setdefault("headers", {}).setdefault("User-Agent", USER_AGENT)
+    headers = kwargs.setdefault("headers", {})
+    if "user-agent" not in {header.lower() for header in headers}:
+        kwargs["headers"]["User-Agent"] = USER_AGENT
     client = ASGIClient(app)
     response = client.get(schema_path, **kwargs)
     # Raising exception to provide unified behavior

diff --git a/src/schemathesis/models.py b/src/schemathesis/models.py
@@ -141,7 +141,7 @@ def _get_headers(self, headers: Optional[Dict[str, str]] = None) -> Dict[str, An
         final_headers = self.headers.copy() if self.headers is not None else {}
         if headers:
             final_headers.update(headers)
-        if "User-Agent" not in final_headers:
+        if "user-agent" not in {header.lower() for header in final_headers}:
             final_headers["User-Agent"] = USER_AGENT
         return final_headers
 

diff --git a/src/schemathesis/runner/impl/core.py b/src/schemathesis/runner/impl/core.py
@@ -238,7 +238,8 @@ def network_test(
     """A single test body will be executed against the target."""
     # pylint: disable=too-many-arguments
     headers = headers or {}
-    headers.setdefault("User-Agent", USER_AGENT)
+    if "user-agent" not in {header.lower() for header in headers}:
+        headers["User-Agent"] = USER_AGENT
     timeout = prepare_timeout(request_timeout)
     response = _network_test(
         case,
@@ -368,7 +369,8 @@ def _prepare_wsgi_headers(
     headers: Optional[Dict[str, Any]], auth: Optional[RawAuth], auth_type: Optional[str]
 ) -> Dict[str, Any]:
     headers = headers or {}
-    headers.setdefault("User-Agent", USER_AGENT)
+    if "user-agent" not in {header.lower() for header in headers}:
+        headers["User-Agent"] = USER_AGENT
     wsgi_auth = get_wsgi_auth(auth, auth_type)
     if wsgi_auth:
         headers["Authorization"] = wsgi_auth

diff --git a/test/test_models.py b/test/test_models.py
@@ -47,6 +47,7 @@ def test_as_requests_kwargs(override, server, base_url, swagger_20, converter):
         (None, {"User-Agent": USER_AGENT, "X-Key": "foo"}),
         ({"User-Agent": "foo/1.0"}, {"User-Agent": "foo/1.0", "X-Key": "foo"}),
         ({"X-Value": "bar"}, {"X-Value": "bar", "User-Agent": USER_AGENT, "X-Key": "foo"}),
+        ({"UsEr-agEnT": "foo/1.0"}, {"UsEr-agEnT": "foo/1.0", "X-Key": "foo"}),
     ),
 )
 def test_as_requests_kwargs_override_user_agent(server, openapi2_base_url, swagger_20, headers, expected):