Migrate to urfave/cli/v2

coder · cmoog · Aug 10, 2020 · Jul 31, 2020 · Aug 2, 2020 · Aug 4, 2020
commit 8212be0d7b6ccb0f8c40f091875d5079afb1c4e7
diff --git a/ci/integration/secrets_test.go b/ci/integration/secrets_test.go
@@ -39,7 +39,7 @@ func TestSecrets(t *testing.T) {
 	)
 
 	// this tests the "Value:" prompt fallback
-	c.Run(ctx, fmt.Sprintf("echo %s | coder secrets create %s --from-prompt", value, name)).Assert(t,
+	c.Run(ctx, fmt.Sprintf("echo %s | coder secrets create --from-prompt %s", value, name)).Assert(t,
 		tcli.Success(),
 		tcli.StderrEmpty(),
 	)
@@ -70,7 +70,7 @@ func TestSecrets(t *testing.T) {
 
 	name, value = randString(8), randString(8)
 
-	c.Run(ctx, fmt.Sprintf("coder secrets create %s --from-literal %s", name, value)).Assert(t,
+	c.Run(ctx, fmt.Sprintf("coder secrets create --from-literal %s %s", value, name)).Assert(t,
 		tcli.Success(),
 		tcli.StderrEmpty(),
 	)
@@ -84,10 +84,7 @@ func TestSecrets(t *testing.T) {
 	c.Run(ctx, fmt.Sprintf("echo %s > ~/secret.json", value)).Assert(t,
 		tcli.Success(),
 	)
-	c.Run(ctx, fmt.Sprintf("coder secrets create %s --from-literal %s --from-file ~/secret.json", name, value)).Assert(t,
-		tcli.Error(),
-	)
-	c.Run(ctx, fmt.Sprintf("coder secrets create %s --from-file ~/secret.json", name)).Assert(t,
+	c.Run(ctx, fmt.Sprintf("coder secrets create --from-file ~/secret.json %s", name)).Assert(t,
 		tcli.Success(),
 	)
 	//

diff --git a/cmd/coder/configssh.go b/cmd/coder/configssh.go
@@ -13,30 +13,30 @@ import (
 
 	"cdr.dev/coder-cli/internal/config"
 	"cdr.dev/coder-cli/internal/entclient"
-	"github.com/urfave/cli"
+	"github.com/urfave/cli/v2"
 	"golang.org/x/xerrors"
 )
 
-func makeConfigSSHCmd() cli.Command {
+func makeConfigSSHCmd() *cli.Command {
 	var (
 		configpath string
 		remove     = false
 	)
 
-	return cli.Command{
+	return &cli.Command{
 		Name:        "config-ssh",
 		Usage:       "Configure SSH to access Coder environments",
 		Description: "Inject the proper OpenSSH configuration into your local SSH config file.",
 		Action:      configSSH(&configpath, &remove),
 		Flags: []cli.Flag{
-			cli.StringFlag{
+			&cli.StringFlag{
 				Name:        "filepath",
 				Usage:       "overide the default path of your ssh config file",
 				Value:       filepath.Join(os.Getenv("HOME"), ".ssh", "config"),
 				TakesFile:   true,
 				Destination: &configpath,
 			},
-			cli.BoolFlag{
+			&cli.BoolFlag{
 				Name:        "remove",
 				Usage:       "remove the auto-generated Coder Enterprise ssh config",
 				Destination: &remove,

diff --git a/cmd/coder/envs.go b/cmd/coder/envs.go
@@ -5,18 +5,18 @@ import (
 	"os"
 
 	"cdr.dev/coder-cli/internal/x/xtabwriter"
-	"github.com/urfave/cli"
+	"github.com/urfave/cli/v2"
 	"golang.org/x/xerrors"
 )
 
-func makeEnvsCommand() cli.Command {
+func makeEnvsCommand() *cli.Command {
 	var outputFmt string
-	return cli.Command{
+	return &cli.Command{
 		Name:        "envs",
 		Usage:       "Interact with Coder environments",
 		Description: "Perform operations on the Coder environments owned by the active user.",
 		Action:      exitHelp,
-		Subcommands: []cli.Command{
+		Subcommands: []*cli.Command{
 			{
 				Name:        "ls",
 				Usage:       "list all environments owned by the active user",
@@ -48,8 +48,9 @@ func makeEnvsCommand() cli.Command {
 					return nil
 				},
 				Flags: []cli.Flag{
-					cli.StringFlag{
+					&cli.StringFlag{
 						Name:        "output",
+						Aliases:     []string{"o"},
 						Usage:       "json | human",
 						Value:       "human",
 						Destination: &outputFmt,

diff --git a/cmd/coder/login.go b/cmd/coder/login.go
@@ -10,14 +10,14 @@ import (
 	"cdr.dev/coder-cli/internal/config"
 	"cdr.dev/coder-cli/internal/loginsrv"
 	"github.com/pkg/browser"
-	"github.com/urfave/cli"
+	"github.com/urfave/cli/v2"
 	"golang.org/x/xerrors"
 
 	"go.coder.com/flog"
 )
 
-func makeLoginCmd() cli.Command {
-	return cli.Command{
+func makeLoginCmd() *cli.Command {
+	return &cli.Command{
 		Name:      "login",
 		Usage:     "Authenticate this client for future operations",
 		ArgsUsage: "[Coder Enterprise URL eg. http://my.coder.domain/]",

diff --git a/cmd/coder/logout.go b/cmd/coder/logout.go
@@ -4,14 +4,14 @@ import (
 	"os"
 
 	"cdr.dev/coder-cli/internal/config"
-	"github.com/urfave/cli"
+	"github.com/urfave/cli/v2"
 	"golang.org/x/xerrors"
 
 	"go.coder.com/flog"
 )
 
-func makeLogoutCmd() cli.Command {
-	return cli.Command{
+func makeLogoutCmd() *cli.Command {
+	return &cli.Command{
 		Name:   "logout",
 		Usage:  "Remove local authentication credentials if any exist",
 		Action: logout,

diff --git a/cmd/coder/main.go b/cmd/coder/main.go
@@ -9,7 +9,7 @@ import (
 	"runtime"
 
 	"cdr.dev/coder-cli/internal/x/xterminal"
-	"github.com/urfave/cli"
+	"github.com/urfave/cli/v2"
 
 	"go.coder.com/flog"
 )
@@ -35,14 +35,12 @@ func main() {
 	app.Name = "coder"
 	app.Usage = "coder provides a CLI for working with an existing Coder Enterprise installation"
 	app.Version = fmt.Sprintf("%s %s %s/%s", version, runtime.Version(), runtime.GOOS, runtime.GOARCH)
-	app.Author = "Coder Technologies Inc."
 	app.CommandNotFound = func(c *cli.Context, s string) {
 		flog.Fatal("command %q not found", s)
 	}
-	app.Email = "support@coder.com"
 	app.Action = exitHelp
 
-	app.Commands = []cli.Command{
+	app.Commands = []*cli.Command{
 		makeLoginCmd(),
 		makeLogoutCmd(),
 		makeShellCmd(),
@@ -59,6 +57,7 @@ func main() {
 	}
 }
 
-func exitHelp(c *cli.Context) {
+func exitHelp(c *cli.Context) error {
 	cli.ShowCommandHelpAndExit(c, c.Command.FullName(), 1)
+	return nil
 }
diff --git a/cmd/coder/secrets.go b/cmd/coder/secrets.go
@@ -8,19 +8,19 @@ import (
 	"cdr.dev/coder-cli/internal/entclient"
 	"cdr.dev/coder-cli/internal/x/xtabwriter"
 	"github.com/manifoldco/promptui"
-	"github.com/urfave/cli"
+	"github.com/urfave/cli/v2"
 	"golang.org/x/xerrors"
 
 	"go.coder.com/flog"
 )
 
-func makeSecretsCmd() cli.Command {
-	return cli.Command{
+func makeSecretsCmd() *cli.Command {
+	return &cli.Command{
 		Name:        "secrets",
 		Usage:       "Interact with Coder Secrets",
 		Description: "Interact with secrets objects owned by the active user.",
 		Action:      exitHelp,
-		Subcommands: []cli.Command{
+		Subcommands: []*cli.Command{
 			{
 				Name:   "ls",
 				Usage:  "List all secrets owned by the active user",
@@ -43,15 +43,15 @@ func makeSecretsCmd() cli.Command {
 	}
 }
 
-func makeCreateSecret() cli.Command {
+func makeCreateSecret() *cli.Command {
 	var (
 		fromFile    string
 		fromLiteral string
 		fromPrompt  bool
 		description string
 	)
 
-	return cli.Command{
+	return &cli.Command{
 		Name:        "create",
 		Usage:       "Create a new secret",
 		Description: "Create a new secret object to store application secrets and access them securely from within your environments.",
@@ -114,23 +114,23 @@ func makeCreateSecret() cli.Command {
 			return nil
 		},
 		Flags: []cli.Flag{
-			cli.StringFlag{
+			&cli.StringFlag{
 				Name:        "from-file",
 				Usage:       "a file from which to read the value of the secret",
 				TakesFile:   true,
 				Destination: &fromFile,
 			},
-			cli.StringFlag{
+			&cli.StringFlag{
 				Name:        "from-literal",
 				Usage:       "the value of the secret",
 				Destination: &fromLiteral,
 			},
-			cli.BoolFlag{
+			&cli.BoolFlag{
 				Name:        "from-prompt",
 				Usage:       "enter the secret value through a terminal prompt",
 				Destination: &fromPrompt,
 			},
-			cli.StringFlag{
+			&cli.StringFlag{
 				Name:        "description",
 				Usage:       "a description of the secret",
 				Destination: &description,
@@ -197,10 +197,10 @@ func removeSecrets(c *cli.Context) error {
 	for _, n := range names {
 		err := client.DeleteSecretByName(n)
 		if err != nil {
-			flog.Error("Failed to delete secret: %v", err)
+			flog.Error("failed to delete secret %q: %v", n, err)
 			errorSeen = true
 		} else {
-			flog.Info("Successfully deleted secret %q", n)
+			flog.Success("successfully deleted secret %q", n)
 		}
 	}
 	if errorSeen {

diff --git a/cmd/coder/shell.go b/cmd/coder/shell.go
@@ -10,7 +10,7 @@ import (
 	"cdr.dev/coder-cli/internal/activity"
 	"cdr.dev/coder-cli/internal/x/xterminal"
 	"cdr.dev/wsep"
-	"github.com/urfave/cli"
+	"github.com/urfave/cli/v2"
 	"golang.org/x/crypto/ssh/terminal"
 	"golang.org/x/time/rate"
 	"golang.org/x/xerrors"
@@ -19,14 +19,13 @@ import (
 	"go.coder.com/flog"
 )
 
-func makeShellCmd() cli.Command {
-	return cli.Command{
+func makeShellCmd() *cli.Command {
+	return &cli.Command{
 		Name:            "sh",
 		Usage:           "Open a shell and execute commands in a Coder environment",
 		Description:     "Execute a remote command on the environment\\nIf no command is specified, the default shell is opened.",
 		ArgsUsage:       "[env_name] [<command [args...]>]",
 		SkipFlagParsing: true,
-		SkipArgReorder:  true,
 		Before: func(c *cli.Context) error {
 			if c.Args().First() == "" {
 				return xerrors.New("argument [env_name] is required")

diff --git a/cmd/coder/sync.go b/cmd/coder/sync.go
@@ -9,15 +9,15 @@ import (
 	"strings"
 
 	"cdr.dev/coder-cli/internal/sync"
-	"github.com/urfave/cli"
+	"github.com/urfave/cli/v2"
 	"golang.org/x/xerrors"
 
 	"go.coder.com/flog"
 )
 
-func makeSyncCmd() cli.Command {
+func makeSyncCmd() *cli.Command {
 	var init bool
-	return cli.Command{
+	return &cli.Command{
 		Name:      "sync",
 		Usage:     "Establish a one way directory sync to a Coder environment",
 		ArgsUsage: "[local directory] [<env name>:<remote directory>]",
@@ -29,7 +29,7 @@ func makeSyncCmd() cli.Command {
 		},
 		Action: makeRunSync(&init),
 		Flags: []cli.Flag{
-			cli.BoolFlag{
+			&cli.BoolFlag{
 				Name:        "init",
 				Usage:       "do initial transfer and exit",
 				Destination: &init,

diff --git a/cmd/coder/urls.go b/cmd/coder/urls.go
@@ -10,19 +10,19 @@ import (
 	"strings"
 
 	"cdr.dev/coder-cli/internal/x/xtabwriter"
-	"github.com/urfave/cli"
+	"github.com/urfave/cli/v2"
 	"golang.org/x/xerrors"
 
 	"go.coder.com/flog"
 )
 
-func makeURLCmd() cli.Command {
+func makeURLCmd() *cli.Command {
 	var outputFmt string
-	return cli.Command{
+	return &cli.Command{
 		Name:   "urls",
 		Usage:  "Interact with environment DevURLs",
 		Action: exitHelp,
-		Subcommands: []cli.Command{
+		Subcommands: []*cli.Command{
 			makeCreateDevURL(),
 			{
 				Name:      "ls",
@@ -39,8 +39,9 @@ func makeURLCmd() cli.Command {
 				},
 				Action: makeListDevURLs(&outputFmt),
 				Flags: []cli.Flag{
-					cli.StringFlag{
+					&cli.StringFlag{
 						Name:        "output",
+						Aliases:     []string{"o"},
 						Usage:       "human | json",
 						Value:       "human",
 						Destination: &outputFmt,
@@ -137,12 +138,12 @@ func makeListDevURLs(outputFmt *string) func(c *cli.Context) error {
 	}
 }
 
-func makeCreateDevURL() cli.Command {
+func makeCreateDevURL() *cli.Command {
 	var (
 		access  string
 		urlname string
 	)
-	return cli.Command{
+	return &cli.Command{
 		Name:      "create",
 		Usage:     "Create a new devurl for an environment",
 		ArgsUsage: "[env_name] [port] [--access <level>] [--name <name>]",
@@ -154,13 +155,13 @@ func makeCreateDevURL() cli.Command {
 			return nil
 		},
 		Flags: []cli.Flag{
-			cli.StringFlag{
+			&cli.StringFlag{
 				Name:        "access",
 				Usage:       "Set DevURL access to [private | org | authed | public]",
 				Value:       "private",
 				Destination: &access,
 			},
-			cli.StringFlag{
+			&cli.StringFlag{
 				Name:        "name",
 				Usage:       "DevURL name",
 				Required:    true,