✨ Add API utility function CallAndCheckSuccess (#106)

<!--
Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors.
All rights reserved.
SPDX-License-Identifier: Proprietary
-->
### Description
`CallAndCheckSuccess` is a wrapper for making an API call and then
checking success with `CheckAPICallSuccess`



### Test Coverage

<!--
Please put an `x` in the correct box e.g. `[x]` to indicate the testing
coverage of this change.
-->

- [X]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

Author: aorabdel

changes/20250414111304.feature

@@ -0,0 +1 @@
+:sparkles: Add an API utility function `CallAndCheckSuccess`

utils/api/api.go

@@ -58,3 +58,23 @@ func CheckAPICallSuccess(ctx context.Context, errorContext string, resp *_http.R
 	}
 	return
 }
+
+// CallAndCheckSuccess is a wrapper for making an API call and then checking success with `CheckAPICallSuccess`
+// errorContext corresponds to the description of what led to the error if error there is e.g. `Failed adding a user`.
+// apiCallFunc corresponds to a generic function that will be called to make the API call
+func CallAndCheckSuccess[T any](ctx context.Context, errorContext string, apiCallFunc func(ctx context.Context) (T, *_http.Response, error)) (result T, err error) {
+	if err = parallelisation.DetermineContextError(ctx); err != nil {
+		return
+	}
+
+	result, resp, apiErr := apiCallFunc(ctx)
+	if resp != nil && resp.Body != nil {
+		_ = resp.Body.Close()
+	}
+
+	if err = CheckAPICallSuccess(ctx, errorContext, resp, apiErr); err != nil {
+		return
+	}
+
+	return
+}

utils/api/api_test.go

@@ -75,3 +75,39 @@ func TestCheckAPICallSuccess(t *testing.T) {
 		assert.NoError(t, err)
 	})
 }
+
+func TestCallAndCheckSuccess(t *testing.T) {
+	t.Run("context cancelled", func(t *testing.T) {
+		errMessage := "context cancelled"
+		parentCtx := context.Background()
+		ctx, cancelCtx := context.WithCancel(parentCtx)
+		cancelCtx()
+		_, actualErr := CallAndCheckSuccess(ctx, errMessage,
+			func(ctx context.Context) (*struct{}, *_http.Response, error) {
+				return nil, &_http.Response{Body: io.NopCloser(bytes.NewReader(nil))}, errors.New(errMessage)
+			})
+		assert.True(t, commonerrors.Any(actualErr, commonerrors.ErrCancelled))
+	})
+
+	t.Run("api call not successful", func(t *testing.T) {
+		errMessage := "client error"
+		parentCtx := context.Background()
+		_, actualErr := CallAndCheckSuccess(parentCtx, errMessage,
+			func(ctx context.Context) (*struct{}, *_http.Response, error) {
+				resp := _http.Response{StatusCode: 400, Body: io.NopCloser(bytes.NewReader([]byte("{\"message\": \"client error\",\"requestId\": \"761761721\"}")))}
+				return nil, &resp, errors.New(errMessage)
+			})
+		expectedErr := "client error (400): API call error [request-id: 761761721] client error; client error"
+		assert.Equal(t, actualErr.Error(), expectedErr)
+	})
+
+	t.Run("no context error, api call successful", func(t *testing.T) {
+		errMessage := "no error"
+		parentCtx := context.Background()
+		_, err := CallAndCheckSuccess(parentCtx, errMessage,
+			func(ctx context.Context) (*struct{}, *_http.Response, error) {
+				return nil, &_http.Response{StatusCode: 200}, errors.New(errMessage)
+			})
+		assert.NoError(t, err)
+	})
+}