Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b2da92c5a0 |
@@ -1,38 +0,0 @@
|
|||||||
# Dev-Loop Cycle Status — 2026-05-15 14:42 UTC
|
|
||||||
|
|
||||||
**Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
|
||||||
**Cycle:** review-bot-dev-loop (4-hour schedule)
|
|
||||||
**Status:** ✅ **STEADY STATE** — All systems nominal, repo healthy
|
|
||||||
|
|
||||||
## Health Check Summary
|
|
||||||
|
|
||||||
| Check | Status | Details |
|
|
||||||
|-------|--------|---------|
|
|
||||||
| Main branch | ✅ Current | HEAD at 8ab45be (synced) |
|
|
||||||
| Working tree | ✅ Clean | No uncommitted changes |
|
|
||||||
| Test suite | ✅ All pass | 100% pass rate (go test ./...) |
|
|
||||||
| Code coverage | ✅ 76.7% | Above baseline target |
|
|
||||||
| Open issues | ✅ None | No assigned work |
|
|
||||||
| Open PRs | ✅ None | All merged |
|
|
||||||
| Remote sync | ✅ On-time | Up-to-date with origin/main |
|
|
||||||
|
|
||||||
## Actions This Cycle
|
|
||||||
|
|
||||||
- ✅ Fetched origin/main — up-to-date
|
|
||||||
- ✅ Ran full test suite — all pass
|
|
||||||
- ✅ Calculated code coverage — 76.7%
|
|
||||||
- ✅ Checked for new issues/PRs — none found
|
|
||||||
- ✅ Verified working tree clean
|
|
||||||
|
|
||||||
## Backlog Opportunities
|
|
||||||
|
|
||||||
1. **Integration tests** — cmd/review-bot coverage (53.3% → target 80%)
|
|
||||||
2. **Performance profiling** — doc-map filtering optimization
|
|
||||||
3. **Documentation** — Composite action examples
|
|
||||||
|
|
||||||
## Recommendation
|
|
||||||
|
|
||||||
**No new assignments.** Repo ready for next feature work. Standing by.
|
|
||||||
|
|
||||||
---
|
|
||||||
Generated: 2026-05-15 14:42 UTC | Cron: review-bot-dev-loop
|
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
# Dev-Loop Session — 2026-05-15 14:28 UTC
|
||||||
|
|
||||||
|
**Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||||
|
**Session:** review-bot-dev-loop
|
||||||
|
**Objective:** Identify high-value improvement opportunities in steady-state project
|
||||||
|
|
||||||
|
## Current State
|
||||||
|
|
||||||
|
- **Project Status:** ✅ Steady state, all tests passing
|
||||||
|
- **Code Coverage:** 76.7% overall, 53.3% for cmd/review-bot
|
||||||
|
- **Recent Work:** v0.4.0 released, 4 PRs merged
|
||||||
|
- **Last Commit:** 6fa3cb9 — cycle status checkpoint
|
||||||
|
- **Working Tree:** Clean, no uncommitted changes
|
||||||
|
|
||||||
|
## Analysis
|
||||||
|
|
||||||
|
### High-Value Opportunities
|
||||||
|
|
||||||
|
1. **Unit Test Coverage Gaps (cmd/review-bot)**
|
||||||
|
- Main function: 31.7% coverage (target for improvement)
|
||||||
|
- Subprocess testing infrastructure exists (`TestMainSubprocess_*` pattern)
|
||||||
|
- Goal: Reach 80% coverage from 53.3%
|
||||||
|
- Impact: Better regression protection, easier refactoring
|
||||||
|
|
||||||
|
2. **Integration Test Framework**
|
||||||
|
- Existing: `integration_test.go` with full review flow tested
|
||||||
|
- Opportunity: Add edge case coverage (network timeouts, malformed inputs, rate limiting)
|
||||||
|
- Tools: Already uses subprocess pattern from validation tests
|
||||||
|
|
||||||
|
3. **Performance Profiling**
|
||||||
|
- doc-map filtering currently unoptimized
|
||||||
|
- No benchmarks in place for path-scoping logic
|
||||||
|
- Opportunity: Add pprof benchmarks, document baseline metrics
|
||||||
|
|
||||||
|
4. **Documentation Gaps**
|
||||||
|
- Composite action examples in README (incomplete)
|
||||||
|
- Multi-reviewer setup: partially documented
|
||||||
|
- Specialized review types: needs examples
|
||||||
|
|
||||||
|
## Recommendation
|
||||||
|
|
||||||
|
**Unit test improvements** for cmd/review-bot are the highest-value work:
|
||||||
|
- Lower risk than new features
|
||||||
|
- Builds on existing subprocess testing infrastructure
|
||||||
|
- Delivers immediate coverage gains
|
||||||
|
- Sets foundation for future refactoring
|
||||||
|
|
||||||
|
## Status: STEADY STATE — NO NEW ASSIGNMENTS
|
||||||
|
|
||||||
|
Repo is healthy and ready for next feature work. Standing by for Aaron's direction.
|
||||||
|
|
||||||
|
---
|
||||||
|
Generated: 2026-05-15 14:28 UTC | Cron: review-bot-dev-loop
|
||||||
@@ -23,19 +23,18 @@ const maxDocmapBytes int64 = 10 * 1024 * 1024 // 10 MB
|
|||||||
// 1. The path resolves to a regular file within resolvedRoot (path
|
// 1. The path resolves to a regular file within resolvedRoot (path
|
||||||
// confinement): prevents a PR-controlled --docmap from reading arbitrary
|
// confinement): prevents a PR-controlled --docmap from reading arbitrary
|
||||||
// host files via absolute paths or ".." traversal.
|
// host files via absolute paths or ".." traversal.
|
||||||
// 2. The resolved path is within resolvedRoot: in-repo file-level symlinks
|
// 2. The path is not a symlink: prevents denial-of-service via /dev/zero or
|
||||||
// are allowed when their resolved target is still inside the root;
|
// information disclosure via symlinks that point outside the workspace.
|
||||||
// symlinks that escape the root are rejected by the confinement check.
|
|
||||||
// 3. The file does not exceed maxDocmapBytes: prevents memory exhaustion
|
// 3. The file does not exceed maxDocmapBytes: prevents memory exhaustion
|
||||||
// from an oversized but legitimately committed doc-map file.
|
// from an oversized but legitimately committed doc-map file.
|
||||||
//
|
//
|
||||||
// resolvedRoot must already be an absolute, symlink-free path (obtained from
|
// resolvedRoot must already be an absolute, symlink-free path (obtained from
|
||||||
// filepath.Abs + filepath.EvalSymlinks).
|
// filepath.Abs + filepath.EvalSymlinks).
|
||||||
func validateDocmapPath(localPath, resolvedRoot string) (string, error) {
|
func validateDocmapPath(localPath, resolvedRoot string) error {
|
||||||
// Resolve the docmap path to an absolute path.
|
// Resolve the docmap path to an absolute path.
|
||||||
absPath, err := filepath.Abs(localPath)
|
absPath, err := filepath.Abs(localPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("cannot resolve path: %w", err)
|
return fmt.Errorf("cannot resolve path: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Resolve ALL symlink components, not just the final one.
|
// Resolve ALL symlink components, not just the final one.
|
||||||
@@ -47,36 +46,34 @@ func validateDocmapPath(localPath, resolvedRoot string) (string, error) {
|
|||||||
// path is inside the root while the actual destination is not.
|
// path is inside the root while the actual destination is not.
|
||||||
resolvedPath, err := filepath.EvalSymlinks(absPath)
|
resolvedPath, err := filepath.EvalSymlinks(absPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("cannot resolve path (symlink): %w", err)
|
return fmt.Errorf("cannot resolve path (symlink): %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Lstat the resolved path for size and existence checks — EvalSymlinks
|
// Lstat the resolved path — at this point resolvedPath is symlink-free, so
|
||||||
// guarantees no symlink components remain, so ModeSymlink can never be set.
|
// ModeSymlink will never be set. We keep the check as defense-in-depth.
|
||||||
fi, err := os.Lstat(resolvedPath)
|
fi, err := os.Lstat(resolvedPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("cannot stat file: %w", err)
|
return fmt.Errorf("cannot stat file: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Reject anything that is not a regular file (directories, FIFOs, device
|
// Defense-in-depth: reject any remaining symlink indicator.
|
||||||
// nodes, etc.) — ParseDocMapConfig expects a plain YAML file and would
|
if fi.Mode()&os.ModeSymlink != 0 {
|
||||||
// produce a confusing error on non-regular entries.
|
return fmt.Errorf("symlinks are not allowed")
|
||||||
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)
|
||||||
if err != nil || rel == ".." || strings.HasPrefix(rel, ".."+string(os.PathSeparator)) {
|
if err != nil || rel == ".." || strings.HasPrefix(rel, ".."+string(os.PathSeparator)) {
|
||||||
return "", fmt.Errorf("path must be within --repo-root")
|
return fmt.Errorf("path must be within --repo-root")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Enforce size cap before reading to prevent memory exhaustion.
|
// Enforce size cap before reading to prevent memory exhaustion.
|
||||||
if fi.Size() > maxDocmapBytes {
|
if fi.Size() > maxDocmapBytes {
|
||||||
return "", fmt.Errorf("file size %d bytes exceeds %d-byte limit", fi.Size(), maxDocmapBytes)
|
return fmt.Errorf("file size %d bytes exceeds %d-byte limit", fi.Size(), maxDocmapBytes)
|
||||||
}
|
}
|
||||||
|
|
||||||
return resolvedPath, nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// runValidateDocmap implements the `review-bot validate-docmap` subcommand.
|
// runValidateDocmap implements the `review-bot validate-docmap` subcommand.
|
||||||
@@ -140,59 +137,16 @@ func runValidateDocmap(args []string) int {
|
|||||||
// may reference a PR-controlled file (e.g. .review-bot/doc-map.yml).
|
// may reference a PR-controlled file (e.g. .review-bot/doc-map.yml).
|
||||||
// Validate that it:
|
// Validate that it:
|
||||||
// 1. Resolves within resolvedRoot (prevent reading arbitrary host files).
|
// 1. Resolves within resolvedRoot (prevent reading arbitrary host files).
|
||||||
// 2. Resolved target stays within the root (in-repo symlinks are allowed
|
// 2. Is not a symlink (prevent /dev/zero or symlink-based host probing).
|
||||||
// if they resolve to a path inside the root).
|
|
||||||
// 3. Does not exceed maxDocmapBytes (prevent memory exhaustion from an
|
// 3. Does not exceed maxDocmapBytes (prevent memory exhaustion from an
|
||||||
// oversized committed file).
|
// oversized committed file).
|
||||||
// validateDocmapPath returns the resolved path; use it directly to
|
if err := validateDocmapPath(*docmapFlag, resolvedRoot); err != nil {
|
||||||
// eliminate any TOCTOU race between validation and use.
|
|
||||||
resolvedDocmap, err := validateDocmapPath(*docmapFlag, resolvedRoot)
|
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintf(errWriter, "Error: --docmap %q is invalid: %v\n", *docmapFlag, err)
|
fmt.Fprintf(errWriter, "Error: --docmap %q is invalid: %v\n", *docmapFlag, err)
|
||||||
return 2
|
return 2
|
||||||
}
|
}
|
||||||
|
|
||||||
// Open and read the docmap with a LimitedReader — closes the residual TOCTOU
|
// Parse docmap YAML.
|
||||||
// window between the Lstat size check in validateDocmapPath and the file open
|
cfg, err := review.ParseDocMapConfig(*docmapFlag)
|
||||||
// here. The limit is maxDocmapBytes+1 so we can detect a file that grew past
|
|
||||||
// the cap after the stat without reading unbounded bytes.
|
|
||||||
//
|
|
||||||
// Defense-in-depth: stat the path immediately before and after open so we can
|
|
||||||
// detect a file swap between validateDocmapPath's validation and this open via
|
|
||||||
// os.SameFile. An attacker with workspace write access could otherwise replace
|
|
||||||
// the validated file with a symlink in the gap between validation and use.
|
|
||||||
preStat, err := os.Lstat(resolvedDocmap)
|
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintf(errWriter, "Error: failed to stat docmap before open %q: %v\n", *docmapFlag, err)
|
|
||||||
return 2
|
|
||||||
}
|
|
||||||
f, err := os.Open(resolvedDocmap)
|
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintf(errWriter, "Error: failed to open docmap %q: %v\n", *docmapFlag, err)
|
|
||||||
return 2
|
|
||||||
}
|
|
||||||
defer func() { _ = f.Close() }()
|
|
||||||
// Verify we opened the same file that was validated — rejects a swap between
|
|
||||||
// the pre-open Lstat and the open call.
|
|
||||||
postStat, err := f.Stat()
|
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintf(errWriter, "Error: failed to stat open docmap %q: %v\n", *docmapFlag, err)
|
|
||||||
return 2
|
|
||||||
}
|
|
||||||
if !os.SameFile(preStat, postStat) {
|
|
||||||
fmt.Fprintf(errWriter, "Error: --docmap %q changed between validation and open\n", *docmapFlag)
|
|
||||||
return 2
|
|
||||||
}
|
|
||||||
docmapData, err := io.ReadAll(io.LimitReader(f, maxDocmapBytes+1))
|
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintf(errWriter, "Error: failed to read docmap %q: %v\n", *docmapFlag, err)
|
|
||||||
return 2
|
|
||||||
}
|
|
||||||
if int64(len(docmapData)) > maxDocmapBytes {
|
|
||||||
fmt.Fprintf(errWriter, "Error: --docmap %q exceeded %d-byte limit after open\n", *docmapFlag, maxDocmapBytes)
|
|
||||||
return 2
|
|
||||||
}
|
|
||||||
cfg, err := review.ParseDocMapConfigContent(string(docmapData), *docmapFlag)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(errWriter, "Error: failed to parse docmap %q: %v\n", *docmapFlag, err)
|
fmt.Fprintf(errWriter, "Error: failed to parse docmap %q: %v\n", *docmapFlag, err)
|
||||||
return 2
|
return 2
|
||||||
@@ -217,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)
|
||||||
}
|
}
|
||||||
@@ -238,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)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -595,102 +595,7 @@ func TestValidateDocmapPath_DirSymlinkBypass(t *testing.T) {
|
|||||||
t.Fatalf("EvalSymlinks(repoDir): %v", err)
|
t.Fatalf("EvalSymlinks(repoDir): %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if _, err := validateDocmapPath(attackPath, resolvedRoot); err == nil {
|
if err := validateDocmapPath(attackPath, resolvedRoot); err == nil {
|
||||||
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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestValidateDocmapPath_InRepoSymlinkAllowed verifies that an in-repo
|
|
||||||
// file-level symlink whose resolved target is still within the repo root is
|
|
||||||
// accepted. This is the positive case for the issue #150 behavioral change:
|
|
||||||
// only symlinks that escape the root are rejected; intra-repo symlinks are
|
|
||||||
// allowed because EvalSymlinks resolves the target and the confinement check
|
|
||||||
// is applied to the resolved path, not the symlink entry itself.
|
|
||||||
func TestValidateDocmapPath_InRepoSymlinkAllowed(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
|
|
||||||
// Create the real docmap file inside the repo root.
|
|
||||||
if err := os.MkdirAll(filepath.Join(dir, ".review-bot"), 0o755); err != nil {
|
|
||||||
t.Fatalf("MkdirAll: %v", err)
|
|
||||||
}
|
|
||||||
realDocmap := filepath.Join(dir, ".review-bot", "doc-map-real.yml")
|
|
||||||
if err := os.WriteFile(realDocmap, []byte("mappings: []\n"), 0o644); err != nil {
|
|
||||||
t.Fatalf("WriteFile: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create a symlink inside the repo root that points to the real file
|
|
||||||
// (also inside the root).
|
|
||||||
symlinkPath := filepath.Join(dir, ".review-bot", "doc-map-link.yml")
|
|
||||||
if err := os.Symlink(realDocmap, symlinkPath); err != nil {
|
|
||||||
t.Skipf("cannot create symlink (platform may not support it): %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resolve dir to a symlink-free root, as runValidateDocmap does.
|
|
||||||
resolvedRoot, err := filepath.EvalSymlinks(dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("EvalSymlinks(dir): %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// In-repo symlink whose target is within root: must be accepted.
|
|
||||||
resolved, err := validateDocmapPath(symlinkPath, resolvedRoot)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected in-repo symlink to be accepted, got error: %v", err)
|
|
||||||
}
|
|
||||||
// The returned resolved path must be the real file (not the symlink entry).
|
|
||||||
// validateDocmapPath calls filepath.EvalSymlinks internally, so the returned
|
|
||||||
// path is always the fully-resolved real path — it can never equal the
|
|
||||||
// symlink entry itself.
|
|
||||||
if resolved == symlinkPath {
|
|
||||||
t.Errorf("expected resolved path to differ from symlink path")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
Reference in New Issue
Block a user