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.
460 lines
17 KiB
Go
460 lines
17 KiB
Go
package doc
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakeListSvc captures the request args and returns canned responses.
|
|
type fakeListSvc struct {
|
|
items []sdk.Knowledge
|
|
total int64
|
|
err error
|
|
got struct {
|
|
kbID string
|
|
page int
|
|
pageSize int
|
|
filter sdk.KnowledgeListFilter
|
|
}
|
|
}
|
|
|
|
func (f *fakeListSvc) ListKnowledgeWithFilter(_ context.Context, kbID string, page, pageSize int, filter sdk.KnowledgeListFilter) ([]sdk.Knowledge, int64, error) {
|
|
f.got.kbID, f.got.page, f.got.pageSize, f.got.filter = kbID, page, pageSize, filter
|
|
return f.items, f.total, f.err
|
|
}
|
|
|
|
// chdirIsolated parks cwd in a fresh tempdir so Factory.ResolveKB doesn't pick
|
|
// up a stray .weknora/project.yaml from the repo. Also clears WEKNORA_KB_ID
|
|
// for the duration of the test.
|
|
func chdirIsolated(t *testing.T) {
|
|
t.Helper()
|
|
prev, err := os.Getwd()
|
|
require.NoError(t, err)
|
|
require.NoError(t, os.Chdir(t.TempDir()))
|
|
t.Cleanup(func() { _ = os.Chdir(prev) })
|
|
t.Setenv("WEKNORA_KB_ID", "")
|
|
}
|
|
|
|
func TestList_Success_Text(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
now := time.Now()
|
|
items := []sdk.Knowledge{
|
|
{ID: "doc1", FileName: "alpha.pdf", FileSize: 2048, ParseStatus: "completed", UpdatedAt: now.Add(-1 * time.Hour)},
|
|
{ID: "doc2", FileName: "beta.md", FileSize: 0, ParseStatus: "pending", UpdatedAt: now.Add(-2 * 24 * time.Hour)},
|
|
}
|
|
svc := &fakeListSvc{items: items, total: 2}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
|
|
assert.Equal(t, "kb_xxx", svc.got.kbID)
|
|
assert.Equal(t, 1, svc.got.page)
|
|
assert.Equal(t, 20, svc.got.pageSize)
|
|
assert.Equal(t, sdk.KnowledgeListFilter{}, svc.got.filter, "no flags ⇒ empty filter")
|
|
|
|
got := out.String()
|
|
for _, want := range []string{"ID", "NAME", "STATUS", "SIZE", "UPDATED", "doc1", "alpha.pdf", "completed", "2.0KB", "doc2", "beta.md", "pending"} {
|
|
if !strings.Contains(got, want) {
|
|
t.Errorf("output missing %q in:\n%s", want, got)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestList_Success_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{items: []sdk.Knowledge{{ID: "doc1", FileName: "a.pdf"}}, total: 1}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "kb_xxx"))
|
|
|
|
got := out.String()
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data []sdk.Knowledge `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":"doc1"`)
|
|
assert.NotContains(t, got, `"_meta":`)
|
|
}
|
|
|
|
func TestList_Empty_Text(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{items: nil, total: 0}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Contains(t, out.String(), "(no documents)")
|
|
}
|
|
|
|
func TestList_Empty_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{items: nil, total: 0}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "kb_xxx"))
|
|
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data []sdk.Knowledge `json:"data"`
|
|
}
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env), "expected valid JSON envelope, got %q", out.String())
|
|
assert.True(t, env.OK, "envelope.ok must be true")
|
|
assert.Len(t, env.Data, 0, "empty list must produce empty data array, not null")
|
|
}
|
|
|
|
func TestList_HTTPError_500(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{err: errors.New("HTTP error 500: internal")}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30}
|
|
err := runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx")
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeServerError, typed.Code)
|
|
}
|
|
|
|
// TestList_KBIDRequired drives the cobra layer to verify Factory.ResolveKB's
|
|
// "no source supplied" path bubbles up as CodeKBIDRequired. Isolates cwd so
|
|
// no project.yaml sneaks in, and clears WEKNORA_KB_ID.
|
|
func TestList_KBIDRequired(t *testing.T) {
|
|
chdirIsolated(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
cfg := &config.Config{
|
|
CurrentProfile: "default",
|
|
Profiles: map[string]config.Profile{"default": {Host: "https://example"}},
|
|
}
|
|
f := &cmdutil.Factory{
|
|
Config: func() (*config.Config, error) { return cfg, nil },
|
|
Client: func() (*sdk.Client, error) {
|
|
return nil, errors.New("client should not be called when kb id is missing")
|
|
},
|
|
}
|
|
cmd := NewCmdList(f)
|
|
cmd.SetContext(context.Background())
|
|
cmd.SetArgs([]string{}) // no --kb
|
|
cmd.SilenceErrors = true
|
|
cmd.SilenceUsage = true
|
|
err := cmd.Execute()
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeKBIDRequired, typed.Code)
|
|
}
|
|
|
|
// TestList_KBFlagWiredToResolveKB confirms that --kb=kb_<id> passed at the
|
|
// cobra layer reaches Factory.ResolveKB and short-circuits without listing.
|
|
func TestList_KBFlagWiredToResolveKB(t *testing.T) {
|
|
chdirIsolated(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
cfg := &config.Config{
|
|
CurrentProfile: "default",
|
|
Profiles: map[string]config.Profile{"default": {Host: "https://example"}},
|
|
}
|
|
f := &cmdutil.Factory{
|
|
Config: func() (*config.Config, error) { return cfg, nil },
|
|
Client: func() (*sdk.Client, error) {
|
|
return nil, errors.New("forced-after-resolvekb")
|
|
},
|
|
}
|
|
// With --kb=kb_<id> supplied, ResolveKB short-circuits on the prefix
|
|
// match without consulting the client. The RunE then asks for the client
|
|
// to run the actual list - that call triggers the forced error.
|
|
// Surfacing "forced-after-resolvekb" (rather than CodeKBIDRequired) is
|
|
// the proof point that --kb was honored.
|
|
cmd := NewCmdList(f)
|
|
cmd.SetContext(context.Background())
|
|
cmd.SetArgs([]string{"--kb", "kb_explicit"})
|
|
cmd.SilenceErrors = true
|
|
cmd.SilenceUsage = true
|
|
err := cmd.Execute()
|
|
require.Error(t, err, "expected client construction error")
|
|
assert.Contains(t, err.Error(), "forced-after-resolvekb",
|
|
"should surface the Client closure error, not a kb-required error")
|
|
}
|
|
|
|
// pinning the sort order: most-recent-first regardless of input order.
|
|
func TestList_SortByUpdatedDesc(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
now := time.Now()
|
|
// Server returns oldest first; CLI must reorder.
|
|
items := []sdk.Knowledge{
|
|
{ID: "old", FileName: "old.pdf", UpdatedAt: now.Add(-10 * 24 * time.Hour)},
|
|
{ID: "new", FileName: "new.pdf", UpdatedAt: now.Add(-1 * time.Hour)},
|
|
}
|
|
svc := &fakeListSvc{items: items, total: 2}
|
|
require.NoError(t, runList(context.Background(), &ListOptions{PageSize: 20, Limit: 30}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
|
|
got := out.String()
|
|
newIdx := strings.Index(got, "new.pdf")
|
|
oldIdx := strings.Index(got, "old.pdf")
|
|
require.GreaterOrEqual(t, newIdx, 0)
|
|
require.GreaterOrEqual(t, oldIdx, 0)
|
|
assert.Less(t, newIdx, oldIdx, "most-recent should render first")
|
|
}
|
|
|
|
// TestFormatSize sanity-checks the byte-count formatter without exporting it.
|
|
func TestFormatSize(t *testing.T) {
|
|
cases := []struct {
|
|
in int64
|
|
want string
|
|
}{
|
|
{0, "-"},
|
|
{-1, "-"},
|
|
{900, "900B"},
|
|
{2048, "2.0KB"},
|
|
{5 * 1024 * 1024, "5.0MB"},
|
|
}
|
|
for _, c := range cases {
|
|
if got := formatSize(c.in); got != c.want {
|
|
t.Errorf("formatSize(%d) = %q, want %q", c.in, got, c.want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestList_StatusFilter_ForwardedToSDK(t *testing.T) {
|
|
chdirIsolated(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, Status: "failed"}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Equal(t, "failed", svc.got.filter.ParseStatus,
|
|
"--status must be forwarded as filter.ParseStatus for server-side filtering")
|
|
}
|
|
|
|
func TestList_StatusFilter_RejectsUnknownValue(t *testing.T) {
|
|
chdirIsolated(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, Status: "bogus"}
|
|
err := runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
assert.Contains(t, typed.Message, "pending")
|
|
assert.Contains(t, typed.Message, "failed")
|
|
}
|
|
|
|
func TestList_StatusFilter_AcceptsAllEnumValues(t *testing.T) {
|
|
chdirIsolated(t)
|
|
for _, v := range docListStatusValues {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, Status: v}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"),
|
|
"status=%q should be accepted", v)
|
|
}
|
|
}
|
|
|
|
// makeDocs returns N Knowledge records with distinct IDs and descending
|
|
// UpdatedAt timestamps, useful for limit / pagination tests.
|
|
func makeDocs(n int) []sdk.Knowledge {
|
|
base := time.Now()
|
|
out := make([]sdk.Knowledge, n)
|
|
for i := 0; i < n; i++ {
|
|
out[i] = sdk.Knowledge{
|
|
ID: fmt.Sprintf("doc_%02d", i),
|
|
FileName: fmt.Sprintf("f_%02d.pdf", i),
|
|
UpdatedAt: base.Add(-time.Duration(i) * time.Hour),
|
|
}
|
|
}
|
|
return out
|
|
}
|
|
|
|
// pagedDocSvc returns server-paginated Knowledge results from a flat slice.
|
|
// Records the page numbers requested for assertion.
|
|
type pagedDocSvc struct {
|
|
all []sdk.Knowledge
|
|
calls []int // 1-based page numbers received
|
|
pageSize int
|
|
}
|
|
|
|
func (p *pagedDocSvc) ListKnowledgeWithFilter(_ context.Context, _ string, page, pageSize int, _ sdk.KnowledgeListFilter) ([]sdk.Knowledge, int64, error) {
|
|
p.calls = append(p.calls, page)
|
|
p.pageSize = pageSize
|
|
start := (page - 1) * pageSize
|
|
if start >= len(p.all) {
|
|
return []sdk.Knowledge{}, int64(len(p.all)), nil
|
|
}
|
|
end := start + pageSize
|
|
if end > len(p.all) {
|
|
end = len(p.all)
|
|
}
|
|
return p.all[start:end], int64(len(p.all)), nil
|
|
}
|
|
|
|
func TestList_Limit_LessThanPageSize_SlicesToLimit(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{items: makeDocs(20), total: 20}
|
|
opts := &ListOptions{PageSize: 20, Limit: 5}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "kb_xxx"))
|
|
body := out.String()
|
|
// Count occurrences of "id":"doc_" - should be exactly 5.
|
|
got := strings.Count(body, `"id":"doc_`)
|
|
assert.Equal(t, 5, got, "--limit 5 must slice 20 returned items to 5; body=\n%s", body)
|
|
}
|
|
|
|
func TestList_Limit_GreaterThanPageSize_NoCap(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{items: makeDocs(10), total: 10}
|
|
opts := &ListOptions{PageSize: 10, Limit: 50}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "kb_xxx"))
|
|
got := strings.Count(out.String(), `"id":"doc_`)
|
|
assert.Equal(t, 10, got, "--limit 50 with page-size 10 + 10 items returns all 10")
|
|
}
|
|
|
|
func TestList_Limit_Negative_Rejected(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
opts := &ListOptions{PageSize: 20, Limit: -1}
|
|
err := runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &fakeListSvc{}, "kb_xxx")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
}
|
|
|
|
func TestList_AllPages_WalksAllServerPages(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &pagedDocSvc{all: makeDocs(45)}
|
|
opts := &ListOptions{PageSize: 20, Limit: 10000, AllPages: true}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "kb_xxx"))
|
|
// 45 items / page_size 20 = 3 pages: 20 + 20 + 5.
|
|
assert.Equal(t, []int{1, 2, 3}, svc.calls)
|
|
got := strings.Count(out.String(), `"id":"doc_`)
|
|
assert.Equal(t, 45, got)
|
|
}
|
|
|
|
func TestList_AllPages_WithLimit_StopsAtLimit(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &pagedDocSvc{all: makeDocs(200)}
|
|
opts := &ListOptions{PageSize: 20, AllPages: true, Limit: 50}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "kb_xxx"))
|
|
got := strings.Count(out.String(), `"id":"doc_`)
|
|
assert.Equal(t, 50, got, "--limit 50 with --all-pages should stop after 50 items")
|
|
// Should have called pages 1..3 (60 items) then capped at 50.
|
|
assert.LessOrEqual(t, len(svc.calls), 3, "should not walk past the page that fills --limit")
|
|
}
|
|
|
|
// ----- C11: richer filter flags -----
|
|
|
|
func TestList_Keyword_PassedToFilter(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, Keyword: "spec"}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Equal(t, "spec", svc.got.filter.Keyword)
|
|
}
|
|
|
|
func TestList_FileType_PassedToFilter(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, FileType: "pdf"}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Equal(t, "pdf", svc.got.filter.FileType)
|
|
}
|
|
|
|
func TestList_Source_PassedToFilter(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, Source: "api"}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Equal(t, "api", svc.got.filter.Source)
|
|
}
|
|
|
|
func TestList_TagID_PassedToFilter(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, TagID: "tag_42"}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Equal(t, "tag_42", svc.got.filter.TagID)
|
|
}
|
|
|
|
func TestList_StartTime_RFC3339Parses(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
want := "2026-05-01T00:00:00Z"
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, StartTime: want}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
parsed, err := time.Parse(time.RFC3339, want)
|
|
require.NoError(t, err)
|
|
assert.True(t, svc.got.filter.StartTime.Equal(parsed),
|
|
"--start-time must be parsed into filter.StartTime; got %v want %v",
|
|
svc.got.filter.StartTime, parsed)
|
|
}
|
|
|
|
func TestList_EndTime_RFC3339Parses(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
want := "2026-06-30T23:59:59Z"
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, EndTime: want}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
parsed, err := time.Parse(time.RFC3339, want)
|
|
require.NoError(t, err)
|
|
assert.True(t, svc.got.filter.EndTime.Equal(parsed))
|
|
}
|
|
|
|
func TestList_StartTime_InvalidFormat_Rejected(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, StartTime: "tomorrow"}
|
|
err := runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &fakeListSvc{}, "kb_xxx")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
assert.Contains(t, typed.Message, "--start-time")
|
|
assert.Contains(t, typed.Message, "RFC3339")
|
|
}
|
|
|
|
func TestList_EndTime_InvalidFormat_Rejected(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
opts := &ListOptions{PageSize: 20, Limit: 30, EndTime: "2026-05-01"} // date-only, not RFC3339
|
|
err := runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &fakeListSvc{}, "kb_xxx")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
assert.Contains(t, typed.Message, "--end-time")
|
|
}
|
|
|
|
// TestList_AllFiltersCombined drives every new filter flag at once to confirm
|
|
// they all land on the same filter struct (AND combine on the server).
|
|
func TestList_AllFiltersCombined(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeListSvc{}
|
|
opts := &ListOptions{
|
|
PageSize: 20,
|
|
Limit: 30,
|
|
Status: "completed",
|
|
Keyword: "spec",
|
|
FileType: "pdf",
|
|
Source: "api",
|
|
TagID: "tag_42",
|
|
StartTime: "2026-01-01T00:00:00Z",
|
|
EndTime: "2026-12-31T23:59:59Z",
|
|
}
|
|
require.NoError(t, runList(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
f := svc.got.filter
|
|
assert.Equal(t, "completed", f.ParseStatus)
|
|
assert.Equal(t, "spec", f.Keyword)
|
|
assert.Equal(t, "pdf", f.FileType)
|
|
assert.Equal(t, "api", f.Source)
|
|
assert.Equal(t, "tag_42", f.TagID)
|
|
assert.False(t, f.StartTime.IsZero())
|
|
assert.False(t, f.EndTime.IsZero())
|
|
}
|