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
166 lines
6.1 KiB
Go
166 lines
6.1 KiB
Go
package kb
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakeEditSvc captures the (id, request) pair handed to UpdateKnowledgeBase
|
|
// and scripts the GetKnowledgeBase fetch used by the fetch-then-update path.
|
|
type fakeEditSvc struct {
|
|
current *sdk.KnowledgeBase // returned by GetKnowledgeBase
|
|
currentErr error
|
|
gotID string
|
|
gotReq *sdk.UpdateKnowledgeBaseRequest
|
|
resp *sdk.KnowledgeBase
|
|
err error
|
|
}
|
|
|
|
func (f *fakeEditSvc) GetKnowledgeBase(_ context.Context, id string) (*sdk.KnowledgeBase, error) {
|
|
if f.currentErr != nil {
|
|
return nil, f.currentErr
|
|
}
|
|
if f.current != nil {
|
|
return f.current, nil
|
|
}
|
|
return &sdk.KnowledgeBase{ID: id}, nil
|
|
}
|
|
|
|
func (f *fakeEditSvc) UpdateKnowledgeBase(_ context.Context, id string, req *sdk.UpdateKnowledgeBaseRequest) (*sdk.KnowledgeBase, error) {
|
|
f.gotID = id
|
|
f.gotReq = req
|
|
return f.resp, f.err
|
|
}
|
|
|
|
func TestEdit_RequiresAtLeastOneFlag(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeEditSvc{}
|
|
err := runEdit(context.Background(), &EditOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_abc")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputMissingFlag, typed.Code)
|
|
assert.Contains(t, typed.Hint, "--name")
|
|
assert.Contains(t, typed.Hint, "--description")
|
|
}
|
|
|
|
// When only --name is passed, the request must carry the user's new name
|
|
// AND the current Description (preserved via the fetch). Sending Description=""
|
|
// would clobber the server-side value because UpdateKnowledgeBaseRequest
|
|
// fields are `string`, not `*string`.
|
|
func TestEdit_OnlyName_PreservesCurrentDescription(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeEditSvc{
|
|
current: &sdk.KnowledgeBase{ID: "kb_abc", Name: "old", Description: "keep me"},
|
|
resp: &sdk.KnowledgeBase{ID: "kb_abc", Name: "new", Description: "keep me"},
|
|
}
|
|
opts := &EditOptions{}
|
|
opts.Name = stringPtr("new")
|
|
require.NoError(t, runEdit(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_abc"))
|
|
|
|
assert.Equal(t, "kb_abc", svc.gotID)
|
|
require.NotNil(t, svc.gotReq)
|
|
assert.Equal(t, "new", svc.gotReq.Name)
|
|
assert.Equal(t, "keep me", svc.gotReq.Description, "Description must be preserved from fetch when not in --description")
|
|
assert.Contains(t, out.String(), "kb_abc")
|
|
}
|
|
|
|
// Symmetric: only --description must preserve current Name. The server's
|
|
// `Name required` validation made this case fail without the fetch.
|
|
func TestEdit_OnlyDescription_PreservesCurrentName(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeEditSvc{
|
|
current: &sdk.KnowledgeBase{ID: "kb_abc", Name: "keep me", Description: "old"},
|
|
resp: &sdk.KnowledgeBase{ID: "kb_abc"},
|
|
}
|
|
opts := &EditOptions{}
|
|
opts.Description = stringPtr("new desc")
|
|
require.NoError(t, runEdit(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_abc"))
|
|
|
|
require.NotNil(t, svc.gotReq)
|
|
assert.Equal(t, "new desc", svc.gotReq.Description)
|
|
assert.Equal(t, "keep me", svc.gotReq.Name, "Name must be preserved from fetch when not in --name")
|
|
}
|
|
|
|
func TestEdit_BothFlags(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeEditSvc{resp: &sdk.KnowledgeBase{ID: "kb_abc"}}
|
|
opts := &EditOptions{}
|
|
opts.Name = stringPtr("renamed")
|
|
opts.Description = stringPtr("new desc")
|
|
require.NoError(t, runEdit(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_abc"))
|
|
assert.Equal(t, "renamed", svc.gotReq.Name)
|
|
assert.Equal(t, "new desc", svc.gotReq.Description)
|
|
}
|
|
|
|
func TestEdit_NotFound(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
// 404 must come from the GetKnowledgeBase pre-fetch in the fetch-then-
|
|
// update flow - that's the first server roundtrip when the id is bad.
|
|
svc := &fakeEditSvc{currentErr: errors.New("HTTP error 404: not found")}
|
|
opts := &EditOptions{}
|
|
opts.Name = stringPtr("x")
|
|
err := runEdit(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_missing")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
}
|
|
|
|
func stringPtr(s string) *string { return &s }
|
|
|
|
// withRootHarnessKB wraps `weknora kb edit ...` under a synthetic root cmd
|
|
// that registers the global persistent flags (mirrors addGlobalFlags in
|
|
// cmd/root.go). Required because NewCmdEdit reads --yes and --format from the
|
|
// persistent flag set.
|
|
func withRootHarnessKB(edit *cobra.Command, args ...string) *cobra.Command {
|
|
root := &cobra.Command{Use: "weknora"}
|
|
pf := root.PersistentFlags()
|
|
pf.BoolP("yes", "y", false, "")
|
|
pf.String("format", "", "Output format: text | json | ndjson")
|
|
pf.StringP("jq", "q", "", "")
|
|
kb := &cobra.Command{Use: "kb"}
|
|
kb.AddCommand(edit)
|
|
root.AddCommand(kb)
|
|
root.SetArgs(append([]string{"kb", "edit"}, args...))
|
|
root.SetContext(context.Background())
|
|
root.SilenceErrors = true
|
|
root.SilenceUsage = true
|
|
return root
|
|
}
|
|
|
|
// TestKBEdit_RequiresConfirmation asserts that without -y (non-TTY / JSON
|
|
// mode), kb edit returns input.confirmation_required (exit 10).
|
|
func TestKBEdit_RequiresConfirmation(t *testing.T) {
|
|
iostreams.SetForTest(t) // non-TTY
|
|
svc := &fakeEditSvc{
|
|
current: &sdk.KnowledgeBase{ID: "kb_abc", Name: "old"},
|
|
resp: &sdk.KnowledgeBase{ID: "kb_abc", Name: "new"},
|
|
}
|
|
f := &cmdutil.Factory{
|
|
Client: func() (*sdk.Client, error) { return nil, nil },
|
|
Prompter: func() prompt.Prompter { return prompt.AgentPrompter{} },
|
|
}
|
|
_ = svc // gate fires before SDK call
|
|
root := withRootHarnessKB(NewCmdEdit(f), "kb_abc", "--name", "new", "--format", "json")
|
|
err := root.Execute()
|
|
require.Error(t, err)
|
|
var ce *cmdutil.Error
|
|
require.ErrorAs(t, err, &ce)
|
|
assert.Equal(t, cmdutil.CodeInputConfirmationRequired, ce.Code)
|
|
assert.Equal(t, 10, cmdutil.ExitCode(err))
|
|
// retry command must include -y
|
|
assert.Contains(t, ce.RetryCommand, "-y")
|
|
assert.Contains(t, ce.RetryCommand, "kb_abc")
|
|
}
|