Merge pull request #12969 from ptabor/20210514-etcdctl-step-by-step

Refactor common code from etcdctl (v2,v3) to pkg/corbautl.

etcdctl/ctlv2/command/cluster_health.go

@@ -25,6 +25,7 @@ import (
 	"time"
 
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 
 	"github.com/urfave/cli"
 )
@@ -55,7 +56,7 @@ func handleClusterHealth(c *cli.Context) error {
 
 	tr, err := getTransport(c)
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 
 	hc := http.Client{
@@ -67,7 +68,7 @@ func handleClusterHealth(c *cli.Context) error {
 	ms, err := mi.List(context.TODO())
 	if err != nil {
 		fmt.Println("cluster may be unhealthy: failed to list members")
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 
 	for {
@@ -128,9 +129,9 @@ func handleClusterHealth(c *cli.Context) error {
 
 		if !forever {
 			if healthyMembers == len(ms) {
-				os.Exit(ExitSuccess)
+				os.Exit(cobrautl.ExitSuccess)
 			}
-			os.Exit(ExitClusterNotHealthy)
+			os.Exit(cobrautl.ExitClusterNotHealthy)
 		}
 
 		fmt.Printf("\nnext check after 10 second...\n\n")

etcdctl/ctlv2/command/error.go

@@ -23,15 +23,6 @@ import (
 	"go.etcd.io/etcd/client/v2"
 )
 
-const (
-	ExitSuccess = iota
-	ExitBadArgs
-	ExitBadConnection
-	ExitBadAuth
-	ExitServerError
-	ExitClusterNotHealthy
-)
-
 func handleError(c *cli.Context, code int, err error) {
 	if c.GlobalString("output") == "json" {
 		if err, ok := err.(*client.Error); ok {

etcdctl/ctlv2/command/exec_watch_command.go

@@ -23,6 +23,7 @@ import (
 	"os/signal"
 
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 
 	"github.com/urfave/cli"
 )
@@ -50,7 +51,7 @@ func execWatchCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	argslen := len(args)
 
 	if argslen < 2 {
-		handleError(c, ExitBadArgs, errors.New("key and command to exec required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key and command to exec required"))
 	}
 
 	var (
@@ -93,7 +94,7 @@ func execWatchCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	for {
 		resp, err := w.Next(context.TODO())
 		if err != nil {
-			handleError(c, ExitServerError, err)
+			handleError(c, cobrautl.ExitServerError, err)
 		}
 		if resp.Node.Dir {
 			fmt.Fprintf(os.Stderr, "Ignored dir %s change\n", resp.Node.Key)

etcdctl/ctlv2/command/get_command.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/urfave/cli"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 )
 
 // NewGetCommand returns the CLI command for "get".
@@ -43,7 +44,7 @@ func NewGetCommand() cli.Command {
 // getCommandFunc executes the "get" command.
 func getCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	if len(c.Args()) == 0 {
-		handleError(c, ExitBadArgs, errors.New("key required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key required"))
 	}
 
 	key := c.Args()[0]
@@ -54,7 +55,7 @@ func getCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	resp, err := ki.Get(ctx, key, &client.GetOptions{Sort: sorted, Quorum: quorum})
 	cancel()
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 
 	if resp.Node.Dir {

etcdctl/ctlv2/command/ls_command.go

@@ -19,6 +19,7 @@ import (
 
 	"github.com/urfave/cli"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 )
 
 func NewLsCommand() cli.Command {
@@ -54,7 +55,7 @@ func lsCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	resp, err := ki.Get(ctx, key, &client.GetOptions{Sort: sort, Recursive: recursive, Quorum: quorum})
 	cancel()
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 
 	printLs(c, resp)

etcdctl/ctlv2/command/mk_command.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/urfave/cli"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 )
 
 // NewMakeCommand returns the CLI command for "mk".
@@ -43,12 +44,12 @@ func NewMakeCommand() cli.Command {
 // mkCommandFunc executes the "mk" command.
 func mkCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	if len(c.Args()) == 0 {
-		handleError(c, ExitBadArgs, errors.New("key required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key required"))
 	}
 	key := c.Args()[0]
 	value, err := argOrStdin(c.Args(), os.Stdin, 1)
 	if err != nil {
-		handleError(c, ExitBadArgs, errors.New("value required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("value required"))
 	}
 
 	ttl := c.Int("ttl")
@@ -69,7 +70,7 @@ func mkCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	}
 	cancel()
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 
 	printResponseKey(resp, c.GlobalString("output"))

etcdctl/ctlv2/command/mkdir_command.go

@@ -20,6 +20,7 @@ import (
 
 	"github.com/urfave/cli"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 )
 
 // NewMakeDirCommand returns the CLI command for "mkdir".
@@ -41,7 +42,7 @@ func NewMakeDirCommand() cli.Command {
 // mkdirCommandFunc executes the "mkdir" command.
 func mkdirCommandFunc(c *cli.Context, ki client.KeysAPI, prevExist client.PrevExistType) {
 	if len(c.Args()) == 0 {
-		handleError(c, ExitBadArgs, errors.New("key required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key required"))
 	}
 
 	key := c.Args()[0]
@@ -51,7 +52,7 @@ func mkdirCommandFunc(c *cli.Context, ki client.KeysAPI, prevExist client.PrevEx
 	resp, err := ki.Set(ctx, key, "", &client.SetOptions{TTL: time.Duration(ttl) * time.Second, Dir: true, PrevExist: prevExist})
 	cancel()
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 	if c.GlobalString("output") != "simple" {
 		printResponseKey(resp, c.GlobalString("output"))

etcdctl/ctlv2/command/rm_command.go

@@ -19,6 +19,7 @@ import (
 
 	"github.com/urfave/cli"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 )
 
 // NewRemoveCommand returns the CLI command for "rm".
@@ -43,7 +44,7 @@ func NewRemoveCommand() cli.Command {
 // rmCommandFunc executes the "rm" command.
 func rmCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	if len(c.Args()) == 0 {
-		handleError(c, ExitBadArgs, errors.New("key required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key required"))
 	}
 	key := c.Args()[0]
 	recursive := c.Bool("recursive")
@@ -55,7 +56,7 @@ func rmCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	resp, err := ki.Delete(ctx, key, &client.DeleteOptions{PrevIndex: uint64(prevIndex), PrevValue: prevValue, Dir: dir, Recursive: recursive})
 	cancel()
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 	if !resp.Node.Dir || c.GlobalString("output") != "simple" {
 		printResponseKey(resp, c.GlobalString("output"))

etcdctl/ctlv2/command/rmdir_command.go

@@ -19,6 +19,7 @@ import (
 
 	"github.com/urfave/cli"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 )
 
 // NewRemoveDirCommand returns the CLI command for "rmdir".
@@ -37,15 +38,15 @@ func NewRemoveDirCommand() cli.Command {
 // rmdirCommandFunc executes the "rmdir" command.
 func rmdirCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	if len(c.Args()) == 0 {
-		handleError(c, ExitBadArgs, errors.New("key required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key required"))
 	}
 	key := c.Args()[0]
 
 	ctx, cancel := contextWithTotalTimeout(c)
 	resp, err := ki.Delete(ctx, key, &client.DeleteOptions{Dir: true})
 	cancel()
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 
 	if !resp.Node.Dir || c.GlobalString("output") != "simple" {

etcdctl/ctlv2/command/set_command.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/urfave/cli"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 )
 
 // NewSetCommand returns the CLI command for "set".
@@ -50,12 +51,12 @@ func NewSetCommand() cli.Command {
 // setCommandFunc executes the "set" command.
 func setCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	if len(c.Args()) == 0 {
-		handleError(c, ExitBadArgs, errors.New("key required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key required"))
 	}
 	key := c.Args()[0]
 	value, err := argOrStdin(c.Args(), os.Stdin, 1)
 	if err != nil {
-		handleError(c, ExitBadArgs, errors.New("value required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("value required"))
 	}
 
 	ttl := c.Int("ttl")
@@ -66,7 +67,7 @@ func setCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	resp, err := ki.Set(ctx, key, value, &client.SetOptions{TTL: time.Duration(ttl) * time.Second, PrevIndex: uint64(prevIndex), PrevValue: prevValue})
 	cancel()
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 
 	printResponseKey(resp, c.GlobalString("output"))

etcdctl/ctlv2/command/update_command.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/urfave/cli"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 )
 
 // NewUpdateCommand returns the CLI command for "update".
@@ -42,12 +43,12 @@ func NewUpdateCommand() cli.Command {
 // updateCommandFunc executes the "update" command.
 func updateCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	if len(c.Args()) == 0 {
-		handleError(c, ExitBadArgs, errors.New("key required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key required"))
 	}
 	key := c.Args()[0]
 	value, err := argOrStdin(c.Args(), os.Stdin, 1)
 	if err != nil {
-		handleError(c, ExitBadArgs, errors.New("value required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("value required"))
 	}
 
 	ttl := c.Int("ttl")
@@ -56,7 +57,7 @@ func updateCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	resp, err := ki.Set(ctx, key, value, &client.SetOptions{TTL: time.Duration(ttl) * time.Second, PrevExist: client.PrevExist})
 	cancel()
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 
 	printResponseKey(resp, c.GlobalString("output"))

etcdctl/ctlv2/command/update_dir_command.go

@@ -20,6 +20,7 @@ import (
 
 	"github.com/urfave/cli"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 )
 
 // NewUpdateDirCommand returns the CLI command for "updatedir".
@@ -41,15 +42,15 @@ func NewUpdateDirCommand() cli.Command {
 // updatedirCommandFunc executes the "updatedir" command.
 func updatedirCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	if len(c.Args()) == 0 {
-		handleError(c, ExitBadArgs, errors.New("key required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key required"))
 	}
 	key := c.Args()[0]
 	ttl := c.Int("ttl")
 	ctx, cancel := contextWithTotalTimeout(c)
 	resp, err := ki.Set(ctx, key, "", &client.SetOptions{TTL: time.Duration(ttl) * time.Second, Dir: true, PrevExist: client.PrevExist})
 	cancel()
 	if err != nil {
-		handleError(c, ExitServerError, err)
+		handleError(c, cobrautl.ExitServerError, err)
 	}
 	if c.GlobalString("output") != "simple" {
 		printResponseKey(resp, c.GlobalString("output"))

etcdctl/ctlv2/command/util.go

@@ -30,6 +30,7 @@ import (
 
 	"go.etcd.io/etcd/client/pkg/v3/transport"
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 
 	"github.com/bgentry/speakeasy"
 	"github.com/urfave/cli"
@@ -242,10 +243,10 @@ func mustNewClient(c *cli.Context) client.Client {
 			if err == client.ErrNoEndpoints {
 				fmt.Fprintf(os.Stderr, "etcd cluster has no published client endpoints.\n")
 				fmt.Fprintf(os.Stderr, "Try '--no-sync' if you want to access non-published client endpoints(%s).\n", strings.Join(hc.Endpoints(), ","))
-				handleError(c, ExitServerError, err)
+				handleError(c, cobrautl.ExitServerError, err)
 			}
 			if isConnectionError(err) {
-				handleError(c, ExitBadConnection, err)
+				handleError(c, cobrautl.ExitBadConnection, err)
 			}
 		}
 		if debug {

etcdctl/ctlv2/command/watch_command.go

@@ -22,6 +22,7 @@ import (
 	"os/signal"
 
 	"go.etcd.io/etcd/client/v2"
+	"go.etcd.io/etcd/pkg/v3/cobrautl"
 
 	"github.com/urfave/cli"
 )
@@ -47,7 +48,7 @@ func NewWatchCommand() cli.Command {
 // watchCommandFunc executes the "watch" command.
 func watchCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	if len(c.Args()) == 0 {
-		handleError(c, ExitBadArgs, errors.New("key required"))
+		handleError(c, cobrautl.ExitBadArgs, errors.New("key required"))
 	}
 	key := c.Args()[0]
 	recursive := c.Bool("recursive")
@@ -68,7 +69,7 @@ func watchCommandFunc(c *cli.Context, ki client.KeysAPI) {
 	for !stop {
 		resp, err := w.Next(context.TODO())
 		if err != nil {
-			handleError(c, ExitServerError, err)
+			handleError(c, cobrautl.ExitServerError, err)
 		}
 		if resp.Node.Dir {
 			continue