feat: support --mode for cd preview (#1151)

Author: lionello

src/cmd/cli/command/cd.go

@@ -198,6 +198,6 @@ var cdPreviewCmd = &cobra.Command{
 			return err
 		}
 
-		return cli.Preview(cmd.Context(), project, client, provider) // TODO: support --mode #1022
+		return cli.Preview(cmd.Context(), project, client, provider, mode.Value())
 	},
 }

src/cmd/cli/command/commands.go

@@ -46,6 +46,7 @@ var (
 	gitHubClientId = pkg.Getenv("DEFANG_CLIENT_ID", "7b41848ca116eac4b125") // GitHub OAuth app
 	hasTty         = term.IsTerminal() && !pkg.GetenvBool("CI")
 	hideUpdate     = pkg.GetenvBool("DEFANG_HIDE_UPDATE")
+	mode           = Mode(defangv1.DeploymentMode_MODE_UNSPECIFIED)
 	modelId        = os.Getenv("DEFANG_MODEL_ID") // for Pro users only
 	nonInteractive = !hasTty
 	org            string
@@ -177,6 +178,7 @@ func SetupCommands(ctx context.Context, version string) {
 	cdListCmd.Flags().Bool("remote", false, "invoke the command on the remote cluster")
 	cdCmd.AddCommand(cdListCmd)
 	cdCmd.AddCommand(cdCancelCmd)
+	cdPreviewCmd.Flags().VarP(&mode, "mode", "m", fmt.Sprintf("deployment mode; one of %v", allModes()))
 	cdCmd.AddCommand(cdPreviewCmd)
 
 	// Eula command

src/cmd/cli/command/compose.go

@@ -18,7 +18,6 @@ import (
 	"github.com/DefangLabs/defang/src/pkg/track"
 	"github.com/DefangLabs/defang/src/pkg/types"
 	defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
-
 	"github.com/bufbuild/connect-go"
 	"github.com/spf13/cobra"
 )
@@ -49,7 +48,6 @@ func createProjectForDebug(loader *compose.Loader) (*compose.Project, error) {
 }
 
 func makeComposeUpCmd() *cobra.Command {
-	mode := Mode(defangv1.DeploymentMode_DEVELOPMENT)
 	composeUpCmd := &cobra.Command{
 		Use:         "up",
 		Annotations: authNeededAnnotation,
@@ -199,7 +197,7 @@ func makeComposeUpCmd() *cobra.Command {
 	composeUpCmd.Flags().Bool("utc", false, "show logs in UTC timezone (ie. TZ=UTC)")
 	composeUpCmd.Flags().Bool("tail", false, "tail the service logs after updating") // obsolete, but keep for backwards compatibility
 	_ = composeUpCmd.Flags().MarkHidden("tail")
-	composeUpCmd.Flags().VarP(&mode, "mode", "m", "deployment mode, possible values: "+strings.Join(allModes(), ", "))
+	composeUpCmd.Flags().VarP(&mode, "mode", "m", fmt.Sprintf("deployment mode; one of %v", allModes()))
 	composeUpCmd.Flags().Bool("build", true, "build the image before starting the service") // docker-compose compatibility
 	_ = composeUpCmd.Flags().MarkHidden("build")
 	composeUpCmd.Flags().Bool("wait", true, "wait for services to be running|healthy") // docker-compose compatibility
@@ -511,7 +509,7 @@ func makeComposeLogsCmd() *cobra.Command {
 	logsCmd.Flags().String("since", "", "show logs since duration/time")
 	logsCmd.Flags().String("until", "", "show logs until duration/time")
 	logsCmd.Flags().Bool("utc", false, "show logs in UTC timezone (ie. TZ=UTC)")
-	logsCmd.Flags().Var(&logType, "type", fmt.Sprintf(`show logs of type; one of %v`, logs.AllLogTypes))
+	logsCmd.Flags().Var(&logType, "type", fmt.Sprintf("show logs of type; one of %v", logs.AllLogTypes))
 	logsCmd.Flags().String("filter", "", "only show logs containing given text; case-insensitive")
 	return logsCmd
 }

src/cmd/cli/command/mode.go

@@ -2,6 +2,7 @@ package command
 
 import (
 	"fmt"
+	"slices"
 	"strings"
 
 	defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
@@ -10,16 +11,21 @@ import (
 type Mode defangv1.DeploymentMode
 
 func (b Mode) String() string {
+	if b == 0 {
+		return ""
+	}
 	return strings.ToLower(defangv1.DeploymentMode_name[int32(b)])
 }
+
 func (b *Mode) Set(s string) error {
 	mode, ok := defangv1.DeploymentMode_value[strings.ToUpper(s)]
 	if !ok {
-		return fmt.Errorf("invalid mode: %s, valid values are: %v", s, strings.Join(allModes(), ", "))
+		return fmt.Errorf("invalid mode: %s, not one of %v", s, allModes())
 	}
 	*b = Mode(mode)
 	return nil
 }
+
 func (b Mode) Type() string {
 	return "mode"
 }
@@ -36,5 +42,6 @@ func allModes() []string {
 		}
 		modes = append(modes, strings.ToLower(mode))
 	}
+	slices.Sort(modes) // TODO: sort by enum value instead of string
 	return modes
 }

src/pkg/cli/preview.go

@@ -9,8 +9,8 @@ import (
 	defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
 )
 
-func Preview(ctx context.Context, project *compose.Project, fabric cliClient.FabricClient, provider cliClient.Provider) error {
-	resp, project, err := ComposeUp(ctx, project, fabric, provider, compose.UploadModePreview, defangv1.DeploymentMode_MODE_UNSPECIFIED)
+func Preview(ctx context.Context, project *compose.Project, fabric cliClient.FabricClient, provider cliClient.Provider, mode defangv1.DeploymentMode) error {
+	resp, project, err := ComposeUp(ctx, project, fabric, provider, compose.UploadModePreview, mode)
 	if err != nil {
 		return err
 	}

src/pkg/cli/preview_test.go

@@ -10,6 +10,7 @@ import (
 	"github.com/DefangLabs/defang/src/pkg/cli/client"
 	"github.com/DefangLabs/defang/src/pkg/cli/compose"
 	"github.com/DefangLabs/defang/src/pkg/clouds/aws/ecs"
+	defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
 	"github.com/aws/aws-sdk-go-v2/service/ecs/types"
 )
 
@@ -45,7 +46,7 @@ func TestPreviewStops(t *testing.T) {
 				deploymentStatus: tt.err,
 			}
 
-			err := Preview(context.Background(), project, fabric, provider)
+			err := Preview(context.Background(), project, fabric, provider, defangv1.DeploymentMode_MODE_UNSPECIFIED)
 			if err != nil {
 				if err.Error() != tt.wantError {
 					t.Errorf("got error: %v, want: %v", err, tt.wantError)
@@ -67,7 +68,7 @@ func TestPreviewStops(t *testing.T) {
 
 		provider := &mockDeployProvider{}
 
-		err := Preview(ctx, project, fabric, provider)
+		err := Preview(ctx, project, fabric, provider, defangv1.DeploymentMode_MODE_UNSPECIFIED)
 		if err != nil {
 			t.Errorf("got error: %v, want nil", err)
 		}