auto-apply flags for create/edit deploy requests

Adding `enable-auto-apply` & `disable-auto-apply` flags to both the create and edit commands.

Updated the edit command to use boolean flags so that we can be consistent across commands.

This setting is unique in that each new DR remembers the setting used from the previous DR. So we want to allow users to either: enable it,
disable it, or do nothing and inherit the previous setting from the last DR.

Usage:
```
pscale deploy-request create mydb mybranch --enable-auto-apply

pscale deploy-request create mydb mybranch --disable-auto-apply

pscale deploy-request create mydb mybranch

pscale deploy-request edit mydb 123 --enable-auto-apply

pscale deploy-request edit mydb 123 --disable-auto-apply
```

Author: mscoutermarsh

internal/cmd/deployrequest/create.go

@@ -16,6 +16,8 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
 		into               string
 		notes              string
 		auto_delete_branch bool
+		enable_auto_apply  bool
+		disable_auto_apply bool
 	}
 
 	cmd := &cobra.Command{
@@ -32,6 +34,10 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
 				return err
 			}
 
+			if flags.enable_auto_apply && flags.disable_auto_apply {
+				return fmt.Errorf("cannot use both --enable-auto-apply and --disable-auto-apply flags together")
+			}
+
 			end := ch.Printer.PrintProgress(fmt.Sprintf("Request deploying of %s branch in %s...", printer.BoldBlue(branch), printer.BoldBlue(database)))
 			defer end()
 
@@ -43,6 +49,12 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
 				Notes:        flags.notes,
 			}
 
+			if flags.enable_auto_apply {
+				request.AutoCutover = true
+			} else if flags.disable_auto_apply {
+				request.AutoCutover = false
+			}
+
 			if flags.auto_delete_branch {
 				request.AutoDeleteBranch = true
 			}
@@ -73,6 +85,8 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd.PersistentFlags().StringVar(&flags.into, "into", "", "Branch to deploy into. By default, it's the parent branch (if present) or the database's default branch.")
 	cmd.PersistentFlags().StringVar(&flags.notes, "notes", "", "Notes to include with the deploy request.")
 	cmd.Flags().BoolVar(&flags.auto_delete_branch, "auto-delete-branch", false, "Delete the branch after the deploy request completes.")
+	cmd.Flags().BoolVar(&flags.enable_auto_apply, "enable-auto-apply", false, "Enable auto-apply. The deploy request will automatically swap over to the new schema once ready.")
+	cmd.Flags().BoolVar(&flags.disable_auto_apply, "disable-auto-apply", false, "Disable auto-apply. The deploy request will wait for your confirmation before swapping to the new schema. Use 'deploy-request apply' to apply the changes manually.")
 
 	return cmd
 }

internal/cmd/deployrequest/create_test.go

@@ -33,6 +33,7 @@ func TestDeployRequest_CreateCmd(t *testing.T) {
 			c.Assert(req.Organization, qt.Equals, org)
 			c.Assert(req.Database, qt.Equals, db)
 			c.Assert(req.Branch, qt.Equals, branch)
+			c.Assert(req.AutoCutover, qt.Equals, false)
 			c.Assert(req.Notes, qt.Equals, notes)
 			c.Assert(req.AutoDeleteBranch, qt.Equals, true)
 			c.Assert(req.IntoBranch, qt.Equals, "", qt.Commentf("default value of the '--into' flag has changed"))
@@ -64,6 +65,129 @@ func TestDeployRequest_CreateCmd(t *testing.T) {
 	c.Assert(buf.String(), qt.JSONEquals, res)
 }
 
+func TestDeployRequest_CreateCmdEnableAutoApplyFlag(t *testing.T) {
+	c := qt.New(t)
+
+	var buf bytes.Buffer
+	format := printer.JSON
+	p := printer.NewPrinter(&format)
+	p.SetResourceOutput(&buf)
+
+	org := "planetscale"
+	db := "planetscale"
+	branch := "development"
+	var number uint64 = 10
+
+	svc := &mock.DeployRequestsService{
+		CreateFn: func(ctx context.Context, req *ps.CreateDeployRequestRequest) (*ps.DeployRequest, error) {
+			c.Assert(req.Organization, qt.Equals, org)
+			c.Assert(req.Database, qt.Equals, db)
+			c.Assert(req.Branch, qt.Equals, branch)
+			c.Assert(req.AutoCutover, qt.Equals, true)
+
+			return &ps.DeployRequest{Number: number}, nil
+		},
+	}
+
+	ch := &cmdutil.Helper{
+		Printer: p,
+		Config: &config.Config{
+			Organization: org,
+		},
+		Client: func() (*ps.Client, error) {
+			return &ps.Client{
+				DeployRequests: svc,
+			}, nil
+		},
+	}
+
+	cmd := CreateCmd(ch)
+	cmd.SetArgs([]string{db, branch, "--enable-auto-apply"})
+	err := cmd.Execute()
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(svc.CreateFnInvoked, qt.IsTrue)
+
+	res := &ps.DeployRequest{Number: number}
+	c.Assert(buf.String(), qt.JSONEquals, res)
+}
+
+func TestDeployRequest_CreateCmdDisableAutoApplyFlag(t *testing.T) {
+	c := qt.New(t)
+
+	var buf bytes.Buffer
+	format := printer.JSON
+	p := printer.NewPrinter(&format)
+	p.SetResourceOutput(&buf)
+
+	org := "planetscale"
+	db := "planetscale"
+	branch := "development"
+	var number uint64 = 10
+
+	svc := &mock.DeployRequestsService{
+		CreateFn: func(ctx context.Context, req *ps.CreateDeployRequestRequest) (*ps.DeployRequest, error) {
+			c.Assert(req.Organization, qt.Equals, org)
+			c.Assert(req.Database, qt.Equals, db)
+			c.Assert(req.Branch, qt.Equals, branch)
+			c.Assert(req.AutoCutover, qt.Equals, false)
+
+			return &ps.DeployRequest{Number: number}, nil
+		},
+	}
+
+	ch := &cmdutil.Helper{
+		Printer: p,
+		Config: &config.Config{
+			Organization: org,
+		},
+		Client: func() (*ps.Client, error) {
+			return &ps.Client{
+				DeployRequests: svc,
+			}, nil
+		},
+	}
+
+	cmd := CreateCmd(ch)
+	cmd.SetArgs([]string{db, branch, "--disable-auto-apply"})
+	err := cmd.Execute()
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(svc.CreateFnInvoked, qt.IsTrue)
+
+	res := &ps.DeployRequest{Number: number}
+	c.Assert(buf.String(), qt.JSONEquals, res)
+}
+
+func TestDeployRequest_CreateCmdBothAutoApplyFlags(t *testing.T) {
+	c := qt.New(t)
+
+	var buf bytes.Buffer
+	format := printer.JSON
+	p := printer.NewPrinter(&format)
+	p.SetResourceOutput(&buf)
+
+	org := "planetscale"
+	db := "planetscale"
+	branch := "development"
+
+	ch := &cmdutil.Helper{
+		Printer: p,
+		Config: &config.Config{
+			Organization: org,
+		},
+		Client: func() (*ps.Client, error) {
+			return &ps.Client{}, nil
+		},
+	}
+
+	cmd := CreateCmd(ch)
+	cmd.SetArgs([]string{db, branch, "--enable-auto-apply", "--disable-auto-apply"})
+	err := cmd.Execute()
+
+	c.Assert(err, qt.ErrorMatches, "cannot use both --enable-auto-apply and --disable-auto-apply flags together")
+}
+
 func TestDeployRequest_CreateCmdIntoFlag(t *testing.T) {
 	c := qt.New(t)
 

internal/cmd/deployrequest/edit.go

@@ -14,7 +14,8 @@ import (
 // EditCmd is the command for editing preferences on deploy requests.
 func EditCmd(ch *cmdutil.Helper) *cobra.Command {
 	var flags struct {
-		autoApply string
+		enable_auto_apply  bool
+		disable_auto_apply bool
 	}
 
 	cmd := &cobra.Command{
@@ -36,17 +37,19 @@ func EditCmd(ch *cmdutil.Helper) *cobra.Command {
 				return fmt.Errorf("the argument <number> is invalid: %s", err)
 			}
 
-			switch flags.autoApply {
-			case "enable", "disable":
-			default:
-				return fmt.Errorf("--auto-apply accepts only \"enable\" or \"disable\" but got %q", flags.autoApply)
+			if flags.enable_auto_apply && flags.disable_auto_apply {
+				return fmt.Errorf("cannot use both --enable-auto-apply and --disable-auto-apply flags together")
+			}
+
+			if !flags.enable_auto_apply && !flags.disable_auto_apply {
+				return fmt.Errorf("must specify either --enable-auto-apply or --disable-auto-apply")
 			}
 
 			dr, err := client.DeployRequests.AutoApplyDeploy(ctx, &planetscale.AutoApplyDeployRequestRequest{
 				Organization: ch.Config.Organization,
 				Database:     database,
 				Number:       n,
-				Enable:       flags.autoApply == "enable",
+				Enable:       flags.enable_auto_apply,
 			})
 			if err != nil {
 				switch cmdutil.ErrCode(err) {
@@ -69,6 +72,7 @@ func EditCmd(ch *cmdutil.Helper) *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringVar(&flags.autoApply, "auto-apply", "enable", "Update the auto apply setting for a deploy request. Possible values: [enable,disable]")
+	cmd.Flags().BoolVar(&flags.enable_auto_apply, "enable-auto-apply", false, "Enable auto-apply. The deploy request will automatically swap over to the new schema once ready.")
+	cmd.Flags().BoolVar(&flags.disable_auto_apply, "disable-auto-apply", false, "Disable auto-apply. The deploy request will wait for your confirmation before swapping to the new schema. Use 'deploy-request apply' to apply the changes manually.")
 	return cmd
 }

internal/cmd/deployrequest/edit_test.go

@@ -15,7 +15,7 @@ import (
 	ps "github.com/planetscale/planetscale-go/planetscale"
 )
 
-func TestDeployRequest_EditCmd(t *testing.T) {
+func TestDeployRequest_EditCmdEnableAutoApply(t *testing.T) {
 	c := qt.New(t)
 
 	var buf bytes.Buffer
@@ -52,7 +52,54 @@ func TestDeployRequest_EditCmd(t *testing.T) {
 	}
 
 	cmd := EditCmd(ch)
-	cmd.SetArgs([]string{db, strconv.FormatUint(number, 10)})
+	cmd.SetArgs([]string{db, strconv.FormatUint(number, 10), "--enable-auto-apply"})
+	err := cmd.Execute()
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(svc.AutoApplyFnInvoked, qt.IsTrue)
+
+	res := &ps.DeployRequest{Number: number}
+	c.Assert(buf.String(), qt.JSONEquals, res)
+}
+
+func TestDeployRequest_EditCmdDisableAutoApply(t *testing.T) {
+	c := qt.New(t)
+
+	var buf bytes.Buffer
+	format := printer.JSON
+	p := printer.NewPrinter(&format)
+	p.SetResourceOutput(&buf)
+
+	org := "planetscale"
+	db := "planetscale"
+	number := uint64(10)
+	enable := false
+
+	svc := &mock.DeployRequestsService{
+		AutoApplyFn: func(ctx context.Context, req *ps.AutoApplyDeployRequestRequest) (*ps.DeployRequest, error) {
+			c.Assert(req.Number, qt.Equals, number)
+			c.Assert(req.Database, qt.Equals, db)
+			c.Assert(req.Organization, qt.Equals, org)
+			c.Assert(req.Enable, qt.Equals, enable)
+
+			return &ps.DeployRequest{Number: number}, nil
+		},
+	}
+
+	ch := &cmdutil.Helper{
+		Printer: p,
+		Config: &config.Config{
+			Organization: org,
+		},
+		Client: func() (*ps.Client, error) {
+			return &ps.Client{
+				DeployRequests: svc,
+			}, nil
+		},
+	}
+
+	cmd := EditCmd(ch)
+	cmd.SetArgs([]string{db, strconv.FormatUint(number, 10), "--disable-auto-apply"})
 	err := cmd.Execute()
 
 	c.Assert(err, qt.IsNil)
@@ -61,3 +108,61 @@ func TestDeployRequest_EditCmd(t *testing.T) {
 	res := &ps.DeployRequest{Number: number}
 	c.Assert(buf.String(), qt.JSONEquals, res)
 }
+
+func TestDeployRequest_EditCmdNoFlags(t *testing.T) {
+	c := qt.New(t)
+
+	var buf bytes.Buffer
+	format := printer.JSON
+	p := printer.NewPrinter(&format)
+	p.SetResourceOutput(&buf)
+
+	org := "planetscale"
+	db := "planetscale"
+	number := uint64(10)
+
+	ch := &cmdutil.Helper{
+		Printer: p,
+		Config: &config.Config{
+			Organization: org,
+		},
+		Client: func() (*ps.Client, error) {
+			return &ps.Client{}, nil
+		},
+	}
+
+	cmd := EditCmd(ch)
+	cmd.SetArgs([]string{db, strconv.FormatUint(number, 10)})
+	err := cmd.Execute()
+
+	c.Assert(err, qt.ErrorMatches, "must specify either --enable-auto-apply or --disable-auto-apply")
+}
+
+func TestDeployRequest_EditCmdBothFlags(t *testing.T) {
+	c := qt.New(t)
+
+	var buf bytes.Buffer
+	format := printer.JSON
+	p := printer.NewPrinter(&format)
+	p.SetResourceOutput(&buf)
+
+	org := "planetscale"
+	db := "planetscale"
+	number := uint64(10)
+
+	ch := &cmdutil.Helper{
+		Printer: p,
+		Config: &config.Config{
+			Organization: org,
+		},
+		Client: func() (*ps.Client, error) {
+			return &ps.Client{}, nil
+		},
+	}
+
+	cmd := EditCmd(ch)
+	cmd.SetArgs([]string{db, strconv.FormatUint(number, 10), "--enable-auto-apply", "--disable-auto-apply"})
+	err := cmd.Execute()
+
+	c.Assert(err, qt.ErrorMatches, "cannot use both --enable-auto-apply and --disable-auto-apply flags together")
+}