Files
Enterprise-Knowledge-Base/cli/internal/output/batch_test.go
T
nullkey ad150c7126 refactor(cli): envelope sweep — Emit shape, batch ops, MCP StructuredContent, api flag cleanup
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
2026-05-27 10:56:34 +08:00

105 lines
3.7 KiB
Go

package output_test
import (
"bytes"
"strings"
"testing"
"github.com/Tencent/WeKnora/cli/internal/output"
)
func TestWriteBatchEnvelope_AllSuccess(t *testing.T) {
items := []output.BatchItem{
{ID: "id1", OK: true, Result: map[string]string{"deleted_at": "2026-05-20T00:00:00Z"}},
{ID: "id2", OK: true, Result: map[string]string{"deleted_at": "2026-05-20T00:00:00Z"}},
}
var buf bytes.Buffer
if err := output.WriteBatchEnvelope(&buf, items, false, ""); err != nil {
t.Fatalf("unexpected error: %v", err)
}
got := buf.String()
if !strings.Contains(got, `"ok":true`) {
t.Errorf("expected ok:true; got %q", got)
}
if !strings.Contains(got, `"successes":2`) {
t.Errorf("expected successes:2; got %q", got)
}
if !strings.Contains(got, `"count":2`) {
t.Errorf("expected count:2; got %q", got)
}
}
func TestWriteBatchEnvelope_PartialFailure(t *testing.T) {
items := []output.BatchItem{
{ID: "id1", OK: true, Result: map[string]string{"deleted_at": "2026-05-20T00:00:00Z"}},
{ID: "id2", OK: false, Error: &output.ErrDetail{Type: "resource.not_found", Message: "id2 not found"}},
}
var buf bytes.Buffer
if err := output.WriteBatchEnvelope(&buf, items, false, ""); err != nil {
t.Fatalf("unexpected error: %v", err)
}
got := buf.String()
if !strings.Contains(got, `"ok":false`) {
t.Errorf("expected ok:false (partial failure); got %q", got)
}
if !strings.Contains(got, `"successes":1`) || !strings.Contains(got, `"failures":1`) {
t.Errorf("expected counts; got %q", got)
}
if !strings.Contains(got, `"type":"resource.not_found"`) {
t.Errorf("expected per-item error; got %q", got)
}
}
func TestWriteBatchEnvelope_EmptyItems_EmitsEmptyArray(t *testing.T) {
var buf bytes.Buffer
if err := output.WriteBatchEnvelope(&buf, nil, false, ""); err != nil {
t.Fatalf("unexpected: %v", err)
}
got := buf.String()
if strings.Contains(got, `"data":null`) {
t.Errorf("empty items must marshal to [], not null; got %q", got)
}
if !strings.Contains(got, `"data":[]`) {
t.Errorf("expected data:[]; got %q", got)
}
if !strings.Contains(got, `"ok":true`) {
t.Errorf("expected ok:true for empty batch; got %q", got)
}
// count:0 is omitted by omitempty; assert no non-zero count appears.
if strings.Contains(got, `"count":`) {
// If count key is present, it must not be a non-zero value.
if !strings.Contains(got, `"count":0`) {
t.Errorf("count key present but not zero; got %q", got)
}
}
}
func TestWriteBatchEnvelope_AllFail(t *testing.T) {
items := []output.BatchItem{
{ID: "id1", OK: false, Error: &output.ErrDetail{Type: "auth.forbidden", Message: "no perm"}},
{ID: "id2", OK: false, Error: &output.ErrDetail{Type: "resource.not_found", Message: "missing"}},
}
var buf bytes.Buffer
if err := output.WriteBatchEnvelope(&buf, items, false, ""); err != nil {
t.Fatalf("unexpected error: %v", err)
}
got := buf.String()
if !strings.Contains(got, `"ok":false`) {
t.Errorf("expected ok:false; got %q", got)
}
// 全失败仍走 batch envelope shape,不退化到 ErrorEnvelope.
// An ErrorEnvelope has a top-level "error" key alongside "ok"; a batch
// envelope has a top-level "data" array. Check that "data":[ is present.
if !strings.Contains(got, `"data":[`) {
t.Errorf("batch all-fail should still use batch shape (data array), not error envelope; got %q", got)
}
if !strings.Contains(got, `"failures":2`) {
t.Errorf("expected failures:2; got %q", got)
}
// H3b invariant: successes:0 must appear even when all items failed.
// (*int semantics: nil is omitted; &0 is serialized as 0.)
if !strings.Contains(got, `"successes":0`) {
t.Errorf("all-fail batch must emit successes:0 (not omit it); invariant successes+failures==count would be broken; got %q", got)
}
}