[core] add non odatav4 error bodies to message (#21800)

Author: iscai-msft

sdk/core/azure-core/CHANGELOG.md

@@ -10,6 +10,8 @@
 
 ### Bugs Fixed
 
+- Add response body to string representation of `HttpResponseError` if we're not able to parse out information #21800
+
 ### Other Changes
 
 ## 1.20.1 (2021-11-08)

sdk/core/azure-core/azure/core/exceptions.py

@@ -333,6 +333,16 @@ def _parse_odata_body(error_format, response):
             pass
         return None
 
+    def __str__(self):
+        retval = super(HttpResponseError, self).__str__()
+        try:
+            body = self.response.text()
+            if body and not self.error:
+                return "{}\nContent: {}".format(retval, body)[:2048]
+        except Exception:  # pylint: disable=broad-except
+            pass
+        return retval
+
 
 class DecodeError(HttpResponseError):
     """Error raised during response deserialization."""

sdk/core/azure-core/tests/test_exceptions.py

@@ -37,6 +37,7 @@
 from azure.core.pipeline.transport import RequestsTransportResponse
 from azure.core.pipeline.transport._base import _HttpResponseBase as PipelineTransportHttpResponseBase
 from azure.core.rest._http_response_impl import _HttpResponseBaseImpl as RestHttpResponseBase
+from utils import HTTP_REQUESTS
 
 class PipelineTransportMockResponse(PipelineTransportHttpResponseBase):
     def __init__(self, json_body):
@@ -152,6 +153,8 @@ def test_deserialized_httpresponse_error_code(self, mock_response):
         assert error.error.error.code == "FakeErrorOne"
         assert error.error.error.message == "A fake error"
 
+        assert str(error) == "(FakeErrorOne) A fake error\nCode: FakeErrorOne\nMessage: A fake error"
+
 
     @pytest.mark.parametrize("mock_response", MOCK_RESPONSES)
     def test_deserialized_httpresponse_error_message(self, mock_response):
@@ -284,4 +287,36 @@ def test_null_odata_details(self, mock_response):
             }
         }
         exp = HttpResponseError(response=mock_response(json.dumps(message).encode("utf-8")))
-        assert exp.error.code == "501"
+        assert exp.error.code == "501"
+
+    @pytest.mark.parametrize("http_request", HTTP_REQUESTS)
+    def test_non_odatav4_error_body(self, client, http_request):
+        request = http_request("GET", "/errors/non-odatav4-body")
+        response = client.send_request(request)
+        with pytest.raises(HttpResponseError) as ex:
+            response.raise_for_status()
+        assert str(ex.value) == "Operation returned an invalid status 'BAD REQUEST'\nContent: {\"code\": 400, \"error\": {\"global\": [\"MY-ERROR-MESSAGE-THAT-IS-COMING-FROM-THE-API\"]}}"
+
+    @pytest.mark.parametrize("http_request", HTTP_REQUESTS)
+    def test_malformed_json(self, client, http_request):
+        request = http_request("GET", "/errors/malformed-json")
+        response = client.send_request(request)
+        with pytest.raises(HttpResponseError) as ex:
+            response.raise_for_status()
+        assert str(ex.value) == "Operation returned an invalid status 'BAD REQUEST'\nContent: {\"code\": 400, \"error\": {\"global\": [\"MY-ERROR-MESSAGE-THAT-IS-COMING-FROM-THE-API\"]"
+
+    @pytest.mark.parametrize("http_request", HTTP_REQUESTS)
+    def test_text(self, client, http_request):
+        request = http_request("GET", "/errors/text")
+        response = client.send_request(request)
+        with pytest.raises(HttpResponseError) as ex:
+            response.raise_for_status()
+        assert str(ex.value) == "Operation returned an invalid status 'BAD REQUEST'\nContent: I am throwing an error"
+
+    @pytest.mark.parametrize("http_request", HTTP_REQUESTS)
+    def test_datav4_error(self, client, http_request):
+        request = http_request("GET", "/errors/odatav4")
+        response = client.send_request(request)
+        with pytest.raises(HttpResponseError) as ex:
+            response.raise_for_status()
+        assert "Content: {\"" not in str(ex.value)

sdk/core/azure-core/tests/testserver_tests/coretestserver/coretestserver/test_routes/errors.py

@@ -33,3 +33,31 @@ def get_short_data():
     response.automatically_set_content_length = False
     response.headers["Content-Length"] = "8"
     return response
+
+@errors_api.route('/non-odatav4-body', methods=['GET'])
+def get_non_odata_v4_response_body():
+    return Response(
+        '{"code": 400, "error": {"global": ["MY-ERROR-MESSAGE-THAT-IS-COMING-FROM-THE-API"]}}',
+        status=400
+    )
+
+@errors_api.route('/malformed-json', methods=['GET'])
+def get_malformed_json():
+    return Response(
+        '{"code": 400, "error": {"global": ["MY-ERROR-MESSAGE-THAT-IS-COMING-FROM-THE-API"]',
+        status=400
+    )
+
+@errors_api.route('/text', methods=['GET'])
+def get_text_body():
+    return Response(
+        'I am throwing an error',
+        status=400
+    )
+
+@errors_api.route('/odatav4', methods=['GET'])
+def get_odatav4():
+    return Response(
+        '{"error": {"code": "501", "message": "Unsupported functionality", "target": "query", "details": [{"code": "301", "target": "$search", "message": "$search query option not supported"}], "innererror": {"trace": [], "context": {}}}}',
+        status=400
+    )