mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-02 05:03:00 +08:00
A hardening + finalization pass over the agent-first CLI: correctness fixes,
richer machine-readable signals, flag/naming consistency, and a symmetric
config surface. Pre-1.0, so it includes breaking renames.
Correctness:
- agent update: resolve/validate --model/--rerank-model (was storing a bogus
name verbatim, corrupting config.model_id).
- doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports
"no host configured").
- session ask / MCP session_ask: text answer was empty on non-TTY — the agent
stream sets Done=true on an intermediate agent_query frame before the answer,
and AgentAccumulator treated the first Done as terminal. Terminate on the
`complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done.
- batch exit codes: any per-item failure collapses to operation.failed (exit 1),
including `doc upload --recursive` partial failures — a permanent per-file
failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent
would loop on; per-item typed errors stay in the envelope.
Agent-first signals & discovery:
- error.exit_code in the envelope (type + exit_code disambiguate the
input.invalid_argument exit-2-vs-5 split in one JSON read).
- meta.hint on empty content search and on draft doc create; doc wait fails fast
on a never-parsing draft instead of hanging to --timeout.
- retrieval-readiness is visible in the natural flow: kb status / kb check emit
retrieval_ready, and kb create hints the fix when no embedding model is bound
— an unconfigured KB no longer looks silently healthy.
- schema contract completeness: every leaf declares output + >=1 example
(drift-guarded); output strings match the meta actually emitted; chunk list
and search docs now emit meta.total_count (both previously dropped it).
- schema tolerates a quoted multi-word command label; zero-state auth — and
`link` with no profile — point at profile setup / the headless WEKNORA_KB_ID
path instead of looping on `auth login`.
- id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view
accept and ignore it, declared in schema) so a carried-over --kb doesn't
exit 2; streaming commands warn that --jq does not apply to an NDJSON stream.
- keep JSON-always as the default; --jq hints spell out the .data path.
Consistency & gating:
- doc create: drop the deprecated --name alias (--title only; pre-1.0 break).
- chunk list --limit aligned to 1..10000; model list --limit/-L with
has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install
expands a leading ~.
- docs corrected: search docs / doc list --keyword help is case-insensitive
(server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add
model.update / kb.config.set) and batch example (failed item carries `error`);
session resume --message id comes from `message list`, not the stream.
- auth/profile ergonomics: env credentials are now first-class — `auth token`
prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh
give an env-aware message instead of looping on "run auth login". `auth logout`
clears credentials but keeps the profile registered (host preserved for
re-login); deleting a profile is `profile remove`'s job (clean logout/remove
separation, matching gh / lark).
Config surface (symmetric read/write, in-place model edits):
- kb config now returns a secret-free KBModelConfigView (was {}); `kb config`
reads, new `kb config set` writes; `kb init` removed (misnomer).
- kb create --chat-model: retrieval-ready in one step.
- model update: edit a model in place (id preserved, references survive) —
rotate --api-key-stdin, change base-url / display-name / etc.
- session continue-stream renamed to session resume.
Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale
kb-init / continue-stream references removed; skill wire-vocab guard extended.
AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an
embedding model to be searchable), that --jq does not apply to NDJSON
streams, and the env-credential-first auth path; the KB quickstart example
now creates a retrieval-ready KB.
120 lines
4.1 KiB
Go
120 lines
4.1 KiB
Go
package cmd
|
|
|
|
import (
|
|
"encoding/json"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
// TestSchema_Index: `weknora schema` lists every leaf command with its purpose.
|
|
func TestSchema_Index(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
root := NewRootCmd(cmdutil.New())
|
|
root.SetArgs([]string{"schema", "--format", "json"})
|
|
require.NoError(t, root.Execute())
|
|
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data []schemaIndexEntry `json:"data"`
|
|
Meta struct {
|
|
Count int `json:"count"`
|
|
} `json:"meta"`
|
|
}
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env), "got %q", out.String())
|
|
assert.True(t, env.OK)
|
|
assert.Greater(t, env.Meta.Count, 30, "index should enumerate the whole leaf surface")
|
|
|
|
byCmd := map[string]string{}
|
|
for _, e := range env.Data {
|
|
byCmd[e.Command] = e.UsedFor
|
|
}
|
|
// schema lists itself and other leaves, each with a used_for.
|
|
assert.Contains(t, byCmd, "kb create")
|
|
assert.Contains(t, byCmd, "schema")
|
|
assert.NotEmpty(t, byCmd["kb create"])
|
|
// group commands (kb, doc) are not leaves and must not appear.
|
|
assert.NotContains(t, byCmd, "kb")
|
|
}
|
|
|
|
// TestSchema_SingleCommand: a command path emits its full contract incl. flags.
|
|
func TestSchema_SingleCommand(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
root := NewRootCmd(cmdutil.New())
|
|
root.SetArgs([]string{"schema", "kb", "create", "--format", "json"})
|
|
require.NoError(t, root.Execute())
|
|
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data commandSchema `json:"data"`
|
|
}
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env), "got %q", out.String())
|
|
assert.True(t, env.OK)
|
|
assert.Equal(t, "kb create", env.Data.Command)
|
|
assert.NotEmpty(t, env.Data.UsedFor)
|
|
assert.NotEmpty(t, env.Data.Examples)
|
|
|
|
flagNames := map[string]bool{}
|
|
for _, f := range env.Data.Flags {
|
|
flagNames[f.Name] = true
|
|
}
|
|
assert.True(t, flagNames["description"], "kb create local flags should include --description; got %v", flagNames)
|
|
// global persistent flags (--format, --profile) are inherited, not local —
|
|
// schema lists only command-specific flags.
|
|
assert.False(t, flagNames["profile"], "inherited global flags must be excluded")
|
|
}
|
|
|
|
// TestSchema_QuotedMultiWordArg: the no-arg `schema` index prints command
|
|
// labels like "agent create"; an agent that pastes that label back as a single
|
|
// quoted arg (`schema "agent create"`) must resolve the same as two tokens,
|
|
// not fail with unknown_subcommand.
|
|
func TestSchema_QuotedMultiWordArg(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
root := NewRootCmd(cmdutil.New())
|
|
root.SetArgs([]string{"schema", "agent create", "--format", "json"})
|
|
require.NoError(t, root.Execute(), "got %q", out.String())
|
|
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data commandSchema `json:"data"`
|
|
}
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env), "got %q", out.String())
|
|
assert.True(t, env.OK)
|
|
assert.Equal(t, "agent create", env.Data.Command)
|
|
}
|
|
|
|
// TestSchema_SurfacesRisk: a destructive command exposes its risk annotation,
|
|
// so an agent can discover confirmation-gating without running the command.
|
|
func TestSchema_SurfacesRisk(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
root := NewRootCmd(cmdutil.New())
|
|
root.SetArgs([]string{"schema", "doc", "update", "--format", "json"})
|
|
require.NoError(t, root.Execute())
|
|
|
|
var env struct {
|
|
Data commandSchema `json:"data"`
|
|
}
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env), "got %q", out.String())
|
|
require.NotNil(t, env.Data.Risk)
|
|
assert.Equal(t, "doc.update", env.Data.Risk.Action)
|
|
assert.Equal(t, "write", env.Data.Risk.Level)
|
|
}
|
|
|
|
// TestSchema_UnknownCommand: a bad path returns a typed unknown_subcommand
|
|
// error (exit 5) with a did-you-mean hint — never a silent empty result.
|
|
func TestSchema_UnknownCommand(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
root := NewRootCmd(cmdutil.New())
|
|
root.SetArgs([]string{"schema", "kbb", "--format", "json"})
|
|
err := root.Execute()
|
|
require.Error(t, err)
|
|
var ce *cmdutil.Error
|
|
require.ErrorAs(t, err, &ce)
|
|
assert.Equal(t, cmdutil.CodeInputUnknownSubcommand, ce.Code)
|
|
assert.Contains(t, ce.Hint, "did you mean")
|
|
}
|