chore: Backfill args usage on recent commands (#553)

* go mod tidy * update api commands * update auth commands * update bounce commands * update bundle commands * update clone commands * update cd commands * update config commands * update crypto commands * update deploy commands * update destroy commands * update more commands * update more commands * update more commands * update more commands * update cluster args * update service args * update service args * fix unit tests
pluralsh · Oct 2, 2024 · 1807416 · 1807416
1 parent ab38cc9
commit 1807416
Show file tree

Hide file tree

Showing 38 changed files with 179 additions and 194 deletions.
diff --git a/cmd/command/api/api.go b/cmd/command/api/api.go
@@ -32,48 +32,47 @@ func (p *Plural) apiCommands() []cli.Command {
 			Usage: "lists plural resources",
 			Subcommands: []cli.Command{
 				{
-					Name:      "installations",
-					Usage:     "lists your installations",
-					ArgsUsage: "",
-					Action:    common.LatestVersion(p.handleInstallations),
+					Name:   "installations",
+					Usage:  "lists your installations",
+					Action: common.LatestVersion(p.handleInstallations),
 				},
 				{
 					Name:      "charts",
 					Usage:     "lists charts for a repository",
-					ArgsUsage: "REPO_ID",
-					Action:    common.LatestVersion(common.RequireArgs(p.handleCharts, []string{"REPO_ID"})),
+					ArgsUsage: "{repository-id}",
+					Action:    common.LatestVersion(common.RequireArgs(p.handleCharts, []string{"{repository-id}"})),
 				},
 				{
 					Name:      "terraform",
 					Usage:     "lists terraform modules for a repository",
-					ArgsUsage: "REPO_ID",
-					Action:    common.LatestVersion(common.RequireArgs(p.handleTerraforma, []string{"REPO_ID"})),
+					ArgsUsage: "{repository-id}",
+					Action:    common.LatestVersion(common.RequireArgs(p.handleTerraforma, []string{"{repository-id}"})),
 				},
 				{
 					Name:      "versions",
 					Usage:     "lists versions of a chart",
-					ArgsUsage: "CHART_ID",
-					Action:    common.LatestVersion(common.RequireArgs(p.handleVersions, []string{"CHART_ID"})),
+					ArgsUsage: "{chart-id}",
+					Action:    common.LatestVersion(common.RequireArgs(p.handleVersions, []string{"{chart-id}"})),
 				},
 				{
 					Name:      "chartinstallations",
 					Aliases:   []string{"ci"},
 					Usage:     "lists chart installations for a repository",
-					ArgsUsage: "REPO_ID",
-					Action:    common.LatestVersion(common.RequireArgs(p.handleChartInstallations, []string{"REPO_ID"})),
+					ArgsUsage: "{repository-id}",
+					Action:    common.LatestVersion(common.RequireArgs(p.handleChartInstallations, []string{"{repository-id}"})),
 				},
 				{
 					Name:      "terraforminstallations",
 					Aliases:   []string{"ti"},
 					Usage:     "lists terraform installations for a repository",
-					ArgsUsage: "REPO_ID",
-					Action:    common.LatestVersion(common.RequireArgs(p.handleTerraformInstallations, []string{"REPO_ID"})),
+					ArgsUsage: "{repository-id}",
+					Action:    common.LatestVersion(common.RequireArgs(p.handleTerraformInstallations, []string{"{repository-id}"})),
 				},
 				{
 					Name:      "artifacts",
 					Usage:     "Lists artifacts for a repository",
-					ArgsUsage: "REPO_ID",
-					Action:    common.LatestVersion(common.RequireArgs(p.handleArtifacts, []string{"REPO_ID"})),
+					ArgsUsage: "{repository-id}",
+					Action:    common.LatestVersion(common.RequireArgs(p.handleArtifacts, []string{"{repository-id}"})),
 				},
 			},
 		},
@@ -84,8 +83,8 @@ func (p *Plural) apiCommands() []cli.Command {
 				{
 					Name:      "domain",
 					Usage:     "creates a new domain for your account",
-					ArgsUsage: "DOMAIN",
-					Action:    common.LatestVersion(p.handleCreateDomain),
+					ArgsUsage: "{domain}",
+					Action:    common.LatestVersion(common.RequireArgs(p.handleCreateDomain, []string{"{domain}"})),
 				},
 			},
 		},

diff --git a/cmd/command/api/api_test.go b/cmd/command/api/api_test.go
@@ -39,9 +39,9 @@ func TestListArtifacts(t *testing.T) {
 `,
 		},
 		{
-			name:          `test "api list artifacts" without REPO_ID parameter`,
+			name:          `test "api list artifacts" without {repository-id} parameter`,
 			args:          []string{plural.ApplicationName, "api", "list", "artifacts"},
-			expectedError: "Not enough arguments provided: needs REPO_ID. Try running --help to see usage.",
+			expectedError: "Not enough arguments provided: needs {repository-id}. Try running --help to see usage.",
 			artifacts:     []api.Artifact{},
 		},
 	}
@@ -154,10 +154,10 @@ func TestGetCharts(t *testing.T) {
 `,
 		},
 		{
-			name:          `test "api list charts" without REPO_ID parameter`,
+			name:          `test "api list charts" without {repository-id} parameter`,
 			args:          []string{plural.ApplicationName, "api", "list", "charts"},
 			charts:        []*api.Chart{},
-			expectedError: "Not enough arguments provided: needs REPO_ID. Try running --help to see usage.",
+			expectedError: "Not enough arguments provided: needs {repository-id}. Try running --help to see usage.",
 		},
 	}
 	for _, test := range tests {
@@ -214,10 +214,10 @@ func TestGetTerraform(t *testing.T) {
 `,
 		},
 		{
-			name:          `test "api list terraform" without REPO_ID parameter`,
+			name:          `test "api list terraform" without {repository-id} parameter`,
 			args:          []string{plural.ApplicationName, "api", "list", "terraform"},
 			terraform:     []*api.Terraform{},
-			expectedError: "Not enough arguments provided: needs REPO_ID. Try running --help to see usage.",
+			expectedError: "Not enough arguments provided: needs {repository-id}. Try running --help to see usage.",
 		},
 	}
 	for _, test := range tests {
@@ -273,10 +273,10 @@ func TestGetVersons(t *testing.T) {
 `,
 		},
 		{
-			name:          `test "api list versions" without CHART_ID parameter`,
+			name:          `test "api list versions" without {chart-id} parameter`,
 			args:          []string{plural.ApplicationName, "api", "list", "versions"},
 			versions:      []*api.Version{},
-			expectedError: "Not enough arguments provided: needs CHART_ID. Try running --help to see usage.",
+			expectedError: "Not enough arguments provided: needs {chart-id}. Try running --help to see usage.",
 		},
 	}
 	for _, test := range tests {
@@ -343,10 +343,10 @@ func TestGetChartInstallations(t *testing.T) {
 `,
 		},
 		{
-			name:               `test "api list chartinstallations" without REPO_ID parameter`,
+			name:               `test "api list chartinstallations" without {repository-id} parameter`,
 			args:               []string{plural.ApplicationName, "api", "list", "chartinstallations"},
 			chartInstallations: []*api.ChartInstallation{},
-			expectedError:      "Not enough arguments provided: needs REPO_ID. Try running --help to see usage.",
+			expectedError:      "Not enough arguments provided: needs {repository-id}. Try running --help to see usage.",
 		},
 	}
 	for _, test := range tests {
@@ -407,10 +407,10 @@ func TestGetTerraformInstallations(t *testing.T) {
 `,
 		},
 		{
-			name:                   `test "api list terraforminstallations" without REPO_ID parameter`,
+			name:                   `test "api list terraforminstallations" without {repository-id} parameter`,
 			args:                   []string{plural.ApplicationName, "api", "list", "terraforminstallations"},
 			terraformInstallations: []*api.TerraformInstallation{},
-			expectedError:          "Not enough arguments provided: needs REPO_ID. Try running --help to see usage.",
+			expectedError:          "Not enough arguments provided: needs {repository-id}. Try running --help to see usage.",
 		},
 	}
 	for _, test := range tests {

diff --git a/cmd/command/auth/auth.go b/cmd/command/auth/auth.go
@@ -6,6 +6,7 @@ import (
 
 	"github.com/pluralsh/gqlclient"
 	"github.com/pluralsh/plural-cli/pkg/client"
+	"github.com/pluralsh/plural-cli/pkg/common"
 	"github.com/pluralsh/plural-cli/pkg/config"
 	"github.com/pluralsh/plural-cli/pkg/utils"
 	"github.com/urfave/cli"
@@ -30,7 +31,7 @@ func (p *Plural) authCommands() []cli.Command {
 	return []cli.Command{
 		{
 			Name:      "oidc",
-			ArgsUsage: "PROVIDER",
+			ArgsUsage: "{provider}",
 			Usage:     "logs in using an exchange from a given oidc id token",
 			Flags: []cli.Flag{
 				cli.StringFlag{
@@ -42,7 +43,7 @@ func (p *Plural) authCommands() []cli.Command {
 					Usage: "the plural email you want to log in as",
 				},
 			},
-			Action: p.handleOidcToken,
+			Action: common.RequireArgs(p.handleOidcToken, []string{"{provider}"}),
 		},
 		{
 			Name:        "trust",
@@ -75,9 +76,9 @@ func (p *Plural) trustCommands() []cli.Command {
 		},
 		{
 			Name:      "delete",
-			ArgsUsage: "ID",
+			ArgsUsage: "{id}",
 			Usage:     "deletes an existing oidc trust relationship by id",
-			Action:    p.handleDeleteTrust,
+			Action:    common.RequireArgs(p.handleDeleteTrust, []string{"{id}"}),
 		},
 	}
 }

diff --git a/cmd/command/bounce/bounce.go b/cmd/command/bounce/bounce.go
@@ -27,8 +27,8 @@ func Command(clients client.Plural) cli.Command {
 		Name:      "bounce",
 		Aliases:   []string{"b"},
 		Usage:     "redeploys the charts in a workspace",
-		ArgsUsage: "APP",
-		Action:    common.LatestVersion(common.InitKubeconfig(common.Owned(p.bounce))),
+		ArgsUsage: "{app}",
+		Action:    common.LatestVersion(common.RequireArgs(common.InitKubeconfig(common.Owned(p.bounce)), []string{"{app}"})),
 	}
 }
 

diff --git a/cmd/command/bundle/bundle.go b/cmd/command/bundle/bundle.go
@@ -33,13 +33,13 @@ func (p *Plural) bundleCommands() []cli.Command {
 		{
 			Name:      "list",
 			Usage:     "lists bundles for a repository",
-			ArgsUsage: "REPO",
-			Action:    common.LatestVersion(common.Rooted(common.RequireArgs(p.bundleList, []string{"repo"}))),
+			ArgsUsage: "{repo}",
+			Action:    common.LatestVersion(common.Rooted(common.RequireArgs(p.bundleList, []string{"{repo}"}))),
 		},
 		{
 			Name:      "install",
 			Usage:     "installs a bundle and writes the configuration to this installation's context",
-			ArgsUsage: "REPO NAME",
+			ArgsUsage: "{repo} {bundle}",
 			Flags: []cli.Flag{
 				cli.BoolFlag{
 					Name:  "refresh",

diff --git a/cmd/command/cd/cd.go b/cmd/command/cd/cd.go
@@ -115,11 +115,10 @@ func Commands(clients client.Plural, helmConfiguration *action.Configuration) []
 		},
 		{
 			Name:      "eject",
-			Action:    p.handleEject,
+			Action:    common.RequireArgs(p.handleEject, []string{"{cluster-id}"}),
 			Usage:     "ejects cluster scaffolds",
-			ArgsUsage: "<cluster-id>",
-			// TODO: enable once logic is finished
-			Hidden: true,
+			ArgsUsage: "{cluster-id}",
+			Hidden:    true, // TODO: enable once logic is finished
 		},
 	}
 }
@@ -287,10 +286,6 @@ func (p *Plural) handlePrintControlPlaneValues(c *cli.Context) error {
 }
 
 func (p *Plural) handleEject(c *cli.Context) (err error) {
-	if !c.Args().Present() {
-		return fmt.Errorf("clusterid cannot be empty")
-	}
-
 	if err := p.InitConsoleClient(consoleToken, consoleURL); err != nil {
 		return err
 	}

diff --git a/cmd/command/cd/cd_clusters.go b/cmd/command/cd/cd_clusters.go
@@ -45,18 +45,16 @@ func (p *Plural) cdClusterCommands() []cli.Command {
 		},
 		{
 			Name:      "describe",
-			Action:    common.LatestVersion(common.RequireArgs(p.handleDescribeCluster, []string{"CLUSTER_ID"})),
+			Action:    common.LatestVersion(common.RequireArgs(p.handleDescribeCluster, []string{"@{cluster-handle}"})),
 			Usage:     "describe cluster",
-			ArgsUsage: "CLUSTER_ID",
-			Flags: []cli.Flag{
-				cli.StringFlag{Name: "o", Usage: "output format"},
-			},
+			ArgsUsage: "@{cluster-handle}",
+			Flags:     []cli.Flag{cli.StringFlag{Name: "o", Usage: "output format"}},
 		},
 		{
 			Name:      "update",
-			Action:    common.LatestVersion(common.RequireArgs(p.handleUpdateCluster, []string{"CLUSTER_ID"})),
+			Action:    common.LatestVersion(common.RequireArgs(p.handleUpdateCluster, []string{"@{cluster-handle}"})),
 			Usage:     "update cluster",
-			ArgsUsage: "CLUSTER_ID",
+			ArgsUsage: "@{cluster-handle}",
 			Flags: []cli.Flag{
 				cli.StringFlag{Name: "handle", Usage: "unique human readable name used to identify this cluster"},
 				cli.StringFlag{Name: "kubeconf-path", Usage: "path to kubeconfig"},
@@ -65,9 +63,9 @@ func (p *Plural) cdClusterCommands() []cli.Command {
 		},
 		{
 			Name:      "delete",
-			Action:    common.LatestVersion(common.RequireArgs(p.handleDeleteCluster, []string{"CLUSTER_ID"})),
+			Action:    common.LatestVersion(common.RequireArgs(p.handleDeleteCluster, []string{"@{cluster-handle}"})),
 			Usage:     "deregisters a cluster in plural cd, and drains all services (unless --soft is specified)",
-			ArgsUsage: "CLUSTER_ID",
+			ArgsUsage: "@{cluster-handle}",
 			Flags: []cli.Flag{
 				cli.BoolFlag{
 					Name:  "soft",
@@ -78,15 +76,15 @@ func (p *Plural) cdClusterCommands() []cli.Command {
 		{
 			Name:      "get-credentials",
 			Aliases:   []string{"kubeconfig"},
-			Action:    common.LatestVersion(common.RequireArgs(p.handleGetClusterCredentials, []string{"CLUSTER_ID"})),
+			Action:    common.LatestVersion(common.RequireArgs(p.handleGetClusterCredentials, []string{"@{cluster-handle}"})),
 			Usage:     "updates kubeconfig file with appropriate credentials to point to specified cluster",
-			ArgsUsage: "CLUSTER_ID",
+			ArgsUsage: "@{cluster-handle}",
 		},
 		{
 			Name:      "create",
-			Action:    common.LatestVersion(common.RequireArgs(p.handleCreateCluster, []string{"CLUSTER_NAME"})),
+			Action:    common.LatestVersion(common.RequireArgs(p.handleCreateCluster, []string{"{cluster-name}"})),
 			Usage:     "create cluster",
-			ArgsUsage: "CLUSTER_NAME",
+			ArgsUsage: "{cluster-name}",
 			Flags: []cli.Flag{
 				cli.StringFlag{Name: "handle", Usage: "unique human readable name used to identify this cluster"},
 				cli.StringFlag{Name: "version", Usage: "kubernetes cluster version", Required: true},

diff --git a/cmd/command/cd/cd_contexts.go b/cmd/command/cd/cd_contexts.go
@@ -24,18 +24,18 @@ func (p *Plural) cdServiceContextCommands() []cli.Command {
 	return []cli.Command{
 		{
 			Name:      "upsert",
-			ArgsUsage: "NAME",
+			ArgsUsage: "{name}",
 			Flags: []cli.Flag{
 				cli.StringFlag{Name: "config-file", Usage: "path for json configuration file with the context blob", Required: true},
 				cli.StringFlag{Name: "name", Usage: "context name", Required: true},
 			},
-			Action: common.LatestVersion(common.RequireArgs(p.handleUpsertServiceContext, []string{"NAME"})),
+			Action: common.LatestVersion(common.RequireArgs(p.handleUpsertServiceContext, []string{"{name}"})),
 			Usage:  "upsert service context",
 		},
 		{
 			Name:      "get",
-			ArgsUsage: "NAME",
-			Action:    common.LatestVersion(common.RequireArgs(p.handleGetServiceContext, []string{"NAME"})),
+			ArgsUsage: "{name}",
+			Action:    common.LatestVersion(common.RequireArgs(p.handleGetServiceContext, []string{"name"})),
 			Usage:     "get service context",
 		},
 	}

diff --git a/cmd/command/cd/cd_credentials.go b/cmd/command/cd/cd_credentials.go
@@ -23,14 +23,14 @@ func (p *Plural) cdCredentialsCommands() []cli.Command {
 	return []cli.Command{
 		{
 			Name:      "create",
-			ArgsUsage: "PROVIDER_NAME",
-			Action:    common.LatestVersion(common.RequireArgs(p.handleCreateProviderCredentials, []string{"PROVIDER_NAME"})),
+			ArgsUsage: "{provider-name}",
+			Action:    common.LatestVersion(common.RequireArgs(p.handleCreateProviderCredentials, []string{"{provider-name}"})),
 			Usage:     "create provider credentials",
 		},
 		{
 			Name:      "delete",
-			ArgsUsage: "ID",
-			Action:    common.LatestVersion(common.RequireArgs(p.handleDeleteProviderCredentials, []string{"ID"})),
+			ArgsUsage: "{id}",
+			Action:    common.LatestVersion(common.RequireArgs(p.handleDeleteProviderCredentials, []string{"{id}"})),
 			Usage:     "delete provider credentials",
 		},
 	}

diff --git a/cmd/command/cd/cd_notifications.go b/cmd/command/cd/cd_notifications.go
@@ -34,8 +34,8 @@ func (p *Plural) cdNotificationSinkCommands() []cli.Command {
 		},
 		{
 			Name:      "upsert",
-			ArgsUsage: "NAME",
-			Action:    common.LatestVersion(common.RequireArgs(p.handleCreateNotificationSinks, []string{"NAME"})),
+			ArgsUsage: "{name}",
+			Action:    common.LatestVersion(common.RequireArgs(p.handleCreateNotificationSinks, []string{"{name}"})),
 			Usage:     "upsert notification sink",
 		},
 	}

diff --git a/cmd/command/cd/cd_pipelines.go b/cmd/command/cd/cd_pipelines.go
@@ -36,9 +36,9 @@ func (p *Plural) pipelineCommands() []cli.Command {
 		},
 		{
 			Name:      "context",
-			Action:    common.LatestVersion(common.RequireArgs(p.handlePipelineContext, []string{"PIPELINE_ID"})),
+			Action:    common.LatestVersion(common.RequireArgs(p.handlePipelineContext, []string{"{pipeline-id}"})),
 			Usage:     "set pipeline context",
-			ArgsUsage: "PIPELINE_ID",
+			ArgsUsage: "{pipeline-id}",
 			Flags: []cli.Flag{
 				cli.StringSliceFlag{
 					Name:     "set",

diff --git a/cmd/command/cd/cd_repositories.go b/cmd/command/cd/cd_repositories.go
@@ -40,8 +40,8 @@ func (p *Plural) cdRepositoriesCommands() []cli.Command {
 		},
 		{
 			Name:      "update",
-			ArgsUsage: "REPO_ID",
-			Action:    common.LatestVersion(common.RequireArgs(p.handleUpdateCDRepository, []string{"REPO_ID"})),
+			ArgsUsage: "{repository-id}",
+			Action:    common.LatestVersion(common.RequireArgs(p.handleUpdateCDRepository, []string{"{repository-id}"})),
 			Flags: []cli.Flag{
 				cli.StringFlag{Name: "url", Usage: "git repo url", Required: true},
 				cli.StringFlag{Name: "private-key", Usage: "git repo private key"},