5adcedf170
Cross-cutting findings surfaced by the branch-completion review. Perf bug: - Factory.Client closure was not memoized. Factory.ResolveKB internally calls f.Client() to resolve --kb name → id, then the command's RunE calls f.Client() again. Two SDK clients, two keyring reads, two AuthRetryTransport allocations per name-resolved invocation, with *independent* token state (a refresh in one was invisible to the other). Switched to sync.Once like Secrets already does. Silent bug bait: - cmdutil.NormalizeHost docstring claimed CodeInputMissingFlag for the empty case; code returned CodeInputInvalidArgument. Aligned doc to code (present-but-empty is a bad value, not a missing flag). Agent contract gaps: - Five user-facing subcommands lacked SetAgentHelp: auth login / logout / list / status and chat. Added concise strings with error- code call-outs so agents can branch without parsing human strings. Helper extraction (≥3 callers): - text.KnowledgeDisplayName(fileName, title, id) — byte-identical formatter that was in both cmd/doc/list.go and cmd/search/docs.go. Takes fields directly so internal/text stays SDK-free. - cmdutil.WrapHTTP(cause, fmt, args...) *Error — replaces the `Wrapf(ClassifyHTTPError(err), err, ...)` pattern across 24 SDK call sites. Sed-driven migration; off-pattern shapes in chat.go (used streamErr) and cmdutil/kb.go (in-package) hand-edited. Contract test gains a comment update: post-migration the dominant pattern is WrapHTTP which the AST scanner skips entirely (only NewError/Wrapf selectors inspected); ClassifyHTTPErrorOutputs() bridge still covers the dynamic codes those paths can yield. UX consistency: - cmd/doc/list.go --page-size help now reads "Items per page (1..1000)" matching cmd/session/list.go. The bounds validation already enforced 1..1000; the help text was the last drift. Comment-discipline sweep: - Deleted the WHAT-only "*Options captures `weknora ...` flag state" docstring across 23 files (context, kb, auth, doc, session, search, chat, doctor, link). Where the line carried a real WHY clause (kb/delete, doc/delete, session/delete, kb/edit), kept the WHY and dropped only the leading WHAT phrase. - Stripped third-party project-name attribution from inline comments and one user-visible flag-help string across ~40 files in cli/cmd and cli/internal (plus 4 test-file comments). Removed phrases like "Mirrors `gh X`", "borrowed from lark-cli", "kubectl-style", "gcloud `--project`", "Stripe pattern", and the embedded GitHub URLs pointing at those projects. Behavioral descriptions and the WHY behind each comment are preserved; only the upstream-name attribution is gone. Inspiration / north-star references belong in cli/AGENTS.md (the design doc) and commit messages, not scattered through every file. Triggered by an audit round that surfaced several false / fragile parity claims (e.g. "Mirrors `gh repo edit`" — gh repo edit has no --name flag; "matches gcloud `--project` id-or-name" — gcloud's --project accepts ID only). Rather than fix them one by one, the whole category of in-comment external-project references was stripped uniformly.
122 lines
4.0 KiB
Go
122 lines
4.0 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/format"
|
|
"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}, 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}, 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}, 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}, 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}, 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}, 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, JSONOut: true}, svc))
|
|
|
|
var env format.Envelope
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env))
|
|
require.True(t, env.OK)
|
|
assert.Contains(t, out.String(), `"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}, svc)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeAuthUnauthenticated, typed.Code)
|
|
}
|
|
|