Change allocator vacate default polling settings (#151)

Changes the allocator vacate command default polling settings and also
adds `--max-poll-retries` and `--poll-frequency` flags which allow the
user to control the track settings providing the newly changed defaults.

Signed-off-by: Marc Lopez <marc5.12@outlook.com>
Co-authored-by: Papapetrou Patroklos <1743100+ppapapetrou76@users.noreply.github.com>

Author: marclop

cmd/platform/allocator/vacate.go

@@ -155,6 +155,7 @@ var vacateAllocatorCmd = &cobra.Command{
 			fmt.Fprint(ecctl.Get().Config.OutputDevice, merr)
 		}
 
+		maxRetries, pollFrequency := cmdutil.GetTrackSettings(cmd)
 		var params = &allocator.VacateParams{
 			API:                 ecctl.Get().API,
 			Allocators:          args,
@@ -170,6 +171,8 @@ var vacateAllocatorCmd = &cobra.Command{
 				SkipDataMigration: skipDataMigration,
 				OverrideFailsafe:  ec.Bool(overrideFailsafe),
 			},
+			MaxPollRetries: uint8(maxRetries),
+			TrackFrequency: pollFrequency,
 		}
 		if len(args) == 1 && allocatorDownRaw != "" {
 			params.AllocatorDown = &allocatorDown
@@ -200,4 +203,5 @@ func init() {
 	vacateAllocatorCmd.Flags().Bool("override-failsafe", false, "If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints. [true|false]")
 	vacateAllocatorCmd.Flags().String("skip-snapshot", "", "Skips the snapshot operation on the specified cluster IDs. ONLY available when the cluster IDs are specified. [true|false]")
 	vacateAllocatorCmd.Flags().String("skip-data-migration", "", "Skips the data-migration operation on the specified cluster IDs. ONLY available when the cluster IDs are specified and --move-only is true. [true|false]")
+	cmdutil.AddTrackFlags(vacateAllocatorCmd)
 }

cmd/util/flag.go

@@ -20,6 +20,7 @@ package cmdutil
 import (
 	"fmt"
 	"strings"
+	"time"
 
 	"github.com/spf13/cobra"
 
@@ -35,6 +36,11 @@ const (
 `
 )
 
+const (
+	maxPollRetriesFlag = "max-poll-retries"
+	pollFrequencyFlag  = "poll-frequency"
+)
+
 var (
 	// StatelessTypes declares the stateless deployment resource types
 	StatelessTypes = []string{"apm", "appsearch", "kibana"}
@@ -91,3 +97,18 @@ func AddTypeFlag(cmd *cobra.Command, prefix string, all bool) *string {
 
 	return s
 }
+
+// AddTrackFlags adds flags which control the tracking frequency to the passed
+// command reference.
+func AddTrackFlags(cmd *cobra.Command) {
+	cmd.Flags().Int(maxPollRetriesFlag, util.DefaultRetries, "Optional maximum plan tracking retries")
+	cmd.Flags().Duration(pollFrequencyFlag, util.DefaultPollFrequency, "Optional polling frequency to check for plan change updates")
+}
+
+// GetTrackSettings obtains the currently set tracking settings, the first
+// return value being the MaxPollRetries and the second one the poll frequency.
+func GetTrackSettings(cmd *cobra.Command) (int, time.Duration) {
+	maxPollRetries, _ := cmd.Flags().GetInt(maxPollRetriesFlag)
+	pollFrequency, _ := cmd.Flags().GetDuration(pollFrequencyFlag)
+	return maxPollRetries, pollFrequency
+}

cmd/util/flag_test.go

@@ -21,7 +21,9 @@ import (
 	"errors"
 	"net/http"
 	"reflect"
+	"strconv"
 	"testing"
+	"time"
 
 	"github.com/elastic/cloud-sdk-go/pkg/api"
 	"github.com/elastic/cloud-sdk-go/pkg/api/mock"
@@ -216,3 +218,101 @@ func TestAddTypeFlag(t *testing.T) {
 		})
 	}
 }
+
+func TestAddTrackFlags(t *testing.T) {
+	var wantRetriesPflag = &flag.Flag{
+		Name:     maxPollRetriesFlag,
+		DefValue: strconv.Itoa(util.DefaultRetries),
+		Usage:    "Optional maximum plan tracking retries",
+	}
+	var wantPollFrequencyPflag = &flag.Flag{
+		Name:     pollFrequencyFlag,
+		DefValue: util.DefaultPollFrequency.String(),
+		Usage:    "Optional polling frequency to check for plan change updates",
+	}
+	type args struct {
+		cmd *cobra.Command
+	}
+	tests := []struct {
+		name          string
+		args          args
+		wantRetries   *flag.Flag
+		wantFrequency *flag.Flag
+	}{
+		{
+			name: "Annotates the type flag with all types",
+			args: args{
+				cmd: &cobra.Command{
+					Use: "somethingrequired",
+					Run: func(cmd *cobra.Command, args []string) {},
+				},
+			},
+			wantRetries:   wantRetriesPflag,
+			wantFrequency: wantPollFrequencyPflag,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			AddTrackFlags(tt.args.cmd)
+		})
+		gotRetries := tt.args.cmd.Flag(maxPollRetriesFlag)
+		gotRetries.Value = nil
+		if !reflect.DeepEqual(gotRetries, tt.wantRetries) {
+			t.Errorf("AddTypeFlag() gotRetries = \n%+v, wantRetries \n%+v", gotRetries, tt.wantRetries)
+		}
+		gotFrequency := tt.args.cmd.Flag(pollFrequencyFlag)
+		gotFrequency.Value = nil
+		if !reflect.DeepEqual(gotFrequency, tt.wantFrequency) {
+			t.Errorf("AddTypeFlag() gotFrequency = \n%+v, wantFrequency \n%+v", gotFrequency, tt.wantFrequency)
+		}
+	}
+}
+
+func TestGetTrackSettings(t *testing.T) {
+	c := &cobra.Command{
+		Use: "somethingrequired",
+		Run: func(cmd *cobra.Command, args []string) {},
+	}
+	AddTrackFlags(c)
+
+	c2 := &cobra.Command{
+		Use: "somethingrequired",
+		Run: func(cmd *cobra.Command, args []string) {},
+	}
+	AddTrackFlags(c2)
+	_ = c2.Flag(maxPollRetriesFlag).Value.Set("5")
+	_ = c2.Flag(pollFrequencyFlag).Value.Set("50s")
+	type args struct {
+		cmd *cobra.Command
+	}
+	tests := []struct {
+		name  string
+		args  args
+		want  int
+		want1 time.Duration
+	}{
+		{
+			name:  "Gets default values",
+			args:  args{cmd: c},
+			want:  util.DefaultRetries,
+			want1: util.DefaultPollFrequency,
+		},
+		{
+			name:  "Gets the changed values",
+			args:  args{cmd: c2},
+			want:  5,
+			want1: time.Second * 50,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, got1 := GetTrackSettings(tt.args.cmd)
+			if got != tt.want {
+				t.Errorf("GetTrackSettings() got = %v, want %v", got, tt.want)
+			}
+			if got1 != tt.want1 {
+				t.Errorf("GetTrackSettings() got1 = %v, want %v", got1, tt.want1)
+			}
+		})
+	}
+}

docs/ecctl_platform_allocator_vacate.md

@@ -57,8 +57,10 @@ ecctl platform allocator vacate <source> [flags]
   -h, --help                         help for vacate
   -k, --kind string                  Kind of workload to vacate (elasticsearch|kibana)
   -m, --maintenance                  Whether to set the allocator(s) in maintenance before performing the vacate
+      --max-poll-retries int         Optional maximum plan tracking retries (default 2)
       --move-only                    Keeps the cluster in its current -possibly broken- state and just does the bare minimum to move the requested instances across to another allocator. [true|false] (default true)
       --override-failsafe            If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints. [true|false]
+      --poll-frequency duration      Optional polling frequency to check for plan change updates (default 10s)
       --skip-data-migration string   Skips the data-migration operation on the specified cluster IDs. ONLY available when the cluster IDs are specified and --move-only is true. [true|false]
       --skip-snapshot string         Skips the snapshot operation on the specified cluster IDs. ONLY available when the cluster IDs are specified. [true|false]
       --skip-tracking                Skips tracking the vacate progress causing the command to return after the move operation has been executed. Not recommended.

pkg/platform/allocator/vacate.go

@@ -20,7 +20,6 @@ package allocator
 import (
 	"fmt"
 	"strings"
-	"time"
 
 	"github.com/elastic/cloud-sdk-go/pkg/api"
 	"github.com/elastic/cloud-sdk-go/pkg/client/platform_infrastructure"
@@ -31,15 +30,11 @@ import (
 	"github.com/elastic/cloud-sdk-go/pkg/util/slice"
 	multierror "github.com/hashicorp/go-multierror"
 	"github.com/pkg/errors"
+
+	"github.com/elastic/ecctl/pkg/util"
 )
 
 const (
-	// DefaultTrackRetries is used when TrackRetries is empty
-	DefaultTrackRetries uint8 = 4
-
-	// DefaultTrackFrequency is used when TrackFrequency is 0
-	DefaultTrackFrequency = time.Second
-
 	// PlanPendingMessage is used to discard
 	PlanPendingMessage = "There is a plan still pending, cancel that or wait for it to complete before restarting"
 )
@@ -301,11 +296,11 @@ func fillVacateClusterParams(params *VacateClusterParams) (*VacateClusterParams,
 	}
 
 	if params.MaxPollRetries == 0 {
-		params.MaxPollRetries = DefaultTrackRetries
+		params.MaxPollRetries = util.DefaultRetries
 	}
 
 	if params.TrackFrequency.Nanoseconds() == 0 {
-		params.TrackFrequency = DefaultTrackFrequency
+		params.TrackFrequency = util.DefaultPollFrequency
 	}
 
 	return params, nil

pkg/platform/allocator/vacate_test.go

@@ -909,8 +909,8 @@ func Test_fillVacateClusterParams(t *testing.T) {
 				ClusterID:      "3ee11eb40eda22cac0cce259625c6734",
 				Kind:           "elasticsearch",
 				Output:         output.NewDevice(new(bytes.Buffer)),
-				MaxPollRetries: DefaultTrackRetries,
-				TrackFrequency: DefaultTrackFrequency,
+				MaxPollRetries: util.DefaultRetries,
+				TrackFrequency: util.DefaultPollFrequency,
 				AllocatorDown:  ec.Bool(false),
 			},
 		},