ad150c7126
Sweep every CLI output path through the v0.7 envelope contract.
FormatOptions.Emit signature changes to (w, data, meta *output.Meta)
so list commands surface meta.count / has_more in the wire envelope.
TTY indent decision plumbed via FormatOptions.TTY (set by
ResolveDefault). --format and --jq promoted to persistent root flags
so unknown-subcommand paths still reach the typed-envelope guard
(per-command registration would have rejected --format on unknown
commands as cobra-prose exit 2). WEKNORA_FORMAT env-var fallback
honored before TTY-resolved default. AddFormatFlag retained for the
per-command --jq field-hint Long-text addendum.
~55 production Emit call sites swept across cli/cmd/**: list paths
populate meta.count; mutation paths pass nil meta; envelope.profile
threaded via globalProfile. Existing JSON-shape tests migrated to
decode the envelope wrapper.
Multi-target batch operations get a unified shape via new helpers:
- output.BatchItem + output.WriteBatchEnvelope (§4.5 per-item ok
pattern; data:[{id, ok, result?|error?}], meta:{count, successes*,
failures*}; Successes/Failures *int so explicit zero survives
omitempty in all-fail case).
- cmdutil.RunBatch + cmdutil.EmitBatch + cmdutil.DeletedAtNow +
cmdutil.ClassifyContextErr collapse the three previously-duplicated
multi-delete pipelines (doc / chunk / session) into one call site
pattern. doc upload --recursive uses the same helpers with a per-
file resultFn. Summary error sets Silent:true so the stderr
envelope path doesn't duplicate the stdout batch detail (exit 1
preserved via Code → ExitCode).
ConfirmDestructive / ConfirmDestructiveBatch extended with action +
retryCmd parameters. Every destructive command (kb delete, kb edit,
doc delete, doc delete --all, agent delete, agent edit, session
delete, chunk delete, auth logout, api -X DELETE) now attaches
error.risk.{level:"destructive", action:"<noun.verb>"} +
error.retry_command on the exit-10 envelope. kb edit / agent edit
also gain the destructive guard wiring (CHANGELOG listed them as
gated but they were silently executing without -y).
MCP tool handlers' 31 error paths return CallToolResult with
IsError + Content text fallback + StructuredContent (envelope.error
shape via cmdutil.ErrorToDetail). Handler Out type changed from
typed *sdk.X to any so the go-sdk auto-marshal doesn't overwrite
StructuredContent with a zero-struct on error returns. Success path
manually populates CallToolResult.StructuredContent via successResult
helper.
weknora api cleanup:
- -d/--data flag removed; body via --input <file> or --input -
(stdin) only. Aligns with gh / curl convention.
- HTTP method whitelist removed; any non-empty method accepted.
- HTTP Retry-After header → cmdutil.Error.RetryAfterSeconds →
envelope.error.retry_after_seconds.
- runAPIPaginated raw-passthrough fallback now wraps response in
envelope so --paginate never emits bare JSON to stdout.
Test sweep: ~60 cmd/** tests migrated to decode envelope shape.
9 wire-contract goldens updated under cli/acceptance/testdata/wire/.
Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §4 / §5
197 lines
7.2 KiB
Go
197 lines
7.2 KiB
Go
package search
|
|
|
|
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"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
type fakeChunksSvc struct {
|
|
results []*sdk.SearchResult
|
|
err error
|
|
gotKB string
|
|
gotQ string
|
|
}
|
|
|
|
func (f *fakeChunksSvc) HybridSearch(_ context.Context, kbID string, p *sdk.SearchParams) ([]*sdk.SearchResult, error) {
|
|
f.gotKB = kbID
|
|
f.gotQ = p.QueryText
|
|
return f.results, f.err
|
|
}
|
|
|
|
func TestRunSearch_HumanOutput(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: []*sdk.SearchResult{
|
|
{Score: 0.92, Content: "first chunk", KnowledgeID: "doc-1", MatchType: sdk.MatchTypeVector},
|
|
{Score: 0.81, Content: "second chunk", KnowledgeID: "doc-2", MatchType: sdk.MatchTypeKeyword},
|
|
}}
|
|
opts := &ChunksOptions{Query: "hello", KBID: "kb_abc", Limit: 5}
|
|
require.NoError(t, runChunks(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
|
|
assert.Equal(t, "kb_abc", svc.gotKB)
|
|
assert.Equal(t, "hello", svc.gotQ)
|
|
got := out.String()
|
|
assert.Contains(t, got, "2 result(s) from kb=kb_abc")
|
|
assert.Contains(t, got, "first chunk")
|
|
assert.Contains(t, got, "doc-1")
|
|
}
|
|
|
|
// JSON output must surface match_type so machine consumers / agents can
|
|
// reason about retrieval channels without re-implementing the wire format.
|
|
// (Human renderer keeps default minimal - diagnostic info opt-in via --format json.)
|
|
func TestRunSearch_JSONIncludesMatchType(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: []*sdk.SearchResult{
|
|
{Score: 0.9, Content: "x", MatchType: sdk.MatchTypeKeyword},
|
|
}}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc))
|
|
assert.Contains(t, out.String(), `"match_type":1`)
|
|
}
|
|
|
|
func TestRunSearch_JSONOutput(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: []*sdk.SearchResult{{Score: 0.9, Content: "x"}}}
|
|
opts := &ChunksOptions{Query: "q", KBID: "kb1", Limit: 1}
|
|
require.NoError(t, runChunks(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc))
|
|
got := out.String()
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data []*sdk.SearchResult `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.Contains(t, got, `"score":0.9`)
|
|
}
|
|
|
|
func TestRunSearch_EmptyResults(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: nil}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
assert.Contains(t, out.String(), "(no results)")
|
|
}
|
|
|
|
// Server returns primary matches plus parent/related/nearby enrichment chunks,
|
|
// so the wire response can exceed Limit. CLI must trim to honor the user's
|
|
// hard-limit contract.
|
|
func TestRunSearch_LimitHardCap(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: []*sdk.SearchResult{
|
|
{Score: 0.9, Content: "primary 1"},
|
|
{Score: 0.8, Content: "primary 2"},
|
|
{Score: 0.7, Content: "primary 3"},
|
|
{Score: 0, Content: "enrichment parent"}, // server-padded
|
|
{Score: 0, Content: "enrichment nearby"}, // server-padded
|
|
}}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1", Limit: 3}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
got := out.String()
|
|
assert.Contains(t, got, "3 result(s)")
|
|
assert.NotContains(t, got, "enrichment parent")
|
|
assert.NotContains(t, got, "enrichment nearby")
|
|
}
|
|
|
|
func TestRunSearch_BothChannelsDisabled(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
err := runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1", NoVector: true, NoKeyword: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, &fakeChunksSvc{})
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "input.invalid_argument")
|
|
}
|
|
|
|
func TestRunSearch_ServiceError_Transport(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{err: assert.AnError}
|
|
err := runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeNetworkError, typed.Code,
|
|
"non-HTTP-shaped errors classify as network.error so IsTransient picks them up")
|
|
}
|
|
|
|
func TestRunSearch_ServiceError_HTTPNotFound(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{err: errors.New("HTTP error 404: knowledge base not found")}
|
|
err := runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "missing"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
}
|
|
|
|
func TestIndent(t *testing.T) {
|
|
assert.Equal(t, " foo\n bar", indent("foo\nbar", " "))
|
|
assert.Equal(t, "", indent("", " "))
|
|
}
|
|
|
|
func TestRunSearch_NilService(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
err := runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, nil)
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "server.error")
|
|
}
|
|
|
|
func TestNewCmdChunks_RequiresQuery(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
cmd := NewCmdChunks(&cmdutil.Factory{
|
|
Client: func() (*sdk.Client, error) { return nil, nil },
|
|
})
|
|
cmd.SetArgs([]string{}) // no query
|
|
cmd.SilenceErrors = true
|
|
cmd.SilenceUsage = true
|
|
err := cmd.Execute()
|
|
require.Error(t, err)
|
|
}
|
|
|
|
func TestNewCmdChunks_RejectsEmptyQuery(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
cmd := NewCmdChunks(&cmdutil.Factory{
|
|
Client: func() (*sdk.Client, error) { return nil, nil },
|
|
})
|
|
cmd.SetArgs([]string{" ", "--kb", "kb1"})
|
|
cmd.SilenceErrors = true
|
|
cmd.SilenceUsage = true
|
|
err := cmd.Execute()
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "input.invalid_argument")
|
|
}
|
|
|
|
func TestRunSearch_NoVectorPassedThrough(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
var got *sdk.SearchParams
|
|
svc := &capturingChunksSvc{capture: func(p *sdk.SearchParams) { got = p }}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{
|
|
Query: "q", KBID: "kb1", NoVector: true,
|
|
}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
require.NotNil(t, got)
|
|
assert.True(t, got.DisableVectorMatch)
|
|
assert.False(t, got.DisableKeywordsMatch)
|
|
}
|
|
|
|
func TestRunSearch_NoKeywordPassedThrough(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
var got *sdk.SearchParams
|
|
svc := &capturingChunksSvc{capture: func(p *sdk.SearchParams) { got = p }}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{
|
|
Query: "q", KBID: "kb1", NoKeyword: true,
|
|
}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
require.NotNil(t, got)
|
|
assert.True(t, got.DisableKeywordsMatch)
|
|
assert.False(t, got.DisableVectorMatch)
|
|
}
|
|
|
|
type capturingChunksSvc struct {
|
|
capture func(*sdk.SearchParams)
|
|
}
|
|
|
|
func (c *capturingChunksSvc) HybridSearch(_ context.Context, _ string, p *sdk.SearchParams) ([]*sdk.SearchResult, error) {
|
|
c.capture(p)
|
|
return nil, nil
|
|
}
|