Files
WeKnora/cli/internal/cmdutil/agenthelp_test.go
T
nullkey 2ce348d020 feat(cli): --format json default + NDJSON event stream + context→profile cascade + help calibration + docs (BREAKING)
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
2026-05-27 10:56:34 +08:00

101 lines
2.8 KiB
Go

package cmdutil
import (
"bytes"
"encoding/json"
"testing"
"github.com/spf13/cobra"
)
func TestSetAgentHelp_EmitsJSONWhenEnvSet(t *testing.T) {
t.Setenv("WEKNORA_AGENT_HELP", "1")
cmd := &cobra.Command{Use: "foo"}
ah := AgentHelp{
UsedFor: "frob a bar",
RequiredFlags: []string{"--name"},
Examples: []string{"weknora foo --name=x"},
}
SetAgentHelp(cmd, ah)
var buf bytes.Buffer
cmd.SetOut(&buf)
cmd.Help()
var got AgentHelp
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
t.Fatalf("output not JSON: %v\n%s", err, buf.String())
}
if got.UsedFor != "frob a bar" {
t.Errorf("UsedFor=%q, want %q", got.UsedFor, "frob a bar")
}
if len(got.RequiredFlags) != 1 || got.RequiredFlags[0] != "--name" {
t.Errorf("RequiredFlags=%v", got.RequiredFlags)
}
}
func TestSetAgentHelp_FallsThroughToHumanHelp(t *testing.T) {
t.Setenv("WEKNORA_AGENT_HELP", "")
cmd := &cobra.Command{
Use: "foo",
Short: "frob a bar",
Long: "Detailed human help here.",
}
SetAgentHelp(cmd, AgentHelp{UsedFor: "ignored"})
var buf bytes.Buffer
cmd.SetOut(&buf)
cmd.Help()
// Should NOT be JSON (human help is text)
if json.Valid(buf.Bytes()) {
t.Errorf("expected human text, got JSON:\n%s", buf.String())
}
if !bytes.Contains(buf.Bytes(), []byte("Detailed human help")) {
t.Errorf("human help missing from output:\n%s", buf.String())
}
}
func TestSetAgentHelp_AgentJSON_NoTrailingWarningsProse(t *testing.T) {
cmd := &cobra.Command{Use: "kb-delete-test"}
SetAgentHelp(cmd, AgentHelp{
UsedFor: "Delete a knowledge base",
Warnings: []string{"irreversible"},
})
t.Setenv("WEKNORA_AGENT_HELP", "1")
var buf bytes.Buffer
cmd.SetOut(&buf)
cmd.HelpFunc()(cmd, nil)
// Should be parseable as a single JSON object with the warnings field.
var got AgentHelp
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
t.Fatalf("agent-help output is not valid JSON: %v\n%s", err, buf.String())
}
if len(got.Warnings) != 1 || got.Warnings[0] != "irreversible" {
t.Errorf("warnings field missing or wrong: %v", got.Warnings)
}
// Should NOT contain the human-prose "AI agents:" block
if bytes.Contains(buf.Bytes(), []byte("AI agents:")) {
t.Errorf("agent JSON path leaked human prose:\n%s", buf.String())
}
}
func TestSetAgentHelp_HumanHelp_AppendsWarningsBlock(t *testing.T) {
cmd := &cobra.Command{Use: "kb-delete-test", Short: "short"}
SetAgentHelp(cmd, AgentHelp{
UsedFor: "Delete a KB",
Warnings: []string{"irreversible"},
})
// Env unset → human help path
var buf bytes.Buffer
cmd.SetOut(&buf)
cmd.HelpFunc()(cmd, nil)
if !bytes.Contains(buf.Bytes(), []byte("AI agents:")) {
t.Errorf("human help should include AI agents: block; got:\n%s", buf.String())
}
if !bytes.Contains(buf.Bytes(), []byte("- irreversible")) {
t.Errorf("human help should list warning; got:\n%s", buf.String())
}
}