mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-08-31 00:50:02 +08:00
e623e8208f
Removes the entire envelope machinery now that every success path
emits bare JSON:
- cli/internal/format/envelope.go (Envelope, Success, Failure,
SuccessWithRisk, WriteEnvelope, Meta, Notice, UpdateNotice,
VersionSkewNotice, Risk, RiskLevel, ErrorBody) + tests.
- cli/internal/format/filter.go envelope-specific helpers
(WriteEnvelopeFiltered, marshalEnvelope, applyFieldFilter,
filterDataPayload, filterObjectData); the reusable
filterArrayItems / filterObjectKeys / writeJQ stay for bare.go.
- cli/internal/cmdutil/exporter.go + tests (envelope-only).
- cli/internal/cmdutil/PrintErrorEnvelope + ToErrorBody +
operationRiskOf + Error.OperationRisk field + OperationRisk struct.
Error path: all errors now go to stderr via cmdutil.PrintError in
`code: message\nhint: ...` form, regardless of --json. Stdout stays
empty (or holds the partial-success the command already wrote) so
downstream `--json | jq` pipelines never have to filter error shapes
out of the success stream. Typed exit codes (3 auth.* / 4
resource.not_found / 5 input.* / 6 server.rate_limited / 7 server.*
+ network.* / 10 input.confirmation_required) carry the failure
class for agents that branch on it.
Acceptance contract:
- envelope_test.go → wire_test.go (TestEnvelopeGolden → TestWireGolden).
- testdata/envelopes/ → testdata/wire/.
- Error-path cases assert the typed code substring on stderr.
- Orphan whoami.*.json goldens deleted.
AGENTS.md + README.md rewritten for the bare-data contract:
- Drop envelope schema section + dry-run rule.
- Document bare JSON on stdout + `code: msg\nhint: …` on stderr.
- ADR-3 reframed around bare data and why error separation matters
for `--json | jq` pipelines.
WriteJSONFiltered short-circuits to WriteJSON when both filters are
empty (skip the marshal-buffer round-trip for the common case).
Final review pass:
- Fix wire-contract bug: `--json id,name` (space form) is broken by
pflag's NoOptDefVal; AGENTS.md / README.md / SetAgentHelp + the
field-discovery help text all switched to `--json=id,name`.
- Fix `weknora api --jq` silently ignored: api.go now routes through
WriteJSONFiltered with jopts.JQ.
- AGENTS.md: drop the false claim that `auth logout` honors `-y`
(logout is local-only with no ConfirmDestructive guard); list the
actual destructive commands instead.
- Rewrite cli/acceptance/e2e/e2e_test.go for the bare-data wire shape
(was still parsing `out["data"]` / `env["ok"]`).
- Add `JSONOptions.Emit(w, v)` helper; collapse ~33 repeated
`format.WriteJSONFiltered(iostreams.IO.Out, X, jopts.Fields,
jopts.JQ)` sites to `jopts.Emit(iostreams.IO.Out, X)` — drops the
format import from 22 cmd/* files.
- Delete single-caller `cmdutil.MustRequireFlag`; inline as
`_ = cmd.MarkFlagRequired(...)` everywhere.
- Add `_ = cmd.MarkFlagRequired("name")` to `kb create`; it was the
only write command relying on runtime --name validation while
`context add` already used the cobra-level mark.
- `context use`: register `--json` / `--jq` (was always emitting JSON
unconditionally with no human path and no flag — diverged from
every other write command); human mode now prints
`✓ Switched context to X (was Y)`.
- Replace per-package `confirmPrompter` / `scriptedConfirm` /
`errPrompter` test doubles with `testutil.ConfirmPrompter`.
- Rename `chatService` → `ChatService` (export to match siblings
`ListService` / `ViewService`); rename `printUploadSuccess` →
`renderUploadSuccess` (siblings use `render*`).
- `defaultHint(CodeResourceNotFound)`: drop the hardcoded
"list available with `weknora kb list`" — misleading on agent /
doc / session 404. Replaced with "verify the resource ID and try
again".
- Strip stale `v0.2/v0.3` / "envelope" / "v0.0/v0.1 supports only"
historical tags from production comments and a few test
descriptions.
131 lines
3.7 KiB
Go
131 lines
3.7 KiB
Go
package contextcmd
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
func TestUse_OK(t *testing.T) {
|
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
cfg := &config.Config{
|
|
CurrentContext: "staging",
|
|
Contexts: map[string]config.Context{
|
|
"staging": {Host: "https://staging.example.com"},
|
|
"production": {Host: "https://prod.example.com"},
|
|
},
|
|
}
|
|
if err := config.Save(cfg); err != nil {
|
|
t.Fatalf("Save initial config: %v", err)
|
|
}
|
|
|
|
if err := runUse("production", nil); err != nil {
|
|
t.Fatalf("runUse: %v", err)
|
|
}
|
|
|
|
got, err := config.Load()
|
|
if err != nil {
|
|
t.Fatalf("reload: %v", err)
|
|
}
|
|
if got.CurrentContext != "production" {
|
|
t.Errorf("CurrentContext = %q, want production", got.CurrentContext)
|
|
}
|
|
if !strings.Contains(out.String(), "production") {
|
|
t.Errorf("output should mention switched-to context, got %q", out.String())
|
|
}
|
|
}
|
|
|
|
func TestUse_NotFound_WithDidYouMean(t *testing.T) {
|
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
cfg := &config.Config{Contexts: map[string]config.Context{
|
|
"production": {Host: "https://prod"},
|
|
"staging": {Host: "https://staging"},
|
|
}}
|
|
if err := config.Save(cfg); err != nil {
|
|
t.Fatalf("Save: %v", err)
|
|
}
|
|
|
|
err := runUse("prodution", nil) // typo: missing 'c'
|
|
if err == nil {
|
|
t.Fatal("expected error")
|
|
}
|
|
cm, ok := err.(*cmdutil.Error)
|
|
if !ok {
|
|
t.Fatalf("expected *cmdutil.Error, got %T", err)
|
|
}
|
|
if cm.Code != cmdutil.CodeLocalContextNotFound {
|
|
t.Errorf("code = %q, want %q", cm.Code, cmdutil.CodeLocalContextNotFound)
|
|
}
|
|
if cm.Hint != `did you mean: "production"?` {
|
|
t.Errorf("hint should be exact `did you mean: \"production\"?`, got %q", cm.Hint)
|
|
}
|
|
}
|
|
|
|
// TestUse_NotFound_DeterministicTieBreak guards against map-iteration-order
|
|
// flake: when two candidates have equal levenshtein distance, the suggestion
|
|
// must be reproducibly the lexicographically-smaller one.
|
|
func TestUse_NotFound_DeterministicTieBreak(t *testing.T) {
|
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
|
_, _ = iostreams.SetForTest(t)
|
|
cfg := &config.Config{Contexts: map[string]config.Context{
|
|
"prod": {Host: "https://a"},
|
|
"prom": {Host: "https://b"},
|
|
"prog": {Host: "https://c"},
|
|
}}
|
|
if err := config.Save(cfg); err != nil {
|
|
t.Fatalf("Save: %v", err)
|
|
}
|
|
// "prox" is distance 1 from prod / prom (both win); lex tie-break → prod.
|
|
for i := 0; i < 5; i++ {
|
|
err := runUse("prox", nil)
|
|
if err == nil {
|
|
t.Fatalf("iter %d: expected error", i)
|
|
}
|
|
cm := err.(*cmdutil.Error)
|
|
if cm.Hint != `did you mean: "prod"?` {
|
|
t.Fatalf("iter %d: tie-break must pick lex-smallest 'prod', got %q", i, cm.Hint)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestUse_NotFound_EmptyContexts(t *testing.T) {
|
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
err := runUse("anything", nil)
|
|
if err == nil {
|
|
t.Fatal("expected error")
|
|
}
|
|
cm := err.(*cmdutil.Error)
|
|
if !strings.Contains(cm.Hint, "auth login") {
|
|
t.Errorf("hint should mention `auth login` for empty Contexts, got %q", cm.Hint)
|
|
}
|
|
}
|
|
|
|
func TestUse_CaseSensitive(t *testing.T) {
|
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
cfg := &config.Config{Contexts: map[string]config.Context{
|
|
"Production": {Host: "https://prod"},
|
|
}}
|
|
_ = config.Save(cfg)
|
|
|
|
err := runUse("production", nil) // lowercase — must NOT match "Production"
|
|
if err == nil {
|
|
t.Fatal("expected case-sensitive miss")
|
|
}
|
|
cm := err.(*cmdutil.Error)
|
|
// did-you-mean kicks in (distance 1 — "P"→"p")
|
|
if !strings.Contains(cm.Hint, "Production") {
|
|
t.Errorf("hint should suggest 'Production' (case-different), got %q", cm.Hint)
|
|
}
|
|
}
|