mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-02 13:12:00 +08:00
D1 — --format default flipped to json regardless of TTY: - v0.6: smart default (text on TTY, json on pipe). - v0.7: always json; TTY only affects indent (compact in pipe). Enum values unchanged (text | json | ndjson). - Typed FormatMode enum replaces untyped string consts. - --format / --jq promoted to persistent root flags so unknown- subcommand paths still reach the typed-envelope guard (per-command registration in v0.6 would have rejected --format on unknown commands as cobra-prose exit 2). - WEKNORA_FORMAT env var added; precedence --format > env > default. Invalid env values silently ignored. D2 — chat / session ask default to NDJSON event-stream: - New cli/internal/output/ndjson_stream.go: InitEvent struct + EmitInit / EmitSDKEvent / WriteNDJSONLine helpers. EmitInit doc encodes the must-be-first-line invariant agents key on. - chat / session ask: --format json AND --format ndjson both emit one JSON event per line (no envelope wrapping). CLI injects exactly one `init` event at stream head carrying session_id + optional kb_id / agent_id / profile. Subsequent events pass through verbatim from the SDK (passthrough discipline per spec §5.1). - --format text keeps the SSE-style live renderer. context → profile full cascade: - Command group: cli/cmd/context/ → cli/cmd/profile/ (git mv; package contextcmd → profilecmd). - Global flag --context → --profile. Factory.ContextOverride → ProfileOverride. WEKNORA_PROFILE env var honored (--profile flag > env > config.CurrentContext). When --profile or WEKNORA_PROFILE references a missing profile, the error is input.invalid_argument with hint "weknora profile list" — not the destructive local.config_corrupt path (which would have told users to delete their config file). - Binding file .weknora/project.yaml field context: → profile: (no backwards-compat alias; re-run weknora link). - profile use JSON fields current_context / previous_context → current_profile / previous_profile. - weknora link JSON field context → profile. - CodeLocalContextNotFound → CodeLocalProfileNotFound (typed code rename). - Envelope top-level profile field populated via globalProfile (set by root PersistentPreRunE from Factory.ActiveProfile). chat / session ask NDJSON init event carries the same profile. - Rationale: "context" collided with LLM context window / RAG context / Go context.Context; mainstream multi-credential CLIs (AWS / Stripe / OpenAI / Anthropic / lark) all use "profile". H2/C1' help calibration: - AgentHelp gains Warnings []string; single SetAgentHelp helper routes on WEKNORA_AGENT_HELP=1 (emits JSON blob including warnings) vs human help (appends "AI agents:" block from same source). Warnings surface as both a structured JSON field and visible help-text addendum without drift. - 9 destructive commands carry warnings: kb / doc / agent / session / chunk delete; profile remove; kb / agent edit; auth logout. - weknora doc wait dedups ids at entry; SIGINT mid-wait returns silently (root signal handler maps to exit 130) instead of being miscategorised as operation.timeout / operation.failed. A4 — docs: - cli/AGENTS.md gains four agent-facing sections: Wire contract for AI agents (stdout / stderr / NDJSON / _notice evolution / SDK contract boundary); Deliberate deviations + mainstream alignments; Pre-1.0 breaking policy; Exit-10 anti-patterns. ERROR_REFERENCE table extended. - cli/README.md adds Agent quick start under Wire contract. - cli/CHANGELOG.md v0.7 section: BREAKING entries with migration notes, Added (WEKNORA_FORMAT / WEKNORA_PROFILE / retry_command / retry_after_seconds / risk / _notice reserved infra / meta.count / meta.has_more / doc fetch / doc create / session ask / doc delete --all / NDJSON init), Changed (docs additions), Deprecated (none — pre-release one-shot breaking). Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §3 / §4 / §5 / §6 / §11
491 lines
16 KiB
Go
491 lines
16 KiB
Go
package api
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakeAPISvc is a test double for Service that delegates each call to a
|
|
// caller-supplied do function, giving full control over per-call responses.
|
|
type fakeAPISvc struct {
|
|
do func(method, path string, body any) (*http.Response, error)
|
|
}
|
|
|
|
func (f *fakeAPISvc) Raw(_ context.Context, method, path string, body any) (*http.Response, error) {
|
|
return f.do(method, path, body)
|
|
}
|
|
|
|
// newTestClient stands up an httptest server with the supplied handler and
|
|
// returns an *sdk.Client targeting it plus a teardown closure. The real SDK is
|
|
// used so we exercise the same Raw() code path as production (header
|
|
// injection, JSON marshalling, etc.).
|
|
func newTestClient(t *testing.T, h http.HandlerFunc) (*sdk.Client, func()) {
|
|
t.Helper()
|
|
srv := httptest.NewServer(h)
|
|
return sdk.NewClient(srv.URL), srv.Close
|
|
}
|
|
|
|
func TestAPI_GetSuccess(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodGet || r.URL.Path != "/api/v1/foo" {
|
|
t.Errorf("unexpected request: %s %s", r.Method, r.URL.Path)
|
|
}
|
|
w.Header().Set("Content-Type", "application/json")
|
|
_, _ = w.Write([]byte(`{"hello":"world"}`))
|
|
})
|
|
defer stop()
|
|
|
|
if err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "GET", "/api/v1/foo", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
got := out.String()
|
|
if !strings.Contains(got, `"hello":"world"`) {
|
|
t.Errorf("expected raw JSON body in stdout, got %q", got)
|
|
}
|
|
if !strings.HasSuffix(got, "\n") {
|
|
t.Errorf("expected trailing newline appended, got %q", got)
|
|
}
|
|
}
|
|
|
|
func TestAPI_GetSuccess_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
w.Header().Set("X-Request-Id", "req-123")
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"value":42}`))
|
|
})
|
|
defer stop()
|
|
|
|
if err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, cli, "GET", "/api/v1/foo", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
// v0.7 envelope: {ok:true, data:{status, headers, body}}
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data struct {
|
|
Status int `json:"status"`
|
|
Headers map[string]string `json:"headers"`
|
|
Body map[string]any `json:"body"`
|
|
} `json:"data"`
|
|
}
|
|
if err := json.Unmarshal(out.Bytes(), &env); err != nil {
|
|
t.Fatalf("decode envelope JSON: %v\n%s", err, out.String())
|
|
}
|
|
if !env.OK {
|
|
t.Errorf("envelope ok: want true, got false")
|
|
}
|
|
got := env.Data
|
|
if got.Status != 200 {
|
|
t.Errorf("status: want 200, got %d", got.Status)
|
|
}
|
|
if got.Headers["Content-Type"] != "application/json" {
|
|
t.Errorf("Content-Type header missing: %v", got.Headers)
|
|
}
|
|
if v, ok := got.Body["value"]; !ok || v.(float64) != 42 {
|
|
t.Errorf("body.value: want 42, got %v", got.Body)
|
|
}
|
|
}
|
|
|
|
func TestAPI_PostWithStdinInput(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
var seenBody []byte
|
|
var seenMethod, seenPath string
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
seenMethod = r.Method
|
|
seenPath = r.URL.Path
|
|
seenBody, _ = io.ReadAll(r.Body)
|
|
w.Header().Set("Content-Type", "application/json")
|
|
_, _ = w.Write([]byte(`{"id":"new"}`))
|
|
})
|
|
defer stop()
|
|
|
|
opts := &Options{Input: "-", StdinReader: strings.NewReader(`{"name":"foo"}`)}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "POST", "/api/v1/things", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if seenMethod != http.MethodPost || seenPath != "/api/v1/things" {
|
|
t.Errorf("server saw %s %s, want POST /api/v1/things", seenMethod, seenPath)
|
|
}
|
|
if string(seenBody) != `{"name":"foo"}` {
|
|
t.Errorf("server received body %q, want %q", seenBody, `{"name":"foo"}`)
|
|
}
|
|
}
|
|
|
|
// TestAPI_InputFile verifies --input <file> reads the request body from disk.
|
|
func TestAPI_InputFile(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
tmp := filepath.Join(t.TempDir(), "body.json")
|
|
payload := `{"k":"from-file"}`
|
|
if err := os.WriteFile(tmp, []byte(payload), 0o600); err != nil {
|
|
t.Fatalf("write temp: %v", err)
|
|
}
|
|
var seenBody []byte
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
seenBody, _ = io.ReadAll(r.Body)
|
|
_, _ = w.Write([]byte(`{}`))
|
|
})
|
|
defer stop()
|
|
|
|
opts := &Options{Input: tmp}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "POST", "/api/v1/x", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if string(seenBody) != payload {
|
|
t.Errorf("body from --input: got %q, want %q", seenBody, payload)
|
|
}
|
|
}
|
|
|
|
// TestAPI_InputDash_Stdin verifies the "--input -" form: the payload comes
|
|
// from opts.StdinReader (production-default iostreams.IO.In).
|
|
func TestAPI_InputDash_Stdin(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
var seenBody []byte
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
seenBody, _ = io.ReadAll(r.Body)
|
|
_, _ = w.Write([]byte(`{}`))
|
|
})
|
|
defer stop()
|
|
|
|
payload := `{"k":"from-stdin"}`
|
|
opts := &Options{Input: "-", StdinReader: strings.NewReader(payload)}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "POST", "/api/v1/x", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if string(seenBody) != payload {
|
|
t.Errorf("body from --input -: got %q, want %q", seenBody, payload)
|
|
}
|
|
}
|
|
|
|
func TestAPI_NotFound(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusNotFound)
|
|
_, _ = w.Write([]byte(`{"error":"missing"}`))
|
|
})
|
|
defer stop()
|
|
|
|
err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "GET", "/api/v1/missing", false)
|
|
if err == nil {
|
|
t.Fatal("expected error for 404")
|
|
}
|
|
if !cmdutil.IsNotFound(err) {
|
|
t.Errorf("expected resource.not_found, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestAPI_AcceptsArbitraryMethod(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
var seenMethod string
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
seenMethod = r.Method
|
|
w.WriteHeader(http.StatusOK)
|
|
})
|
|
defer stop()
|
|
for _, m := range []string{"OPTIONS", "PATCH", "TRACE", "CUSTOM"} {
|
|
t.Run(m, func(t *testing.T) {
|
|
seenMethod = ""
|
|
err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, m, "/api/v1/things", false)
|
|
if err != nil {
|
|
t.Fatalf("expected method %q to be accepted, got %v", m, err)
|
|
}
|
|
if seenMethod != m {
|
|
t.Errorf("server saw method %q, want %q", seenMethod, m)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestAPI_EmptyMethodRejected(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, nil, "", "/api/v1/things", false)
|
|
if err == nil {
|
|
t.Fatal("expected error for empty method")
|
|
}
|
|
var fe *cmdutil.FlagError
|
|
if !errors.As(err, &fe) {
|
|
t.Errorf("expected FlagError, got %T %v", err, err)
|
|
}
|
|
}
|
|
|
|
func TestAPI_PathWithoutSlash(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, nil, "GET", "api/v1/things", false)
|
|
if err == nil {
|
|
t.Fatal("expected error for missing leading slash")
|
|
}
|
|
var ce *cmdutil.Error
|
|
if !asTypedError(err, &ce) || ce.Code != cmdutil.CodeInputInvalidArgument {
|
|
t.Errorf("expected input.invalid_argument, got %v", err)
|
|
}
|
|
}
|
|
|
|
// withRootHarness wraps `weknora api ...` under a synthetic root cmd that
|
|
// registers the global `-y/--yes` persistent flag (mirrors addGlobalFlags in
|
|
// cmd/root.go). Required because api's NewCmd doesn't register --yes itself
|
|
// - it inherits from root in production.
|
|
func withRootHarness(api *cobra.Command, args ...string) *cobra.Command {
|
|
root := &cobra.Command{Use: "weknora"}
|
|
root.PersistentFlags().BoolP("yes", "y", false, "")
|
|
root.AddCommand(api)
|
|
root.SetArgs(append([]string{"api"}, args...))
|
|
root.SetContext(context.Background())
|
|
root.SilenceErrors = true
|
|
root.SilenceUsage = true
|
|
return root
|
|
}
|
|
|
|
// TestAPI_DELETE_RequiresConfirmation pins the exit-10 protocol on the
|
|
// escape-hatch DELETE path: agent invokes `weknora api DELETE /...` without
|
|
// -y/--yes, must get input.confirmation_required + exit 10. Confirmation is
|
|
// enforced in NewCmd.RunE (not runAPI), so the test drives the cobra cmd.
|
|
func TestAPI_DELETE_RequiresConfirmation(t *testing.T) {
|
|
iostreams.SetForTest(t) // non-TTY
|
|
f := &cmdutil.Factory{
|
|
Client: func() (*sdk.Client, error) { return nil, nil },
|
|
Prompter: func() prompt.Prompter { return prompt.AgentPrompter{} },
|
|
}
|
|
root := withRootHarness(NewCmd(f), "/api/v1/knowledge-bases/kb_xxx", "-X", "DELETE")
|
|
err := root.Execute()
|
|
if err == nil {
|
|
t.Fatal("expected confirmation_required error for DELETE without -y")
|
|
}
|
|
var ce *cmdutil.Error
|
|
if !asTypedError(err, &ce) || ce.Code != cmdutil.CodeInputConfirmationRequired {
|
|
t.Errorf("want input.confirmation_required, got %v", err)
|
|
}
|
|
if got := cmdutil.ExitCode(err); got != 10 {
|
|
t.Errorf("exit code = %d, want 10", got)
|
|
}
|
|
}
|
|
|
|
// TestAPI_DELETE_WithYes_Proceeds: -y/--yes opt-in skips confirmation and
|
|
// dispatches to the SDK. Server returns 200 to verify the happy-path lands
|
|
// on the response body emit.
|
|
func TestAPI_DELETE_WithYes_Proceeds(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
called := false
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodDelete {
|
|
t.Errorf("expected DELETE, got %s", r.Method)
|
|
}
|
|
called = true
|
|
w.WriteHeader(http.StatusOK)
|
|
})
|
|
defer stop()
|
|
f := &cmdutil.Factory{
|
|
Client: func() (*sdk.Client, error) { return cli, nil },
|
|
Prompter: func() prompt.Prompter { return prompt.AgentPrompter{} },
|
|
}
|
|
root := withRootHarness(NewCmd(f), "/api/v1/knowledge-bases/kb_xxx", "-X", "DELETE", "-y")
|
|
if err := root.Execute(); err != nil {
|
|
t.Fatalf("execute: %v", err)
|
|
}
|
|
if !called {
|
|
t.Error("DELETE handler not called - confirmation may have blocked")
|
|
}
|
|
}
|
|
|
|
// asTypedError is a tiny wrapper around errors.As that keeps the call sites
|
|
// concise. Returns true on success, populating dst.
|
|
func asTypedError(err error, dst **cmdutil.Error) bool {
|
|
for e := err; e != nil; {
|
|
if t, ok := e.(*cmdutil.Error); ok {
|
|
*dst = t
|
|
return true
|
|
}
|
|
type unwrapper interface{ Unwrap() error }
|
|
u, ok := e.(unwrapper)
|
|
if !ok {
|
|
return false
|
|
}
|
|
e = u.Unwrap()
|
|
}
|
|
return false
|
|
}
|
|
|
|
func TestAPI_PaginateMergesPages(t *testing.T) {
|
|
pages := [][]byte{
|
|
[]byte(`{"success":true,"data":[{"id":"1"},{"id":"2"}],"total":5,"page":1,"page_size":2}`),
|
|
[]byte(`{"success":true,"data":[{"id":"3"},{"id":"4"}],"total":5,"page":2,"page_size":2}`),
|
|
[]byte(`{"success":true,"data":[{"id":"5"}],"total":5,"page":3,"page_size":2}`),
|
|
}
|
|
idx := 0
|
|
svc := &fakeAPISvc{do: func(method, path string, _ any) (*http.Response, error) {
|
|
if idx >= len(pages) {
|
|
return nil, fmt.Errorf("too many calls; idx=%d", idx)
|
|
}
|
|
body := pages[idx]
|
|
idx++
|
|
return &http.Response{
|
|
StatusCode: 200,
|
|
Body: io.NopCloser(bytes.NewReader(body)),
|
|
Header: make(http.Header),
|
|
}, nil
|
|
}}
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
opts := &Options{}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "GET", "/api/v1/knowledge-base?page=1&page_size=2", true); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data struct {
|
|
Data []map[string]string `json:"data"`
|
|
Total int `json:"total"`
|
|
} `json:"data"`
|
|
}
|
|
if err := json.Unmarshal(out.Bytes(), &env); err != nil {
|
|
t.Fatalf("unmarshal: %v\n%s", err, out.String())
|
|
}
|
|
got := env.Data
|
|
if len(got.Data) != 5 || got.Total != 5 {
|
|
t.Errorf("got %d records (total %d), want 5/5", len(got.Data), got.Total)
|
|
}
|
|
if idx != 3 {
|
|
t.Errorf("called %d times, want 3", idx)
|
|
}
|
|
}
|
|
|
|
func TestAPI_PaginateIgnoredForPOST(t *testing.T) {
|
|
// --paginate should be a no-op for non-GET methods (no pagination
|
|
// semantic for POST/PUT/DELETE). Single call expected.
|
|
called := 0
|
|
svc := &fakeAPISvc{do: func(method, path string, _ any) (*http.Response, error) {
|
|
called++
|
|
return &http.Response{
|
|
StatusCode: 200,
|
|
Body: io.NopCloser(bytes.NewReader([]byte(`{"success":true,"data":[],"total":5,"page":1,"page_size":2}`))),
|
|
Header: make(http.Header),
|
|
}, nil
|
|
}}
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
opts := &Options{Input: "-", StdinReader: strings.NewReader(`{"name":"foo"}`)}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "POST", "/api/v1/knowledge-base", true); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if called != 1 {
|
|
t.Errorf("called %d times, want 1 (POST should not paginate)", called)
|
|
}
|
|
}
|
|
|
|
func TestAPI_PaginateNoMetadataPassesThrough(t *testing.T) {
|
|
// If response doesn't look paginated (no total/page/page_size), --paginate
|
|
// should fall back to single-call envelope behavior (same shape as api without --paginate).
|
|
called := 0
|
|
svc := &fakeAPISvc{do: func(method, path string, _ any) (*http.Response, error) {
|
|
called++
|
|
hdr := make(http.Header)
|
|
hdr.Set("Content-Type", "application/json")
|
|
return &http.Response{
|
|
StatusCode: 200,
|
|
Body: io.NopCloser(bytes.NewReader([]byte(`{"hello":"world"}`))),
|
|
Header: hdr,
|
|
}, nil
|
|
}}
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
opts := &Options{}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "GET", "/api/v1/whoami", true); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if called != 1 {
|
|
t.Errorf("called %d times, want 1 (non-paginated response)", called)
|
|
}
|
|
// H3a: fallback must produce an envelope, not raw passthrough.
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data struct {
|
|
Status int `json:"status"`
|
|
Headers map[string]string `json:"headers"`
|
|
Body map[string]any `json:"body"`
|
|
} `json:"data"`
|
|
}
|
|
if err := json.Unmarshal(out.Bytes(), &env); err != nil {
|
|
t.Fatalf("non-paginated fallback must emit envelope JSON, unmarshal failed: %v\n%s", err, out.String())
|
|
}
|
|
if !env.OK {
|
|
t.Errorf("envelope ok: want true, got false")
|
|
}
|
|
if env.Data.Status != 200 {
|
|
t.Errorf("envelope data.status: want 200, got %d", env.Data.Status)
|
|
}
|
|
if v, ok := env.Data.Body["hello"]; !ok || v.(string) != "world" {
|
|
t.Errorf("envelope data.body: want {hello:world}, got %v", env.Data.Body)
|
|
}
|
|
}
|
|
|
|
// TestAPI_PaginateServerCapsPageSize covers the case where the user
|
|
// requests --page_size=50 but the server caps page_size at a smaller
|
|
// value (e.g. 2). Termination must count actually-collected records
|
|
// (len(allData)) not requested-page-count (page*pageSize) — otherwise
|
|
// we'd break early and silently truncate results.
|
|
func TestAPI_PaginateServerCapsPageSize(t *testing.T) {
|
|
// User asks page_size=10; server only ever returns 2 per page (cap).
|
|
// Total = 5 records; should make 3 calls (2+2+1) and return all 5.
|
|
pages := [][]byte{
|
|
[]byte(`{"success":true,"data":[{"id":"1"},{"id":"2"}],"total":5,"page":1,"page_size":2}`),
|
|
[]byte(`{"success":true,"data":[{"id":"3"},{"id":"4"}],"total":5,"page":2,"page_size":2}`),
|
|
[]byte(`{"success":true,"data":[{"id":"5"}],"total":5,"page":3,"page_size":2}`),
|
|
}
|
|
idx := 0
|
|
svc := &fakeAPISvc{do: func(_, _ string, _ any) (*http.Response, error) {
|
|
if idx >= len(pages) {
|
|
return nil, fmt.Errorf("too many calls; idx=%d", idx)
|
|
}
|
|
body := pages[idx]
|
|
idx++
|
|
return &http.Response{
|
|
StatusCode: 200,
|
|
Body: io.NopCloser(bytes.NewReader(body)),
|
|
Header: make(http.Header),
|
|
}, nil
|
|
}}
|
|
var stdout bytes.Buffer
|
|
iostreams.IO.Out = &stdout
|
|
defer func() { iostreams.IO.Out = os.Stdout }()
|
|
|
|
opts := &Options{}
|
|
// User requests page_size=10; server caps at 2 each response.
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "GET", "/api/v1/items?page=1&page_size=10", true); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data struct {
|
|
Data []map[string]string `json:"data"`
|
|
Total int `json:"total"`
|
|
} `json:"data"`
|
|
}
|
|
if err := json.Unmarshal(stdout.Bytes(), &env); err != nil {
|
|
t.Fatalf("unmarshal: %v\n%s", err, stdout.String())
|
|
}
|
|
got := env.Data
|
|
if len(got.Data) != 5 {
|
|
t.Errorf("got %d records, want 5 (server-capped page_size should not cause truncation)", len(got.Data))
|
|
}
|
|
}
|