cc8254f862
Two intertwined mainstream-alignment moves bundled because they share
the migration target (every command's --json path):
1. Drop --dry-run entirely. Survey of comparable API-wrapper CLIs
(gh, aws, stripe, lark): none expose --dry-run. The mainstream that
does (kubectl/git/helm/ansible) operates on declarative manifests
or local state where the preview is materially different from the
executed action. WeKnora's CLI just echoed the same parameters
that would have gone on the wire — the preview added no real
signal over `--help` + reading the call site. Removes:
- root --dry-run persistent flag + cmdutil/dryrun.go
- DryRun fields + EmitDryRun calls in 12 write commands
- format.Envelope.DryRun field
- 8 corresponding *_test.go cases
- --dry-run mention from README.md and CHANGELOG.md
- "dry_run":false from 16 golden envelopes
2. Migrate every --json output to bare data:
- New format.WriteJSON / WriteJSONFiltered helpers
(cli/internal/format/bare.go) share filterArrayItems /
filterObjectKeys / writeJQ with the (still-live for now) envelope
filter helpers.
- Read commands (kb/doc/session list+view, search chunks/docs/
sessions/kb, auth list/status, agent list/view, context list,
doctor) emit bare arrays / objects on stdout.
- Write commands (kb create/edit/delete/pin/empty, doc upload/
upload_recursive/delete, session delete, auth login/logout/
refresh/token, link/unlink, context add/use/remove, agent
invoke, chat, api, version) emit bare result objects. Risk
classification dropped — the resource + exit code already
convey the action.
Per-command shape changes:
list / search → []T (was {ok, data:{items:[…]}})
view → T (was {ok, data:T, _meta:…})
create / edit → T
delete / pin / etc. → {id, …action result…}
doctor → {summary, checks}
api → {status, headers, body}
_meta dropped on the read path:
pagination (page/page_size/total/has_more) — agents iterate with
--all-pages or accept --limit (gh CLI parity);
kb_id / context echo — caller already knows what it asked for.
Acceptance contract goldens regenerated for the new bare shape.
Error envelope on stdout (PrintErrorEnvelope) stays live for now —
the envelope-infra deletion lands in the next commit.
193 lines
6.7 KiB
Go
193 lines
6.7 KiB
Go
package search
|
|
|
|
import (
|
|
"context"
|
|
"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 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, nil, 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 envelope 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 --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.JSONOptions{}, 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.JSONOptions{}, svc))
|
|
got := out.String()
|
|
assert.True(t, strings.HasPrefix(strings.TrimSpace(got), "["), "expected bare JSON array, got: %q", got)
|
|
assert.NotContains(t, got, `"ok":`)
|
|
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"}, nil, 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}, nil, 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}, nil, &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"}, nil, 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"}, nil, 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"}, nil, 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,
|
|
}, nil, 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,
|
|
}, nil, 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
|
|
}
|