nullkey
6d8c8650cd
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
62 lines
2.4 KiB
Go
62 lines
2.4 KiB
Go
package kb
|
|
|
|
import (
|
|
"encoding/json"
|
|
"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"
|
|
)
|
|
|
|
// TestKBDelete_DryRun_NoExit10: --dry-run must bypass ConfirmDestructive.
|
|
// Non-TTY without -y normally yields exit 10 (CodeInputConfirmationRequired);
|
|
// with --dry-run it must early-exit successfully (exit 0) because no real
|
|
// delete happens — preview implies no execution, so the confirmation gate
|
|
// is irrelevant.
|
|
func TestKBDelete_DryRun_NoExit10(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t) // non-TTY
|
|
f := kbDryRunFactory(t)
|
|
root := withRootHarness(NewCmdDelete(f), "kb_to_preview", "--dry-run", "--format", "json")
|
|
err := root.Execute()
|
|
require.NoError(t, err, "dry-run must succeed (exit 0); ConfirmDestructive must be skipped")
|
|
assert.Equal(t, 0, cmdutil.ExitCode(err), "exit code must be 0, not 10 (confirmation_required)")
|
|
|
|
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, "kb.delete", env.Meta.Plan["action"])
|
|
}
|
|
|
|
// TestKBDelete_DryRunWithYes_EquivalentToDryRunAlone: -y is a no-op when
|
|
// --dry-run is set (no real delete happens, so no confirmation gate to skip).
|
|
// The envelope shape must match the dry-run-alone case exactly so agents can
|
|
// rely on the plan output regardless of whether the human pre-approved.
|
|
func TestKBDelete_DryRunWithYes_EquivalentToDryRunAlone(t *testing.T) {
|
|
// First invocation: --dry-run alone.
|
|
outA, _ := iostreams.SetForTest(t)
|
|
rootA := withRootHarness(NewCmdDelete(kbDryRunFactory(t)),
|
|
"kb_to_preview", "--dry-run", "--format", "json")
|
|
require.NoError(t, rootA.Execute())
|
|
gotA := outA.String()
|
|
|
|
// Second invocation: --dry-run + -y.
|
|
outB, _ := iostreams.SetForTest(t)
|
|
rootB := withRootHarness(NewCmdDelete(kbDryRunFactory(t)),
|
|
"kb_to_preview", "--dry-run", "-y", "--format", "json")
|
|
require.NoError(t, rootB.Execute(), "--dry-run + -y must succeed identically to --dry-run alone")
|
|
gotB := outB.String()
|
|
|
|
assert.JSONEq(t, gotA, gotB,
|
|
"--dry-run output must be identical with or without -y; -y is a no-op under dry-run")
|
|
}
|