WeKnora/cli/internal/cmdutil/risk_test.go

55 lines
1.4 KiB
Go
Raw Normal View History

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
2026-05-27 20:28:48 +00:00
package cmdutil
import (
"testing"
"github.com/spf13/cobra"
"github.com/stretchr/testify/assert"
)
func TestSetRisk_WritesAnnotations(t *testing.T) {
cmd := &cobra.Command{Use: "delete"}
SetRisk(cmd, "kb.delete")
assert.Equal(t, "destructive", cmd.Annotations["risk.level"])
assert.Equal(t, "kb.delete", cmd.Annotations["risk.action"])
}
func TestSetRisk_NilMapGuard(t *testing.T) {
cmd := &cobra.Command{Use: "delete"}
// cmd.Annotations is nil by default
assert.Nil(t, cmd.Annotations)
SetRisk(cmd, "agent.delete")
// Should not panic; should initialize map
assert.NotNil(t, cmd.Annotations)
assert.Equal(t, "agent.delete", cmd.Annotations["risk.action"])
}
func TestGetRisk_ReturnsWritten(t *testing.T) {
cmd := &cobra.Command{Use: "delete"}
SetRisk(cmd, "doc.delete")
level, action, ok := GetRisk(cmd)
assert.True(t, ok)
assert.Equal(t, "destructive", level)
assert.Equal(t, "doc.delete", action)
}
func TestGetRisk_NotFound(t *testing.T) {
cmd := &cobra.Command{Use: "list"}
level, action, ok := GetRisk(cmd)
assert.False(t, ok)
assert.Empty(t, level)
assert.Empty(t, action)
}
func TestGetRisk_NilAnnotationsMap(t *testing.T) {
cmd := &cobra.Command{Use: "list"}
// Annotations is nil — should not panic, return ok=false
assert.Nil(t, cmd.Annotations)
_, _, ok := GetRisk(cmd)
assert.False(t, ok)
}
func TestRiskDestructive_Const(t *testing.T) {
assert.Equal(t, "destructive", RiskDestructive)
}