Merge pull request #104 from GitGuardian/agateau/improve-error-handling

Improve error handling

Author: agateau-gg

changelog.d/20240514_143905_aurelien.gateau_improve_error_handling.md

@@ -0,0 +1,3 @@
+### Fixed
+
+- GGClient no longer crashes when it receives an odd server response, like a response with no Content-Type header.

pygitguardian/client.py

@@ -82,7 +82,7 @@ def load_detail(resp: Response) -> Detail:
     :return: detail object of response
     :rtype: Detail
     """
-    if resp.headers["content-type"] == "application/json":
+    if resp.headers.get("content-type") == "application/json":
         data = resp.json()
     else:
         data = {"detail": resp.text}
@@ -96,7 +96,7 @@ def is_ok(resp: Response) -> bool:
     and the content type is JSON.
     """
     return (
-        resp.headers["content-type"] == "application/json"
+        resp.headers.get("content-type") == "application/json"
         and resp.status_code == codes.ok
     )
 
@@ -107,7 +107,7 @@ def is_create_ok(resp: Response) -> bool:
     and the content type is JSON.
     """
     return (
-        resp.headers["content-type"] == "application/json"
+        resp.headers.get("content-type") == "application/json"
         and resp.status_code == codes.created
     )
 

tests/test_client.py

@@ -1113,3 +1113,38 @@ def test_sca_client_scan_diff_with_params(client: GGClient):
 
     assert vyper_vulns is not None
     assert all(vuln.severity in ("high", "critical") for vuln in vyper_vulns.vulns)
+
+
+def test_is_ok_bad_response():
+    """
+    GIVEN a 500 response with no content-type header
+    WHEN is_ok() is called
+    THEN it does not fail
+    AND returns false
+    """
+    resp = Mock()
+    resp.headers = {}
+    resp.status_code = 500
+    resp.text = "Failed"
+
+    assert not is_ok(resp)
+
+
+@responses.activate
+def test_read_metadata_bad_response(client: GGClient):
+    """
+    GIVEN a /metadata endpoint that returns a 500 error with no content-type
+    THEN a call to read_metadata() does not fail
+    AND returns a valid Detail instance
+    """
+    mock_response = responses.get(
+        url=client._url_from_endpoint("metadata", "v1"),
+        status=500,
+        body="Failed",
+    )
+
+    detail = client.read_metadata()
+
+    assert mock_response.call_count == 1
+    assert detail.status_code == 500
+    assert detail.detail == "Failed"