fix api client error handling, add tests

Author: alyssaruth

.github/workflows/test.yml

@@ -29,19 +29,13 @@ jobs:
       run: |
         go build -v .
 
-  # run acceptance tests in a matrix with Terraform core versions
+  # run acceptance tests
   test:
-    name: Matrix Test
+    name: Test
     needs: build
     runs-on: ubuntu-latest
     environment: "acceptance tests"
     timeout-minutes: 15
-    strategy:
-      fail-fast: false
-      matrix:
-        # list whatever Terraform versions here you would like to support
-        terraform:
-          - '1.5.7'
     steps:
 
     - name: Set up Go
@@ -57,6 +51,9 @@ jobs:
       run: |
         go mod download
 
+    - name: Unit tests
+      run: go test -v -cover ./...
+
     - name: Boot services for acceptance tests
       run: docker compose -f scripts/docker-compose.yaml up --wait -d
       env:
@@ -65,7 +62,7 @@ jobs:
       timeout-minutes: 10
       env:
         TF_ACC: "1"
-        TF_ACC_TERRAFORM_VERSION: ${{ matrix.terraform }}
+        TF_ACC_TERRAFORM_VERSION: '1.5.7'
 
         # Set whatever additional acceptance test env vars here. You can
         # optionally use data from your repository secrets using the

aidbox/api_client.go

@@ -128,10 +128,18 @@ func (apiClient *ApiClient) addAuthAndHost(req *http.Request) {
 func errorToTerraform(request *http.Request, response *http.Response, requestBody interface{}, responseBody []byte) error {
 	var sensitiveDetails = ""
 	var prettyResponse bytes.Buffer
-	err := json.Indent(&prettyResponse, responseBody, "", "  ")
-	if err != nil {
-		panic(err)
+	jsonParseErr := json.Indent(&prettyResponse, responseBody, "", "  ")
+	if jsonParseErr != nil {
+		return fmt.Errorf("unexpected status code (%d) received: %s\n\n"+
+			"===== %s %s =====\n\n"+
+			"===== RESPONSE BODY =====\n"+
+			"%s\n",
+			response.StatusCode,
+			response.Status,
+			request.Method, request.URL.String(),
+			string(responseBody))
 	}
+
 	if os.Getenv("TF_ACC") == "1" {
 		prettyRequest, err := json.MarshalIndent(requestBody, "", "  ")
 		if err != nil {

aidbox/api_client_test.go

@@ -0,0 +1,82 @@
+package aidbox
+
+import (
+	"context"
+	"fmt"
+	"github.com/stretchr/testify/assert"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+)
+
+type TestResponse struct {
+	Name  string `json:"name"`
+	Value int    `json:"value"`
+}
+
+func TestApiClient(t *testing.T) {
+	t.Run("Should call the correct endpoint and deserialise to an interface", func(t *testing.T) {
+		server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			w.WriteHeader(200)
+			w.Write([]byte("{\"name\": \"Lord Vetinari\", \"value\": 8}"))
+		}))
+
+		client := NewApiClient(server.URL, "foo", "bar")
+		response := &TestResponse{}
+		err := client.post(context.TODO(), "", "/endpoint", response)
+
+		assert.Equal(t, nil, err)
+		assert.Equal(t, TestResponse{"Lord Vetinari", 8}, *response)
+	})
+
+	t.Run("should log an error response that isn't JSON", func(t *testing.T) {
+		server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			w.WriteHeader(502)
+			w.Write([]byte("Service Unavailable"))
+		}))
+
+		client := NewApiClient(server.URL, "foo", "bar")
+		err := client.post(context.TODO(), "", "/endpoint", "")
+
+		expectedError := fmt.Sprintf(`unexpected status code (502) received: 502 Bad Gateway
+
+===== POST %s/endpoint =====
+
+===== RESPONSE BODY =====
+Service Unavailable
+`, server.URL)
+
+		assert.Equal(t, expectedError, err.Error())
+	})
+
+	t.Run("should pretty-print a JSON error response", func(t *testing.T) {
+		server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			w.WriteHeader(422)
+			w.Write([]byte("{ \"name\": \"Ankh-Morpork City Watch\", \"type\": \"Organisation\", \"members\": [\"Sam Vimes\", \"Fred Colon\", \"Nobby Nobbs\", \"Cheery Littlebottom\", \"Detritus\", \"Reg Shoe\"] }"))
+		}))
+
+		client := NewApiClient(server.URL, "foo", "bar")
+		err := client.post(context.TODO(), "", "/endpoint", "")
+
+		expectedError := fmt.Sprintf(`unexpected status code (422) received: 422 Unprocessable Entity
+
+===== POST %s/endpoint =====
+
+===== RESPONSE BODY =====
+{
+  "name": "Ankh-Morpork City Watch",
+  "type": "Organisation",
+  "members": [
+    "Sam Vimes",
+    "Fred Colon",
+    "Nobby Nobbs",
+    "Cheery Littlebottom",
+    "Detritus",
+    "Reg Shoe"
+  ]
+}
+`, server.URL)
+
+		assert.Equal(t, expectedError, err.Error())
+	})
+}