feat(cli): context CRUD
New v0.3 P0 entry 3-4: kubectl-style context-management subtree using gh's `<noun> <verb>` surface convention consistent with the rest of this CLI. - context list: tabwriter rendering + --json envelope; reads config.yaml only. - context add <name> --host <url> [--user]: validates http(s) URL, first context auto-becomes current, rejects duplicates with did-you-mean. - context remove <name>: best-effort keyring cleanup like `auth logout`. Removing the current context triggers exit-10 confirmation (lark-cli skill protocol) — subsequent commands would lose their default --context. (`context use` predates v0.3; the subtree was previously use-only.) Bugs caught and fixed inline by the post-commit reviewer round: - auth login was accepting `http://` (empty host portion) because the old validateHost only checked the scheme. New cmdutil.NormalizeHost (shared by both login and context add) requires u.Host != "". - context add's validateName claimed `..` was rejected but only denied / \\ space. Switched to positive allowlist [A-Za-z0-9._-] plus explicit ./../path-separator rejection. Helper consolidation: - cli/internal/cmdutil/host.go: NormalizeHost (trim, scheme, host non-empty) — both auth login and context add share it. - cli/internal/format/dash.go: DashIfEmpty — promoted from copies in cmd/auth/list.go and cmd/context/list.go. - recordingStore test stub dropped in favor of secrets.NewMemStore; contextKeyList test helper replaced by the existing contextKeys. 14 unit tests; 13 e2e branches verified. Roadmap: 3-4.
This commit is contained in:
@@ -0,0 +1,148 @@
|
||||
package contextcmd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/Tencent/WeKnora/cli/internal/agent"
|
||||
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
||||
"github.com/Tencent/WeKnora/cli/internal/config"
|
||||
"github.com/Tencent/WeKnora/cli/internal/format"
|
||||
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
||||
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
||||
"github.com/Tencent/WeKnora/cli/internal/secrets"
|
||||
)
|
||||
|
||||
// RemoveOptions captures `weknora context remove` flag state. Yes is sourced
|
||||
// from the global -y/--yes persistent flag (matches `kb delete`).
|
||||
type RemoveOptions struct {
|
||||
Yes bool
|
||||
JSONOut bool
|
||||
DryRun bool
|
||||
}
|
||||
|
||||
// removeResult is the typed payload emitted under data on success.
|
||||
type removeResult struct {
|
||||
Name string `json:"name"`
|
||||
Removed bool `json:"removed"`
|
||||
WasCurrent bool `json:"was_current"`
|
||||
}
|
||||
|
||||
// NewCmdRemove builds `weknora context remove`. Drops the entry from
|
||||
// config.yaml and best-effort clears keyring references. The kubectl
|
||||
// equivalent is `config delete-context`; we use the noun-verb form
|
||||
// instead. Removing a non-current context is low-friction (no prompt).
|
||||
// Removing the *current* context triggers the lark-cli exit-10
|
||||
// confirmation protocol because subsequent commands will have no
|
||||
// default connection target.
|
||||
func NewCmdRemove(f *cmdutil.Factory) *cobra.Command {
|
||||
opts := &RemoveOptions{}
|
||||
cmd := &cobra.Command{
|
||||
Use: "remove <name>",
|
||||
Short: "Remove a context (drops entry, clears keyring refs)",
|
||||
Long: `Deletes the named context from config.yaml and best-effort clears any
|
||||
keyring references it owned (matches ` + "`weknora auth logout`" + `).
|
||||
|
||||
Removing the current context also clears CurrentContext — subsequent commands
|
||||
will error until you select another with ` + "`weknora context use <name>`" + ` or pick
|
||||
one up via the global ` + "`--context`" + ` flag. Because that change is observable in
|
||||
every later command, removing the current context requires explicit -y/--yes
|
||||
in scripted / --json invocations (exit-10 protocol; AGENTS.md).`,
|
||||
Example: ` weknora context remove staging # remove non-current → no prompt
|
||||
weknora context remove production -y # remove current → confirm`,
|
||||
Args: cobra.ExactArgs(1),
|
||||
RunE: func(c *cobra.Command, args []string) error {
|
||||
opts.Yes, _ = c.Flags().GetBool("yes")
|
||||
opts.DryRun = cmdutil.IsDryRun(c)
|
||||
store, err := f.Secrets()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return runRemove(opts, args[0], store, f.Prompter())
|
||||
},
|
||||
}
|
||||
cmd.Flags().BoolVar(&opts.JSONOut, "json", false, "Output JSON envelope")
|
||||
agent.SetAgentHelp(cmd, "Removes a context entry. Removing the current context requires -y in non-TTY/--json (exit-10). Always best-effort clears keyring refs.")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func runRemove(opts *RemoveOptions, name string, store secrets.Store, p prompt.Prompter) error {
|
||||
cfg, err := config.Load()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
ctx, exists := cfg.Contexts[name]
|
||||
if !exists {
|
||||
return notFoundError(name, cfg)
|
||||
}
|
||||
wasCurrent := name == cfg.CurrentContext
|
||||
risk := riskForRemove(name, wasCurrent)
|
||||
|
||||
if opts.DryRun {
|
||||
return cmdutil.EmitDryRun(opts.JSONOut,
|
||||
removeResult{Name: name, Removed: false, WasCurrent: wasCurrent},
|
||||
&format.Meta{Context: cfg.CurrentContext},
|
||||
risk)
|
||||
}
|
||||
// Confirmation only fires for removing the current context — non-current
|
||||
// remove matches `auth logout`'s low-friction policy.
|
||||
if wasCurrent {
|
||||
if err := cmdutil.ConfirmDestructive(p, opts.Yes, opts.JSONOut, "current context", name); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// Config first, secrets after: a crash in between leaves an orphan
|
||||
// keyring entry but no dangling config ref (same ordering as auth logout).
|
||||
delete(cfg.Contexts, name)
|
||||
if wasCurrent {
|
||||
cfg.CurrentContext = ""
|
||||
}
|
||||
if err := config.Save(cfg); err != nil {
|
||||
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "save config")
|
||||
}
|
||||
clearContextSecrets(store, ctx, name)
|
||||
|
||||
result := removeResult{Name: name, Removed: true, WasCurrent: wasCurrent}
|
||||
if opts.JSONOut {
|
||||
return format.WriteEnvelope(iostreams.IO.Out, format.SuccessWithRisk(
|
||||
result, &format.Meta{Context: cfg.CurrentContext}, risk,
|
||||
))
|
||||
}
|
||||
if wasCurrent {
|
||||
fmt.Fprintf(iostreams.IO.Out, "✓ Removed context %s (current context cleared — run `weknora context use <name>` to pick another)\n", name)
|
||||
} else {
|
||||
fmt.Fprintf(iostreams.IO.Out, "✓ Removed context %s\n", name)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// riskForRemove returns the operation risk: high-risk-write only when the
|
||||
// target is the currently-active context (subsequent commands will have no
|
||||
// default --context until the user picks one).
|
||||
func riskForRemove(name string, wasCurrent bool) *format.Risk {
|
||||
if wasCurrent {
|
||||
return &format.Risk{
|
||||
Level: format.RiskHighRiskWrite,
|
||||
Action: fmt.Sprintf("remove context %s (the current context — subsequent commands will need a new --context)", name),
|
||||
}
|
||||
}
|
||||
return &format.Risk{Level: format.RiskWrite, Action: fmt.Sprintf("remove context %s", name)}
|
||||
}
|
||||
|
||||
// clearContextSecrets mirrors auth/logout.go: best-effort delete every secret
|
||||
// slot the context references. Errors are swallowed so a missing keyring
|
||||
// entry doesn't block remove (logout had the same policy from v0.2).
|
||||
func clearContextSecrets(store secrets.Store, c config.Context, name string) {
|
||||
if c.TokenRef != "" {
|
||||
_ = store.Delete(name, "access")
|
||||
}
|
||||
if c.RefreshRef != "" {
|
||||
_ = store.Delete(name, "refresh")
|
||||
}
|
||||
if c.APIKeyRef != "" {
|
||||
_ = store.Delete(name, "api_key")
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user