mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-08-30 16:53:21 +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.
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)
|
|
})
|
|
}
|
|
}
|
|
|