d3c03b2f34
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.
211 lines
8.1 KiB
Go
211 lines
8.1 KiB
Go
package kb
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"strings"
|
|
"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"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakeCreateSvc captures the request and returns canned responses.
|
|
type fakeCreateSvc struct {
|
|
resp *sdk.KnowledgeBase
|
|
err error
|
|
got *sdk.KnowledgeBase
|
|
}
|
|
|
|
func (f *fakeCreateSvc) CreateKnowledgeBase(_ context.Context, kb *sdk.KnowledgeBase) (*sdk.KnowledgeBase, error) {
|
|
f.got = kb
|
|
return f.resp, f.err
|
|
}
|
|
|
|
func TestCreate_Success_Text(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.KnowledgeBase{
|
|
ID: "kb_new",
|
|
Name: "Marketing",
|
|
Description: "team docs",
|
|
EmbeddingModelID: "model_x",
|
|
}}
|
|
opts := &CreateOptions{
|
|
Name: "Marketing",
|
|
Description: "team docs",
|
|
EmbeddingModel: "model_x",
|
|
}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
|
|
|
|
// Body sent to SDK matches flags.
|
|
require.NotNil(t, svc.got)
|
|
assert.Equal(t, "Marketing", svc.got.Name)
|
|
assert.Equal(t, "team docs", svc.got.Description)
|
|
assert.Equal(t, "model_x", svc.got.EmbeddingModelID)
|
|
|
|
got := out.String()
|
|
for _, want := range []string{"✓", "Created", "Marketing", "kb_new"} {
|
|
if !strings.Contains(got, want) {
|
|
t.Errorf("output missing %q in:\n%s", want, got)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestCreate_Success_OmitsEmbeddingModelWhenEmpty(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.KnowledgeBase{ID: "kb_x", Name: "n"}}
|
|
opts := &CreateOptions{Name: "n"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
|
|
|
|
require.NotNil(t, svc.got)
|
|
assert.Equal(t, "", svc.got.EmbeddingModelID, "embedding-model unset ⇒ empty in request")
|
|
}
|
|
|
|
// A KB created without an embedding model can never retrieve; the create result
|
|
// must hand the agent the fix (kb config set) instead of a silent unusable KB.
|
|
func TestCreate_HintsWhenNoEmbeddingModel(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.KnowledgeBase{ID: "kb_x", Name: "n"}}
|
|
require.NoError(t, runCreate(context.Background(), &CreateOptions{Name: "n"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc))
|
|
var env struct {
|
|
Meta struct {
|
|
Hint string `json:"hint"`
|
|
} `json:"meta"`
|
|
}
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env))
|
|
assert.Contains(t, env.Meta.Hint, "kb config set", "unconfigured KB must hint the retrieval-readiness fix")
|
|
}
|
|
|
|
// A retrieval-ready KB (embedding model bound) carries no such hint — no noise.
|
|
func TestCreate_NoHintWhenEmbeddingModelBound(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.KnowledgeBase{ID: "kb_x", Name: "n", EmbeddingModelID: "emb_1"}}
|
|
require.NoError(t, runCreate(context.Background(), &CreateOptions{Name: "n", EmbeddingModel: "emb_1"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc))
|
|
var env struct {
|
|
Meta *struct {
|
|
Hint string `json:"hint"`
|
|
} `json:"meta"`
|
|
}
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env))
|
|
if env.Meta != nil {
|
|
assert.Empty(t, env.Meta.Hint, "retrieval-ready KB must not emit a readiness hint")
|
|
}
|
|
}
|
|
|
|
// TestCreate_ChatModelSetsSummaryModelID: --chat-model rides the create request
|
|
// as summary_model_id, so a KB can be born retrieval-ready in one step.
|
|
func TestCreate_ChatModelSetsSummaryModelID(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.KnowledgeBase{ID: "kb_x", Name: "n"}}
|
|
opts := &CreateOptions{Name: "n", EmbeddingModel: "emb_x", ChatModel: "chat_x"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
|
|
|
|
require.NotNil(t, svc.got)
|
|
assert.Equal(t, "emb_x", svc.got.EmbeddingModelID)
|
|
assert.Equal(t, "chat_x", svc.got.SummaryModelID, "--chat-model must set summary_model_id on the create request")
|
|
}
|
|
|
|
func TestCreate_NameRequired(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{}
|
|
err := runCreate(context.Background(), &CreateOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc)
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
assert.Nil(t, svc.got, "service must not be called when name is missing")
|
|
}
|
|
|
|
func TestCreate_NameWhitespaceOnly(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{}
|
|
err := runCreate(context.Background(), &CreateOptions{Name: " "}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc)
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
}
|
|
|
|
func TestCreate_HTTPError_500(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{err: errors.New("HTTP error 500: internal")}
|
|
err := runCreate(context.Background(), &CreateOptions{Name: "x"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc)
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeServerError, typed.Code)
|
|
}
|
|
|
|
func TestCreate_HTTPError_409Conflict(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{err: errors.New("HTTP error 409: name exists")}
|
|
err := runCreate(context.Background(), &CreateOptions{Name: "dup"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc)
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceAlreadyExists, typed.Code)
|
|
}
|
|
|
|
func TestCreate_JSONOutput(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.KnowledgeBase{ID: "kb_99", Name: "Eng"}}
|
|
opts := &CreateOptions{Name: "Eng"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc))
|
|
|
|
got := out.String()
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data sdk.KnowledgeBase `json:"data"`
|
|
}
|
|
require.NoError(t, json.Unmarshal([]byte(got), &env), "expected valid JSON envelope, got %q", got)
|
|
assert.True(t, env.OK, "envelope.ok must be true")
|
|
assert.Equal(t, "kb_99", env.Data.ID, "envelope.data.id must be kb_99")
|
|
assert.Contains(t, got, `"name":"Eng"`)
|
|
}
|
|
|
|
func TestCreate_StorageProvider_InjectsRequest(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.KnowledgeBase{ID: "kb_s", Name: "n"}}
|
|
opts := &CreateOptions{Name: "n", StorageProvider: "Local"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
|
|
|
|
require.NotNil(t, svc.got.StorageProviderConfig)
|
|
assert.Equal(t, "local", svc.got.StorageProviderConfig.Provider, "value should be lowercased + trimmed before send")
|
|
}
|
|
|
|
func TestCreate_StorageProvider_InvalidValueReturnsInputError(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{}
|
|
opts := &CreateOptions{Name: "n", StorageProvider: "azure"}
|
|
err := runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc)
|
|
require.Error(t, err)
|
|
|
|
// A bad enum *value* (cobra accepted the string; the app rejected it) is an
|
|
// app-level input error → exit 5, consistent with every other enum flag
|
|
// (model --type, agent --agent-mode, message search --mode).
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
assert.Equal(t, 5, cmdutil.ExitCode(err), "invalid --storage-provider must exit 5 (app-level input validation)")
|
|
assert.Contains(t, err.Error(), "--storage-provider")
|
|
assert.Nil(t, svc.got, "SDK must not be called when input validation fails")
|
|
}
|
|
|
|
func TestCreate_StorageProvider_OmittedWhenEmpty(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.KnowledgeBase{ID: "kb_n", Name: "n"}}
|
|
opts := &CreateOptions{Name: "n"} // no --storage-provider
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
|
|
|
|
assert.Nil(t, svc.got.StorageProviderConfig, "empty flag must omit StorageProviderConfig (let server pick default)")
|
|
}
|