[Corehttp] Add model attribute to HttpResponseError (Azure#39636)

Signed-off-by: Paul Van Eck <[email protected]>

Author: pvaneck

sdk/core/corehttp/CHANGELOG.md

@@ -9,6 +9,7 @@
 - Added a new `AccessTokenInfo` class, which is returned by `get_token_info` implementations. This class contains the token, its expiration time, and optional additional information like when a token should be refreshed. [#38346](https://github.com/Azure/azure-sdk-for-python/pull/38346)
 - `BearerTokenCredentialPolicy` and `AsyncBearerTokenCredentialPolicy` now check if a credential has the `get_token_info` method defined. If so, the `get_token_info` method is used to acquire a token. [#38346](https://github.com/Azure/azure-sdk-for-python/pull/38346)
   - These policies now also check the `refresh_on` attribute when determining if a new token request should be made.
+- Added `model` attribute to `HttpResponseError` to allow accessing error attributes based on a known model. [#39636](https://github.com/Azure/azure-sdk-for-python/pull/39636)
 
 ### Breaking Changes
 

sdk/core/corehttp/corehttp/exceptions.py

@@ -187,6 +187,8 @@ class HttpResponseError(BaseError):
     :vartype status_code: int
     :ivar response: The response that triggered the exception.
     :vartype response: ~corehttp.rest.HttpResponse or ~corehttp.rest.AsyncHttpResponse
+    :ivar model: The response body model
+    :vartype model: Any
     """
 
     def __init__(
@@ -200,6 +202,8 @@ def __init__(
             self.reason = response.reason
             self.status_code = response.status_code
 
+        self.model: Optional[Any] = kwargs.pop("model", None)
+
         # By priority, message is:
         # - parameter "message", OR
         # - generic message using "reason"

sdk/core/corehttp/tests/test_exceptions.py

@@ -72,6 +72,20 @@ def test_httpresponse_error_with_response(self, port, transport):
         assert error.reason == "OK"
         assert isinstance(error.status_code, int)
 
+    @pytest.mark.parametrize("transport", SYNC_TRANSPORTS)
+    def test_httpresponse_error_with_model(self, port, transport):
+        request = HttpRequest("GET", url="http://localhost:{}/basic/string".format(port))
+        client = MockRestClient(port, transport=transport())
+        response = client.send_request(request, stream=False)
+        error = HttpResponseError(response=response, model=FakeErrorTwo())
+        assert error.message == "Operation returned an invalid status 'OK'"
+        assert error.response is not None
+        assert error.reason == "OK"
+        assert error.model
+        assert error.model.code == "FakeErrorTwo"
+        assert error.model.message == "A different fake error"
+        assert isinstance(error.status_code, int)
+
     @pytest.mark.parametrize("transport", SYNC_TRANSPORTS)
     def test_malformed_json(self, port, transport):
         request = HttpRequest("GET", "/errors/malformed-json")