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
124 lines
4.5 KiB
Go
124 lines
4.5 KiB
Go
package search
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"strings"
|
|
"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 fakeKBSearchSvc struct {
|
|
items []sdk.KnowledgeBase
|
|
err error
|
|
}
|
|
|
|
func (f *fakeKBSearchSvc) ListKnowledgeBases(_ context.Context) ([]sdk.KnowledgeBase, error) {
|
|
return f.items, f.err
|
|
}
|
|
|
|
func TestKBSearch_Substring(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeKBSearchSvc{items: []sdk.KnowledgeBase{
|
|
{ID: "kb1", Name: "Marketing Q3", KnowledgeCount: 10},
|
|
{ID: "kb2", Name: "Engineering Docs", KnowledgeCount: 50},
|
|
{ID: "kb3", Name: "Marketing Q4 Plan", KnowledgeCount: 5},
|
|
}}
|
|
require.NoError(t, runKBSearch(context.Background(), &KBSearchOptions{Query: "marketing", Limit: 20}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
got := out.String()
|
|
assert.Contains(t, got, "kb1")
|
|
assert.Contains(t, got, "kb3")
|
|
assert.NotContains(t, got, "Engineering")
|
|
}
|
|
|
|
func TestKBSearch_CaseInsensitive(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeKBSearchSvc{items: []sdk.KnowledgeBase{
|
|
{ID: "kb1", Name: "ENGINEERING"},
|
|
}}
|
|
require.NoError(t, runKBSearch(context.Background(), &KBSearchOptions{Query: "engineering", Limit: 20}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
assert.Contains(t, out.String(), "kb1")
|
|
}
|
|
|
|
func TestKBSearch_MatchesDescription(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeKBSearchSvc{items: []sdk.KnowledgeBase{
|
|
{ID: "kb1", Name: "Engineering", Description: "all marketing docs are here"},
|
|
}}
|
|
require.NoError(t, runKBSearch(context.Background(), &KBSearchOptions{Query: "marketing", Limit: 20}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
assert.Contains(t, out.String(), "kb1")
|
|
}
|
|
|
|
func TestKBSearch_SortByNameLength(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeKBSearchSvc{items: []sdk.KnowledgeBase{
|
|
{ID: "kb_long", Name: "very long name marketing"},
|
|
{ID: "kb_short", Name: "marketing"},
|
|
{ID: "kb_mid", Name: "marketing 2024"},
|
|
}}
|
|
require.NoError(t, runKBSearch(context.Background(), &KBSearchOptions{Query: "marketing", Limit: 20}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
got := out.String()
|
|
// Order: shortest name first.
|
|
iShort := strings.Index(got, "kb_short")
|
|
iMid := strings.Index(got, "kb_mid")
|
|
iLong := strings.Index(got, "kb_long")
|
|
assert.Less(t, iShort, iMid)
|
|
assert.Less(t, iMid, iLong)
|
|
}
|
|
|
|
func TestKBSearch_LimitHardCap(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeKBSearchSvc{items: []sdk.KnowledgeBase{
|
|
{ID: "a", Name: "match-a"}, {ID: "b", Name: "match-b"},
|
|
{ID: "c", Name: "match-c"}, {ID: "d", Name: "match-d"},
|
|
}}
|
|
require.NoError(t, runKBSearch(context.Background(), &KBSearchOptions{Query: "match", Limit: 2}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
got := out.String()
|
|
count := 0
|
|
for _, id := range []string{"a", "b", "c", "d"} {
|
|
if strings.Contains(got, "match-"+id) {
|
|
count++
|
|
}
|
|
}
|
|
assert.Equal(t, 2, count)
|
|
}
|
|
|
|
func TestKBSearch_NoMatches(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeKBSearchSvc{items: []sdk.KnowledgeBase{{Name: "foo"}}}
|
|
require.NoError(t, runKBSearch(context.Background(), &KBSearchOptions{Query: "bar", Limit: 20}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
|
|
assert.Contains(t, out.String(), "(no matches)")
|
|
}
|
|
|
|
func TestKBSearch_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeKBSearchSvc{items: []sdk.KnowledgeBase{{ID: "kb1", Name: "marketing"}}}
|
|
require.NoError(t, runKBSearch(context.Background(), &KBSearchOptions{Query: "marketing", Limit: 20}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc))
|
|
|
|
got := out.String()
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data []sdk.KnowledgeBase `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, `"id":"kb1"`)
|
|
}
|
|
|
|
func TestKBSearch_NetworkError(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeKBSearchSvc{err: errors.New("HTTP error 401: unauthenticated")}
|
|
err := runKBSearch(context.Background(), &KBSearchOptions{Query: "x", Limit: 20}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeAuthUnauthenticated, typed.Code)
|
|
}
|