Merge pull request #550 from appgate/537-gateway-upgrade-output-is-a-…

…bit-off Fix progress output
appgate · Apr 25, 2024 · b04a6fa · b04a6fa
2 parents f23cdb6 + 009a647
commit b04a6fa
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 23 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -4,3 +4,6 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    ignore:
+      - dependency-name: "github.com/vbauerster/mpb/v8"
+        versions: ["8.7.x"]
diff --git a/cmd/appliance/upgrade/cancel.go b/cmd/appliance/upgrade/cancel.go
@@ -58,7 +58,7 @@ func NewUpgradeCancelCmd(f *factory.Factory) *cobra.Command {
 		Long:    docs.ApplianceUpgradeCancelDoc.Long,
 		Example: docs.ApplianceUpgradeCancelDoc.ExampleString(),
 		RunE: func(c *cobra.Command, args []string) error {
-			return upgradeCancelRun(c, args, &opts)
+			return upgradeCancelRun(c, &opts)
 		},
 	}
 
@@ -69,7 +69,7 @@ func NewUpgradeCancelCmd(f *factory.Factory) *cobra.Command {
 	return upgradeCancelCmd
 }
 
-func upgradeCancelRun(cmd *cobra.Command, args []string, opts *upgradeCancelOptions) error {
+func upgradeCancelRun(cmd *cobra.Command, opts *upgradeCancelOptions) error {
 	terminal.Lock()
 	defer terminal.Unlock()
 	cfg := opts.Config

diff --git a/cmd/appliance/upgrade/complete.go b/cmd/appliance/upgrade/complete.go
@@ -414,12 +414,12 @@ func upgradeCompleteRun(cmd *cobra.Command, args []string, opts *upgradeComplete
 
 	msg := ""
 	if primaryControllerUpgradeStatus.Status == appliancepkg.UpgradeStatusReady {
-		msg, err = printCompleteSummary(opts.Out, primaryController, additionalControllers, logForwardersAndServers, chunks, skipping, toBackup, opts.backupDestination, primaryControllerPreparedVersion)
+		msg, err = printCompleteSummary(primaryController, additionalControllers, logForwardersAndServers, chunks, skipping, toBackup, opts.backupDestination, primaryControllerPreparedVersion)
 		if err != nil {
 			return err
 		}
 	} else {
-		msg, err = printCompleteSummary(opts.Out, nil, additionalControllers, logForwardersAndServers, chunks, skipping, toBackup, opts.backupDestination, primaryControllerPreparedVersion)
+		msg, err = printCompleteSummary((*openapi.Appliance)(nil), additionalControllers, logForwardersAndServers, chunks, skipping, toBackup, opts.backupDestination, primaryControllerPreparedVersion)
 		if err != nil {
 			return err
 		}
@@ -862,7 +862,7 @@ func upgradeCompleteRun(cmd *cobra.Command, args []string, opts *upgradeComplete
 	return nil
 }
 
-func printCompleteSummary(out io.Writer, primaryController *openapi.Appliance, additionalControllers, logForwardersServers []openapi.Appliance, chunks [][]openapi.Appliance, skipped []appliancepkg.SkipUpgrade, backup []openapi.Appliance, backupDestination string, toVersion *version.Version) (string, error) {
+func printCompleteSummary(primaryController *openapi.Appliance, additionalControllers, logForwardersServers []openapi.Appliance, chunks [][]openapi.Appliance, skipped []appliancepkg.SkipUpgrade, backup []openapi.Appliance, backupDestination string, toVersion *version.Version) (string, error) {
 	var (
 		completeSummaryTpl = `
 UPGRADE COMPLETE SUMMARY{{ if .Version }}
@@ -1032,7 +1032,7 @@ WARNING: Upgrade was completed, but not all appliances are running the same vers
 
 	tb := &bytes.Buffer{}
 	tp := util.NewPrinter(tb, 4)
-	tp.AddHeader("Appliance", "Upgraded to")
+	tp.AddHeader("Appliance", "Current Version")
 	for _, k := range keys {
 		tp.AddLine(k, applianceVersions[k])
 	}

diff --git a/cmd/appliance/upgrade/complete_test.go b/cmd/appliance/upgrade/complete_test.go
@@ -734,7 +734,10 @@ Appliances that will be skipped:
 			if err != nil {
 				t.Fatalf("Failed to parse toVersion %s", err)
 			}
-			res, err := printCompleteSummary(&b, tt.primaryController, tt.additionalControllers, tt.logServersForwarders, tt.chunks, tt.skipped, tt.backup, tt.backupDestination, version)
+			res, err := func() (string, error) {
+				var _ io.Writer = &b
+				return printCompleteSummary(tt.primaryController, tt.additionalControllers, tt.logServersForwarders, tt.chunks, tt.skipped, tt.backup, tt.backupDestination, version)
+			}()
 			if err != nil {
 				t.Errorf("printCompleteSummary() error - %s", err)
 			}
@@ -759,8 +762,8 @@ func TestPrintPostCompleteSummary(t *testing.T) {
 			hasDiff: false,
 			expect: `UPGRADE COMPLETE
 
-Appliance     Upgraded to
----------     -----------
+Appliance     Current Version
+---------     ---------------
 controller    6.0.0+12345
 gateway       6.0.0+12345
 
@@ -776,8 +779,8 @@ gateway       6.0.0+12345
 			hasDiff: true,
 			expect: `UPGRADE COMPLETE
 
-Appliance               Upgraded to
----------               -----------
+Appliance               Current Version
+---------               ---------------
 gateway                 6.0.0+23456
 primary-controller      6.0.0-beta+12345
 secondary-controller    6.0.0+23456

diff --git a/cmd/appliance/upgrade/prepare.go b/cmd/appliance/upgrade/prepare.go
@@ -197,7 +197,7 @@ func NewPrepareUpgradeCmd(f *factory.Factory) *cobra.Command {
 			if err := network.ValidateHostnameUniqueness(h); err != nil {
 				return err
 			}
-			return prepareRun(c, args, opts)
+			return prepareRun(c, opts)
 		},
 	}
 
@@ -224,7 +224,7 @@ func checkImageFilename(i string) error {
 	return nil
 }
 
-func prepareRun(cmd *cobra.Command, args []string, opts *prepareUpgradeOptions) error {
+func prepareRun(cmd *cobra.Command, opts *prepareUpgradeOptions) error {
 	fmt.Fprintf(opts.Out, "sdpctl_version: %s\n\n", cmd.Root().Version)
 	terminal.Lock()
 	defer terminal.Unlock()

diff --git a/cmd/appliance/upgrade/status.go b/cmd/appliance/upgrade/status.go
@@ -43,7 +43,7 @@ func NewUpgradeStatusCmd(f *factory.Factory) *cobra.Command {
 		Long:    docs.ApplianceUpgradeStatusDoc.Long,
 		Example: docs.ApplianceUpgradeStatusDoc.ExampleString(),
 		RunE: func(c *cobra.Command, args []string) error {
-			return upgradeStatusRun(c, args, &opts)
+			return upgradeStatusRun(c, &opts)
 		},
 	}
 
@@ -53,7 +53,7 @@ func NewUpgradeStatusCmd(f *factory.Factory) *cobra.Command {
 	return upgradeStatusCmd
 }
 
-func upgradeStatusRun(cmd *cobra.Command, args []string, opts *upgradeStatusOptions) error {
+func upgradeStatusRun(cmd *cobra.Command, opts *upgradeStatusOptions) error {
 	cfg := opts.Config
 	a, err := opts.Appliance(cfg)
 	if err != nil {

diff --git a/go.mod b/go.mod
@@ -8,7 +8,7 @@ require (
 	github.com/adrg/xdg v0.4.0
 	github.com/appgate/sdp-api-client-go v1.2.3
 	github.com/billgraziano/dpapi v0.5.0
-	github.com/cenkalti/backoff/v4 v4.2.1
+	github.com/cenkalti/backoff/v4 v4.3.0
 	github.com/cheynewallace/tabby v1.1.1
 	github.com/creack/pty v1.1.21
 	github.com/denisbrodbeck/machineid v1.0.1
@@ -30,10 +30,10 @@ require (
 	github.com/spf13/pflag v1.0.5
 	github.com/spf13/viper v1.18.2
 	github.com/stretchr/testify v1.9.0
-	github.com/vbauerster/mpb/v8 v8.7.2
+	github.com/vbauerster/mpb/v8 v8.6.2
 	github.com/zalando/go-keyring v0.2.4
 	golang.org/x/net v0.24.0
-	golang.org/x/sync v0.6.0
+	golang.org/x/sync v0.7.0
 	golang.org/x/sys v0.19.0
 )
 

diff --git a/go.sum b/go.sum
@@ -49,8 +49,8 @@ github.com/appgate/sdp-api-client-go v1.2.3 h1:FVGg4fnj8EekYAMdw8qVLeRrbEt/5lTCf
 github.com/appgate/sdp-api-client-go v1.2.3/go.mod h1:aPyFeh0fein8VSxFPZpEkeMi8m9dbN+I1RVO4QrONyk=
 github.com/billgraziano/dpapi v0.5.0 h1:pcxA17vyjbDqYuxCFZbgL9tYIk2xgbRZjRaIbATwh+8=
 github.com/billgraziano/dpapi v0.5.0/go.mod h1:lmEcZjRfLCSbUTsRu8V2ti6Q17MvnKn3N9gQqzDdTh0=
-github.com/cenkalti/backoff/v4 v4.2.1 h1:y4OZtCnogmCPw98Zjyt5a6+QwPLGkiQsYW5oUqylYbM=
-github.com/cenkalti/backoff/v4 v4.2.1/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE=
+github.com/cenkalti/backoff/v4 v4.3.0 h1:MyRJ/UdXutAwSAT+s3wNd7MfTIcy71VQueUuFK343L8=
+github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE=
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/cheynewallace/tabby v1.1.1 h1:JvUR8waht4Y0S3JF17G6Vhyt+FRhnqVCkk8l4YrOU54=
 github.com/cheynewallace/tabby v1.1.1/go.mod h1:Pba/6cUL8uYqvOc9RkyvFbHGrQ9wShyrn6/S/1OYVys=
@@ -245,6 +245,8 @@ github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsT
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
 github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
+github.com/vbauerster/mpb/v8 v8.6.2 h1:9EhnJGQRtvgDVCychJgR96EDCOqgg2NsMuk5JUcX4DA=
+github.com/vbauerster/mpb/v8 v8.6.2/go.mod h1:oVJ7T+dib99kZ/VBjoBaC8aPXiSAihnzuKmotuihyFo=
 github.com/vbauerster/mpb/v8 v8.7.2 h1:SMJtxhNho1MV3OuFgS1DAzhANN1Ejc5Ct+0iSaIkB14=
 github.com/vbauerster/mpb/v8 v8.7.2/go.mod h1:ZFnrjzspgDHoxYLGvxIruiNk73GNTPG4YHgVNpR10VY=
 github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
@@ -362,8 +364,8 @@ golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
 golang.org/x/sync v0.4.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
 golang.org/x/sync v0.5.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
-golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ=
-golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
+golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=

diff --git a/pkg/tui/spinner.go b/pkg/tui/spinner.go
@@ -11,7 +11,7 @@ func AddDefaultSpinner(p *mpb.Progress, name string, stage string, cmsg string,
 		mpb.BarWidth(1),
 		mpb.AppendDecorators(
 			decor.Name(name, decor.WCSyncWidthR),
-			decor.Name(":", decor.WC{W: 2, C: decor.WCSyncSpaceR.W}),
+			decor.Name(":", decor.WC{W: 2, C: decor.DidentRight}),
 			decor.OnComplete(decor.OnAbort(decor.Name(stage), ""), cmsg),
 		),
 	}