update integration tests for other app commands (#456)

* update integration tests for other app commands

* f

cli/cmd/app_create.go

@@ -1,8 +1,11 @@
 package cmd
 
 import (
+	"context"
+
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/replicated/cli/print"
+	"github.com/replicatedhq/replicated/pkg/integration"
 	"github.com/replicatedhq/replicated/pkg/kotsclient"
 	"github.com/replicatedhq/replicated/pkg/types"
 	"github.com/spf13/cobra"
@@ -35,11 +38,19 @@ The NAME argument is required and will be used as the application's name.`,
   # Create a new app with a specific name and view details in table format
   replicated app create "Custom App" --output table`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx := context.Background()
+			if integrationTest != "" {
+				ctx = context.WithValue(ctx, integration.IntegrationTestContextKey, integrationTest)
+			}
+			if logAPICalls != "" {
+				ctx = context.WithValue(ctx, integration.APICallLogContextKey, logAPICalls)
+			}
+
 			if len(args) != 1 {
 				return errors.New("missing app name")
 			}
 			opts.name = args[0]
-			return r.createApp(cmd, opts, outputFormat)
+			return r.createApp(ctx, cmd, opts, outputFormat)
 		},
 		SilenceUsage: true,
 	}
@@ -49,10 +60,12 @@ The NAME argument is required and will be used as the application's name.`,
 	return cmd
 }
 
-func (r *runners) createApp(cmd *cobra.Command, opts createAppOpts, outputFormat string) error {
-	kotsRestClient := kotsclient.VendorV3Client{HTTPClient: *r.platformAPI}
+func (r *runners) createApp(ctx context.Context, cmd *cobra.Command, opts createAppOpts, outputFormat string) error {
+	kotsRestClient := kotsclient.VendorV3Client{
+		HTTPClient: *r.platformAPI,
+	}
 
-	app, err := kotsRestClient.CreateKOTSApp(opts.name)
+	app, err := kotsRestClient.CreateKOTSApp(ctx, opts.name)
 	if err != nil {
 		return errors.Wrap(err, "create app")
 	}

cli/cmd/app_rm.go

@@ -1,9 +1,12 @@
 package cmd
 
 import (
+	"context"
+
 	"github.com/manifoldco/promptui"
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/replicated/cli/print"
+	"github.com/replicatedhq/replicated/pkg/integration"
 	"github.com/replicatedhq/replicated/pkg/logger"
 	"github.com/replicatedhq/replicated/pkg/types"
 	"github.com/spf13/cobra"
@@ -36,10 +39,18 @@ Use this command with caution as there is no way to undo this operation.`,
   # Delete an app and output the result in JSON format
   replicated app delete "Custom App" --output json`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx := context.Background()
+			if integrationTest != "" {
+				ctx = context.WithValue(ctx, integration.IntegrationTestContextKey, integrationTest)
+			}
+			if logAPICalls != "" {
+				ctx = context.WithValue(ctx, integration.APICallLogContextKey, logAPICalls)
+			}
+
 			if len(args) != 1 {
 				return errors.New("missing app slug or id")
 			}
-			return r.deleteApp(cmd, args[0], opts, outputFormat)
+			return r.deleteApp(ctx, cmd, args[0], opts, outputFormat)
 		},
 		SilenceUsage: true,
 	}
@@ -50,18 +61,22 @@ Use this command with caution as there is no way to undo this operation.`,
 	return cmd
 }
 
-func (r *runners) deleteApp(cmd *cobra.Command, appName string, opts deleteAppOpts, outputFormat string) error {
+func (r *runners) deleteApp(ctx context.Context, cmd *cobra.Command, appName string, opts deleteAppOpts, outputFormat string) error {
 	log := logger.NewLogger(r.w)
 
 	log.ActionWithSpinner("Fetching App")
-	app, err := r.kotsAPI.GetApp(appName, true)
+	app, err := r.kotsAPI.GetApp(ctx, appName, true)
 	if err != nil {
 		log.FinishSpinnerWithError()
 		return errors.Wrap(err, "list apps")
 	}
 	log.FinishSpinner()
 
-	apps := []types.AppAndChannels{{App: app}}
+	apps := []types.AppAndChannels{
+		{
+			App: app,
+		},
+	}
 
 	err = print.Apps(outputFormat, r.w, apps)
 	if err != nil {
@@ -80,7 +95,7 @@ func (r *runners) deleteApp(cmd *cobra.Command, appName string, opts deleteAppOp
 	}
 
 	log.ActionWithSpinner("Deleting App")
-	err = r.kotsAPI.DeleteKOTSApp(app.ID)
+	err = r.kotsAPI.DeleteKOTSApp(ctx, app.ID)
 	if err != nil {
 		log.FinishSpinnerWithError()
 		return errors.Wrap(err, "delete app")
@@ -98,7 +113,6 @@ var templates = &promptui.PromptTemplates{
 }
 
 func promptConfirmDelete() (string, error) {
-
 	prompt := promptui.Prompt{
 		Label:     "Delete the above listed application? There is no undo:",
 		Templates: templates,

cli/cmd/cache_helper.go

@@ -1,6 +1,8 @@
 package cmd
 
 import (
+	"context"
+
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/replicated/pkg/kotsclient"
 	"github.com/replicatedhq/replicated/pkg/types"
@@ -17,7 +19,7 @@ func getApp(appSlugOrID string, kotsClient *kotsclient.VendorV3Client) (*types.A
 	}
 
 	if app == nil {
-		a, err := kotsClient.GetApp(appSlugOrID, true)
+		a, err := kotsClient.GetApp(context.TODO(), appSlugOrID, true)
 		if err != nil {
 			return nil, errors.Wrap(err, "get app from api")
 		}

cli/cmd/root.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"context"
 	"fmt"
 	"io"
 	"os"
@@ -348,7 +349,7 @@ func Execute(rootCmd *cobra.Command, stdin io.Reader, stdout io.Writer, stderr i
 		}
 
 		if appSlugOrID != "" && (runCmds.appType == "" || runCmds.appID == "" || runCmds.appSlug == "") {
-			app, appType, err := runCmds.api.GetAppType(appSlugOrID, true)
+			app, appType, err := runCmds.api.GetAppType(context.TODO(), appSlugOrID, true)
 			if err != nil {
 				return errors.Wrap(err, "get app type")
 			}

client/client.go

@@ -1,6 +1,8 @@
 package client
 
 import (
+	"context"
+
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/replicated/pkg/kotsclient"
 	"github.com/replicatedhq/replicated/pkg/platformclient"
@@ -22,7 +24,7 @@ func NewClient(platformOrigin string, apiToken string, kurlOrigin string) Client
 	return client
 }
 
-func (c *Client) GetAppType(appID string, excludeChannels bool) (*types.App, string, error) {
+func (c *Client) GetAppType(ctx context.Context, appID string, excludeChannels bool) (*types.App, string, error) {
 	platformSwaggerApp, err1 := c.PlatformClient.GetApp(appID)
 	if err1 == nil && platformSwaggerApp != nil {
 		platformApp := &types.App{
@@ -34,7 +36,7 @@ func (c *Client) GetAppType(appID string, excludeChannels bool) (*types.App, str
 		return platformApp, "platform", nil
 	}
 
-	kotsApp, err2 := c.KotsClient.GetApp(appID, excludeChannels)
+	kotsApp, err2 := c.KotsClient.GetApp(ctx, appID, excludeChannels)
 	if err2 == nil && kotsApp != nil {
 		return kotsApp, "kots", nil
 	}

pact/kotsclient/app_create_test.go

@@ -1,6 +1,7 @@
 package kotsclient
 
 import (
+	"context"
 	"fmt"
 	"testing"
 
@@ -17,7 +18,7 @@ func Test_AppCreate(t *testing.T) {
 		api := platformclient.NewHTTPClient(u, "replicated-cli-app-create-token")
 		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
-		createdApp, err := client.CreateKOTSApp("app-create-1")
+		createdApp, err := client.CreateKOTSApp(context.TODO(), "app-create-1")
 		assert.Nil(t, err)
 
 		assert.Equal(t, "app-create-1", createdApp.Name)

pact/kotsclient/app_test.go

@@ -72,7 +72,7 @@ func Test_RemoveApp(t *testing.T) {
 		api := platformclient.NewHTTPClient(u, "replicated-cli-rm-app-token")
 		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
-		err = client.DeleteKOTSApp("replicated-cli-rm-app-app")
+		err = client.DeleteKOTSApp(context.TODO(), "replicated-cli-rm-app-app")
 		assert.Nil(t, err)
 
 		apps, err := client.ListApps(context.TODO(), false)

pkg/integration/app_test.go

@@ -10,42 +10,64 @@ import (
 
 func TestApp(t *testing.T) {
 	tests := []struct {
-		name       string
-		cli        string
-		wantFormat format
-		wantLines  int
-		wantMethod string
-		wantPath   string
+		name            string
+		cli             string
+		wantFormat      format
+		wantLines       int
+		wantAPIRequests []string
+		ignoreCLIOutput bool
 	}{
 		{
 			name:       "app-ls-empty",
 			cli:        "app ls",
 			wantFormat: FormatTable,
 			wantLines:  1,
-			wantMethod: "GET",
-			wantPath:   "/v3/apps?excludeChannels=false",
+			wantAPIRequests: []string{
+				"GET:/v3/apps?excludeChannels=false",
+			},
 		},
 		{
 			name:       "app-ls-empty",
 			cli:        "app ls --output json",
 			wantFormat: FormatJSON,
-			wantMethod: "GET",
-			wantPath:   "/v3/apps?excludeChannels=false",
+			wantAPIRequests: []string{
+				"GET:/v3/apps?excludeChannels=false",
+			},
 		},
 		{
 			name:       "app-ls-single",
 			cli:        "app ls",
 			wantFormat: FormatTable,
 			wantLines:  2,
-			wantMethod: "GET",
-			wantPath:   "/v3/apps?excludeChannels=false",
+			wantAPIRequests: []string{
+				"GET:/v3/apps?excludeChannels=false",
+			},
 		},
 		{
 			name:       "app-ls-single",
 			cli:        "app ls --output json",
 			wantFormat: FormatJSON,
-			wantMethod: "GET",
-			wantPath:   "/v3/apps?excludeChannels=false",
+			wantAPIRequests: []string{
+				"GET:/v3/apps?excludeChannels=false",
+			},
+		},
+		{
+			name: "app-rm",
+			cli:  "app rm slug --force",
+			wantAPIRequests: []string{
+				"GET:/v3/apps?excludeChannels=true",
+				"DELETE:/v3/app/id",
+			},
+			ignoreCLIOutput: true,
+		},
+		{
+			name:       "app-create",
+			cli:        "app create name",
+			wantFormat: FormatTable,
+			wantLines:  2,
+			wantAPIRequests: []string{
+				"POST:/v3/app",
+			},
 		},
 	}
 
@@ -69,8 +91,11 @@ func TestApp(t *testing.T) {
 				t.Errorf("error running cli: %v", err)
 			}
 
-			AssertCLIOutput(t, string(out), tt.wantFormat, tt.wantLines)
-			AssertAPIRequests(t, tt.wantMethod, tt.wantPath, apiCallLog.Name())
+			if !tt.ignoreCLIOutput {
+				AssertCLIOutput(t, string(out), tt.wantFormat, tt.wantLines)
+			}
+
+			AssertAPIRequests(t, tt.wantAPIRequests, apiCallLog.Name())
 		})
 	}
 }

pkg/integration/integration.go

@@ -28,6 +28,7 @@ var (
 				Name: "channel-name",
 			},
 		},
+		Id:           "id",
 		Slug:         "slug",
 		Name:         "name",
 		IsFoundation: true,
@@ -37,19 +38,22 @@ var (
 func Response(key string) interface{} {
 	switch key {
 	case "app-ls-empty":
-		return kotsclienttypes.KotsAppResponse{
+		return &kotsclienttypes.KotsAppResponse{
 			Apps: []types.KotsAppWithChannels{},
 		}
-	case "app-ls-single":
-		return kotsclienttypes.KotsAppResponse{
+	case "app-ls-single", "app-rm":
+		return &kotsclienttypes.KotsAppResponse{
 			Apps: []types.KotsAppWithChannels{
 				typeKOTSAppWithChannels,
 			},
 		}
+	case "app-create":
+		return &kotsclienttypes.CreateKOTSAppResponse{
+			App: &typeKOTSAppWithChannels,
+		}
 	default:
 		panic(fmt.Sprintf("unknown integration test: %s", key))
 	}
-
 }
 
 func CLIPath() string {

pkg/integration/util_test.go

@@ -29,13 +29,34 @@ func AssertCLIOutput(t *testing.T, got string, wantFormat format, wantLines int)
 	}
 }
 
-func AssertAPIRequests(t *testing.T, wantMethod string, wantPath string, apiCallLogFilename string) {
+func AssertAPIRequests(t *testing.T, wantAPIRequests []string, apiCallLogFilename string) {
 	apiCallLog, err := os.ReadFile(apiCallLogFilename)
 	if err != nil {
 		t.Errorf("error reading api call log: %v", err)
+		return
 	}
 
-	if string(apiCallLog) != fmt.Sprintf("%s:%s\n", wantMethod, wantPath) {
-		t.Errorf("got %s, want %s", apiCallLog, fmt.Sprintf("%s:%s\n", wantMethod, wantPath))
+	gotAPIRequests := strings.Split(string(apiCallLog), "\n")
+
+	cleaned := []string{}
+	for _, line := range gotAPIRequests {
+		if strings.TrimSpace(line) != "" {
+			cleaned = append(cleaned, line)
+		}
+	}
+	gotAPIRequests = cleaned
+
+	if len(gotAPIRequests) != len(wantAPIRequests) {
+		fmt.Printf("got: %v\n", gotAPIRequests)
+		fmt.Printf("want: %v\n", wantAPIRequests)
+		t.Errorf("got %d requests, want %d", len(gotAPIRequests), len(wantAPIRequests))
+		return
+	}
+
+	for i, wantAPIRequest := range wantAPIRequests {
+		gotAPIRequest := gotAPIRequests[i]
+		if gotAPIRequest != wantAPIRequest {
+			t.Errorf("got %s, want %s", gotAPIRequest, wantAPIRequest)
+		}
 	}
 }