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
190 lines
7.4 KiB
Go
190 lines
7.4 KiB
Go
package kb
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"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"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
"github.com/Tencent/WeKnora/cli/internal/testutil"
|
|
)
|
|
|
|
// fakeDeleteSvc records what id was deleted.
|
|
type fakeDeleteSvc struct {
|
|
err error
|
|
gotID string
|
|
called bool
|
|
}
|
|
|
|
func (f *fakeDeleteSvc) DeleteKnowledgeBase(_ context.Context, id string) error {
|
|
f.called = true
|
|
f.gotID = id
|
|
return f.err
|
|
}
|
|
|
|
func TestDelete_Success_WithForce(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{}
|
|
p := &testutil.ConfirmPrompter{}
|
|
opts := &DeleteOptions{Yes: true}
|
|
require.NoError(t, runDelete(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, p, "kb_force"))
|
|
|
|
assert.True(t, svc.called)
|
|
assert.Equal(t, "kb_force", svc.gotID)
|
|
assert.False(t, p.Asked, "--force must skip the confirm prompt")
|
|
assert.Contains(t, out.String(), "✓ Deleted")
|
|
assert.Contains(t, out.String(), "kb_force")
|
|
}
|
|
|
|
func TestDelete_NotFound(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{err: errors.New("HTTP error 404: not found")}
|
|
p := &testutil.ConfirmPrompter{}
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, p, "kb_missing")
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
}
|
|
|
|
func TestDelete_NonTTY_NoYes_RequiresConfirmation(t *testing.T) {
|
|
// SetForTest uses bytes.Buffer for Out - IsStdoutTTY() = false. Without
|
|
// -y/--yes, exit-10 protocol fires (see cli/README.md): the CLI must NOT
|
|
// silently proceed in scripted contexts.
|
|
iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{}
|
|
p := &testutil.ConfirmPrompter{}
|
|
err := runDelete(context.Background(), &DeleteOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, p, "kb_nontty")
|
|
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputConfirmationRequired, typed.Code)
|
|
assert.False(t, svc.called, "non-TTY without -y must not call DeleteKnowledgeBase")
|
|
assert.False(t, p.Asked, "non-TTY ⇒ Confirm is never invoked")
|
|
assert.Equal(t, 10, cmdutil.ExitCode(err), "exit code 10 per destructive-write protocol")
|
|
}
|
|
|
|
func TestDelete_JSONOutput(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{}
|
|
p := &testutil.ConfirmPrompter{}
|
|
opts := &DeleteOptions{Yes: true}
|
|
require.NoError(t, runDelete(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, p, "kb_json"))
|
|
|
|
got := out.String()
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data map[string]any `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_json", env.Data["id"], "envelope.data.id must be kb_json")
|
|
assert.Equal(t, true, env.Data["deleted"], "envelope.data.deleted must be true")
|
|
}
|
|
|
|
// The remaining tests cover the interactive confirm path which only fires
|
|
// under IsStdoutTTY() && !JSONOut - exercised via SetForTestWithTTY.
|
|
|
|
func TestDelete_ConfirmYes(t *testing.T) {
|
|
_, _ = iostreams.SetForTestWithTTY(t)
|
|
svc := &fakeDeleteSvc{}
|
|
p := &testutil.ConfirmPrompter{Answer: true}
|
|
require.NoError(t, runDelete(context.Background(), &DeleteOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, p, "kb_yes"))
|
|
|
|
assert.True(t, p.Asked, "confirm prompt should fire on TTY without --force")
|
|
assert.True(t, svc.called, "answer=yes ⇒ delete proceeds")
|
|
assert.Equal(t, "kb_yes", svc.gotID)
|
|
}
|
|
|
|
func TestDelete_ConfirmNo(t *testing.T) {
|
|
_, errBuf := iostreams.SetForTestWithTTY(t)
|
|
svc := &fakeDeleteSvc{}
|
|
p := &testutil.ConfirmPrompter{Answer: false}
|
|
err := runDelete(context.Background(), &DeleteOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, p, "kb_no")
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeUserAborted, typed.Code)
|
|
assert.True(t, p.Asked)
|
|
assert.False(t, svc.called, "answer=no ⇒ delete must NOT run")
|
|
assert.Contains(t, errBuf.String(), "Aborted")
|
|
}
|
|
|
|
func TestDelete_ConfirmPrompterError(t *testing.T) {
|
|
_, _ = iostreams.SetForTestWithTTY(t)
|
|
svc := &fakeDeleteSvc{}
|
|
p := &testutil.ConfirmPrompter{Err: prompt.ErrAgentNoPrompt}
|
|
err := runDelete(context.Background(), &DeleteOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, p, "kb_err")
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputMissingFlag, typed.Code,
|
|
"prompter error should surface as missing-flag (pass --force)")
|
|
assert.False(t, svc.called)
|
|
}
|
|
|
|
func TestDelete_JSONOut_NoYes_RequiresConfirmation(t *testing.T) {
|
|
// Even on a TTY, --format json indicates a scripted caller; cannot prompt.
|
|
// Exit-10 protocol must fire when -y is absent.
|
|
iostreams.SetForTestWithTTY(t)
|
|
svc := &fakeDeleteSvc{}
|
|
p := &testutil.ConfirmPrompter{}
|
|
opts := &DeleteOptions{}
|
|
err := runDelete(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, p, "kb_jtty")
|
|
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputConfirmationRequired, typed.Code)
|
|
assert.False(t, p.Asked, "--format json must skip the prompt even on TTY")
|
|
assert.False(t, svc.called, "--format json without -y must not call DeleteKnowledgeBase")
|
|
assert.Equal(t, 10, cmdutil.ExitCode(err))
|
|
}
|
|
|
|
func TestDelete_JSONOut_WithYes_Proceeds(t *testing.T) {
|
|
// --format json + -y is the agent happy-path: scripted caller with explicit
|
|
// approval. Must call SDK and emit the bare result object.
|
|
out, _ := iostreams.SetForTestWithTTY(t)
|
|
svc := &fakeDeleteSvc{}
|
|
p := &testutil.ConfirmPrompter{}
|
|
opts := &DeleteOptions{Yes: true}
|
|
require.NoError(t, runDelete(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, p, "kb_jtty"))
|
|
|
|
assert.False(t, p.Asked, "-y must skip the prompt")
|
|
assert.True(t, svc.called)
|
|
assert.Contains(t, out.String(), `"deleted":true`)
|
|
}
|
|
|
|
func TestKbDelete_NoYes_JSONMode_AttachesRiskAndRetry(t *testing.T) {
|
|
// Non-TTY + JSON mode without -y must return CodeInputConfirmationRequired
|
|
// with risk.action == "kb.delete" and retry_command == "weknora kb delete kb_x -y".
|
|
// Regression test for H1: ConfirmDestructive must attach risk + retry_command.
|
|
iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{}
|
|
p := &testutil.ConfirmPrompter{}
|
|
opts := &DeleteOptions{Yes: false}
|
|
|
|
err := runDelete(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, p, "kb_x")
|
|
|
|
require.Error(t, err, "expected confirmation_required error")
|
|
ce := cmdutil.AsError(err)
|
|
require.NotNil(t, ce, "expected *cmdutil.Error; got %T %v", err, err)
|
|
assert.Equal(t, cmdutil.CodeInputConfirmationRequired, ce.Code)
|
|
assert.False(t, svc.called, "SDK must not be called without confirmation")
|
|
assert.False(t, p.Asked, "--format json must not prompt even on test setup")
|
|
require.NotNil(t, ce.Risk, "expected risk metadata on confirmation_required error")
|
|
assert.Equal(t, "kb.delete", ce.Risk.Action, "expected risk.action == kb.delete")
|
|
assert.Equal(t, "destructive", ce.Risk.Level, "expected risk.level == destructive")
|
|
assert.Equal(t, "weknora kb delete kb_x -y", ce.RetryCommand, "expected retry_command")
|
|
}
|