fix: include HTTP response in RESTClient error (#123)

Co-authored-by: Liam Wiles <[email protected]>

Author: lwiles

api/rest_client.go

@@ -49,6 +49,15 @@ type RESTClient struct {
 	BaseURL string
 }
 
+type RESTClientError struct {
+	HTTPResponse *http.Response
+	Message      string
+}
+
+func (e *RESTClientError) Error() string {
+	return fmt.Sprintf("HTTP %d: %s", e.HTTPResponse.StatusCode, e.Message)
+}
+
 // RegisterStub registers a new stub for the given matcher/responder pair.
 func (c *RESTClient) RegisterStub(matcher Matcher, responder Responder) *RESTClient {
 	c.Client.RegisterStub(matcher, responder)
@@ -91,10 +100,7 @@ func (c *RESTClient) DoWithContext(ctx context.Context, method string, url strin
 
 	success := resp.StatusCode >= 200 && resp.StatusCode < 300
 	if !success {
-		// defer resp.Body.Close()
-		// api.HandleHTTPError(resp)
-		// TODO: return a proper error type
-		return fmt.Errorf("HTTP %d", resp.StatusCode)
+		return &RESTClientError{resp, "received unsuccessful response"}
 	}
 
 	if resp.StatusCode == http.StatusNoContent {

api/rest_client_test.go

@@ -97,7 +97,10 @@ func TestRESTClient_DoWithContext_SuccessError(t *testing.T) {
 	defer client.VerifyStubs(t)
 
 	err := client.DoWithContext(ctx, http.MethodGet, "/greet", "", nil)
-	assert.ErrorContains(t, err, "HTTP 500")
+	myErr, ok := err.(*RESTClientError)
+	assert.True(t, ok)
+	assert.Equal(t, 500, myErr.HTTPResponse.StatusCode)
+	assert.ErrorContains(t, err, "HTTP 500: received unsuccessful response")
 }
 
 func TestRESTClient_DoWithContext_NoContent(t *testing.T) {