2026-05-10 18:44:06 +00:00
|
|
|
package doc
|
|
|
|
|
|
|
|
|
|
import (
|
2026-05-17 17:38:30 +00:00
|
|
|
"bytes"
|
2026-05-10 18:44:06 +00:00
|
|
|
"context"
|
2026-05-17 17:38:30 +00:00
|
|
|
"encoding/json"
|
2026-05-10 18:44:06 +00:00
|
|
|
"errors"
|
2026-05-21 10:42:27 +00:00
|
|
|
"fmt"
|
2026-05-29 12:06:30 +00:00
|
|
|
"net/http"
|
|
|
|
|
"net/http/httptest"
|
2026-05-10 18:44:06 +00:00
|
|
|
"testing"
|
|
|
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
|
|
2026-05-21 10:42:27 +00:00
|
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
|
|
|
|
2026-05-10 18:44:06 +00:00
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
2026-05-29 12:06:30 +00:00
|
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
2026-05-10 18:44:06 +00:00
|
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
2026-05-29 12:06:30 +00:00
|
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
refactor(cli): delete envelope infrastructure, errors to stderr
Removes the entire envelope machinery now that every success path
emits bare JSON:
- cli/internal/format/envelope.go (Envelope, Success, Failure,
SuccessWithRisk, WriteEnvelope, Meta, Notice, UpdateNotice,
VersionSkewNotice, Risk, RiskLevel, ErrorBody) + tests.
- cli/internal/format/filter.go envelope-specific helpers
(WriteEnvelopeFiltered, marshalEnvelope, applyFieldFilter,
filterDataPayload, filterObjectData); the reusable
filterArrayItems / filterObjectKeys / writeJQ stay for bare.go.
- cli/internal/cmdutil/exporter.go + tests (envelope-only).
- cli/internal/cmdutil/PrintErrorEnvelope + ToErrorBody +
operationRiskOf + Error.OperationRisk field + OperationRisk struct.
Error path: all errors now go to stderr via cmdutil.PrintError in
`code: message\nhint: ...` form, regardless of --json. Stdout stays
empty (or holds the partial-success the command already wrote) so
downstream `--json | jq` pipelines never have to filter error shapes
out of the success stream. Typed exit codes (3 auth.* / 4
resource.not_found / 5 input.* / 6 server.rate_limited / 7 server.*
+ network.* / 10 input.confirmation_required) carry the failure
class for agents that branch on it.
Acceptance contract:
- envelope_test.go → wire_test.go (TestEnvelopeGolden → TestWireGolden).
- testdata/envelopes/ → testdata/wire/.
- Error-path cases assert the typed code substring on stderr.
- Orphan whoami.*.json goldens deleted.
AGENTS.md + README.md rewritten for the bare-data contract:
- Drop envelope schema section + dry-run rule.
- Document bare JSON on stdout + `code: msg\nhint: …` on stderr.
- ADR-3 reframed around bare data and why error separation matters
for `--json | jq` pipelines.
WriteJSONFiltered short-circuits to WriteJSON when both filters are
empty (skip the marshal-buffer round-trip for the common case).
Final review pass:
- Fix wire-contract bug: `--json id,name` (space form) is broken by
pflag's NoOptDefVal; AGENTS.md / README.md / SetAgentHelp + the
field-discovery help text all switched to `--json=id,name`.
- Fix `weknora api --jq` silently ignored: api.go now routes through
WriteJSONFiltered with jopts.JQ.
- AGENTS.md: drop the false claim that `auth logout` honors `-y`
(logout is local-only with no ConfirmDestructive guard); list the
actual destructive commands instead.
- Rewrite cli/acceptance/e2e/e2e_test.go for the bare-data wire shape
(was still parsing `out["data"]` / `env["ok"]`).
- Add `JSONOptions.Emit(w, v)` helper; collapse ~33 repeated
`format.WriteJSONFiltered(iostreams.IO.Out, X, jopts.Fields,
jopts.JQ)` sites to `jopts.Emit(iostreams.IO.Out, X)` — drops the
format import from 22 cmd/* files.
- Delete single-caller `cmdutil.MustRequireFlag`; inline as
`_ = cmd.MarkFlagRequired(...)` everywhere.
- Add `_ = cmd.MarkFlagRequired("name")` to `kb create`; it was the
only write command relying on runtime --name validation while
`context add` already used the cobra-level mark.
- `context use`: register `--json` / `--jq` (was always emitting JSON
unconditionally with no human path and no flag — diverged from
every other write command); human mode now prints
`✓ Switched context to X (was Y)`.
- Replace per-package `confirmPrompter` / `scriptedConfirm` /
`errPrompter` test doubles with `testutil.ConfirmPrompter`.
- Rename `chatService` → `ChatService` (export to match siblings
`ListService` / `ViewService`); rename `printUploadSuccess` →
`renderUploadSuccess` (siblings use `render*`).
- `defaultHint(CodeResourceNotFound)`: drop the hardcoded
"list available with `weknora kb list`" — misleading on agent /
doc / session 404. Replaced with "verify the resource ID and try
again".
- Strip stale `v0.2/v0.3` / "envelope" / "v0.0/v0.1 supports only"
historical tags from production comments and a few test
descriptions.
2026-05-14 17:51:11 +00:00
|
|
|
"github.com/Tencent/WeKnora/cli/internal/testutil"
|
2026-05-10 18:44:06 +00:00
|
|
|
)
|
|
|
|
|
|
2026-05-21 10:42:27 +00:00
|
|
|
// fakeAllSvc implements AllService for --all mode tests.
|
|
|
|
|
type fakeAllSvc struct {
|
|
|
|
|
err error
|
|
|
|
|
gotID string
|
|
|
|
|
called bool
|
|
|
|
|
resp *sdk.ClearKnowledgeBaseContentsResponse
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (f *fakeAllSvc) ClearKnowledgeBaseContents(_ context.Context, kbID string) (*sdk.ClearKnowledgeBaseContentsResponse, error) {
|
|
|
|
|
f.called = true
|
|
|
|
|
f.gotID = kbID
|
|
|
|
|
if f.err != nil {
|
|
|
|
|
return nil, f.err
|
|
|
|
|
}
|
|
|
|
|
if f.resp == nil {
|
|
|
|
|
return &sdk.ClearKnowledgeBaseContentsResponse{DeletedCount: 0}, nil
|
|
|
|
|
}
|
|
|
|
|
return f.resp, nil
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-17 17:38:30 +00:00
|
|
|
// fakeDeleteSvc captures calls and returns canned errors.
|
|
|
|
|
// errFor maps id → error for per-id failure injection (used in multi-id tests).
|
2026-05-10 18:44:06 +00:00
|
|
|
type fakeDeleteSvc struct {
|
2026-05-17 17:38:30 +00:00
|
|
|
err error
|
|
|
|
|
errFor map[string]error
|
|
|
|
|
got string
|
|
|
|
|
calls int
|
|
|
|
|
// deleted tracks all successfully deleted ids (multi-id tests).
|
|
|
|
|
deleted []string
|
2026-05-10 18:44:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (f *fakeDeleteSvc) DeleteKnowledge(_ context.Context, id string) error {
|
|
|
|
|
f.calls++
|
|
|
|
|
f.got = id
|
2026-05-17 17:38:30 +00:00
|
|
|
if f.errFor != nil {
|
|
|
|
|
if err, ok := f.errFor[id]; ok {
|
|
|
|
|
return err
|
|
|
|
|
}
|
|
|
|
|
f.deleted = append(f.deleted, id)
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
if f.err != nil {
|
|
|
|
|
return f.err
|
|
|
|
|
}
|
|
|
|
|
f.deleted = append(f.deleted, id)
|
|
|
|
|
return nil
|
2026-05-10 18:44:06 +00:00
|
|
|
}
|
|
|
|
|
|
2026-05-17 17:38:30 +00:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
// Single-id tests — runDelete uses the simpler {id, deleted} payload.
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
2026-05-10 18:44:06 +00:00
|
|
|
func TestDelete_Success_WithForce(t *testing.T) {
|
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeDeleteSvc{}
|
2026-05-10 18:44:20 +00:00
|
|
|
opts := &DeleteOptions{Yes: true}
|
2026-05-10 18:44:06 +00:00
|
|
|
// Force=true short-circuits the confirm path; the prompter must not be
|
|
|
|
|
// consulted, so any value works.
|
2026-05-21 10:43:18 +00:00
|
|
|
require.NoError(t, runDelete(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{Answer: false}, "doc_abc"))
|
2026-05-10 18:44:06 +00:00
|
|
|
|
|
|
|
|
assert.Equal(t, "doc_abc", svc.got)
|
|
|
|
|
assert.Equal(t, 1, svc.calls)
|
|
|
|
|
assert.Contains(t, out.String(), "✓")
|
|
|
|
|
assert.Contains(t, out.String(), "doc_abc")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestDelete_Success_JSON(t *testing.T) {
|
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeDeleteSvc{}
|
feat(cli): --json field-select, --jq, auth token, doc --from-url
Output ergonomics:
- `--json` accepts a comma-separated field list (gh-parity); selects
named keys from the per-command payload. Bare `--json` keeps the
full shape.
- `--jq <expr>` evaluates a gojq expression over the JSON; pairs with
`--json field-list` so projection runs before jq.
- `--version` is a global cobra flag in addition to the `version`
subcommand; both render the same line.
- Per-command `--help` now renders the available JSON field list under
"JSON fields available via `--json id,name,...`" (field-discovery
parity with gh / kubectl `-o jsonpath`).
New commands:
- `auth token` — print the active context's credential to stdout for
shell command substitution (`WEKNORA_TOKEN=$(weknora auth token)`).
Default: raw secret, no trailing newline. `--json` emits
`{token, mode, context}`.
- `doc upload --from-url <URL>` — ingest a remote URL via the SDK
`CreateKnowledgeFromURL`. `--name` forwarded as `FileName` so the
server's known-extension heuristic upgrades crawl-mode to
file-download-mode where appropriate.
Includes the simplify post-review polish pass (field-filter unit
tests, --json/--jq compose check, agent_help copy fixes).
2026-05-14 15:28:14 +00:00
|
|
|
opts := &DeleteOptions{Yes: true}
|
2026-05-17 17:38:30 +00:00
|
|
|
require.NoError(t, runDelete(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, &testutil.ConfirmPrompter{Answer: true}, "doc_abc"))
|
2026-05-10 18:44:06 +00:00
|
|
|
|
|
|
|
|
got := out.String()
|
2026-05-21 10:42:27 +00:00
|
|
|
var env struct {
|
|
|
|
|
OK bool `json:"ok"`
|
|
|
|
|
Data map[string]any `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.Equal(t, "doc_abc", env.Data["id"], "envelope.data.id must be doc_abc")
|
|
|
|
|
assert.Equal(t, true, env.Data["deleted"], "envelope.data.deleted must be true")
|
2026-05-10 18:44:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestDelete_NotFound_404(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeDeleteSvc{err: errors.New("HTTP error 404: not found")}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{}, "doc_missing")
|
2026-05-10 18:44:06 +00:00
|
|
|
require.Error(t, err)
|
|
|
|
|
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
|
|
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestDelete_HTTPError_500(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeDeleteSvc{err: errors.New("HTTP error 500: internal")}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{}, "doc_x")
|
2026-05-10 18:44:06 +00:00
|
|
|
require.Error(t, err)
|
|
|
|
|
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
2026-05-17 17:38:30 +00:00
|
|
|
// Single-id delete WrapHTTP-classifies the SDK error; HTTP 500 → server.error.
|
|
|
|
|
// (The multi-id path rolls up failures as operation.failed; this is the
|
|
|
|
|
// single-id path so it stays server.error.)
|
2026-05-10 18:44:06 +00:00
|
|
|
assert.Equal(t, cmdutil.CodeServerError, typed.Code)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestDelete_ConfirmYes(t *testing.T) {
|
|
|
|
|
out, _ := iostreams.SetForTestWithTTY(t)
|
|
|
|
|
svc := &fakeDeleteSvc{}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: false}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{Answer: true}, "doc_abc")
|
2026-05-10 18:44:06 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
assert.Equal(t, 1, svc.calls, "user said yes ⇒ delete proceeds")
|
|
|
|
|
assert.Contains(t, out.String(), "✓")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestDelete_ConfirmNo(t *testing.T) {
|
|
|
|
|
_, errBuf := iostreams.SetForTestWithTTY(t)
|
|
|
|
|
svc := &fakeDeleteSvc{}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: false}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{Answer: false}, "doc_abc")
|
2026-05-10 18:44:06 +00:00
|
|
|
require.Error(t, err)
|
|
|
|
|
assert.Equal(t, 0, svc.calls, "user said no ⇒ SDK must NOT be called")
|
|
|
|
|
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
|
|
|
|
assert.Equal(t, cmdutil.CodeUserAborted, typed.Code)
|
|
|
|
|
assert.Contains(t, errBuf.String(), "Aborted.")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// TestDelete_AgentPrompterErrors covers the path where the prompter itself
|
|
|
|
|
// returns an error (e.g. AgentPrompter, broken stdin). runDelete maps this to
|
|
|
|
|
// CodeInputMissingFlag so the user sees "pass --force" in the hint.
|
|
|
|
|
func TestDelete_AgentPrompterErrors(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTestWithTTY(t)
|
|
|
|
|
svc := &fakeDeleteSvc{}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: false}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{Err: errors.New("no tty")}, "doc_abc")
|
2026-05-10 18:44:06 +00:00
|
|
|
require.Error(t, err)
|
|
|
|
|
assert.Equal(t, 0, svc.calls)
|
|
|
|
|
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
|
|
|
|
assert.Equal(t, cmdutil.CodeInputMissingFlag, typed.Code)
|
|
|
|
|
}
|
|
|
|
|
|
feat(cli): add agent-first affordance — envelope, exit-10, --dry-run
Borrows the lark-cli agent-affordance model
(https://github.com/larksuite/cli/blob/main/AGENTS.md +
skills/lark-shared/SKILL.md) so weknora is designed to be agent-friendly:
error messages, output format, and flag design follow conventions agents
can rely on.
cli/AGENTS.md (operational reference for LLM agents invoking weknora):
Public document covering envelope schema, exit-code protocol
(0/1/2/10/130), stdout/stderr separation, and behavioral rules.
Sensitive commands (\`context use\`, \`kb delete\`, \`doc delete\`, \`init\`)
gain "AI agents:" paragraphs in their cobra Long descriptions so
guidance shows in --help.
format.Envelope schema additions:
Risk per-operation classification (read / write / high-risk-write +
action description), populated by write commands on both success
and failure paths.
Notice system advisories (CLI update available, server-CLI version
skew); type defined, emit sites land in v0.3.
DryRun marker for envelopes returned from --dry-run preview paths.
RiskLevel constants realigned to lark's taxonomy: read / write /
high-risk-write (was: read / mutating / destructive — not yet wired by
any command).
cmdutil.Error gains OperationRisk; PrintErrorEnvelope auto-attaches it
to envelope.Risk so destructive failure paths surface uniformly.
Exit-10 confirmation protocol:
New ErrorCode \`input.confirmation_required\` mapped to exit code 10 in
cmdutil.ExitCode. ConfirmDestructive now returns this code (with
OperationRisk attached) when stdout is non-TTY or --json was set, with
-y/--yes absent. Previous behavior — silent proceed in non-TTY — was
unsafe: scripts and agents could delete resources with no explicit
approval. Three test cases re-pinned around the new contract.
This is a wire-contract change for any caller who relied on silent
proceed; v0.0/v0.1 had no destructive commands, so the blast radius is
contained to v0.2 itself.
--dry-run global flag:
cmd write paths (kb create/delete, doc upload/delete, api POST/PUT/PATCH/
DELETE) check cmdutil.IsDryRun(cmd) and skip the SDK call, emitting an
envelope with dry_run=true plus a Risk classification. Read commands
ignore --dry-run by design (no side effect to preview). Human-mode
prints \`[dry-run] would <action>\` to stdout.
Command discovery: agents introspect via the existing \`--help\` surface
(consistent with gh / kubectl / aws / gcloud / terraform — none of them
ship a CLI-tree self-description command). An earlier draft added a
\`weknora schema\` reflection command; dropped after a mainstream survey
found it has no stable analog (lark-cli's schema describes Lark API
methods, not its own CLI tree).
Tests: 27 cli packages pass at this commit. Added two new tests covering
envelope.risk and envelope._notice serialization.
2026-05-10 18:44:34 +00:00
|
|
|
// TestDelete_NoYes_NonTTY_RequiresConfirmation: when stdout isn't a TTY
|
refactor(cli): v0.3 cross-cutting cleanup
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.
2026-05-12 15:42:20 +00:00
|
|
|
// (typical agent pipe / CI), the destructive-write protocol requires
|
|
|
|
|
// explicit -y/--yes. The CLI exits 10 with input.confirmation_required,
|
refactor(cli): drop aiclient package; align AGENTS.md with mainstream
Survey of 10 mainstream CLIs (gh, lark, stripe, vercel, supabase, aws,
azure, gcloud, openai/codex, github-copilot-cli) showed env-gated
per-command --help blurbs are a Stripe-only pattern; gh uses env detect
for telemetry only, and lark relies on installed agent Skills + MCP.
Our cmd/mcp/serve already covers the dominant 2025/26 path, so
internal/aiclient/ (136 LOC + 38 callsites) is net maintenance burden
without precedent.
- Drop internal/aiclient/ entirely (annotations + detect + tests)
- Remove 38 SetAgentHelp callsites + agentAwareHelpFunc / SetHelpFunc
wiring in cmd/root.go
- Migrate 4 command-level rules to standard Long help (visible to all,
not env-gated): doc upload mode mutex, kb edit at-least-one,
kb pin idempotent, search chunks channel mutex
- Rewrite AGENTS.md as a developer guide (gh-style 6 H2 / 167 lines):
audience preamble + Build / Architecture / Command Structure /
Testing / Code Style / Error Handling. Drops sections absent in
surveyed projects (Commit & PR Conventions, Who Uses This CLI)
- Clean 14 internal doc refs (ADR-N, spec §X, v0.X) in source comments
and docs that pointed at docs/superpowers/ — that directory is
local-only / uncommitted, so refs are dead for outside readers
- Drop forward-looking "once v0.2 ships" from README
2026-05-14 18:16:45 +00:00
|
|
|
// never silently proceeds. See cli/README.md "Exit codes".
|
feat(cli): add agent-first affordance — envelope, exit-10, --dry-run
Borrows the lark-cli agent-affordance model
(https://github.com/larksuite/cli/blob/main/AGENTS.md +
skills/lark-shared/SKILL.md) so weknora is designed to be agent-friendly:
error messages, output format, and flag design follow conventions agents
can rely on.
cli/AGENTS.md (operational reference for LLM agents invoking weknora):
Public document covering envelope schema, exit-code protocol
(0/1/2/10/130), stdout/stderr separation, and behavioral rules.
Sensitive commands (\`context use\`, \`kb delete\`, \`doc delete\`, \`init\`)
gain "AI agents:" paragraphs in their cobra Long descriptions so
guidance shows in --help.
format.Envelope schema additions:
Risk per-operation classification (read / write / high-risk-write +
action description), populated by write commands on both success
and failure paths.
Notice system advisories (CLI update available, server-CLI version
skew); type defined, emit sites land in v0.3.
DryRun marker for envelopes returned from --dry-run preview paths.
RiskLevel constants realigned to lark's taxonomy: read / write /
high-risk-write (was: read / mutating / destructive — not yet wired by
any command).
cmdutil.Error gains OperationRisk; PrintErrorEnvelope auto-attaches it
to envelope.Risk so destructive failure paths surface uniformly.
Exit-10 confirmation protocol:
New ErrorCode \`input.confirmation_required\` mapped to exit code 10 in
cmdutil.ExitCode. ConfirmDestructive now returns this code (with
OperationRisk attached) when stdout is non-TTY or --json was set, with
-y/--yes absent. Previous behavior — silent proceed in non-TTY — was
unsafe: scripts and agents could delete resources with no explicit
approval. Three test cases re-pinned around the new contract.
This is a wire-contract change for any caller who relied on silent
proceed; v0.0/v0.1 had no destructive commands, so the blast radius is
contained to v0.2 itself.
--dry-run global flag:
cmd write paths (kb create/delete, doc upload/delete, api POST/PUT/PATCH/
DELETE) check cmdutil.IsDryRun(cmd) and skip the SDK call, emitting an
envelope with dry_run=true plus a Risk classification. Read commands
ignore --dry-run by design (no side effect to preview). Human-mode
prints \`[dry-run] would <action>\` to stdout.
Command discovery: agents introspect via the existing \`--help\` surface
(consistent with gh / kubectl / aws / gcloud / terraform — none of them
ship a CLI-tree self-description command). An earlier draft added a
\`weknora schema\` reflection command; dropped after a mainstream survey
found it has no stable analog (lark-cli's schema describes Lark API
methods, not its own CLI tree).
Tests: 27 cli packages pass at this commit. Added two new tests covering
envelope.risk and envelope._notice serialization.
2026-05-10 18:44:34 +00:00
|
|
|
func TestDelete_NoYes_NonTTY_RequiresConfirmation(t *testing.T) {
|
2026-05-10 18:44:06 +00:00
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeDeleteSvc{}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: false}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{Err: errors.New("no tty")}, "doc_abc")
|
feat(cli): add agent-first affordance — envelope, exit-10, --dry-run
Borrows the lark-cli agent-affordance model
(https://github.com/larksuite/cli/blob/main/AGENTS.md +
skills/lark-shared/SKILL.md) so weknora is designed to be agent-friendly:
error messages, output format, and flag design follow conventions agents
can rely on.
cli/AGENTS.md (operational reference for LLM agents invoking weknora):
Public document covering envelope schema, exit-code protocol
(0/1/2/10/130), stdout/stderr separation, and behavioral rules.
Sensitive commands (\`context use\`, \`kb delete\`, \`doc delete\`, \`init\`)
gain "AI agents:" paragraphs in their cobra Long descriptions so
guidance shows in --help.
format.Envelope schema additions:
Risk per-operation classification (read / write / high-risk-write +
action description), populated by write commands on both success
and failure paths.
Notice system advisories (CLI update available, server-CLI version
skew); type defined, emit sites land in v0.3.
DryRun marker for envelopes returned from --dry-run preview paths.
RiskLevel constants realigned to lark's taxonomy: read / write /
high-risk-write (was: read / mutating / destructive — not yet wired by
any command).
cmdutil.Error gains OperationRisk; PrintErrorEnvelope auto-attaches it
to envelope.Risk so destructive failure paths surface uniformly.
Exit-10 confirmation protocol:
New ErrorCode \`input.confirmation_required\` mapped to exit code 10 in
cmdutil.ExitCode. ConfirmDestructive now returns this code (with
OperationRisk attached) when stdout is non-TTY or --json was set, with
-y/--yes absent. Previous behavior — silent proceed in non-TTY — was
unsafe: scripts and agents could delete resources with no explicit
approval. Three test cases re-pinned around the new contract.
This is a wire-contract change for any caller who relied on silent
proceed; v0.0/v0.1 had no destructive commands, so the blast radius is
contained to v0.2 itself.
--dry-run global flag:
cmd write paths (kb create/delete, doc upload/delete, api POST/PUT/PATCH/
DELETE) check cmdutil.IsDryRun(cmd) and skip the SDK call, emitting an
envelope with dry_run=true plus a Risk classification. Read commands
ignore --dry-run by design (no side effect to preview). Human-mode
prints \`[dry-run] would <action>\` to stdout.
Command discovery: agents introspect via the existing \`--help\` surface
(consistent with gh / kubectl / aws / gcloud / terraform — none of them
ship a CLI-tree self-description command). An earlier draft added a
\`weknora schema\` reflection command; dropped after a mainstream survey
found it has no stable analog (lark-cli's schema describes Lark API
methods, not its own CLI tree).
Tests: 27 cli packages pass at this commit. Added two new tests covering
envelope.risk and envelope._notice serialization.
2026-05-10 18:44:34 +00:00
|
|
|
require.Error(t, err)
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
|
|
|
|
assert.Equal(t, cmdutil.CodeInputConfirmationRequired, typed.Code)
|
|
|
|
|
assert.Equal(t, 0, svc.calls, "non-TTY without -y must not call DeleteKnowledge")
|
|
|
|
|
assert.Equal(t, 10, cmdutil.ExitCode(err))
|
2026-05-10 18:44:06 +00:00
|
|
|
}
|
2026-05-17 17:38:30 +00:00
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
2026-05-21 10:42:27 +00:00
|
|
|
// Multi-id tests (cmdutil.RunBatch, keep-going semantics)
|
2026-05-17 17:38:30 +00:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
func TestRunMultiDelete_AllSucceed(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeDeleteSvc{}
|
2026-05-21 10:42:27 +00:00
|
|
|
outcomes, err := cmdutil.RunBatch(
|
2026-05-17 17:38:30 +00:00
|
|
|
context.Background(),
|
|
|
|
|
[]string{"a", "b", "c"},
|
2026-05-21 10:42:27 +00:00
|
|
|
func(ctx context.Context, id string) error {
|
|
|
|
|
if err := svc.DeleteKnowledge(ctx, id); err != nil {
|
|
|
|
|
return cmdutil.WrapHTTP(err, "delete document %s", id)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
},
|
2026-05-17 17:38:30 +00:00
|
|
|
)
|
|
|
|
|
require.NoError(t, err)
|
2026-05-21 10:42:27 +00:00
|
|
|
require.Len(t, outcomes, 3)
|
|
|
|
|
for _, oc := range outcomes {
|
|
|
|
|
assert.Nil(t, oc.Err, "expected no error for id %s", oc.ID)
|
|
|
|
|
}
|
|
|
|
|
assert.Equal(t, "a", outcomes[0].ID)
|
|
|
|
|
assert.Equal(t, "b", outcomes[1].ID)
|
|
|
|
|
assert.Equal(t, "c", outcomes[2].ID)
|
2026-05-17 17:38:30 +00:00
|
|
|
assert.Equal(t, 3, svc.calls)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestRunMultiDelete_KeepGoingOnError(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeDeleteSvc{errFor: map[string]error{"doc_b": errors.New("not found")}}
|
2026-05-21 10:42:27 +00:00
|
|
|
outcomes, err := cmdutil.RunBatch(
|
2026-05-17 17:38:30 +00:00
|
|
|
context.Background(),
|
|
|
|
|
[]string{"doc_a", "doc_b", "doc_c"},
|
2026-05-21 10:42:27 +00:00
|
|
|
func(ctx context.Context, id string) error {
|
|
|
|
|
if err := svc.DeleteKnowledge(ctx, id); err != nil {
|
|
|
|
|
return cmdutil.WrapHTTP(err, "delete document %s", id)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
},
|
2026-05-17 17:38:30 +00:00
|
|
|
)
|
|
|
|
|
require.Error(t, err, "partial failure must return non-nil error (exit 1)")
|
|
|
|
|
assert.Equal(t, 3, svc.calls, "all ids must be attempted (keep-going)")
|
2026-05-21 10:42:27 +00:00
|
|
|
require.Len(t, outcomes, 3)
|
|
|
|
|
// order preserved: doc_a ok, doc_b fail, doc_c ok
|
|
|
|
|
assert.Equal(t, "doc_a", outcomes[0].ID)
|
|
|
|
|
assert.Nil(t, outcomes[0].Err)
|
|
|
|
|
assert.Equal(t, "doc_b", outcomes[1].ID)
|
|
|
|
|
assert.NotNil(t, outcomes[1].Err)
|
|
|
|
|
assert.Equal(t, "doc_c", outcomes[2].ID)
|
|
|
|
|
assert.Nil(t, outcomes[2].Err)
|
2026-05-17 17:38:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestRunMultiDelete_AllFail(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeDeleteSvc{errFor: map[string]error{
|
|
|
|
|
"x": errors.New("HTTP error 404: not found"),
|
|
|
|
|
"y": errors.New("HTTP error 403: forbidden"),
|
|
|
|
|
}}
|
2026-05-21 10:42:27 +00:00
|
|
|
outcomes, err := cmdutil.RunBatch(
|
2026-05-17 17:38:30 +00:00
|
|
|
context.Background(),
|
|
|
|
|
[]string{"x", "y"},
|
2026-05-21 10:42:27 +00:00
|
|
|
func(ctx context.Context, id string) error {
|
|
|
|
|
if err := svc.DeleteKnowledge(ctx, id); err != nil {
|
|
|
|
|
return cmdutil.WrapHTTP(err, "delete document %s", id)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
},
|
2026-05-17 17:38:30 +00:00
|
|
|
)
|
|
|
|
|
require.Error(t, err)
|
2026-05-21 10:42:27 +00:00
|
|
|
require.Len(t, outcomes, 2)
|
|
|
|
|
assert.NotNil(t, outcomes[0].Err)
|
|
|
|
|
assert.NotNil(t, outcomes[1].Err)
|
2026-05-17 17:38:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestRunMultiDelete_ConfirmBatch_NonTTY_RequiresConfirmation(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t) // non-TTY
|
|
|
|
|
svc := &fakeDeleteSvc{}
|
2026-05-21 10:42:27 +00:00
|
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}
|
2026-05-29 12:06:30 +00:00
|
|
|
err := cmdutil.ConfirmDestructiveBatch(&testutil.ConfirmPrompter{Answer: false}, false, fopts.WantsJSON(), "delete", "document", 2, "doc.delete", "")
|
2026-05-17 17:38:30 +00:00
|
|
|
require.Error(t, err)
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
|
|
|
|
assert.Equal(t, cmdutil.CodeInputConfirmationRequired, typed.Code)
|
|
|
|
|
assert.Equal(t, 0, svc.calls, "must not call DeleteKnowledge without confirmation")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestRunMultiDelete_ConfirmBatch_TTY_UserAborts(t *testing.T) {
|
|
|
|
|
_, errBuf := iostreams.SetForTestWithTTY(t)
|
|
|
|
|
svc := &fakeDeleteSvc{}
|
2026-05-21 10:43:18 +00:00
|
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatText}
|
2026-05-29 12:06:30 +00:00
|
|
|
err := cmdutil.ConfirmDestructiveBatch(&testutil.ConfirmPrompter{Answer: false}, false, fopts.WantsJSON(), "delete", "document", 3, "doc.delete", "")
|
2026-05-17 17:38:30 +00:00
|
|
|
require.Error(t, err)
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
|
|
|
|
assert.Equal(t, cmdutil.CodeUserAborted, typed.Code)
|
|
|
|
|
assert.Contains(t, errBuf.String(), "Aborted.")
|
|
|
|
|
assert.Equal(t, 0, svc.calls, "user aborted ⇒ SDK must NOT be called")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
refactor(cli): finish context→profile cascade + post-review hardening (BREAKING)
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.
2026-05-21 15:44:16 +00:00
|
|
|
// Emit tests — JSON path now emits the batch envelope
|
2026-05-17 17:38:30 +00:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
2026-05-21 10:42:27 +00:00
|
|
|
// batchEnvelope is a minimal struct for parsing the batch envelope shape.
|
|
|
|
|
type batchEnvelope struct {
|
|
|
|
|
OK bool `json:"ok"`
|
|
|
|
|
Data []batchItem `json:"data"`
|
|
|
|
|
Meta batchMeta `json:"meta"`
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type batchItem struct {
|
|
|
|
|
ID string `json:"id"`
|
|
|
|
|
OK bool `json:"ok"`
|
|
|
|
|
Result json.RawMessage `json:"result,omitempty"`
|
|
|
|
|
Error *batchItemError `json:"error,omitempty"`
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type batchItemError struct {
|
|
|
|
|
Type string `json:"type"`
|
|
|
|
|
Message string `json:"message"`
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type batchMeta struct {
|
|
|
|
|
Count int `json:"count"`
|
|
|
|
|
Successes int `json:"successes"`
|
|
|
|
|
Failures int `json:"failures"`
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-17 17:38:30 +00:00
|
|
|
func TestEmitMultiDelete_JSON(t *testing.T) {
|
|
|
|
|
var buf bytes.Buffer
|
2026-05-21 10:42:27 +00:00
|
|
|
outcomes := []cmdutil.BatchOutcome{
|
|
|
|
|
{ID: "a", Err: nil},
|
|
|
|
|
{ID: "b", Err: nil},
|
|
|
|
|
{ID: "c", Err: errors.New("x")},
|
2026-05-17 17:38:30 +00:00
|
|
|
}
|
2026-05-21 10:42:27 +00:00
|
|
|
err := cmdutil.EmitBatch(outcomes, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, &buf, cmdutil.DeletedAtNow)
|
2026-05-17 17:38:30 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
2026-05-21 10:42:27 +00:00
|
|
|
var got batchEnvelope
|
2026-05-17 17:38:30 +00:00
|
|
|
require.NoError(t, json.Unmarshal(buf.Bytes(), &got))
|
2026-05-21 10:42:27 +00:00
|
|
|
// top-level: partial failure → ok:false
|
|
|
|
|
assert.False(t, got.OK)
|
|
|
|
|
assert.Equal(t, 3, got.Meta.Count)
|
|
|
|
|
assert.Equal(t, 2, got.Meta.Successes)
|
|
|
|
|
assert.Equal(t, 1, got.Meta.Failures)
|
|
|
|
|
require.Len(t, got.Data, 3)
|
|
|
|
|
assert.Equal(t, "a", got.Data[0].ID)
|
|
|
|
|
assert.True(t, got.Data[0].OK)
|
|
|
|
|
assert.Equal(t, "b", got.Data[1].ID)
|
|
|
|
|
assert.True(t, got.Data[1].OK)
|
|
|
|
|
assert.Equal(t, "c", got.Data[2].ID)
|
|
|
|
|
assert.False(t, got.Data[2].OK)
|
|
|
|
|
assert.NotNil(t, got.Data[2].Error)
|
2026-05-17 17:38:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestEmitMultiDelete_Text(t *testing.T) {
|
|
|
|
|
var buf bytes.Buffer
|
2026-05-21 10:42:27 +00:00
|
|
|
outcomes := []cmdutil.BatchOutcome{
|
|
|
|
|
{ID: "a", Err: nil},
|
|
|
|
|
{ID: "b", Err: errors.New("boom")},
|
2026-05-17 17:38:30 +00:00
|
|
|
}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := cmdutil.EmitBatch(outcomes, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &buf, nil)
|
2026-05-17 17:38:30 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
|
|
out := buf.String()
|
|
|
|
|
assert.Contains(t, out, "OK a")
|
2026-05-21 10:42:27 +00:00
|
|
|
assert.Contains(t, out, "FAIL b:")
|
|
|
|
|
assert.Contains(t, out, "boom")
|
2026-05-17 17:38:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestEmitMultiDelete_TextEmpty(t *testing.T) {
|
|
|
|
|
var buf bytes.Buffer
|
2026-05-21 10:42:27 +00:00
|
|
|
outcomes := []cmdutil.BatchOutcome{
|
|
|
|
|
{ID: "x", Err: nil},
|
|
|
|
|
{ID: "y", Err: nil},
|
|
|
|
|
}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := cmdutil.EmitBatch(outcomes, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, &buf, nil)
|
2026-05-17 17:38:30 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
|
|
out := buf.String()
|
|
|
|
|
assert.Contains(t, out, "OK x")
|
|
|
|
|
assert.Contains(t, out, "OK y")
|
|
|
|
|
assert.NotContains(t, out, "FAIL")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestEmitMultiDelete_UnsupportedFormat(t *testing.T) {
|
2026-05-21 10:42:27 +00:00
|
|
|
// EmitBatch defers unsupported format handling to WriteBatchEnvelope; for
|
2026-05-21 10:43:18 +00:00
|
|
|
// non-JSON formats it falls through to text. Verify it does not error.
|
2026-05-21 10:42:27 +00:00
|
|
|
var buf bytes.Buffer
|
|
|
|
|
outcomes := []cmdutil.BatchOutcome{}
|
|
|
|
|
err := cmdutil.EmitBatch(outcomes, &cmdutil.FormatOptions{Mode: "yaml"}, &buf, nil)
|
|
|
|
|
// EmitBatch itself does not error on unknown mode (it uses WantsJSON gate)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
// Batch envelope shape test — Task 2.6
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
// TestDocDelete_MultiID_PartialFailure_BatchEnvelope verifies that when a
|
refactor(cli): finish context→profile cascade + post-review hardening (BREAKING)
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.
2026-05-21 15:44:16 +00:00
|
|
|
// multi-id delete has a partial failure, stdout carries the batch
|
2026-05-21 10:42:27 +00:00
|
|
|
// envelope shape: ok:false, data:[BatchItem...], meta:{count, successes,
|
|
|
|
|
// failures}. Order follows original argv order.
|
|
|
|
|
func TestDocDelete_MultiID_PartialFailure_BatchEnvelope(t *testing.T) {
|
|
|
|
|
// id1 succeeds, id2 fails, id3 succeeds.
|
|
|
|
|
svc := &fakeDeleteSvc{errFor: map[string]error{
|
|
|
|
|
"id2": errors.New("HTTP error 404: not found"),
|
|
|
|
|
}}
|
|
|
|
|
outcomes, runErr := cmdutil.RunBatch(
|
|
|
|
|
context.Background(),
|
|
|
|
|
[]string{"id1", "id2", "id3"},
|
|
|
|
|
func(ctx context.Context, id string) error {
|
|
|
|
|
if err := svc.DeleteKnowledge(ctx, id); err != nil {
|
|
|
|
|
return cmdutil.WrapHTTP(err, "delete document %s", id)
|
|
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
},
|
|
|
|
|
)
|
|
|
|
|
require.Error(t, runErr, "partial failure must return non-nil error")
|
|
|
|
|
require.Len(t, outcomes, 3)
|
|
|
|
|
|
2026-05-17 17:38:30 +00:00
|
|
|
var buf bytes.Buffer
|
2026-05-21 10:42:27 +00:00
|
|
|
require.NoError(t, cmdutil.EmitBatch(outcomes, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON, TTY: false}, &buf, cmdutil.DeletedAtNow))
|
|
|
|
|
|
|
|
|
|
var env batchEnvelope
|
|
|
|
|
require.NoError(t, json.Unmarshal(buf.Bytes(), &env))
|
|
|
|
|
|
|
|
|
|
// top-level ok:false (partial failure)
|
|
|
|
|
assert.False(t, env.OK)
|
|
|
|
|
|
|
|
|
|
// meta counts
|
|
|
|
|
assert.Equal(t, 3, env.Meta.Count)
|
|
|
|
|
assert.Equal(t, 2, env.Meta.Successes)
|
|
|
|
|
assert.Equal(t, 1, env.Meta.Failures)
|
|
|
|
|
|
|
|
|
|
// items in argv order
|
|
|
|
|
require.Len(t, env.Data, 3)
|
|
|
|
|
|
|
|
|
|
assert.Equal(t, "id1", env.Data[0].ID)
|
|
|
|
|
assert.True(t, env.Data[0].OK)
|
|
|
|
|
assert.Nil(t, env.Data[0].Error)
|
|
|
|
|
|
|
|
|
|
assert.Equal(t, "id2", env.Data[1].ID)
|
|
|
|
|
assert.False(t, env.Data[1].OK)
|
|
|
|
|
require.NotNil(t, env.Data[1].Error)
|
|
|
|
|
assert.Equal(t, "resource.not_found", env.Data[1].Error.Type)
|
|
|
|
|
|
|
|
|
|
assert.Equal(t, "id3", env.Data[2].ID)
|
|
|
|
|
assert.True(t, env.Data[2].OK)
|
|
|
|
|
assert.Nil(t, env.Data[2].Error)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
// --all mode tests (runDeleteAll)
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
// TestDocDelete_All_MissingKB_ReturnsFlagError: --all without --kb must exit 2.
|
|
|
|
|
func TestDocDelete_All_MissingKB_ReturnsFlagError(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeAllSvc{}
|
|
|
|
|
// Simulate the RunE guard: --all without --kb returns FlagError before
|
|
|
|
|
// runDeleteAll is ever called.
|
|
|
|
|
err := cmdutil.NewFlagError(fmt.Errorf("--all requires --kb=<id>"))
|
2026-05-17 17:38:30 +00:00
|
|
|
require.Error(t, err)
|
2026-05-21 10:42:27 +00:00
|
|
|
var flagErr *cmdutil.FlagError
|
|
|
|
|
require.ErrorAs(t, err, &flagErr)
|
|
|
|
|
assert.Equal(t, 2, cmdutil.ExitCode(err))
|
|
|
|
|
assert.False(t, svc.called)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// TestDocDelete_All_WithoutYes_JSONMode_ReturnsExit10 verifies the
|
|
|
|
|
// CodeInputConfirmationRequired (exit 10) path with risk metadata in JSON/non-TTY.
|
|
|
|
|
func TestDocDelete_All_WithoutYes_JSONMode_ReturnsExit10(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t) // non-TTY
|
|
|
|
|
svc := &fakeAllSvc{}
|
|
|
|
|
opts := &DeleteOptions{All: true, KB: "kb_x", Yes: false}
|
|
|
|
|
err := runDeleteAll(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, &testutil.ConfirmPrompter{})
|
|
|
|
|
require.Error(t, err)
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
|
|
|
|
assert.Equal(t, cmdutil.CodeInputConfirmationRequired, typed.Code)
|
|
|
|
|
assert.Equal(t, 10, cmdutil.ExitCode(err))
|
|
|
|
|
require.NotNil(t, typed.Risk)
|
|
|
|
|
assert.Equal(t, "destructive", typed.Risk.Level)
|
|
|
|
|
assert.Equal(t, "doc.delete_all", typed.Risk.Action)
|
|
|
|
|
assert.False(t, svc.called)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// TestDocDelete_All_WithYes_CallsClearKB verifies that with -y the call is made
|
|
|
|
|
// and the JSON envelope contains kb_id + deleted_count.
|
|
|
|
|
func TestDocDelete_All_WithYes_CallsClearKB(t *testing.T) {
|
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeAllSvc{resp: &sdk.ClearKnowledgeBaseContentsResponse{DeletedCount: 17}}
|
|
|
|
|
opts := &DeleteOptions{All: true, KB: "kb_x", Yes: true}
|
|
|
|
|
err := runDeleteAll(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, &testutil.ConfirmPrompter{})
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
assert.True(t, svc.called)
|
|
|
|
|
assert.Equal(t, "kb_x", svc.gotID)
|
|
|
|
|
|
|
|
|
|
var env struct {
|
|
|
|
|
OK bool `json:"ok"`
|
|
|
|
|
Data map[string]any `json:"data"`
|
|
|
|
|
}
|
|
|
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env), "expected valid JSON envelope, got %q", out.String())
|
|
|
|
|
assert.True(t, env.OK)
|
|
|
|
|
assert.Equal(t, "kb_x", env.Data["kb_id"])
|
|
|
|
|
assert.Equal(t, float64(17), env.Data["deleted_count"])
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// TestDocDelete_All_WithYes_TextMode verifies the text output path.
|
|
|
|
|
func TestDocDelete_All_WithYes_TextMode(t *testing.T) {
|
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeAllSvc{resp: &sdk.ClearKnowledgeBaseContentsResponse{DeletedCount: 5}}
|
|
|
|
|
opts := &DeleteOptions{All: true, KB: "kb_y", Yes: true}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := runDeleteAll(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{})
|
2026-05-21 10:42:27 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
assert.True(t, svc.called)
|
|
|
|
|
body := out.String()
|
|
|
|
|
assert.Contains(t, body, "5")
|
|
|
|
|
assert.Contains(t, body, "kb_y")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// TestDocDelete_All_TTY_UserAborts: interactive TTY + user says no → CodeUserAborted.
|
|
|
|
|
func TestDocDelete_All_TTY_UserAborts(t *testing.T) {
|
|
|
|
|
_, errBuf := iostreams.SetForTestWithTTY(t)
|
|
|
|
|
svc := &fakeAllSvc{}
|
|
|
|
|
opts := &DeleteOptions{All: true, KB: "kb_z", Yes: false}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := runDeleteAll(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{Answer: false})
|
2026-05-21 10:42:27 +00:00
|
|
|
require.Error(t, err)
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
|
|
|
|
assert.Equal(t, cmdutil.CodeUserAborted, typed.Code)
|
|
|
|
|
assert.False(t, svc.called)
|
|
|
|
|
assert.Contains(t, errBuf.String(), "Aborted")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// TestDocDelete_All_ServiceError propagates SDK errors via WrapHTTP.
|
|
|
|
|
func TestDocDelete_All_ServiceError(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
|
svc := &fakeAllSvc{err: errors.New("HTTP error 404: not found")}
|
|
|
|
|
opts := &DeleteOptions{All: true, KB: "kb_missing", Yes: true}
|
2026-05-21 10:43:18 +00:00
|
|
|
err := runDeleteAll(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{})
|
2026-05-21 10:42:27 +00:00
|
|
|
require.Error(t, err)
|
|
|
|
|
var typed *cmdutil.Error
|
|
|
|
|
require.ErrorAs(t, err, &typed)
|
|
|
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
2026-05-17 17:38:30 +00:00
|
|
|
}
|
2026-05-29 12:06:30 +00:00
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
// KB name resolution tests (--all --kb resolves name → id)
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
// TestDocDelete_All_ResolvesKBNameToID verifies that `doc delete --all --kb eng -y`
|
|
|
|
|
// resolves the KB name "eng" to its canonical id "kb_eng" before calling
|
|
|
|
|
// ClearKnowledgeBaseContents. Uses an httptest.Server to fake both the
|
|
|
|
|
// ListKnowledgeBases and ClearKnowledgeBaseContents endpoints so the real
|
|
|
|
|
// *sdk.Client can be injected through the factory (mirrors link_test.go pattern).
|
|
|
|
|
func TestDocDelete_All_ResolvesKBNameToID(t *testing.T) {
|
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
|
|
|
|
|
|
var clearCalledWith string
|
|
|
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
|
|
|
w.Header().Set("Content-Type", "application/json")
|
|
|
|
|
switch {
|
|
|
|
|
case r.Method == http.MethodGet && r.URL.Path == "/api/v1/knowledge-bases":
|
|
|
|
|
_ = json.NewEncoder(w).Encode(sdk.KnowledgeBaseListResponse{
|
|
|
|
|
Success: true,
|
|
|
|
|
Data: []sdk.KnowledgeBase{{ID: "kb_eng", Name: "eng"}},
|
|
|
|
|
})
|
|
|
|
|
case r.Method == http.MethodDelete && r.URL.Path == "/api/v1/knowledge-bases/kb_eng/knowledge":
|
|
|
|
|
clearCalledWith = "kb_eng"
|
|
|
|
|
_ = json.NewEncoder(w).Encode(map[string]any{
|
|
|
|
|
"success": true,
|
|
|
|
|
"data": map[string]any{"deleted_count": 3},
|
|
|
|
|
})
|
|
|
|
|
default:
|
|
|
|
|
http.NotFound(w, r)
|
|
|
|
|
}
|
|
|
|
|
}))
|
|
|
|
|
t.Cleanup(srv.Close)
|
|
|
|
|
|
|
|
|
|
cli := sdk.NewClient(srv.URL)
|
|
|
|
|
f := &cmdutil.Factory{
|
|
|
|
|
Config: func() (*config.Config, error) {
|
|
|
|
|
return &config.Config{
|
|
|
|
|
CurrentProfile: "default",
|
|
|
|
|
Profiles: map[string]config.Profile{"default": {Host: srv.URL}},
|
|
|
|
|
}, nil
|
|
|
|
|
},
|
|
|
|
|
Client: func() (*sdk.Client, error) { return cli, nil },
|
|
|
|
|
Prompter: func() prompt.Prompter { return &testutil.ConfirmPrompter{Answer: true} },
|
|
|
|
|
}
|
|
|
|
|
root := withRootHarnessDoc(NewCmdDelete(f), "--all", "--kb", "eng", "-y")
|
|
|
|
|
err := root.Execute()
|
|
|
|
|
require.NoError(t, err, "doc delete --all --kb eng -y should succeed")
|
|
|
|
|
assert.Equal(t, "kb_eng", clearCalledWith,
|
|
|
|
|
"ClearKnowledgeBaseContents must be called with resolved id 'kb_eng', not raw name 'eng'")
|
|
|
|
|
}
|