CLI Unification: audit-log, completion, connector, connector-catalog, environment, feedback, ksql, prompt, schema-registry, shell, update, version

internal/cmd/audit-log/command.go

@@ -9,6 +9,7 @@ import (
 	"github.com/spf13/cobra"
 
 	pcmd "github.com/confluentinc/cli/internal/pkg/cmd"
+	v3 "github.com/confluentinc/cli/internal/pkg/config/v3"
 	"github.com/confluentinc/cli/internal/pkg/errors"
 )
 
@@ -18,7 +19,7 @@ type command struct {
 }
 
 // New returns the default command object for interacting with audit logs.
-func New(cliName string, prerunner pcmd.PreRunner) *cobra.Command {
+func New(cfg *v3.Config, prerunner pcmd.PreRunner) *cobra.Command {
 	cliCmd := pcmd.NewCLICommand(
 		&cobra.Command{
 			Use:   "audit-log",
@@ -29,14 +30,14 @@ func New(cliName string, prerunner pcmd.PreRunner) *cobra.Command {
 		CLICommand: cliCmd,
 		prerunner:  prerunner,
 	}
-	cmd.init(cliName)
+	cmd.init(cfg)
 	return cmd.Command
 }
 
-func (c *command) init(cliName string) {
-	if cliName == "ccloud" {
+func (c *command) init(cfg *v3.Config) {
+	if cfg.IsCloud() {
 		c.AddCommand(NewDescribeCommand(c.prerunner))
-	} else if cliName == "confluent" {
+	} else {
 		c.AddCommand(NewMigrateCommand(c.prerunner))
 		c.AddCommand(NewConfigCommand(c.prerunner))
 		c.AddCommand(NewRouteCommand(c.prerunner))

internal/cmd/audit-log/command_describe_test.go

@@ -41,5 +41,6 @@ func mockAuditLogCommand(configured bool) *cobra.Command {
 			TopicName:        "confluent-audit-log-events",
 		}
 	}
-	return New("ccloud", climock.NewPreRunnerMock(client, nil, nil, cfg))
+
+	return New(cfg, climock.NewPreRunnerMock(client, nil, nil, cfg))
 }

internal/cmd/audit-log/command_test.go

@@ -198,7 +198,7 @@ func (suite *AuditConfigTestSuite) newMockCmd(expect chan MockCall) *cobra.Comma
 	}
 	mdsClient := mds.NewAPIClient(mds.NewConfiguration())
 	mdsClient.AuditLogConfigurationApi = suite.mockApi
-	return New("confluent", cliMock.NewPreRunnerMock(nil, mdsClient, nil, suite.conf))
+	return New(suite.conf, cliMock.NewPreRunnerMock(nil, mdsClient, nil, suite.conf))
 }
 
 func TestAuditConfigTestSuite(t *testing.T) {

internal/cmd/command.go

@@ -129,21 +129,21 @@ func NewConfluentCommand(cfg *v3.Config, isTest bool, ver *pversion.Version) *co
 	isAPIKeyLogin := isAPIKeyCredential(cfg)
 
 	// No-login commands
-	cli.AddCommand(completion.New(cli, cliName))
+	cli.AddCommand(completion.New(cli))
 	cli.AddCommand(config.New(cfg.IsCloud(), prerunner, analyticsClient))
 	cli.AddCommand(kafka.New(isAPIKeyLogin, cliName, prerunner, logger.Named("kafka"), ver.ClientID, serverCompleter, analyticsClient))
 	cli.AddCommand(local.New(prerunner))
 	cli.AddCommand(login.New(prerunner, logger, ccloudClientFactory, mdsClientManager, analyticsClient, netrcHandler, loginCredentialsManager, authTokenHandler, isTest).Command)
 	cli.AddCommand(logout.New(cliName, prerunner, analyticsClient, netrcHandler).Command)
 	cli.AddCommand(secret.New(flagResolver, secrets.NewPasswordProtectionPlugin(logger)))
 	if !cfg.DisableUpdates {
-		cli.AddCommand(update.New(cliName, logger, ver, updateClient, analyticsClient))
+		cli.AddCommand(update.New(logger, ver, updateClient, analyticsClient))
 	}
-	cli.AddCommand(version.New(cliName, prerunner, ver))
+	cli.AddCommand(version.New(prerunner, ver))
 
 	if cfg.IsCloud() {
 		cli.AddCommand(admin.New(prerunner, isTest))
-		cli.AddCommand(auditlog.New(cliName, prerunner))
+		cli.AddCommand(auditlog.New(cfg, prerunner))
 		cli.AddCommand(initcontext.New(prerunner, flagResolver, analyticsClient))
 
 		// If a user logs in with an API key, don't allow the remaining commands.
@@ -152,9 +152,9 @@ func NewConfluentCommand(cfg *v3.Config, isTest bool, ver *pversion.Version) *co
 		}
 
 		apiKeyCmd := apikey.New(prerunner, nil, flagResolver, analyticsClient)
-		connectorCmd := connector.New(cliName, prerunner, analyticsClient)
-		connectorCatalogCmd := connectorcatalog.New(cliName, prerunner)
-		environmentCmd := environment.New(cliName, prerunner, analyticsClient)
+		connectorCmd := connector.New(prerunner, analyticsClient)
+		connectorCatalogCmd := connectorcatalog.New(prerunner)
+		environmentCmd := environment.New(prerunner, analyticsClient)
 		serviceAccountCmd := serviceaccount.New(prerunner, analyticsClient)
 
 		serverCompleter.AddCommand(apiKeyCmd)
@@ -168,22 +168,22 @@ func NewConfluentCommand(cfg *v3.Config, isTest bool, ver *pversion.Version) *co
 		cli.AddCommand(connectorCmd.Command)
 		cli.AddCommand(environmentCmd.Command)
 		cli.AddCommand(iam.New(cliName, prerunner))
-		cli.AddCommand(ksql.New(cliName, prerunner, serverCompleter, analyticsClient))
+		cli.AddCommand(ksql.New(cfg, prerunner, serverCompleter, analyticsClient))
 		cli.AddCommand(price.New(prerunner))
-		cli.AddCommand(prompt.New(cliName, prerunner, &ps1.Prompt{}, logger))
-		cli.AddCommand(schemaregistry.New(cliName, prerunner, nil, logger, analyticsClient))
+		cli.AddCommand(prompt.New(cfg, prerunner, &ps1.Prompt{}, logger))
+		cli.AddCommand(schemaregistry.New(cfg, prerunner, nil, logger, analyticsClient))
 		cli.AddCommand(serviceAccountCmd.Command)
-		cli.AddCommand(shell.NewShellCmd(cli, prerunner, cliName, cfg, shellCompleter, logger, analyticsClient, jwtValidator))
+		cli.AddCommand(shell.NewShellCmd(cli, prerunner, cfg, shellCompleter, logger, analyticsClient, jwtValidator))
 		cli.AddCommand(signup.New(prerunner, logger, ver.UserAgent, ccloudClientFactory).Command)
 	}
 
 	if cfg.IsOnPrem() {
-		cli.AddCommand(auditlog.New(cliName, prerunner))
+		cli.AddCommand(auditlog.New(cfg, prerunner))
 		cli.AddCommand(cluster.New(prerunner, cluster.NewScopedIdService(ver.UserAgent, logger)))
 		cli.AddCommand(connect.New(prerunner))
 		cli.AddCommand(iam.New(cliName, prerunner))
-		cli.AddCommand(ksql.New(cliName, prerunner, serverCompleter, analyticsClient))
-		cli.AddCommand(schemaregistry.New(cliName, prerunner, nil, logger, analyticsClient))
+		cli.AddCommand(ksql.New(cfg, prerunner, serverCompleter, analyticsClient))
+		cli.AddCommand(schemaregistry.New(cfg, prerunner, nil, logger, analyticsClient))
 	}
 
 	return command

internal/cmd/completion/completion.go

@@ -9,6 +9,7 @@ import (
 
 	pcmd "github.com/confluentinc/cli/internal/pkg/cmd"
 	"github.com/confluentinc/cli/internal/pkg/errors"
+	pversion "github.com/confluentinc/cli/internal/pkg/version"
 )
 
 const longDescriptionTemplate = `Use this command to print the output Shell completion
@@ -83,19 +84,19 @@ type completionCommand struct {
 }
 
 // New returns the Cobra command for shell completion.
-func New(rootCmd *cobra.Command, cliName string) *cobra.Command {
+func New(rootCmd *cobra.Command) *cobra.Command {
 	cmd := &completionCommand{
 		rootCmd: rootCmd,
 	}
-	cmd.init(cliName)
+	cmd.init()
 	return cmd.Command
 }
 
-func (c *completionCommand) init(cliName string) {
+func (c *completionCommand) init() {
 	c.Command = &cobra.Command{
 		Use:   "completion <shell>",
 		Short: "Print shell completion code.",
-		Long:  getLongDescription(cliName),
+		Long:  getLongDescription(),
 		Args:  cobra.ExactArgs(1),
 		RunE:  pcmd.NewCLIRunE(c.completion),
 	}
@@ -113,10 +114,10 @@ func (c *completionCommand) completion(cmd *cobra.Command, args []string) error
 	return err
 }
 
-func getLongDescription(cliName string) string {
+func getLongDescription() string {
 	t := template.Must(template.New("longDescription").Parse(longDescriptionTemplate))
 	buf := new(bytes.Buffer)
-	data := map[string]interface{}{"CLIName": cliName}
+	data := map[string]interface{}{"CLIName": pversion.CLIName}
 	if err := t.Execute(buf, data); err != nil {
 		// We're okay with this since its definitely a development error; should never happen to users
 		panic(err)

internal/cmd/completion/completion_test.go

@@ -12,7 +12,7 @@ func TestCompletionBash(t *testing.T) {
 	req := require.New(t)
 
 	root := pcmd.BuildRootCommand()
-	cmd := New(root, "ccloud")
+	cmd := New(root)
 	root.AddCommand(cmd)
 
 	output, err := pcmd.ExecuteCommand(root, "completion", "bash")
@@ -24,7 +24,7 @@ func TestCompletionZsh(t *testing.T) {
 	req := require.New(t)
 
 	root := pcmd.BuildRootCommand()
-	cmd := New(root, "ccloud")
+	cmd := New(root)
 	root.AddCommand(cmd)
 
 	output, err := pcmd.ExecuteCommand(root, "completion", "zsh")
@@ -36,7 +36,7 @@ func TestCompletionUnknown(t *testing.T) {
 	req := require.New(t)
 
 	root := pcmd.BuildRootCommand()
-	cmd := New(root, "ccloud")
+	cmd := New(root)
 	root.AddCommand(cmd)
 
 	_, err := pcmd.ExecuteCommand(root, "completion", "newsh")
@@ -48,7 +48,7 @@ func TestCompletionNone(t *testing.T) {
 	req := require.New(t)
 
 	root := pcmd.BuildRootCommand()
-	cmd := New(root, "ccloud")
+	cmd := New(root)
 	root.AddCommand(cmd)
 
 	_, err := pcmd.ExecuteCommand(root, "completion")

internal/cmd/connector-catalog/command.go

@@ -13,6 +13,7 @@ import (
 	"github.com/confluentinc/cli/internal/pkg/examples"
 	"github.com/confluentinc/cli/internal/pkg/output"
 	"github.com/confluentinc/cli/internal/pkg/utils"
+	"github.com/confluentinc/cli/internal/pkg/version"
 )
 
 type command struct {
@@ -31,18 +32,18 @@ var (
 )
 
 // New returns the default command object for interacting with Connect.
-func New(cliName string, prerunner pcmd.PreRunner) *command {
+func New(prerunner pcmd.PreRunner) *command {
 	cmd := &command{
 		AuthenticatedStateFlagCommand: pcmd.NewAuthenticatedStateFlagCommand(&cobra.Command{
 			Use:   "connector-catalog",
 			Short: "Catalog of connectors and their configurations.",
 		}, prerunner, SubcommandFlags),
 	}
-	cmd.init(cliName)
+	cmd.init()
 	return cmd
 }
 
-func (c *command) init(cliName string) {
+func (c *command) init() {
 	describeCmd := &cobra.Command{
 		Use:   "describe <connector-type>",
 		Short: "Describe a connector plugin type.",
@@ -51,7 +52,7 @@ func (c *command) init(cliName string) {
 		Example: examples.BuildExampleString(
 			examples.Example{
 				Text: "Describe required connector configuration parameters for a specific connector plugin.",
-				Code: fmt.Sprintf("%s connector-catalog describe <plugin-name>", cliName),
+				Code: fmt.Sprintf("%s connector-catalog describe <plugin-name>", version.CLIName),
 			},
 		),
 	}
@@ -67,7 +68,7 @@ func (c *command) init(cliName string) {
 		Example: examples.BuildExampleString(
 			examples.Example{
 				Text: "List connectors in the current or specified Kafka cluster context.",
-				Code: fmt.Sprintf("%s connector-catalog list", cliName),
+				Code: fmt.Sprintf("%s connector-catalog list", version.CLIName),
 			},
 		),
 	}

internal/cmd/connector-catalog/command_test.go

@@ -75,8 +75,7 @@ func (suite *CatalogTestSuite) SetupTest() {
 
 func (suite *CatalogTestSuite) newCmd() *command {
 	prerunner := cliMock.NewPreRunnerMock(&ccloud.Client{Connect: suite.connectMock, Kafka: suite.kafkaMock}, nil, nil, suite.conf)
-	cmd := New("ccloud", prerunner)
-	return cmd
+	return New(prerunner)
 }
 
 func (suite *CatalogTestSuite) TestCatalogList() {

internal/cmd/connector/command.go

@@ -6,21 +6,19 @@ import (
 	"os"
 
 	"github.com/c-bata/go-prompt"
-
-	"github.com/confluentinc/cli/internal/pkg/examples"
-
-	"github.com/confluentinc/go-printer"
-	"github.com/spf13/cobra"
-
 	schedv1 "github.com/confluentinc/cc-structs/kafka/scheduler/v1"
 	opv1 "github.com/confluentinc/cc-structs/operator/v1"
+	"github.com/confluentinc/go-printer"
+	"github.com/spf13/cobra"
 
 	"github.com/confluentinc/cli/internal/pkg/analytics"
 	pcmd "github.com/confluentinc/cli/internal/pkg/cmd"
 	"github.com/confluentinc/cli/internal/pkg/errors"
+	"github.com/confluentinc/cli/internal/pkg/examples"
 	"github.com/confluentinc/cli/internal/pkg/output"
 	"github.com/confluentinc/cli/internal/pkg/shell/completer"
 	"github.com/confluentinc/cli/internal/pkg/utils"
+	"github.com/confluentinc/cli/internal/pkg/version"
 )
 
 type command struct {
@@ -61,7 +59,7 @@ var (
 )
 
 // New returns the default command object for interacting with Connect.
-func New(cliName string, prerunner pcmd.PreRunner, analyticsClient analytics.Client) *command {
+func New(prerunner pcmd.PreRunner, analyticsClient analytics.Client) *command {
 	cmd := &command{
 		AuthenticatedStateFlagCommand: pcmd.NewAuthenticatedStateFlagCommand(
 			&cobra.Command{
@@ -71,11 +69,11 @@ func New(cliName string, prerunner pcmd.PreRunner, analyticsClient analytics.Cli
 		prerunner:       prerunner,
 		analyticsClient: analyticsClient,
 	}
-	cmd.init(cliName)
+	cmd.init()
 	return cmd
 }
 
-func (c *command) init(cliName string) {
+func (c *command) init() {
 	describeCmd := &cobra.Command{
 		Use:   "describe <id>",
 		Short: "Describe a connector.",
@@ -84,7 +82,7 @@ func (c *command) init(cliName string) {
 		Example: examples.BuildExampleString(
 			examples.Example{
 				Text: "Describe connector and task level details of a connector in the current or specified Kafka cluster context.",
-				Code: fmt.Sprintf("%s connector describe <id>\n%s connector describe <id> --cluster <cluster-id>", cliName, cliName),
+				Code: fmt.Sprintf("%s connector describe <id>\n%s connector describe <id> --cluster <cluster-id>", version.CLIName, version.CLIName),
 			},
 		),
 	}
@@ -100,7 +98,7 @@ func (c *command) init(cliName string) {
 		Example: examples.BuildExampleString(
 			examples.Example{
 				Text: "List connectors in the current or specified Kafka cluster context.",
-				Code: fmt.Sprintf("%s connector list\n%s connector list --cluster <cluster-id>", cliName, cliName),
+				Code: fmt.Sprintf("%s connector list\n%s connector list --cluster <cluster-id>", version.CLIName, version.CLIName),
 			},
 		),
 	}
@@ -116,7 +114,7 @@ func (c *command) init(cliName string) {
 		Example: examples.BuildExampleString(
 			examples.Example{
 				Text: "Create a connector in the current or specified Kafka cluster context.",
-				Code: fmt.Sprintf("%s connector create --config <file>\n%s connector create --cluster <cluster-id> --config <file>", cliName, cliName),
+				Code: fmt.Sprintf("%s connector create --config <file>\n%s connector create --cluster <cluster-id> --config <file>", version.CLIName, version.CLIName),
 			},
 		),
 	}
@@ -134,7 +132,7 @@ func (c *command) init(cliName string) {
 		Example: examples.BuildExampleString(
 			examples.Example{
 				Text: "Delete a connector in the current or specified Kafka cluster context.",
-				Code: fmt.Sprintf("%s connector delete --config <file>\n%s connector delete --cluster <cluster-id> --config <file>", cliName, cliName),
+				Code: fmt.Sprintf("%s connector delete --config <file>\n%s connector delete --cluster <cluster-id> --config <file>", version.CLIName, version.CLIName),
 			},
 		),
 	}
@@ -159,7 +157,7 @@ func (c *command) init(cliName string) {
 		Example: examples.BuildExampleString(
 			examples.Example{
 				Text: "Pause a connector in the current or specified Kafka cluster context.",
-				Code: fmt.Sprintf("%s connector pause --config <file>\n%s connector pause --cluster <cluster-id> --config <file>", cliName, cliName),
+				Code: fmt.Sprintf("%s connector pause --config <file>\n%s connector pause --cluster <cluster-id> --config <file>", version.CLIName, version.CLIName),
 			},
 		),
 	}
@@ -173,15 +171,13 @@ func (c *command) init(cliName string) {
 		Example: examples.BuildExampleString(
 			examples.Example{
 				Text: "Resume a connector in the current or specified Kafka cluster context.",
-				Code: fmt.Sprintf("%s connector resume --config <file>\n%s connector resume --cluster <cluster-id> --config <file>", cliName, cliName),
+				Code: fmt.Sprintf("%s connector resume --config <file>\n%s connector resume --cluster <cluster-id> --config <file>", version.CLIName, version.CLIName),
 			},
 		),
 	}
 	c.AddCommand(resumeCmd)
 
-	if cliName == "ccloud" {
-		c.AddCommand(NewEventCommand(c.prerunner))
-	}
+	c.AddCommand(NewEventCommand(c.prerunner))
 
 	c.completableChildren = []*cobra.Command{deleteCmd, describeCmd, pauseCmd, resumeCmd, updateCmd}
 	c.completableFlagChildren = map[string][]*cobra.Command{

internal/cmd/connector/command_test.go

@@ -15,6 +15,7 @@ import (
 	opv1 "github.com/confluentinc/cc-structs/operator/v1"
 	"github.com/confluentinc/ccloud-sdk-go-v1"
 	ccsdkmock "github.com/confluentinc/ccloud-sdk-go-v1/mock"
+
 	"github.com/confluentinc/cli/internal/cmd/utils"
 	"github.com/confluentinc/cli/internal/pkg/analytics"
 	v3 "github.com/confluentinc/cli/internal/pkg/config/v3"
@@ -119,7 +120,7 @@ func (suite *ConnectTestSuite) SetupTest() {
 
 func (suite *ConnectTestSuite) newCmd() *command {
 	prerunner := cliMock.NewPreRunnerMock(&ccloud.Client{Connect: suite.connectMock, Kafka: suite.kafkaMock}, nil, nil, suite.conf)
-	cmd := New("ccloud", prerunner, suite.analyticsClient)
+	cmd := New(prerunner, suite.analyticsClient)
 	return cmd
 }