feat(cli): --dry-run + risk metadata + validation parity on 19 mutations
Two intertwined agent safety nets that share the same files:
1. --dry-run flag for offline preview of mutation commands
2. Risk: metadata + SetRisk helper for destructive command surfaces
Coverage (19 mutation commands with --dry-run):
kb.create/edit/delete agent.create/edit/delete
doc.create/upload/fetch/delete doc.delete_all (special variant)
session.delete chunk.delete profile.add/remove
auth.refresh/logout link unlink
api.{post,put,patch,delete} (api.get + --dry-run rejected, exit 2)
Envelope additions (omitempty in non-dry-run paths):
meta.dry_run: bool true when --dry-run was used
meta.plan: map {action, args} per the per-command taxonomy
Risk: metadata
--------------
cmdutil.SetRisk(cmd, action) stamps cobra.Annotations with
risk.level=destructive + risk.action=<action> on the 9 destructive
commands. The SetAgentHelp wrapper prepends a "Risk: <action>
(destructive)" line in the default text help path so agents see a clear
warning before parsing Usage. WEKNORA_AGENT_HELP=1 JSON path stays
unchanged — structured agent-help already carries warnings[].
Validation parity with the live path
------------------------------------
Every pure-local validation (flag presence, mutual exclusion, enum
bounds, URL/regex format, ResolveKBLocal for KB resolution that does not
require an SDK call) runs BEFORE the dry-run gate. This matches the
industry-standard "preview shows what live would do" contract:
--dry-run accepts exactly the same invocations the live path accepts and
rejects exactly the same invocations the live path rejects, modulo the
side-effecting work itself.
The side-effecting work (SDK calls, file writes, keyring writes, server-
side name → id resolution) is what --dry-run actually gates. Each
mutation file pairs its RunE validation block with a regression test
under *_dry_run_test.go / dryrun_validation_test.go so future refactors
don't reintroduce the gap.
Helper surface
--------------
- HandleDryRun(cmd, dryRun, plan) extracts the early-return so the
19 RunE call sites stay 3 lines each.
- EmitDryRun routes through FormatOptions.Emit, inheriting _notice /
TTY indent / --jq filtering for free.
- ResolveKBLocal mirrors ResolveKB but never calls the SDK; dry-run
paths use it so the plan reports the raw --kb value (UUID or name)
without a name → id lookup.
Streaming commands (chat, session ask, session continue-stream) are
deliberately excluded: a buffered plan makes no sense for an event
stream.
Lock semantics in the dry-run path:
- destructive + --dry-run: exit 0, no exit-10 confirmation prompt
- --dry-run + -y: byte-identical envelope to --dry-run alone
- --dry-run + --jq: filter applies to the preview envelope normally
This commit is contained in:
@@ -33,6 +33,7 @@ type Options struct {
|
||||
Method string
|
||||
Input string // --input: file path, "-" for stdin
|
||||
Yes bool
|
||||
DryRun bool
|
||||
StdinReader io.Reader // overridden by tests; defaults to iostreams.IO.In
|
||||
}
|
||||
|
||||
@@ -72,6 +73,43 @@ Examples:
|
||||
return err
|
||||
}
|
||||
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
||||
if opts.DryRun {
|
||||
// --dry-run on the raw escape-hatch is only meaningful when a
|
||||
// would-be mutation exists to preview. GET (default or explicit)
|
||||
// is read-only with no side effect, so previewing it is a
|
||||
// likely user error — signal it via FlagError exit 2 with the
|
||||
// concrete repair. Use resolveMethod so --input auto-promotes
|
||||
// GET → POST identically to the live path.
|
||||
method := resolveMethod(opts)
|
||||
if method == http.MethodGet {
|
||||
return cmdutil.NewFlagError(fmt.Errorf(
|
||||
"--dry-run requires explicit -X POST/PUT/PATCH/DELETE; default GET is read-only with no side effect to preview"))
|
||||
}
|
||||
var body any
|
||||
if opts.Input != "" {
|
||||
contents, err := readInput(opts)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Best-effort JSON decode so the plan body surfaces a
|
||||
// structured object (agents grep meta.plan.body for shape);
|
||||
// fall back to raw string when the payload isn't JSON.
|
||||
var parsed any
|
||||
if json.Unmarshal(contents, &parsed) == nil {
|
||||
body = parsed
|
||||
} else {
|
||||
body = string(contents)
|
||||
}
|
||||
}
|
||||
if handled, err := cmdutil.HandleDryRun(c, true, cmdutil.DryRunPlan{
|
||||
Action: "api." + strings.ToLower(method),
|
||||
Method: method,
|
||||
Path: args[0],
|
||||
Body: body,
|
||||
}); handled {
|
||||
return err
|
||||
}
|
||||
}
|
||||
method := resolveMethod(opts)
|
||||
// Escape-hatch DELETE through `weknora api` is just as destructive
|
||||
// as `weknora kb delete` - exit-10 protocol must apply (cli/README.md).
|
||||
@@ -92,6 +130,21 @@ Examples:
|
||||
cmd.Flags().StringVar(&opts.Input, "input", "", "Read request body from file (use `-` for stdin)")
|
||||
cmd.Flags().Bool("paginate", false, "Follow offset-based pagination (?page=N&page_size=M), merging all pages into a single {data, total} JSON response.")
|
||||
cmdutil.AddFormatFlag(cmd, apiFields...)
|
||||
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
||||
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
||||
UsedFor: "raw HTTP passthrough to weknora-server API endpoints when typed subcommands are insufficient",
|
||||
RequiredFlags: []string{"path (positional)"},
|
||||
Examples: []string{
|
||||
"weknora api /api/v1/knowledge-bases",
|
||||
"weknora api -X DELETE /api/v1/knowledge-bases/kb_x -y",
|
||||
"echo '{\"name\":\"foo\"}' | weknora api -X POST /api/v1/knowledge-bases --input -",
|
||||
},
|
||||
Output: "raw server response body or envelope on error",
|
||||
Warnings: []string{
|
||||
"Note: -X DELETE/PUT/PATCH on existing resources may trigger exit 10 / input.confirmation_required at runtime; -X GET/POST are unguarded.",
|
||||
"Raw HTTP passthrough; agents should prefer typed subcommands (kb/doc/session/...) when available.",
|
||||
},
|
||||
})
|
||||
return cmd
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,127 @@
|
||||
package api
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
||||
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
||||
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
||||
sdk "github.com/Tencent/WeKnora/client"
|
||||
)
|
||||
|
||||
// apiDryRunFactory builds a Factory whose Client closure panics if invoked —
|
||||
// dry-run must early-exit before any SDK call.
|
||||
func apiDryRunFactory(t *testing.T) *cmdutil.Factory {
|
||||
t.Helper()
|
||||
return &cmdutil.Factory{
|
||||
Client: func() (*sdk.Client, error) {
|
||||
t.Fatal("dry-run path must not call Factory.Client(); SDK side effect leaked")
|
||||
return nil, nil
|
||||
},
|
||||
Prompter: func() prompt.Prompter {
|
||||
t.Fatal("dry-run path must not call Factory.Prompter(); confirm-prompt side effect leaked")
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// TestApi_DryRunWithGet_FlagError: default-method GET + --dry-run must return
|
||||
// FlagError (exit 2). The only meaningful target for --dry-run on `api` is a
|
||||
// mutation method; allowing GET to silently succeed would let agents waste a
|
||||
// round-trip previewing a no-op.
|
||||
func TestApi_DryRunWithGet_FlagError(t *testing.T) {
|
||||
iostreams.SetForTest(t)
|
||||
root := withRootHarness(NewCmd(apiDryRunFactory(t)),
|
||||
"/api/v1/knowledge-bases", "--dry-run")
|
||||
err := root.Execute()
|
||||
require.Error(t, err, "GET + --dry-run must error")
|
||||
|
||||
var fe *cmdutil.FlagError
|
||||
require.True(t, errors.As(err, &fe), "expected *cmdutil.FlagError, got %T %v", err, err)
|
||||
assert.Equal(t, 2, cmdutil.ExitCode(err), "FlagError must map to exit 2")
|
||||
assert.Contains(t, err.Error(), "explicit -X POST/PUT/PATCH/DELETE",
|
||||
"error message must point users to the concrete repair")
|
||||
}
|
||||
|
||||
// TestApi_DryRunWithExplicitGet_FlagError: explicit `-X GET` + --dry-run is
|
||||
// also rejected. The reject condition is "method is GET", not "method flag is
|
||||
// unset"; passing -X GET explicitly must produce the same error so users
|
||||
// can't bypass the guard by being verbose.
|
||||
func TestApi_DryRunWithExplicitGet_FlagError(t *testing.T) {
|
||||
iostreams.SetForTest(t)
|
||||
root := withRootHarness(NewCmd(apiDryRunFactory(t)),
|
||||
"/api/v1/knowledge-bases", "-X", "GET", "--dry-run")
|
||||
err := root.Execute()
|
||||
require.Error(t, err, "explicit -X GET + --dry-run must error")
|
||||
|
||||
var fe *cmdutil.FlagError
|
||||
require.True(t, errors.As(err, &fe), "expected *cmdutil.FlagError, got %T %v", err, err)
|
||||
assert.Equal(t, 2, cmdutil.ExitCode(err))
|
||||
}
|
||||
|
||||
// TestApi_DryRunWithInputAutoPromotes_EmitsPlan: --input on its own (no
|
||||
// explicit -X) must auto-promote GET → POST in the dry-run path too,
|
||||
// matching the live behavior in resolveMethod. Before the fix the dry-run
|
||||
// branch built `method` directly from `strings.ToUpper(opts.Method)`, which
|
||||
// is empty when -X is unset, then defaulted to GET — so --input was ignored
|
||||
// at preview time, producing the misleading "GET is read-only" error.
|
||||
func TestApi_DryRunWithInputAutoPromotes_EmitsPlan(t *testing.T) {
|
||||
out, _ := iostreams.SetForTest(t)
|
||||
iostreams.IO.In = strings.NewReader(`{}`)
|
||||
root := withRootHarness(NewCmd(apiDryRunFactory(t)),
|
||||
"/api/v1/knowledge-bases", "--input", "-", "--dry-run", "--format", "json")
|
||||
require.NoError(t, root.Execute(), "--input + --dry-run must succeed (POST auto-promotion)")
|
||||
|
||||
var env struct {
|
||||
OK bool `json:"ok"`
|
||||
Meta struct {
|
||||
DryRun bool `json:"dry_run"`
|
||||
Plan map[string]any `json:"plan"`
|
||||
} `json:"meta"`
|
||||
}
|
||||
require.NoError(t, json.Unmarshal(out.Bytes(), &env), "expected valid JSON envelope, got %q", out.String())
|
||||
assert.True(t, env.OK)
|
||||
assert.True(t, env.Meta.DryRun)
|
||||
assert.Equal(t, "api.post", env.Meta.Plan["action"], "plan.action must reflect auto-promoted POST")
|
||||
assert.Equal(t, "POST", env.Meta.Plan["method"])
|
||||
}
|
||||
|
||||
// TestApi_DryRunWithPost_EmitsPlan: POST + --dry-run + --input - must emit
|
||||
// the standard envelope with action=api.post, method/path echoed, and the
|
||||
// stdin body parsed as JSON under plan.body. No SDK call expected (factory
|
||||
// would panic if Client() were touched).
|
||||
func TestApi_DryRunWithPost_EmitsPlan(t *testing.T) {
|
||||
out, _ := iostreams.SetForTest(t)
|
||||
cmd := NewCmd(apiDryRunFactory(t))
|
||||
// StdinReader is on Options; set it via the recovered options binding by
|
||||
// running through the root harness with --input - and trusting iostreams.IO.In.
|
||||
// Simplest path: write to IO.In directly via SetForTest's reader swap.
|
||||
iostreams.IO.In = strings.NewReader(`{"name":"foo"}`)
|
||||
root := withRootHarness(cmd,
|
||||
"/api/v1/knowledge-bases", "-X", "POST", "--input", "-", "--dry-run", "--format", "json")
|
||||
require.NoError(t, root.Execute(), "POST + --dry-run must succeed (exit 0) without SDK")
|
||||
|
||||
var env struct {
|
||||
OK bool `json:"ok"`
|
||||
Meta struct {
|
||||
DryRun bool `json:"dry_run"`
|
||||
Plan map[string]any `json:"plan"`
|
||||
} `json:"meta"`
|
||||
}
|
||||
require.NoError(t, json.Unmarshal(out.Bytes(), &env), "expected valid JSON envelope, got %q", out.String())
|
||||
assert.True(t, env.OK)
|
||||
assert.True(t, env.Meta.DryRun)
|
||||
assert.Equal(t, "api.post", env.Meta.Plan["action"], "plan.action must lowercase the method")
|
||||
assert.Equal(t, "POST", env.Meta.Plan["method"], "plan.method must be uppercase")
|
||||
assert.Equal(t, "/api/v1/knowledge-bases", env.Meta.Plan["path"])
|
||||
// Body decoded as JSON object (best-effort) for downstream agent inspection.
|
||||
body, ok := env.Meta.Plan["body"].(map[string]any)
|
||||
require.True(t, ok, "plan.body must be a JSON object when --input is valid JSON, got %T", env.Meta.Plan["body"])
|
||||
assert.Equal(t, "foo", body["name"])
|
||||
}
|
||||
@@ -239,12 +239,15 @@ func TestAPI_PathWithoutSlash(t *testing.T) {
|
||||
}
|
||||
|
||||
// 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.
|
||||
// registers the global persistent flags (mirrors addGlobalFlags in
|
||||
// cmd/root.go). Required because api's NewCmd doesn't register --yes /
|
||||
// --format / --jq itself — it inherits them from root in production.
|
||||
func withRootHarness(api *cobra.Command, args ...string) *cobra.Command {
|
||||
root := &cobra.Command{Use: "weknora"}
|
||||
root.PersistentFlags().BoolP("yes", "y", false, "")
|
||||
pf := root.PersistentFlags()
|
||||
pf.BoolP("yes", "y", false, "")
|
||||
pf.String("format", "", "")
|
||||
pf.StringP("jq", "q", "", "")
|
||||
root.AddCommand(api)
|
||||
root.SetArgs(append([]string{"api"}, args...))
|
||||
root.SetContext(context.Background())
|
||||
|
||||
Reference in New Issue
Block a user