CLOUDP-337876: add aliases to plugins (#4229)

Author: blva

internal/cli/plugin/list.go

@@ -29,8 +29,8 @@ func (opts *ListOps) Run() error {
 }
 
 const listTemplate = `NAME	DESCRIPTION	VERSION COMMANDS {{range valueOrEmptySlice .}}
-{{.Name}}	{{.Description}}	{{.Version}}	{{ (index .Commands 0).Name }} {{range slice .Commands 1 }}
-			{{.Name}}{{end}}
+{{.Name}}	{{.Description}}	{{.Version}}	{{- range $i, $cmd := .Commands}}{{if $i}}
+			{{else}}	{{end}}{{$cmd.Name}}{{formatAliases $cmd.Aliases}}{{end}}
 		{{end}}
 `
 

internal/cli/plugin/list_test.go

@@ -16,6 +16,7 @@ package plugin
 
 import (
 	"bytes"
+	"strings"
 	"testing"
 
 	"github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli"
@@ -43,3 +44,32 @@ func TestList_Run(t *testing.T) {
 func TestList_Template(t *testing.T) {
 	test.VerifyOutputTemplate(t, listTemplate, getTestPlugins(t).GetValidAndInvalidPlugins())
 }
+
+func TestList_TemplateWithAliases(t *testing.T) {
+	plugins := getTestPlugins(t)
+
+	listOpts := &ListOps{
+		Opts: Opts{
+			plugins: plugins,
+		},
+		OutputOpts: cli.OutputOpts{
+			Template:  listTemplate,
+			OutWriter: new(bytes.Buffer),
+		},
+	}
+
+	if err := listOpts.Run(); err != nil {
+		t.Fatalf("Run() unexpected error: %v", err)
+	}
+
+	output := listOpts.OutWriter.(*bytes.Buffer).String()
+
+	// Check that aliases are included in the output
+	if !strings.Contains(output, "[aliases: cmd1, c1]") {
+		t.Errorf("Expected to find aliases for command1, but output was: %s", output)
+	}
+
+	if !strings.Contains(output, "[aliases: tf]") {
+		t.Errorf("Expected to find aliases for command3, but output was: %s", output)
+	}
+}

internal/cli/plugin/plugin_test.go

@@ -37,7 +37,7 @@ func getTestPlugins(t *testing.T) *plugin.ValidatedPlugins {
 				Description: "plugin1 description",
 				Version:     version1,
 				Commands: []*plugin.Command{
-					{Name: "command1"},
+					{Name: "command1", Aliases: []string{"cmd1", "c1"}},
 					{Name: "command 2"},
 				},
 				Github: &plugin.Github{
@@ -50,7 +50,7 @@ func getTestPlugins(t *testing.T) *plugin.ValidatedPlugins {
 				Description: "plugin2 description",
 				Version:     version2,
 				Commands: []*plugin.Command{
-					{Name: "command3"},
+					{Name: "command3", Aliases: []string{"tf"}},
 					{Name: "command4"},
 				},
 				Github: &plugin.Github{

internal/templatewriter/templatewriter.go

@@ -17,6 +17,7 @@ package templatewriter
 import (
 	"io"
 	"reflect"
+	"strings"
 	"text/tabwriter"
 	"text/template"
 )
@@ -30,6 +31,7 @@ const (
 
 var funcMap = template.FuncMap{
 	"valueOrEmptySlice": valueOrEmptySlice,
+	"formatAliases":     formatAliases,
 }
 
 func valueOrEmptySlice(slice any) (result any) {
@@ -45,6 +47,16 @@ func valueOrEmptySlice(slice any) (result any) {
 	return slice
 }
 
+// formatAliases formats command aliases for display.
+// Returns a formatted string like " [aliases: cmd1, c2]" if aliases exist,
+// or an empty string if no aliases are present.
+func formatAliases(aliases []string) string {
+	if len(aliases) == 0 {
+		return ""
+	}
+	return " [aliases: " + strings.Join(aliases, ", ") + "]"
+}
+
 // newTabWriter returns a tabwriter that handles tabs(`\t) to space columns evenly.
 func newTabWriter(output io.Writer) *tabwriter.Writer {
 	return tabwriter.NewWriter(output, tabwriterMinWidth, tabwriterWidth, tabwriterPadding, tabwriterPadChar, 0)

internal/templatewriter/templatewriter_test.go

@@ -83,6 +83,34 @@ func Test_Print(t *testing.T) {
 			expected: "items: ",
 			wantErr:  require.NoError,
 		},
+		{
+			name:     "formatAliases with aliases",
+			template: "command{{formatAliases .Aliases}}",
+			data:     struct{ Aliases []string }{Aliases: []string{"cmd1", "c1"}},
+			expected: "command [aliases: cmd1, c1]",
+			wantErr:  require.NoError,
+		},
+		{
+			name:     "formatAliases with single alias",
+			template: "command{{formatAliases .Aliases}}",
+			data:     struct{ Aliases []string }{Aliases: []string{"tf"}},
+			expected: "command [aliases: tf]",
+			wantErr:  require.NoError,
+		},
+		{
+			name:     "formatAliases with no aliases",
+			template: "command{{formatAliases .Aliases}}",
+			data:     struct{ Aliases []string }{Aliases: []string{}},
+			expected: "command",
+			wantErr:  require.NoError,
+		},
+		{
+			name:     "formatAliases with nil aliases",
+			template: "command{{formatAliases .Aliases}}",
+			data:     struct{ Aliases []string }{Aliases: nil},
+			expected: "command",
+			wantErr:  require.NoError,
+		},
 	}
 
 	for _, conf := range tests {