Compare commits

..

1 Commits

Author SHA1 Message Date
Rodin 282b6e0e86 nit(#154): add t.Fatal guard if baseSubprocessArgs flag not found
PR Ready Gate / clear-labels (pull_request) Successful in 2s
CI / test (pull_request) Successful in 17s
CI / review (anthropic--claude-4.6-sonnet, sonnet, SONNET_REVIEW_TOKEN) (pull_request) Successful in 22s
CI / review (gpt-5, security, ., rodin/security-patterns, SECURITY_REVIEW.md, SECURITY_REVIEW_TOKEN) (pull_request) Successful in 38s
CI / review (gpt-5, gpt, GPT_REVIEW_TOKEN) (pull_request) Successful in 40s
Address sonnet NIT: if --repo or --pr is ever removed from
baseSubprocessArgs(), the mutation loop silently no-ops and the test
becomes meaningless. Adding a found guard and t.Fatal makes the
regression immediately visible.
2026-05-15 08:06:18 -07:00
3 changed files with 11 additions and 61 deletions
+10
View File
@@ -903,12 +903,17 @@ func TestMainSubprocess_InvalidRepo(t *testing.T) {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError) flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
args := baseSubprocessArgs() args := baseSubprocessArgs()
// Replace the canonical --repo value with an invalid one. // Replace the canonical --repo value with an invalid one.
found := false
for i, a := range args { for i, a := range args {
if a == "--repo" && i+1 < len(args) { if a == "--repo" && i+1 < len(args) {
args[i+1] = "invalidrepo" args[i+1] = "invalidrepo"
found = true
break break
} }
} }
if !found {
t.Fatal("baseSubprocessArgs() does not contain --repo; test is broken")
}
os.Args = args os.Args = args
main() main()
return return
@@ -930,12 +935,17 @@ func TestMainSubprocess_InvalidPRNumber(t *testing.T) {
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError) flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
args := baseSubprocessArgs() args := baseSubprocessArgs()
// Replace the canonical --pr value with a non-numeric string. // Replace the canonical --pr value with a non-numeric string.
found := false
for i, a := range args { for i, a := range args {
if a == "--pr" && i+1 < len(args) { if a == "--pr" && i+1 < len(args) {
args[i+1] = "notanumber" args[i+1] = "notanumber"
found = true
break break
} }
} }
if !found {
t.Fatal("baseSubprocessArgs() does not contain --pr; test is broken")
}
os.Args = args os.Args = args
main() main()
return return
+1 -11
View File
@@ -61,13 +61,6 @@ func validateDocmapPath(localPath, resolvedRoot string) error {
return fmt.Errorf("symlinks are not allowed") return fmt.Errorf("symlinks are not allowed")
} }
// Reject anything that is not a regular file (directories, FIFOs, device
// nodes, etc.) — ParseDocMapConfig expects a plain YAML file and would
// produce a confusing error on non-regular entries.
if !fi.Mode().IsRegular() {
return fmt.Errorf("docmap must be a regular file")
}
// Confine to resolvedRoot: use the fully-resolved path so that a directory // Confine to resolvedRoot: use the fully-resolved path so that a directory
// symlink inside the repo cannot carry the path outside the root. // symlink inside the repo cannot carry the path outside the root.
rel, err := filepath.Rel(resolvedRoot, resolvedPath) rel, err := filepath.Rel(resolvedRoot, resolvedPath)
@@ -178,9 +171,6 @@ func runValidateDocmap(args []string) int {
// Normalize Windows-style backslashes to forward slashes so that // Normalize Windows-style backslashes to forward slashes so that
// changed-file paths from git on Windows match doc-map globs. // changed-file paths from git on Windows match doc-map globs.
f = strings.ReplaceAll(f, "\\", "/") f = strings.ReplaceAll(f, "\\", "/")
// Strip a leading "./" emitted by non-git tools (e.g. `find`) so that
// paths like "./cmd/foo.go" match doc-map globs written as "cmd/**".
f = strings.TrimPrefix(f, "./")
if !review.FileCoveredByDocMap(cfg, f) { if !review.FileCoveredByDocMap(cfg, f) {
uncovered = append(uncovered, f) uncovered = append(uncovered, f)
} }
@@ -199,7 +189,7 @@ func runValidateDocmap(args []string) int {
staleDocs := checkStaleDocs(cfg, resolvedRoot) staleDocs := checkStaleDocs(cfg, resolvedRoot)
if len(staleDocs) > 0 { if len(staleDocs) > 0 {
failed = true failed = true
fmt.Fprintln(errWriter, "ERROR: stale docmap entries (paths do not exist):") fmt.Fprintln(errWriter, "ERROR: stale docmap docs: entries (paths do not exist):")
for _, d := range staleDocs { for _, d := range staleDocs {
fmt.Fprintf(errWriter, " %s\n", d) fmt.Fprintf(errWriter, " %s\n", d)
} }
-50
View File
@@ -599,53 +599,3 @@ func TestValidateDocmapPath_DirSymlinkBypass(t *testing.T) {
t.Error("expected rejection of dir-symlink bypass, got nil error") t.Error("expected rejection of dir-symlink bypass, got nil error")
} }
} }
// TestValidateDocmapPath_NonRegularFile verifies that --docmap pointing at a
// non-regular file (e.g. a directory) is rejected with a clear error before
// ParseDocMapConfig is called.
func TestValidateDocmapPath_NonRegularFile(t *testing.T) {
dir := t.TempDir()
// Use the directory itself as the docmap path — directories pass Lstat but
// are not regular files.
reviewBotDir := filepath.Join(dir, ".review-bot")
if err := os.MkdirAll(reviewBotDir, 0o755); err != nil {
t.Fatalf("MkdirAll: %v", err)
}
code, _, stderr := stdinValidateDocmap(t,
"",
[]string{"--docmap", reviewBotDir, "--repo-root", dir},
)
if code != 2 {
t.Errorf("expected exit 2 for directory docmap, got %d; stderr: %q", code, stderr)
}
if !strings.Contains(stderr, "regular file") && !strings.Contains(stderr, "invalid") {
t.Errorf("expected regular-file rejection in stderr, got %q", stderr)
}
}
// TestRunValidateDocmap_DotSlashPrefix verifies that paths emitted with a
// leading "./" (e.g. from `find` or `ls`) match doc-map globs correctly.
// Without TrimPrefix, "./cmd/foo.go" would not match the pattern "cmd/**".
func TestRunValidateDocmap_DotSlashPrefix(t *testing.T) {
dir := t.TempDir()
makeDocFile(t, dir, "docs/foo.md")
docmap := makeDocmapInDir(t, dir, `
mappings:
- paths:
- "cmd/**"
docs:
- docs/foo.md
`)
// File with a leading "./" should be treated as covered.
code, _, stderr := stdinValidateDocmap(t,
"./cmd/foo.go\n",
[]string{"--docmap", docmap, "--repo-root", dir},
)
if code != 0 {
t.Errorf("expected exit 0 for './' prefixed covered file, got %d; stderr: %q", code, stderr)
}
}