2ce348d020
D1 — --format default flipped to json regardless of TTY: - v0.6: smart default (text on TTY, json on pipe). - v0.7: always json; TTY only affects indent (compact in pipe). Enum values unchanged (text | json | ndjson). - Typed FormatMode enum replaces untyped string consts. - --format / --jq promoted to persistent root flags so unknown- subcommand paths still reach the typed-envelope guard (per-command registration in v0.6 would have rejected --format on unknown commands as cobra-prose exit 2). - WEKNORA_FORMAT env var added; precedence --format > env > default. Invalid env values silently ignored. D2 — chat / session ask default to NDJSON event-stream: - New cli/internal/output/ndjson_stream.go: InitEvent struct + EmitInit / EmitSDKEvent / WriteNDJSONLine helpers. EmitInit doc encodes the must-be-first-line invariant agents key on. - chat / session ask: --format json AND --format ndjson both emit one JSON event per line (no envelope wrapping). CLI injects exactly one `init` event at stream head carrying session_id + optional kb_id / agent_id / profile. Subsequent events pass through verbatim from the SDK (passthrough discipline per spec §5.1). - --format text keeps the SSE-style live renderer. context → profile full cascade: - Command group: cli/cmd/context/ → cli/cmd/profile/ (git mv; package contextcmd → profilecmd). - Global flag --context → --profile. Factory.ContextOverride → ProfileOverride. WEKNORA_PROFILE env var honored (--profile flag > env > config.CurrentContext). When --profile or WEKNORA_PROFILE references a missing profile, the error is input.invalid_argument with hint "weknora profile list" — not the destructive local.config_corrupt path (which would have told users to delete their config file). - Binding file .weknora/project.yaml field context: → profile: (no backwards-compat alias; re-run weknora link). - profile use JSON fields current_context / previous_context → current_profile / previous_profile. - weknora link JSON field context → profile. - CodeLocalContextNotFound → CodeLocalProfileNotFound (typed code rename). - Envelope top-level profile field populated via globalProfile (set by root PersistentPreRunE from Factory.ActiveProfile). chat / session ask NDJSON init event carries the same profile. - Rationale: "context" collided with LLM context window / RAG context / Go context.Context; mainstream multi-credential CLIs (AWS / Stripe / OpenAI / Anthropic / lark) all use "profile". H2/C1' help calibration: - AgentHelp gains Warnings []string; single SetAgentHelp helper routes on WEKNORA_AGENT_HELP=1 (emits JSON blob including warnings) vs human help (appends "AI agents:" block from same source). Warnings surface as both a structured JSON field and visible help-text addendum without drift. - 9 destructive commands carry warnings: kb / doc / agent / session / chunk delete; profile remove; kb / agent edit; auth logout. - weknora doc wait dedups ids at entry; SIGINT mid-wait returns silently (root signal handler maps to exit 130) instead of being miscategorised as operation.timeout / operation.failed. A4 — docs: - cli/AGENTS.md gains four agent-facing sections: Wire contract for AI agents (stdout / stderr / NDJSON / _notice evolution / SDK contract boundary); Deliberate deviations + mainstream alignments; Pre-1.0 breaking policy; Exit-10 anti-patterns. ERROR_REFERENCE table extended. - cli/README.md adds Agent quick start under Wire contract. - cli/CHANGELOG.md v0.7 section: BREAKING entries with migration notes, Added (WEKNORA_FORMAT / WEKNORA_PROFILE / retry_command / retry_after_seconds / risk / _notice reserved infra / meta.count / meta.has_more / doc fetch / doc create / session ask / doc delete --all / NDJSON init), Changed (docs additions), Deprecated (none — pre-release one-shot breaking). Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §3 / §4 / §5 / §6 / §11
206 lines
7.0 KiB
Go
206 lines
7.0 KiB
Go
package kb
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
type fakeListSvc struct {
|
|
items []sdk.KnowledgeBase
|
|
err error
|
|
}
|
|
|
|
func (f *fakeListSvc) ListKnowledgeBases(ctx context.Context) ([]sdk.KnowledgeBase, error) {
|
|
return f.items, f.err
|
|
}
|
|
|
|
func TestList_Empty_Text(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
if err := runList(context.Background(), &ListOptions{Limit: 30}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &fakeListSvc{items: []sdk.KnowledgeBase{}}); err != nil {
|
|
t.Fatalf("runList: %v", err)
|
|
}
|
|
if !strings.Contains(out.String(), "(no knowledge bases)") {
|
|
t.Errorf("empty output expected '(no knowledge bases)', got %q", out.String())
|
|
}
|
|
}
|
|
|
|
func TestList_Empty_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}
|
|
if err := runList(context.Background(), &ListOptions{Limit: 30}, fopts, &fakeListSvc{items: []sdk.KnowledgeBase{}}); err != nil {
|
|
t.Fatalf("runList: %v", err)
|
|
}
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data []sdk.KnowledgeBase `json:"data"`
|
|
}
|
|
if err := json.Unmarshal(out.Bytes(), &env); err != nil {
|
|
t.Fatalf("parse: %v\n%s", err, out.String())
|
|
}
|
|
if !env.OK {
|
|
t.Error("envelope.ok must be true")
|
|
}
|
|
if len(env.Data) != 0 {
|
|
t.Errorf("expected empty data, got %d items", len(env.Data))
|
|
}
|
|
}
|
|
|
|
func TestList_NonEmpty_Text_RenderColumns(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
now := time.Now()
|
|
items := []sdk.KnowledgeBase{
|
|
{ID: "kb1", Name: "Marketing", KnowledgeCount: 5, UpdatedAt: now.Add(-3 * time.Hour)},
|
|
{ID: "kb2", Name: "Engineering", KnowledgeCount: 1, UpdatedAt: now.Add(-2 * 24 * time.Hour)},
|
|
}
|
|
if err := runList(context.Background(), &ListOptions{Limit: 30}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &fakeListSvc{items: items}); err != nil {
|
|
t.Fatalf("runList: %v", err)
|
|
}
|
|
got := out.String()
|
|
for _, want := range []string{"ID", "NAME", "DOCS", "UPDATED", "kb1", "Marketing", "5 docs", "kb2", "Engineering", "1 doc"} {
|
|
if !strings.Contains(got, want) {
|
|
t.Errorf("output missing %q in:\n%s", want, got)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestList_JSON_JQProjection(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
now := time.Now()
|
|
items := []sdk.KnowledgeBase{
|
|
{ID: "kb1", Name: "Marketing", Description: "MKT desc", UpdatedAt: now},
|
|
}
|
|
// --jq projects from the envelope; .data[] | ... extracts from the array inside envelope.
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON, JQ: ".data[] | {id, name}"}
|
|
if err := runList(context.Background(), &ListOptions{Limit: 30}, fopts, &fakeListSvc{items: items}); err != nil {
|
|
t.Fatalf("runList: %v", err)
|
|
}
|
|
var item map[string]any
|
|
if err := json.Unmarshal(out.Bytes(), &item); err != nil {
|
|
t.Fatalf("parse: %v\n%s", err, out.String())
|
|
}
|
|
if item["id"] != "kb1" || item["name"] != "Marketing" {
|
|
t.Errorf("kept fields wrong: %+v", item)
|
|
}
|
|
if _, has := item["description"]; has {
|
|
t.Errorf("description should be dropped, got: %+v", item)
|
|
}
|
|
}
|
|
|
|
func TestList_JSON_JQ(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
now := time.Now()
|
|
items := []sdk.KnowledgeBase{
|
|
{ID: "kb1", Name: "Marketing", UpdatedAt: now},
|
|
{ID: "kb2", Name: "Engineering", UpdatedAt: now.Add(-time.Hour)},
|
|
}
|
|
// .data | length counts the items inside the envelope's data array.
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON, JQ: ".data | length"}
|
|
if err := runList(context.Background(), &ListOptions{Limit: 30}, fopts, &fakeListSvc{items: items}); err != nil {
|
|
t.Fatalf("runList: %v", err)
|
|
}
|
|
if got := strings.TrimSpace(out.String()); got != "2" {
|
|
t.Errorf("expected '2', got %q", got)
|
|
}
|
|
}
|
|
|
|
func TestList_PinnedFilter(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
now := time.Now()
|
|
items := []sdk.KnowledgeBase{
|
|
{ID: "kb1", Name: "Marketing", IsPinned: true, UpdatedAt: now},
|
|
{ID: "kb2", Name: "Engineering", IsPinned: false, UpdatedAt: now.Add(-time.Hour)},
|
|
{ID: "kb3", Name: "Finance", IsPinned: true, UpdatedAt: now.Add(-2 * time.Hour)},
|
|
}
|
|
if err := runList(context.Background(), &ListOptions{Pinned: true, Limit: 30}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &fakeListSvc{items: items}); err != nil {
|
|
t.Fatalf("runList: %v", err)
|
|
}
|
|
got := out.String()
|
|
if !strings.Contains(got, "kb1") || !strings.Contains(got, "kb3") {
|
|
t.Errorf("expected pinned KBs kb1 and kb3 in output, got:\n%s", got)
|
|
}
|
|
if strings.Contains(got, "kb2") {
|
|
t.Errorf("unpinned kb2 should be filtered out, got:\n%s", got)
|
|
}
|
|
}
|
|
|
|
func TestList_PinnedFilter_NoPinned_TextMessage(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
items := []sdk.KnowledgeBase{
|
|
{ID: "kb1", Name: "Marketing", IsPinned: false, UpdatedAt: time.Now()},
|
|
}
|
|
if err := runList(context.Background(), &ListOptions{Pinned: true, Limit: 30}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &fakeListSvc{items: items}); err != nil {
|
|
t.Fatalf("runList: %v", err)
|
|
}
|
|
if !strings.Contains(out.String(), "(no pinned knowledge bases)") {
|
|
t.Errorf("expected pinned-specific empty message, got: %q", out.String())
|
|
}
|
|
}
|
|
|
|
// makeKBs returns N KBs with distinct IDs and descending UpdatedAt.
|
|
func makeKBs(n int) []sdk.KnowledgeBase {
|
|
base := time.Now()
|
|
out := make([]sdk.KnowledgeBase, n)
|
|
for i := 0; i < n; i++ {
|
|
out[i] = sdk.KnowledgeBase{
|
|
ID: fmt.Sprintf("kb_%02d", i),
|
|
Name: fmt.Sprintf("kb-%02d", i),
|
|
UpdatedAt: base.Add(-time.Duration(i) * time.Hour),
|
|
}
|
|
}
|
|
return out
|
|
}
|
|
|
|
func TestList_Limit_CapsResults(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{items: makeKBs(20)}
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}
|
|
if err := runList(context.Background(), &ListOptions{Limit: 5}, fopts, svc); err != nil {
|
|
t.Fatalf("runList: %v", err)
|
|
}
|
|
got := strings.Count(out.String(), `"id":"kb_`)
|
|
if got != 5 {
|
|
t.Errorf("--limit 5 should slice 20 items to 5; got %d in:\n%s", got, out.String())
|
|
}
|
|
}
|
|
|
|
func TestList_Limit_Zero_Rejected(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{items: makeKBs(7)}
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}
|
|
err := runList(context.Background(), &ListOptions{Limit: 0}, fopts, svc)
|
|
if err == nil {
|
|
t.Fatal("expected error for --limit 0")
|
|
}
|
|
var typed *cmdutil.Error
|
|
if !errors.As(err, &typed) {
|
|
t.Fatalf("expected *cmdutil.Error, got %T: %v", err, err)
|
|
}
|
|
if typed.Code != cmdutil.CodeInputInvalidArgument {
|
|
t.Errorf("expected CodeInputInvalidArgument, got %v", typed.Code)
|
|
}
|
|
}
|
|
|
|
func TestList_Limit_Negative_Rejected(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
err := runList(context.Background(), &ListOptions{Limit: -1}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &fakeListSvc{items: makeKBs(3)})
|
|
if err == nil {
|
|
t.Fatal("expected error for negative --limit")
|
|
}
|
|
var typed *cmdutil.Error
|
|
if !errors.As(err, &typed) {
|
|
t.Fatalf("expected *cmdutil.Error, got %T: %v", err, err)
|
|
}
|
|
if typed.Code != cmdutil.CodeInputInvalidArgument {
|
|
t.Errorf("expected CodeInputInvalidArgument, got %v", typed.Code)
|
|
}
|
|
}
|