Files
zero/internal/tools/plan_tool_test.go
75f15da82a Tools: arg-tolerance, ask_user, secret scrubbing, structured results, hardening (#119)
* Tools: arg-tolerance, ask_user, secret scrubbing, structured results, hardening

First module of the tools->agent->tui chain that leads to the TUI shell (off main). Scope: internal/tools (+ a 1-line specialist vocabulary update).

3-way merged onto main's specialist drift (RunOptions tool-context fields, Safety.AdvertiseInAuto, optionsAwareTool dispatch, PropertySchema, base structured Result) and grafted the runtime-core additions:

- Shared arg-tolerance layer (argtolerance.go: alias-aware/type-strict arg resolution + slice coercion) adopted across all tools so weak models' non-canonical arg shapes are accepted; bool/int coercion in args.go.

- ask_user tool (interactive clarifying questions) wired into CoreReadOnlyTools; nested PropertySchema (Properties/Required) for its object questions + update_plan.

- Secret scrubbing at the registry boundary (scrubResultSecrets via internal/redaction) applied to every tool-execution path, incl. the optionsAwareTool dispatch; structured Result (Display/Redacted/ChangedFiles).

- mutation_targets (paths a mutating tool will write, for session checkpointing) + hardened grep (symlink confinement), apply_patch, bash, edit/write.

EXCLUDED per the module split: the blueprint task tool (subagents — another dev's area; the merged specialist Task is separate) and the skill tool (ships with the later skills module); plus their subagent-only registry helpers (Without/isolateForChild).

ask_user is now a core tool, so internal/specialist knownToolNames adds "ask_user" to keep the TestKnownToolNamesMatchCoreRegistry cross-package invariant. No new deps; build/vet/-race/windows/full-suite green.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

* Address #119 review (CodeRabbit): scrub Display, validate apply_patch mutation paths, narrow test skips

- registry.go: scrubResultSecrets now redacts Result.Display.Summary too (not just Output), so a caller preferring Display can't bypass the boundary redaction.

- mutation_targets.go: apply_patch targets now run through validatePatchPaths(applyRoot, ...) before being returned, so a traversal patch (../x) can't yield an out-of-workspace checkpoint target. Regression case added to TestMutationTargetsRejectsEscapingPaths.

- argtolerance_test/write_tools_test: the apply_patch tests no longer Skipf on ANY non-OK result (which masked real diff/apply regressions); they skip ONLY when the git binary is unavailable (gitApplyUnavailable helper checks exec's 'executable file not found') and otherwise Fatalf.

build/vet/-race/full-suite + GOOS=windows build green.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

* Address #119 re-review (CodeRabbit): best-effort multiSelect + Display.Summary scrub coverage

- ask_user: an uncoercible multiSelect no longer fails the whole call — it's a UI hint, so it defaults to false (best-effort, mirroring the lenient options path). Test: TestParseAskUserQuestionsLenientOptions extended.

- registry_test: TestRunWithOptionsScrubsSecretsForAllCallers now also leaks a secret via Result.Display.Summary and asserts it is redacted, locking in the boundary scrub for the structured-result path (secretTool gained a display field).

build/vet/-race/full-suite + GOOS=windows build green.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

* Address #119 review (@Vasanthdev2004): scrub ALL registry return paths + harden intArg

[blocker] RunWithOptions now scrubs every return path, not just tool-execution: a named return + a single 'defer scrubResultSecrets(result)' covers the unknown-tool, sandbox-deny, sandbox-approval-required, permission-required and permission-denied early returns too. Previously a sandbox denial that echoed a secret-bearing path/arg returned it raw with Redacted=false. Regression: TestRunWithOptionsScrubsSecretsOnDenialPaths (permission-denied reason carrying a token -> scrubbed + Redacted).

[non-blocking] intArg fails closed on NaN/Inf/out-of-range floats (and their string forms) via a floatToInt helper, before any implementation-defined cast. Tests added for NaN/Inf/NaN-string/non-integral.

build/vet/-race/full-suite + GOOS=windows build green.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

* Address #119 review (CodeRabbit grep TOCTOU + anandh8x dependency blockers)

- grep: close the confinement TOCTOU — confineGrepFile now returns the symlink-RESOLVED path and collectGrepMatches reads THAT (not the raw candidate), so a symlink swapped in between check and read can't escape the workspace.

- ask_user: removed from CoreReadOnlyTools. It needs the agent loop's interactive intercept (OnAskUser), which is in the (unmerged) agent module; without it the tool only returns the non-interactive fallback. The tool still ships (NewAskUserTool); the agent module registers it in core + wires the intercept together. Reverted the specialist knownToolNames 'ask_user' entry + the ask_user-in-core test accordingly.

- update_plan: reverted the plan schema to a flat array (item structure documented in the description). The structured nested-object Items schema depends on the agent's PropertySchema serializer (propertyToRuntimeMap) passing nested Properties/Required through to providers, which is in the agent module; a nested schema here would be silently dropped. PropertySchema.Properties/Required fields are kept (used by ask_user.go's own schema + the later MCP module).

build/vet/-race/full-suite + GOOS=windows build green; no new deps.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

* Harden #119 from adversarial self-review: sandbox alias-gate, Meta scrub, intArg 2^63

A multi-dimension adversarial review of the tools diff surfaced 3 real issues beyond the reviewer rounds:

- [major/security] write_file/edit_file path aliases file_path/filename/filepath bypassed the sandbox workspace+symlink gate: sandbox.requestPaths only inspected path/cwd/file/dir, so an aliased target skipped enforcement (same class as audit H4). Aligned requestPaths with the tools' path-alias lists (internal/sandbox/risk.go). The tools' own resolveWorkspaceTargetPath still confined, but the sandbox LAYER/audit/symlink-check was silently skipped. Regression: TestRegistrySandboxGatesPathAliasKeys.

- [minor] scrubResultSecrets skipped Result.Meta, which is forwarded to the transcript and carries model-controlled strings (glob pattern, bash cwd). Now scrubs Meta values too. Covered in TestRunWithOptionsScrubsSecretsForAllCallers.

- [minor] floatToInt used f > float64(MaxInt); that constant rounds up to 2^63 so exactly 2^63 slipped to an out-of-range cast. Changed to >=. Test added for 2^63 float+string.

build/vet/-race/full-suite + GOOS=windows build green; no new deps.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

---------

Co-authored-by: KRATOS <[email protected]>
Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-07 17:13:27 +05:30

167 lines
5.1 KiB
Go

package tools
import (
"context"
"strings"
"sync"
"testing"
)
func TestUpdatePlanToolStoresAndFormatsPlan(t *testing.T) {
tool := NewUpdatePlanTool()
result := tool.Run(context.Background(), map[string]any{
"plan": []any{
map[string]any{"id": "1", "content": "First step", "status": "completed"},
map[string]any{"id": "2", "content": "Second step", "status": "in_progress", "notes": "halfway"},
map[string]any{"id": "3", "content": "Third step", "status": "pending"},
},
})
if result.Status != StatusOK {
t.Fatalf("expected ok status, got %s: %s", result.Status, result.Output)
}
for _, want := range []string{
"Current Plan:",
"1. [completed] First step",
"2. [in_progress] Second step",
"Notes: halfway",
"3. [pending] Third step",
} {
if !strings.Contains(result.Output, want) {
t.Fatalf("expected output to contain %q, got %q", want, result.Output)
}
}
plan := tool.CurrentPlan()
if len(plan) != 3 {
t.Fatalf("expected 3 plan items, got %d", len(plan))
}
plan[0].Content = "mutated"
if tool.CurrentPlan()[0].Content != "First step" {
t.Fatalf("CurrentPlan returned mutable internal state")
}
}
func TestUpdatePlanToolRejectsInvalidStatus(t *testing.T) {
result := NewUpdatePlanTool().Run(context.Background(), map[string]any{
"plan": []any{
map[string]any{"id": "1", "content": "Bad step", "status": "nope"},
},
})
if result.Status != StatusError {
t.Fatalf("expected error status, got %s", result.Status)
}
if !strings.Contains(result.Output, "status must be pending, in_progress, completed, or failed") {
t.Fatalf("unexpected output: %q", result.Output)
}
}
func TestUpdatePlanToolClearPlanResetsState(t *testing.T) {
tool := NewUpdatePlanTool()
result := tool.Run(context.Background(), map[string]any{
"plan": []any{
map[string]any{"id": "1", "content": "First", "status": "pending"},
map[string]any{"id": "2", "content": "Second", "status": "in_progress"},
},
})
if result.Status != StatusOK {
t.Fatalf("expected ok status, got %s: %s", result.Status, result.Output)
}
if got := tool.CurrentPlan(); len(got) == 0 {
t.Fatalf("expected stored plan before ClearPlan")
}
tool.ClearPlan()
if got := tool.CurrentPlan(); len(got) != 0 {
t.Fatalf("expected empty plan after ClearPlan, got %d items", len(got))
}
if got := formatPlan(tool.CurrentPlan()); got != "Plan is currently empty." {
t.Fatalf("expected empty plan formatting after ClearPlan, got %q", got)
}
}
func TestUpdatePlanToolAcceptsItemsWithoutID(t *testing.T) {
tool := NewUpdatePlanTool()
result := tool.Run(context.Background(), map[string]any{
"plan": []any{
map[string]any{"content": "First step", "status": "in_progress"},
map[string]any{"content": "Second step", "status": "pending"},
},
})
if result.Status != StatusOK {
t.Fatalf("expected ok status when id omitted, got %s: %s", result.Status, result.Output)
}
plan := tool.CurrentPlan()
if len(plan) != 2 {
t.Fatalf("expected 2 plan items, got %d", len(plan))
}
if plan[0].ID != "1" || plan[1].ID != "2" {
t.Fatalf("expected ids auto-derived from index, got %q,%q", plan[0].ID, plan[1].ID)
}
}
func TestUpdatePlanToolDefaultsStatusToPending(t *testing.T) {
tool := NewUpdatePlanTool()
result := tool.Run(context.Background(), map[string]any{
"plan": []any{
map[string]any{"content": "Only content"},
},
})
if result.Status != StatusOK {
t.Fatalf("expected ok status when status omitted, got %s: %s", result.Status, result.Output)
}
if got := tool.CurrentPlan(); got[0].Status != "pending" {
t.Fatalf("expected status to default to pending, got %q", got[0].Status)
}
}
func TestUpdatePlanToolRequiresContent(t *testing.T) {
result := NewUpdatePlanTool().Run(context.Background(), map[string]any{
"plan": []any{map[string]any{"status": "pending"}},
})
if result.Status != StatusError {
t.Fatalf("expected error when content missing, got %s", result.Status)
}
if !strings.Contains(result.Output, "content is required") {
t.Fatalf("unexpected output: %q", result.Output)
}
}
func TestUpdatePlanToolConcurrentRunAndRead(t *testing.T) {
tool := NewUpdatePlanTool()
args := map[string]any{
"plan": []any{
map[string]any{"content": "First step", "status": "in_progress"},
map[string]any{"content": "Second step", "status": "pending"},
},
}
var wg sync.WaitGroup
for i := 0; i < 50; i++ {
wg.Add(3)
go func() { defer wg.Done(); tool.Run(context.Background(), args) }()
go func() { defer wg.Done(); _ = tool.CurrentPlan() }()
go func() { defer wg.Done(); tool.ClearPlan() }()
}
wg.Wait()
}
func TestUpdatePlanToolAdvertisesItemSchema(t *testing.T) {
plan := NewUpdatePlanTool().Parameters().Properties["plan"]
if plan.Type != "array" {
t.Fatalf("expected plan to be an array, got %q", plan.Type)
}
// The structured nested-object Items schema is deferred until the agent's
// PropertySchema serializer passes nested Properties/Required through to
// providers; until then the item structure is documented in the description.
for _, want := range []string{"content", "status"} {
if !strings.Contains(plan.Description, want) {
t.Fatalf("plan description should document the %q field, got %q", want, plan.Description)
}
}
}