Reuse existing client creation logic

Author: benPearce1

pkg/cmd/api/api.go

@@ -3,12 +3,12 @@ package api
 import (
 	"bytes"
 	"encoding/json"
-	"fmt"
 	"io"
 	"net/http"
 	"os"
 
 	"github.com/MakeNowJust/heredoc/v2"
+	"github.com/OctopusDeploy/cli/pkg/apiclient"
 	"github.com/OctopusDeploy/cli/pkg/constants"
 	"github.com/OctopusDeploy/cli/pkg/constants/annotations"
 	"github.com/OctopusDeploy/cli/pkg/factory"
@@ -21,7 +21,7 @@ var OsExit = os.Exit
 func NewCmdAPI(f factory.Factory) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "api <url>",
-		Short: "Execute a raw API request",
+		Short: "Execute a raw API GET request",
 		Long:  "Execute an authenticated GET request against the Octopus Server API and print the JSON response.",
 		Example: heredoc.Docf(`
 			$ %[1]s api /api
@@ -41,36 +41,17 @@ func NewCmdAPI(f factory.Factory) *cobra.Command {
 }
 
 func apiRun(cmd *cobra.Command, f factory.Factory, path string) error {
-	host := f.GetCurrentHost()
-	fullURL := host + path
-
-	httpClient, err := f.GetHttpClient()
-	if err != nil {
-		return err
-	}
-	if httpClient == nil {
-		httpClient = &http.Client{}
-	}
-
-	req, err := http.NewRequest("GET", fullURL, nil)
+	client, err := f.GetSystemClient(apiclient.NewRequester(cmd))
 	if err != nil {
 		return err
 	}
 
-	configProvider, err := f.GetConfigProvider()
+	req, err := http.NewRequest("GET", path, nil)
 	if err != nil {
 		return err
 	}
 
-	apiKey := configProvider.Get(constants.ConfigApiKey)
-	accessToken := configProvider.Get(constants.ConfigAccessToken)
-	if apiKey != "" {
-		req.Header.Set("X-Octopus-ApiKey", apiKey)
-	} else if accessToken != "" {
-		req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", accessToken))
-	}
-
-	resp, err := httpClient.Do(req)
+	resp, err := client.HttpSession().DoRawRequest(req)
 	if err != nil {
 		return err
 	}

pkg/cmd/api/api_test.go

@@ -13,6 +13,18 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+// respondToSdkInit handles the two HTTP requests that the Octopus SDK makes
+// when initialising the system client: fetching the root resource and listing
+// spaces to find the default space.
+func respondToSdkInit(t *testing.T, api *testutil.MockHttpServer) {
+	api.ExpectRequest(t, "GET", "/api/").RespondWith(testutil.NewRootResource())
+	api.ExpectRequest(t, "GET", "/api/spaces").RespondWith(map[string]any{
+		"Items":        []any{},
+		"ItemsPerPage": 30,
+		"TotalResults": 0,
+	})
+}
+
 func TestApiCommand(t *testing.T) {
 	tests := []struct {
 		name string
@@ -25,6 +37,8 @@ func TestApiCommand(t *testing.T) {
 				return rootCmd.ExecuteC()
 			})
 
+			respondToSdkInit(t, api)
+
 			api.ExpectRequest(t, "GET", "/api").RespondWithStatus(http.StatusOK, "200 OK", map[string]string{
 				"Application": "Octopus Deploy",
 				"Version":     "2024.1.0",
@@ -49,6 +63,8 @@ func TestApiCommand(t *testing.T) {
 				return rootCmd.ExecuteC()
 			})
 
+			respondToSdkInit(t, api)
+
 			api.ExpectRequest(t, "GET", "/api/nonexistent").RespondWithStatus(http.StatusNotFound, "404 Not Found", map[string]string{
 				"ErrorMessage": "Not found",
 			})
@@ -66,6 +82,8 @@ func TestApiCommand(t *testing.T) {
 				return rootCmd.ExecuteC()
 			})
 
+			respondToSdkInit(t, api)
+
 			r, _ := api.ReceiveRequest()
 			assert.Equal(t, "GET", r.Method)
 			assert.Equal(t, "/api/health", r.URL.Path)