2ee9741fa1
Post-review polish on the v0.7 wire / surface contract. Bundles five
follow-ups that landed after the main BREAKING feat commit:
1. Complete context→profile cascade (internal API + YAML schema)
The prior commit renamed only the user-visible surface (commands /
flags / env / project link / envelope field). The internal Go API
and on-disk config schema were still half-renamed — an L-25
self-consistency violation flagged by post-merge review. Closed here:
Internal Go API:
- config.Context → config.Profile
- config.Config.CurrentContext → CurrentProfile
- config.Config.Contexts → Profiles
- LoginOptions.Context → LoginOptions.Profile
- clearContextSecrets() → clearProfileSecrets()
- saveContextRef() → saveProfileRef()
- secrets.Store: param name `context` → `profile` (interface +
FileStore + KeyringStore + MemStore)
- cmdutil.LoadSecret(store, context, key) → LoadSecret(store, profile, key)
- cmdutil.RefreshAndPersist's ctxName → profileName
- Local var `ctx := &config.Profile{...}` → `prof := &config.Profile{...}`
in auth/login.go to eliminate the visual collision with Go stdlib
context.Context that motivated the whole rename in the first place.
On-disk config.yaml schema:
- current_context: → current_profile:
- contexts: → profiles:
- Pre-1.0 break, no compat alias. Users on v0.6 dogfooded configs
must delete ~/.config/weknora/config.yaml or hand-rename the two
keys (CHANGELOG migration note added).
Tests / fixtures / golden files:
- factory_test.go YAML fixture + assertion updated.
- acceptance/e2e/e2e_test.go writeContextYAML → writeProfileYAML,
fixture YAML keys updated.
- acceptance/testdata/wire/doctor.error_network.json golden updated
("active context" → "active profile" in hint string).
User-visible prose sweep:
- cmd/mcp/serve.go --help Long: "active context (or --context)" →
"active profile (or --profile)" — most-visible miss.
- cmd/{kb/list, search/kb, session/list, api/api} Short/Long help.
- cmd/auth/login.go stdout: `(context=%s)` → `(profile=%s)`.
- cmd/auth/logout.go error: `"no current context"` → `"no current profile"`.
- cmd/doctor/doctor.go hint string (also the wire golden above).
- cmd/auth/refresh.go error: `"refresh token missing for context"` →
`"refresh token missing for profile"`.
- README.md: `## Multi-context` H2 → `## Multi-profile`; code-block
comment `# current context` → `# current profile`.
Code-comment / docstring sweep across cli/cmd/auth/ and
cli/internal/cmdutil/. Comments referencing Go stdlib context.Context,
the RAG / LLM "context window" concept, and historical CHANGELOG
entries for v0.4 / v0.5 were left alone.
CHANGELOG v0.7 BREAKING entry gains the on-disk-schema bullet under
the existing "context → profile" item.
2. Profile name validation (shell-injection guard)
`envelope.error.retry_command` is a single shell-string field. An
AI agent that exec()s it via `sh -c <retry_command>` was injectable
through a maliciously-named profile:
weknora auth logout --name 'x; rm -rf ~'
# would produce: retry_command = "weknora auth logout --name x; rm -rf ~ -y"
`cmd/profile/add.go` already enforced an alphanumeric + `-_.`
allowlist via `validateName`. The `auth login` and `auth logout`
paths bypassed it.
- Moved validation from `cmd/profile/add.go` to
`cli/internal/cmdutil/profilename.go` as exported
`ValidateProfileName` (cmdutil is the import-cycle-safe home;
internal/config can't depend on cmdutil).
- `auth login` runs the validator before any persist call.
- `auth logout` runs the validator on `opts.Name` before
constructing `retry_command`.
- Unit tests (`profilename_test.go`) cover the allowlist, empty
rejection, path-traversal, shell metacharacters (`;`, `&`, `|`,
`$()`, backticks, quotes, whitespace, glob, redirects), and the
user-facing hint text. The shell-metachar test exists as a
regression guard.
Wire shape (`retry_command` string → `retry_command_argv []string`)
remains a v0.8 additive change per ROADMAP — this fix removes the
practical exploit path without touching the wire contract.
3. AI-agent terminology disambiguation
"agent" has three referents in this codebase: (a) WeKnora's
server-side Custom Agent resource, (b) the removed `agent invoke`
verb, (c) external LLM/automation consumers. Per project memory
feedback_no_meta_disambiguation_in_docs, the fix is full-term
naming, not "X has N meanings" prose. Surgical changes at section
headers + ambiguous prose:
- AGENTS.md: "Agent decision shortcuts" → "AI agent decision
shortcuts"; "agent-callable surface" → "AI-agent-callable
surface".
- README.md: "Designed to be agent-first" → "AI-agent-first";
"Other agent ergonomics" → "Other AI-agent ergonomics"; "in
agent contexts" → "in AI-agent contexts"; "for CI / agents" →
"for CI / AI agents".
Anaphoric "agents" inside paragraphs that already established
"AI agents" was left alone — full substitution everywhere would
have been prose noise without clarity gain.
4. Wire-contract review follow-ups
Real findings from a second-pass review of the v0.7 envelope /
streaming / surface design. Per project memory
feedback_check_in_domain_anchor_first, candidate findings were
first verified against the in-domain peer CLI explicitly cited as
the envelope anchor; two earlier-flagged issues turned out to be
in-pattern and were withdrawn.
Surviving fixes:
- AGENTS.md success-envelope example rewritten. The prior example
showed `has_more: false` / `_notice: {}` as if they were always
present, but both fields are `omitempty` and never serialize
when zero / nil. Replaced with three realistic shapes (list /
single resource / mutation with no payload) and added a note
that optional fields are omitted when empty.
- cmd/chat/chat.go Args: MinimumNArgs(1) → ExactArgs(1).
v0.6 silently joined `weknora chat hello world` into
`"hello world"`. v0.7 now rejects multi-arg with exit 2,
matching `weknora session ask`. BREAKING; CHANGELOG entry
added under v0.7 BREAKING.
- internal/output/envelope.go extracts NewEnvelope(data, meta,
profile) constructor. The jq-filter path in
cmdutil.FormatOptions.Emit was manually rebuilding the
envelope literal alongside the canonical WriteEnvelope path —
drift risk when fields are added. Single construction point now.
- internal/cmdutil/factory.go adds AddKBFlag(cmd) helper.
Five files (chat, doc/list, doc/upload, doc/create, doc/fetch)
had verbatim-identical `cmd.Flags().String("kb", ...)`
declarations. Centralised so flag name + help text stay
in sync with Factory.ResolveKB. Docstring reordering + gofmt
fixup landed in the same edit to keep ResolveKB's own godoc
attached to its function.
5. OSS-readiness comment / doc sweep
Pre-publication scrub of code, comments, and shipped Markdown to
remove references that only make sense in the development repo:
- AGENTS.md "Deliberate deviations + mainstream alignments"
section: removed peer-project name-drops from the comparison
table; rewrote as five flagged design decisions with rationale
but no specific competitor named. The four rows that previously
contrasted against a named peer CLI now state WeKnora's choice
+ rationale directly. Section header renamed to "Design
decisions worth flagging" since it is no longer a
deviation/alignment matrix.
- CHANGELOG v0.7 BREAKING rationales: three references to a
named peer CLI removed; the context→profile rationale now
cites only mainstream multi-credential CLIs by category (AWS /
Stripe / OpenAI / Anthropic), and the `api -d/--data` removal
rationale cites only `gh api` / `curl`. `chat` BREAKING entry
rationale similarly simplified.
- 35 cross-references to design-spec section numbers (§4.1 /
§4.5 / §5.3 etc.) removed from Go doc comments and test
comments across 13 files. The referenced spec lives outside
the shipped tree; readers of the public repo cannot resolve
them. Each reference replaced with a self-contained semantic
description (e.g. "the batch envelope" / "AGENTS.md section
on the success path").
- Mixed-language strings translated to English:
- Four Go comments: internal/cmdutil/exit.go:213,215,
internal/cmdutil/errors.go:156,
internal/output/batch_test.go:90,
internal/output/envelope_test.go:27.
- One CHANGELOG section title:
`v0.7 — Agent-first wire contract + 命令面集中清理` →
`... + command-surface cleanup`.
- CJK test fixtures (internal/text/truncate_test.go CJK
truncation cases, cmd/session/list_test.go Chinese session
title, acceptance/e2e/e2e_test.go Chinese RAG corpus)
retained — they are intentional test inputs, not stray prose.
- Makefile help comment: `golangci-lint added in PR-9` →
`golangci-lint planned`. Internal PR numbering should not
surface in shipped Makefile prose.
Build green, 28/28 packages, +5 new ValidateProfileName tests.
go vet / gofmt / go mod verify / go mod tidy all clean.
Rationale for the cascade: pre-1.0 is the cheapest moment to close
L-25 self-consistency (L-26). The half-finished internal rename
would have perpetuated the very `context` vs `context.Context`
ambiguity that motivated v0.7's user-visible rename in the first
place.
466 lines
16 KiB
Go
466 lines
16 KiB
Go
package sessioncmd
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// scriptedAskSvc serves a canned stream of agent events to runAsk.
|
|
type scriptedAskSvc struct {
|
|
createResp *sdk.Session
|
|
createErr error
|
|
events []*sdk.AgentStreamResponse
|
|
streamErr error
|
|
got struct {
|
|
sessionID string
|
|
req *sdk.AgentQARequest
|
|
}
|
|
}
|
|
|
|
func (s *scriptedAskSvc) CreateSession(_ context.Context, req *sdk.CreateSessionRequest) (*sdk.Session, error) {
|
|
if s.createResp == nil && s.createErr == nil {
|
|
return &sdk.Session{ID: "sess_auto", Title: req.Title}, nil
|
|
}
|
|
return s.createResp, s.createErr
|
|
}
|
|
|
|
func (s *scriptedAskSvc) AgentQAStreamWithRequest(_ context.Context, sessionID string, req *sdk.AgentQARequest, cb sdk.AgentEventCallback) error {
|
|
s.got.sessionID = sessionID
|
|
s.got.req = req
|
|
for _, e := range s.events {
|
|
if err := cb(e); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return s.streamErr
|
|
}
|
|
|
|
func answerEvent(content string) *sdk.AgentStreamResponse {
|
|
return &sdk.AgentStreamResponse{ResponseType: sdk.AgentResponseTypeAnswer, Content: content}
|
|
}
|
|
func doneEvent() *sdk.AgentStreamResponse {
|
|
return &sdk.AgentStreamResponse{ResponseType: sdk.AgentResponseTypeAnswer, Done: true}
|
|
}
|
|
func toolCallEvent(id, name string) *sdk.AgentStreamResponse {
|
|
return &sdk.AgentStreamResponse{
|
|
ResponseType: sdk.AgentResponseTypeToolCall,
|
|
ID: id,
|
|
Content: name,
|
|
}
|
|
}
|
|
func referencesEvent(refs []*sdk.SearchResult) *sdk.AgentStreamResponse {
|
|
return &sdk.AgentStreamResponse{
|
|
ResponseType: sdk.AgentResponseTypeReferences,
|
|
KnowledgeReferences: refs,
|
|
}
|
|
}
|
|
|
|
// textOpts returns a FormatOptions configured for the text render path —
|
|
// the most common shape under test.
|
|
func textOpts() *cmdutil.FormatOptions {
|
|
return &cmdutil.FormatOptions{Mode: cmdutil.FormatText}
|
|
}
|
|
|
|
// ndjsonOpts returns a FormatOptions for the NDJSON event-stream path.
|
|
// --format json routes here too for streaming commands.
|
|
func ndjsonOpts() *cmdutil.FormatOptions {
|
|
return &cmdutil.FormatOptions{Mode: cmdutil.FormatNDJSON}
|
|
}
|
|
|
|
// jsonOpts returns a FormatOptions configured for the JSON path.
|
|
// In v0.7 --format json routes to the NDJSON stream path for streaming commands.
|
|
func jsonOpts() *cmdutil.FormatOptions {
|
|
return &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}
|
|
}
|
|
|
|
// TestSessionAsk_NDJSON_FirstLineIsInit verifies that the NDJSON path (--format json)
|
|
// always injects an "init" line first, carrying session_id and agent_id.
|
|
func TestSessionAsk_NDJSON_FirstLineIsInit(t *testing.T) {
|
|
out, errBuf := iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{
|
|
events: []*sdk.AgentStreamResponse{
|
|
answerEvent("answer"),
|
|
doneEvent(),
|
|
},
|
|
}
|
|
opts := &AskOptions{AgentID: "ag_x", Query: "ping"}
|
|
if err := runAsk(context.Background(), opts, jsonOpts(), svc); err != nil {
|
|
t.Fatalf("runAsk: %v", err)
|
|
}
|
|
|
|
// NDJSON mode must NOT print the session hint to stderr.
|
|
if errBuf.Len() != 0 {
|
|
t.Errorf("expected empty stderr in NDJSON mode, got %q", errBuf.String())
|
|
}
|
|
|
|
lines := strings.Split(strings.TrimRight(out.String(), "\n"), "\n")
|
|
if len(lines) == 0 {
|
|
t.Fatal("no output")
|
|
}
|
|
var first struct {
|
|
Type string `json:"type"`
|
|
SessionID string `json:"session_id"`
|
|
AgentID string `json:"agent_id"`
|
|
}
|
|
if err := json.Unmarshal([]byte(lines[0]), &first); err != nil {
|
|
t.Fatalf("first line not JSON: %v\n %s", err, lines[0])
|
|
}
|
|
if first.Type != "init" {
|
|
t.Errorf("first line type: got %q, want init", first.Type)
|
|
}
|
|
if first.SessionID != "sess_auto" {
|
|
t.Errorf("init.session_id: got %q, want sess_auto", first.SessionID)
|
|
}
|
|
if first.AgentID != "ag_x" {
|
|
t.Errorf("init.agent_id: got %q, want ag_x", first.AgentID)
|
|
}
|
|
}
|
|
|
|
// TestSessionAsk_NDJSON_PassthroughEvents verifies init + N SDK events = N+1 total lines.
|
|
func TestSessionAsk_NDJSON_PassthroughEvents(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{
|
|
events: []*sdk.AgentStreamResponse{
|
|
answerEvent("hello"),
|
|
doneEvent(),
|
|
},
|
|
}
|
|
opts := &AskOptions{AgentID: "ag_x", Query: "hi"}
|
|
if err := runAsk(context.Background(), opts, jsonOpts(), svc); err != nil {
|
|
t.Fatalf("runAsk: %v", err)
|
|
}
|
|
|
|
lines := strings.Split(strings.TrimRight(out.String(), "\n"), "\n")
|
|
// 1 init + 2 SDK events = 3 lines.
|
|
if len(lines) != 3 {
|
|
t.Fatalf("got %d lines, want 3:\n%s", len(lines), out.String())
|
|
}
|
|
// Each must be valid JSON.
|
|
for i, line := range lines {
|
|
var obj map[string]any
|
|
if err := json.Unmarshal([]byte(line), &obj); err != nil {
|
|
t.Errorf("line %d not valid JSON: %v\n %s", i+1, err, line)
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestSessionAsk_NDJSON_JSONEqualsNDJSON verifies that --format json and --format ndjson
|
|
// produce identical NDJSON streams for session ask.
|
|
func TestSessionAsk_NDJSON_JSONEqualsNDJSON(t *testing.T) {
|
|
events := []*sdk.AgentStreamResponse{
|
|
answerEvent("hello"),
|
|
doneEvent(),
|
|
}
|
|
|
|
runWith := func(mode cmdutil.FormatMode) string {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{events: events}
|
|
opts := &AskOptions{AgentID: "ag_x", Query: "q"}
|
|
fopts := &cmdutil.FormatOptions{Mode: mode}
|
|
if err := runAsk(context.Background(), opts, fopts, svc); err != nil {
|
|
t.Fatalf("runAsk(%s): %v", mode, err)
|
|
}
|
|
return out.String()
|
|
}
|
|
|
|
jsonOut := runWith(cmdutil.FormatJSON)
|
|
ndjsonOut := runWith(cmdutil.FormatNDJSON)
|
|
if jsonOut != ndjsonOut {
|
|
t.Errorf("--format json and --format ndjson differ:\n json: %q\n ndjson: %q", jsonOut, ndjsonOut)
|
|
}
|
|
}
|
|
|
|
// TestSessionAsk_AutoCreatedSessionID_PassedAsAgentRequest checks the session id
|
|
// flows from auto-create through to the SDK stream call.
|
|
func TestSessionAsk_AutoCreatedSessionID_PassedAsAgentRequest(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{events: []*sdk.AgentStreamResponse{doneEvent()}}
|
|
opts := &AskOptions{AgentID: "ag_42", Query: "x"}
|
|
if err := runAsk(context.Background(), opts, ndjsonOpts(), svc); err != nil {
|
|
t.Fatalf("runAsk: %v", err)
|
|
}
|
|
if svc.got.sessionID != "sess_auto" {
|
|
t.Errorf("agent-chat got sessionID=%q, want sess_auto", svc.got.sessionID)
|
|
}
|
|
if svc.got.req == nil || svc.got.req.AgentID != "ag_42" {
|
|
t.Errorf("AgentID not forwarded: %+v", svc.got.req)
|
|
}
|
|
if !svc.got.req.AgentEnabled {
|
|
t.Error("AgentEnabled must be true for session ask")
|
|
}
|
|
}
|
|
|
|
func TestSessionAsk_ExistingSessionID_SkipsCreate(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
created := false
|
|
svc := &scriptedAskSvc{events: []*sdk.AgentStreamResponse{doneEvent()}}
|
|
// Wrap CreateSession to detect call.
|
|
svc.createResp = &sdk.Session{ID: "should_not_be_used"}
|
|
wrapped := &createSessionTracker{AskService: svc, called: &created}
|
|
opts := &AskOptions{AgentID: "ag", Query: "x", SessionID: "sess_existing"}
|
|
if err := runAsk(context.Background(), opts, ndjsonOpts(), wrapped); err != nil {
|
|
t.Fatalf("runAsk: %v", err)
|
|
}
|
|
if created {
|
|
t.Error("CreateSession should not be called when --session is set")
|
|
}
|
|
if svc.got.sessionID != "sess_existing" {
|
|
t.Errorf("agent-chat got sessionID=%q, want sess_existing", svc.got.sessionID)
|
|
}
|
|
}
|
|
|
|
type createSessionTracker struct {
|
|
AskService
|
|
called *bool
|
|
}
|
|
|
|
func (c *createSessionTracker) CreateSession(ctx context.Context, req *sdk.CreateSessionRequest) (*sdk.Session, error) {
|
|
*c.called = true
|
|
return c.AskService.CreateSession(ctx, req)
|
|
}
|
|
|
|
// TestSessionAsk_EmptyQuery_Rejected checks validation fires before any SDK call.
|
|
func TestSessionAsk_EmptyQuery_Rejected(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{}
|
|
opts := &AskOptions{AgentID: "ag", Query: ""}
|
|
err := runAsk(context.Background(), opts, textOpts(), svc)
|
|
if err == nil {
|
|
t.Fatal("expected input.invalid_argument, got nil")
|
|
}
|
|
var typed *cmdutil.Error
|
|
if !errors.As(err, &typed) || typed.Code != cmdutil.CodeInputInvalidArgument {
|
|
t.Errorf("expected input.invalid_argument, got %v", err)
|
|
}
|
|
}
|
|
|
|
// TestSessionAsk_StreamAbortBeforeDone_MapsToSSEStreamAborted uses the human path
|
|
// because the NDJSON path does not buffer/validate Done events.
|
|
func TestSessionAsk_StreamAbortBeforeDone_MapsToSSEStreamAborted(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{
|
|
events: []*sdk.AgentStreamResponse{
|
|
answerEvent("partial"),
|
|
},
|
|
streamErr: errors.New("connection reset"),
|
|
}
|
|
opts := &AskOptions{AgentID: "ag", Query: "x"}
|
|
// Text path (textOpts) validates Done; NDJSON path does not buffer.
|
|
err := runAsk(context.Background(), opts, textOpts(), svc)
|
|
if err == nil {
|
|
t.Fatal("expected stream-aborted error")
|
|
}
|
|
var typed *cmdutil.Error
|
|
if !errors.As(err, &typed) || typed.Code != cmdutil.CodeSSEStreamAborted {
|
|
t.Errorf("expected local.sse_stream_aborted, got %v", err)
|
|
}
|
|
}
|
|
|
|
// TestSessionAsk_NoDoneEvent_MapsToSSEStreamAborted uses the human path
|
|
// because the NDJSON path does not validate Done events.
|
|
func TestSessionAsk_NoDoneEvent_MapsToSSEStreamAborted(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{events: []*sdk.AgentStreamResponse{answerEvent("incomplete")}}
|
|
opts := &AskOptions{AgentID: "ag", Query: "x"}
|
|
err := runAsk(context.Background(), opts, textOpts(), svc)
|
|
if err == nil {
|
|
t.Fatal("expected stream-aborted error")
|
|
}
|
|
var typed *cmdutil.Error
|
|
if !errors.As(err, &typed) || typed.Code != cmdutil.CodeSSEStreamAborted {
|
|
t.Errorf("expected local.sse_stream_aborted, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestSessionAsk_CreateSessionFails_MapsToSessionCreateFailed(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{createErr: errors.New("connection refused")}
|
|
opts := &AskOptions{AgentID: "ag", Query: "x"}
|
|
err := runAsk(context.Background(), opts, textOpts(), svc)
|
|
if err == nil {
|
|
t.Fatal("expected session_create_failed")
|
|
}
|
|
var typed *cmdutil.Error
|
|
if !errors.As(err, &typed) || typed.Code != cmdutil.CodeSessionCreateFailed {
|
|
t.Errorf("expected server.session_create_failed, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestSessionAsk_Cancellation_MapsToOperationCancelled(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
cancel() // pre-cancel
|
|
svc := &scriptedAskSvc{streamErr: context.Canceled}
|
|
opts := &AskOptions{AgentID: "ag", Query: "x"}
|
|
// NDJSON path also handles cancellation correctly.
|
|
err := runAsk(ctx, opts, ndjsonOpts(), svc)
|
|
if err == nil {
|
|
t.Fatal("expected operation.cancelled")
|
|
}
|
|
var typed *cmdutil.Error
|
|
if !errors.As(err, &typed) || typed.Code != cmdutil.CodeOperationCancelled {
|
|
t.Errorf("expected operation.cancelled, got %v", err)
|
|
}
|
|
}
|
|
|
|
// Sanity: text-mode output writes the answer body and a tool-trace footer.
|
|
func TestSessionAsk_Text_Accumulate_PrintsAnswerAndFooter(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{events: []*sdk.AgentStreamResponse{
|
|
answerEvent("hello"),
|
|
toolCallEvent("c1", "knowledge_search"),
|
|
doneEvent(),
|
|
}}
|
|
opts := &AskOptions{AgentID: "ag", Query: "x"}
|
|
if err := runAsk(context.Background(), opts, textOpts(), svc); err != nil {
|
|
t.Fatalf("runAsk: %v", err)
|
|
}
|
|
got := out.String()
|
|
if !strings.Contains(got, "hello") {
|
|
t.Errorf("answer body missing: %q", got)
|
|
}
|
|
if !strings.Contains(got, "Tool trace") {
|
|
t.Errorf("tool trace footer missing: %q", got)
|
|
}
|
|
}
|
|
|
|
// TestSessionAsk_FormatNDJSON_PassthroughsSDKEvents verifies:
|
|
// 1 init line + N SDK events = N+1 total lines; first is init, rest are SDK events.
|
|
func TestSessionAsk_FormatNDJSON_PassthroughsSDKEvents(t *testing.T) {
|
|
// Fake stream emits 3 events: tool_call, answer, done.
|
|
// With the init injection, total output is 4 lines (1 init + 3 SDK events).
|
|
svc := &scriptedAskSvc{
|
|
events: []*sdk.AgentStreamResponse{
|
|
toolCallEvent("call_1", "knowledge_search"),
|
|
answerEvent("hello"),
|
|
doneEvent(),
|
|
},
|
|
}
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
opts := &AskOptions{AgentID: "ag_x", Query: "hi"}
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatNDJSON}
|
|
if err := runAsk(context.Background(), opts, fopts, svc); err != nil {
|
|
t.Fatalf("runAsk: %v", err)
|
|
}
|
|
|
|
lines := strings.Split(strings.TrimRight(out.String(), "\n"), "\n")
|
|
// 1 init + 3 SDK events = 4 lines.
|
|
if len(lines) != 4 {
|
|
t.Fatalf("got %d lines, want 4:\n%s", len(lines), out.String())
|
|
}
|
|
// Each line must be valid JSON.
|
|
for i, line := range lines {
|
|
var obj map[string]any
|
|
if err := json.Unmarshal([]byte(line), &obj); err != nil {
|
|
t.Fatalf("line %d not valid JSON: %v\n %s", i+1, err, line)
|
|
}
|
|
}
|
|
|
|
// First line: CLI-injected init event.
|
|
var initLine map[string]any
|
|
if err := json.Unmarshal([]byte(lines[0]), &initLine); err != nil {
|
|
t.Fatalf("line 1 (init) not JSON: %v", err)
|
|
}
|
|
if initLine["type"] != "init" {
|
|
t.Errorf("first line type=%v, want init", initLine["type"])
|
|
}
|
|
if initLine["agent_id"] != "ag_x" {
|
|
t.Errorf("first line agent_id=%v, want ag_x", initLine["agent_id"])
|
|
}
|
|
|
|
// Second line: tool_call event (SDK passthrough).
|
|
var second map[string]any
|
|
if err := json.Unmarshal([]byte(lines[1]), &second); err != nil {
|
|
t.Fatalf("line 2 not JSON: %v", err)
|
|
}
|
|
if second["response_type"] != string(sdk.AgentResponseTypeToolCall) {
|
|
t.Errorf("second event response_type=%v, want %s", second["response_type"], sdk.AgentResponseTypeToolCall)
|
|
}
|
|
// Third line: answer event.
|
|
var third map[string]any
|
|
if err := json.Unmarshal([]byte(lines[2]), &third); err != nil {
|
|
t.Fatalf("line 3 not JSON: %v", err)
|
|
}
|
|
if third["response_type"] != string(sdk.AgentResponseTypeAnswer) {
|
|
t.Errorf("third event response_type=%v, want %s", third["response_type"], sdk.AgentResponseTypeAnswer)
|
|
}
|
|
// Fourth line: done event.
|
|
var fourth map[string]any
|
|
if err := json.Unmarshal([]byte(lines[3]), &fourth); err != nil {
|
|
t.Fatalf("line 4 not JSON: %v", err)
|
|
}
|
|
if fourth["done"] != true {
|
|
t.Errorf("fourth event done=%v, want true", fourth["done"])
|
|
}
|
|
}
|
|
|
|
func TestSessionAsk_RequiresAgentFlag(t *testing.T) {
|
|
// Build the real cobra command with a nil factory — flag parsing happens
|
|
// before RunE so the factory is never dereferenced for this test.
|
|
f := &cmdutil.Factory{}
|
|
cmd := NewCmdAsk(f)
|
|
// Redirect output to discard cobra error messages.
|
|
var buf bytes.Buffer
|
|
cmd.SetOut(&buf)
|
|
cmd.SetErr(&buf)
|
|
// Execute without --agent: cobra should refuse with exit-code 2.
|
|
cmd.SetArgs([]string{"some question"})
|
|
err := cmd.Execute()
|
|
if err == nil {
|
|
t.Fatal("expected error when --agent is missing, got nil")
|
|
}
|
|
// Cobra wraps required-flag errors; the message should mention the flag.
|
|
if !strings.Contains(err.Error(), "agent") {
|
|
t.Errorf("error should mention 'agent' flag, got: %v", err)
|
|
}
|
|
}
|
|
|
|
// TestSessionAsk_NDJSON_IncludesReferencesViaSDKEvent verifies that references
|
|
// emitted by the SDK appear as passthrough NDJSON lines (not lost).
|
|
func TestSessionAsk_NDJSON_IncludesReferencesViaSDKEvent(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &scriptedAskSvc{
|
|
events: []*sdk.AgentStreamResponse{
|
|
answerEvent("Hello world."),
|
|
referencesEvent([]*sdk.SearchResult{{KnowledgeID: "k1", KnowledgeTitle: "Doc 1"}}),
|
|
doneEvent(),
|
|
},
|
|
}
|
|
opts := &AskOptions{AgentID: "ag_x", Query: "ping"}
|
|
if err := runAsk(context.Background(), opts, jsonOpts(), svc); err != nil {
|
|
t.Fatalf("runAsk: %v", err)
|
|
}
|
|
|
|
lines := strings.Split(strings.TrimRight(out.String(), "\n"), "\n")
|
|
// 1 init + 3 SDK events = 4 lines.
|
|
if len(lines) != 4 {
|
|
t.Fatalf("got %d NDJSON lines, want 4:\n%s", len(lines), out.String())
|
|
}
|
|
// init line.
|
|
var init map[string]any
|
|
if err := json.Unmarshal([]byte(lines[0]), &init); err != nil {
|
|
t.Fatalf("line 0 not JSON: %v", err)
|
|
}
|
|
if init["type"] != "init" {
|
|
t.Errorf("line 0 type: got %v, want init", init["type"])
|
|
}
|
|
// references line is the third SDK event (lines[3] = index 3).
|
|
var refsLine map[string]any
|
|
if err := json.Unmarshal([]byte(lines[2]), &refsLine); err != nil {
|
|
t.Fatalf("references line not JSON: %v", err)
|
|
}
|
|
if refsLine["response_type"] != string(sdk.AgentResponseTypeReferences) {
|
|
t.Errorf("expected references event at line 3, got response_type=%v", refsLine["response_type"])
|
|
}
|
|
}
|