f2e8e3f56c
Survey of 10 mainstream CLIs (gh, lark, stripe, vercel, supabase, aws, azure, gcloud, openai/codex, github-copilot-cli) showed env-gated per-command --help blurbs are a Stripe-only pattern; gh uses env detect for telemetry only, and lark relies on installed agent Skills + MCP. Our cmd/mcp/serve already covers the dominant 2025/26 path, so internal/aiclient/ (136 LOC + 38 callsites) is net maintenance burden without precedent. - Drop internal/aiclient/ entirely (annotations + detect + tests) - Remove 38 SetAgentHelp callsites + agentAwareHelpFunc / SetHelpFunc wiring in cmd/root.go - Migrate 4 command-level rules to standard Long help (visible to all, not env-gated): doc upload mode mutex, kb edit at-least-one, kb pin idempotent, search chunks channel mutex - Rewrite AGENTS.md as a developer guide (gh-style 6 H2 / 167 lines): audience preamble + Build / Architecture / Command Structure / Testing / Code Style / Error Handling. Drops sections absent in surveyed projects (Commit & PR Conventions, Who Uses This CLI) - Clean 14 internal doc refs (ADR-N, spec §X, v0.X) in source comments and docs that pointed at docs/superpowers/ — that directory is local-only / uncommitted, so refs are dead for outside readers - Drop forward-looking "once v0.2 ships" from README
143 lines
4.8 KiB
Go
143 lines
4.8 KiB
Go
package cmd
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
)
|
|
|
|
func TestRoot_Help(t *testing.T) {
|
|
var out bytes.Buffer
|
|
root := NewRootCmd(cmdutil.New())
|
|
root.SetArgs([]string{"--help"})
|
|
root.SetOut(&out)
|
|
require.NoError(t, root.Execute())
|
|
got := out.String()
|
|
assert.Contains(t, got, "weknora")
|
|
assert.Contains(t, got, "version")
|
|
}
|
|
|
|
func TestVersion_JSON(t *testing.T) {
|
|
var out bytes.Buffer
|
|
root := NewRootCmd(cmdutil.New())
|
|
root.SetArgs([]string{"version", "--json"})
|
|
root.SetOut(&out)
|
|
require.NoError(t, root.Execute())
|
|
got := out.String()
|
|
assert.True(t, strings.HasPrefix(strings.TrimSpace(got), `{`), "expected bare JSON object, got: %q", got)
|
|
assert.Contains(t, got, `"version":"`)
|
|
assert.NotContains(t, got, `"ok":`)
|
|
assert.NotContains(t, got, `"data":`)
|
|
}
|
|
|
|
// Smoke test for cmdutil.ExitCode wiring; full coverage lives in
|
|
// cli/internal/cmdutil/exit_test.go.
|
|
func TestExecute_ExitCodeSurface(t *testing.T) {
|
|
assert.Equal(t, 0, cmdutil.ExitCode(nil))
|
|
assert.Equal(t, 1, cmdutil.ExitCode(assert.AnError))
|
|
}
|
|
|
|
// TestMapCobraError_PinnedPrefixes guards against silent breakage if cobra
|
|
// changes the message format of unknown-command / required-flag / arg-count
|
|
// errors. Cobra v1.10 emits these via fmt.Errorf in args.go and command.go;
|
|
// if a future bump alters the wording, this test fails loudly so we update
|
|
// cobraFlagErrorPrefixes (or migrate to typed sentinels if cobra ever
|
|
// provides them).
|
|
func TestMapCobraError_PinnedPrefixes(t *testing.T) {
|
|
t.Run("unknown command", func(t *testing.T) {
|
|
root := NewRootCmd(cmdutil.New())
|
|
root.SetArgs([]string{"bogus"})
|
|
root.SetErr(&bytes.Buffer{})
|
|
root.SetOut(&bytes.Buffer{})
|
|
err := root.Execute()
|
|
require.Error(t, err)
|
|
assert.True(t, strings.HasPrefix(err.Error(), "unknown command "),
|
|
"cobra unknown-command prefix changed; update cobraFlagErrorPrefixes. got: %q", err.Error())
|
|
})
|
|
|
|
t.Run("required flag(s)", func(t *testing.T) {
|
|
// Self-contained probe - the pin must hold even before resource commands
|
|
// register their own required flags. RunE is required: without it cobra
|
|
// treats the command as a parent and skips ValidateRequiredFlags.
|
|
probe := &cobra.Command{Use: "probe", RunE: func(*cobra.Command, []string) error { return nil }}
|
|
probe.Flags().String("host", "", "")
|
|
require.NoError(t, probe.MarkFlagRequired("host"))
|
|
probe.SetErr(&bytes.Buffer{})
|
|
probe.SetOut(&bytes.Buffer{})
|
|
err := probe.Execute()
|
|
require.Error(t, err)
|
|
assert.True(t, strings.HasPrefix(err.Error(), "required flag(s)"),
|
|
"cobra required-flag prefix changed; update cobraFlagErrorPrefixes. got: %q", err.Error())
|
|
})
|
|
|
|
t.Run("accepts N arg(s) - ExactArgs", func(t *testing.T) {
|
|
probe := &cobra.Command{
|
|
Use: "probe",
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(*cobra.Command, []string) error { return nil },
|
|
}
|
|
probe.SetArgs([]string{}) // no args, but ExactArgs(1) wants 1
|
|
probe.SetErr(&bytes.Buffer{})
|
|
probe.SetOut(&bytes.Buffer{})
|
|
err := probe.Execute()
|
|
require.Error(t, err)
|
|
assert.True(t, strings.HasPrefix(err.Error(), "accepts "),
|
|
"cobra ExactArgs prefix changed; update cobraFlagErrorPrefixes. got: %q", err.Error())
|
|
})
|
|
}
|
|
|
|
func TestMapCobraError(t *testing.T) {
|
|
t.Run("nil passes through", func(t *testing.T) {
|
|
assert.Nil(t, MapCobraError(nil))
|
|
})
|
|
t.Run("non-matching error passes through", func(t *testing.T) {
|
|
err := MapCobraError(assert.AnError)
|
|
assert.Equal(t, assert.AnError, err)
|
|
})
|
|
t.Run("unknown command wraps as FlagError", func(t *testing.T) {
|
|
err := MapCobraError(errors.New(`unknown command "bogus" for "weknora"`))
|
|
var fe *cmdutil.FlagError
|
|
assert.True(t, errors.As(err, &fe))
|
|
})
|
|
t.Run("required flag wraps as FlagError", func(t *testing.T) {
|
|
err := MapCobraError(errors.New(`required flag(s) "host" not set`))
|
|
var fe *cmdutil.FlagError
|
|
assert.True(t, errors.As(err, &fe))
|
|
})
|
|
}
|
|
|
|
// TestRoot_ContextFlagPropagation guards the cobra → Factory wiring of the
|
|
// global --context flag. Without this, a future refactor that disconnects
|
|
// PersistentPreRun from f.ContextOverride would only fail e2e - the
|
|
// per-package TestFactory_ContextOverride only proves the Factory side.
|
|
func TestRoot_ContextFlagPropagation(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
args []string
|
|
want string
|
|
}{
|
|
{"no flag", []string{"version"}, ""},
|
|
{"global before subcmd", []string{"--context", "staging", "version"}, "staging"},
|
|
{"--context=value form", []string{"--context=prod", "version"}, "prod"},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
f := cmdutil.New()
|
|
root := NewRootCmd(f)
|
|
root.SetArgs(tc.args)
|
|
root.SetOut(&bytes.Buffer{})
|
|
root.SetErr(&bytes.Buffer{})
|
|
require.NoError(t, root.Execute())
|
|
assert.Equal(t, tc.want, f.ContextOverride)
|
|
})
|
|
}
|
|
}
|
|
|