Merge pull request #1358 from entireio/linear-brewing-cocke

auth: tab-complete context names for `auth use`

Author: toothbrush

cmd/entire/cli/auth_context.go

@@ -31,7 +31,8 @@ func newAuthUseCmd() *cobra.Command {
 			"Control-plane commands (auth status/list/revoke, org/project/repo/grant) still\n" +
 			"target the configured auth host (ENTIRE_AUTH_BASE_URL / the default), so\n" +
 			"switching to a context on a different login server does not retarget them yet.",
-		Args: cobra.ExactArgs(1),
+		Args:              cobra.ExactArgs(1),
+		ValidArgsFunction: completeContextNames,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if err := auth.SetCurrentContext(args[0]); err != nil {
 				return err //nolint:wrapcheck // already a user-facing message
@@ -43,6 +44,34 @@ func newAuthUseCmd() *cobra.Command {
 	}
 }
 
+// completeContextNames is the ValidArgsFunction for commands taking a single
+// <context> positional. It offers the stored context names, each annotated
+// (shell-completion descriptions, after a tab) with handle, core URL, and an
+// "(active)" marker for the current context. Errors are swallowed because
+// completion runs on every TAB press; a failed read just yields no suggestions.
+func completeContextNames(_ *cobra.Command, args []string, _ string) ([]string, cobra.ShellCompDirective) {
+	if len(args) != 0 {
+		// <context> is a single positional; nothing to complete past it.
+		return nil, cobra.ShellCompDirectiveNoFileComp
+	}
+	all, current, err := auth.Contexts()
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveNoFileComp
+	}
+	out := make([]string, 0, len(all))
+	for _, c := range all {
+		desc := c.Handle
+		if c.CoreURL != "" {
+			desc += " " + c.CoreURL
+		}
+		if c.Name == current {
+			desc += " (active)"
+		}
+		out = append(out, c.Name+"\t"+desc)
+	}
+	return out, cobra.ShellCompDirectiveNoFileComp
+}
+
 // warnIfCrossCoreContext warns when the now-active context authenticates
 // against a different core than the control plane targets. Clone resolves
 // per-cluster and is unaffected, but auth status/list/revoke and the

cmd/entire/cli/auth_context_test.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/entireio/cli/cmd/entire/cli/auth"
 	"github.com/entireio/cli/internal/entireclient/tokenstore"
+	"github.com/spf13/cobra"
 )
 
 // TestResolveStatusTarget_PrefersActiveContext pins the multi-core fix: status
@@ -89,6 +90,74 @@ func TestRunAuthContexts(t *testing.T) {
 	}
 }
 
+func TestCompleteContextNames(t *testing.T) {
+	cfgDir := t.TempDir()
+	t.Setenv("ENTIRE_CONFIG_DIR", cfgDir)
+	restore := tokenstore.UseFileBackendForTesting(filepath.Join(t.TempDir(), "tokens.json"))
+	t.Cleanup(restore)
+
+	exp := time.Now().Add(time.Hour).Unix()
+
+	// Two contexts; the second one recorded with activate=true is current.
+	if _, err := auth.RecordLoginContext(makeContextJWT(t, fmt.Sprintf(`{"iss":"https://core-a.example.com","handle":"alice","exp":%d}`, exp)), "", false); err != nil {
+		t.Fatalf("record core-a: %v", err)
+	}
+	currentName, err := auth.RecordLoginContext(makeContextJWT(t, fmt.Sprintf(`{"iss":"https://core-b.example.com","handle":"bob","exp":%d}`, exp)), "", true)
+	if err != nil {
+		t.Fatalf("record core-b: %v", err)
+	}
+
+	got, directive := completeContextNames(nil, nil, "")
+	if directive != cobra.ShellCompDirectiveNoFileComp {
+		t.Fatalf("directive = %v, want NoFileComp", directive)
+	}
+	if len(got) != 2 {
+		t.Fatalf("completions = %v, want 2 entries", got)
+	}
+
+	// Each entry is "name\tdescription" carrying handle and core URL; the
+	// active context is annotated "(active)" and no other entry is.
+	var activeCount int
+	for _, entry := range got {
+		name, desc, found := strings.Cut(entry, "\t")
+		if !found {
+			t.Fatalf("entry %q missing tab-separated description", entry)
+		}
+		if name == currentName {
+			if !strings.Contains(desc, "(active)") {
+				t.Fatalf("active entry %q missing (active) marker", entry)
+			}
+			if !strings.Contains(desc, "bob") || !strings.Contains(desc, "core-b.example.com") {
+				t.Fatalf("active entry %q missing handle/core URL", entry)
+			}
+			activeCount++
+		} else if strings.Contains(desc, "(active)") {
+			t.Fatalf("non-active entry %q wrongly marked (active)", entry)
+		}
+	}
+	if activeCount != 1 {
+		t.Fatalf("want exactly one (active) entry, got %d", activeCount)
+	}
+
+	// Past the single positional: nothing to complete.
+	got, directive = completeContextNames(nil, []string{"already"}, "")
+	if got != nil || directive != cobra.ShellCompDirectiveNoFileComp {
+		t.Fatalf("with an arg present, want (nil, NoFileComp), got (%v, %v)", got, directive)
+	}
+}
+
+func TestCompleteContextNames_NoContexts(t *testing.T) {
+	cfgDir := t.TempDir()
+	t.Setenv("ENTIRE_CONFIG_DIR", cfgDir)
+	restore := tokenstore.UseFileBackendForTesting(filepath.Join(t.TempDir(), "tokens.json"))
+	t.Cleanup(restore)
+
+	got, directive := completeContextNames(nil, nil, "")
+	if len(got) != 0 || directive != cobra.ShellCompDirectiveNoFileComp {
+		t.Fatalf("no contexts: want (empty, NoFileComp), got (%v, %v)", got, directive)
+	}
+}
+
 func TestWarnIfCrossCoreContext(t *testing.T) {
 	cfgDir := t.TempDir()
 	t.Setenv("ENTIRE_CONFIG_DIR", cfgDir)