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
76 lines
1.9 KiB
Go
76 lines
1.9 KiB
Go
package cmdutil
|
|
|
|
import (
|
|
"bytes"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestSetAgentHelp_PrependsRiskWhenAnnotated(t *testing.T) {
|
|
cmd := &cobra.Command{
|
|
Use: "delete",
|
|
Short: "Delete a knowledge base.",
|
|
Long: "Delete a knowledge base.\n\nThis is irreversible.",
|
|
}
|
|
SetRisk(cmd, "kb.delete")
|
|
SetAgentHelp(cmd, AgentHelp{
|
|
UsedFor: "remove a KB and all its docs/chunks",
|
|
Warnings: []string{"never auto -y"},
|
|
})
|
|
|
|
var buf bytes.Buffer
|
|
cmd.SetOut(&buf)
|
|
cmd.SetErr(&buf)
|
|
t.Setenv("WEKNORA_AGENT_HELP", "")
|
|
|
|
cmd.HelpFunc()(cmd, []string{})
|
|
|
|
out := buf.String()
|
|
assert.True(t, strings.HasPrefix(out, "Risk: kb.delete (destructive)\n\n"),
|
|
"expected Risk: line at top; got:\n%s", out)
|
|
assert.Contains(t, out, "AI agents:", "expected AI agents block still present")
|
|
assert.Contains(t, out, "- never auto -y", "expected Warnings preserved")
|
|
}
|
|
|
|
func TestSetAgentHelp_NoRiskWhenUnannotated(t *testing.T) {
|
|
cmd := &cobra.Command{
|
|
Use: "list",
|
|
Short: "List knowledge bases.",
|
|
Long: "List knowledge bases.",
|
|
}
|
|
// NO SetRisk call — cmd.Annotations stays nil
|
|
SetAgentHelp(cmd, AgentHelp{UsedFor: "list KBs"})
|
|
|
|
var buf bytes.Buffer
|
|
cmd.SetOut(&buf)
|
|
cmd.SetErr(&buf)
|
|
t.Setenv("WEKNORA_AGENT_HELP", "")
|
|
|
|
cmd.HelpFunc()(cmd, []string{})
|
|
|
|
out := buf.String()
|
|
assert.False(t, strings.HasPrefix(out, "Risk:"),
|
|
"expected NO Risk: line when not SetRisk'd; got:\n%s", out)
|
|
}
|
|
|
|
func TestSetAgentHelp_JSONPathUnaffectedByRisk(t *testing.T) {
|
|
cmd := &cobra.Command{Use: "delete"}
|
|
SetRisk(cmd, "kb.delete")
|
|
SetAgentHelp(cmd, AgentHelp{UsedFor: "x", Warnings: []string{"w1"}})
|
|
|
|
var buf bytes.Buffer
|
|
cmd.SetOut(&buf)
|
|
cmd.SetErr(&buf)
|
|
t.Setenv("WEKNORA_AGENT_HELP", "1")
|
|
|
|
cmd.HelpFunc()(cmd, []string{})
|
|
|
|
out := buf.String()
|
|
assert.False(t, strings.HasPrefix(out, "Risk:"),
|
|
"JSON path should NOT contain Risk: prefix; got:\n%s", out)
|
|
assert.Contains(t, out, `"used_for": "x"`, "expected JSON body emitted")
|
|
}
|