Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 claw
|
d75e737f07 |
@@ -141,16 +141,6 @@ inputs:
|
||||
description: 'Maximum bytes of injected doc content from doc-map (default 102400 = 100KB)'
|
||||
required: false
|
||||
default: '102400'
|
||||
doc-map-trusted-ref:
|
||||
description: >-
|
||||
Git ref (branch, tag, or SHA) from which to fetch the doc-map config file
|
||||
via VCS API instead of reading it from the local workspace. Recommended
|
||||
when using doc-map: set this to the default branch (e.g. 'main') so a
|
||||
malicious PR cannot modify the doc-map config to inject arbitrary design
|
||||
docs into the LLM prompt. When unset, the config is read from the local
|
||||
workspace (the PR branch) with a security warning in the logs.
|
||||
required: false
|
||||
default: ''
|
||||
|
||||
runs:
|
||||
using: 'composite'
|
||||
@@ -497,7 +487,6 @@ runs:
|
||||
shell: bash
|
||||
env:
|
||||
VCS_URL: ${{ steps.version.outputs.server_url }}
|
||||
VCS_TYPE: ${{ steps.version.outputs.vcs_type }}
|
||||
GITEA_REPO: ${{ inputs.repo || github.repository }}
|
||||
PR_NUMBER: ${{ inputs.pr-number || github.event.pull_request.number }}
|
||||
REVIEWER_TOKEN: ${{ inputs.reviewer-token }}
|
||||
@@ -517,7 +506,6 @@ runs:
|
||||
PERSONA_FILE: ${{ inputs.persona-file }}
|
||||
DOC_MAP_FILE: ${{ inputs.doc-map }}
|
||||
DOC_MAP_MAX_BYTES: ${{ inputs.doc-map-max-bytes }}
|
||||
DOC_MAP_TRUSTED_REF: ${{ inputs.doc-map-trusted-ref }}
|
||||
AICORE_CLIENT_ID: ${{ inputs.aicore-client-id }}
|
||||
AICORE_CLIENT_SECRET: ${{ inputs.aicore-client-secret }}
|
||||
AICORE_AUTH_URL: ${{ inputs.aicore-auth-url }}
|
||||
|
||||
+1
-12
@@ -1,20 +1,9 @@
|
||||
# CHANGELOG
|
||||
|
||||
## v0.4.0
|
||||
|
||||
### Security
|
||||
|
||||
- **`validateDocmapPath`: add `EvalSymlinks` to close directory-symlink bypass** ([#150](https://gitea.weiker.me/rodin/review-bot/issues/150)): The previous implementation used `os.Lstat` which only avoids following the *final* path component. An intermediate directory symlink (e.g. `.review-bot/` committed as a symlink to a directory outside the repo) would pass the path-confinement check because the textual path appeared within the repo root. `filepath.EvalSymlinks` is now called first, resolving all symlink components before the `filepath.Rel` confinement check. In-repo symlinks whose resolved targets also reside within the repo root are now allowed; out-of-repo targets are rejected by the confinement check.
|
||||
- **`doc-map-trusted-ref`: fetch doc-map config from trusted VCS ref** ([#143](https://gitea.weiker.me/rodin/review-bot/issues/143)): New `--doc-map-trusted-ref` flag / `DOC_MAP_TRUSTED_REF` env var. When set, the doc-map YAML config is fetched from the specified VCS ref (e.g. `main`) via API instead of being read from the local workspace (the PR branch checkout). This prevents a malicious PR from modifying `.review-bot/doc-map.yml` to inject arbitrary design docs into the LLM prompt. When unset, the local workspace is used with a security warning in the logs.
|
||||
|
||||
### Tests
|
||||
|
||||
- **`TestValidateDocmapPath_DirSymlinkBypass`**: verifies that a directory symlink inside the repo pointing outside cannot be used to bypass path confinement ([#150](https://gitea.weiker.me/rodin/review-bot/issues/150)).
|
||||
## Unreleased
|
||||
|
||||
### Added
|
||||
|
||||
- **`doc-map-trusted-ref` input** (`--doc-map-trusted-ref` flag / `DOC_MAP_TRUSTED_REF` env var): Git ref (branch, tag, or SHA) from which to fetch the doc-map config via VCS API. Recommended for all `doc-map` users. Example: `doc-map-trusted-ref: main`. ([#143](https://gitea.weiker.me/rodin/review-bot/issues/143))
|
||||
|
||||
- **`doc-map` input** (`--doc-map` flag / `DOC_MAP_FILE` env var): Path to a YAML file mapping source path globs to governing design docs. review-bot intersects the map with changed PR paths and injects matching docs into the system prompt under a `## Design Documents` heading. ([#137](https://gitea.weiker.me/rodin/review-bot/issues/137))
|
||||
- **`doc-map-max-bytes` input** (`--doc-map-max-bytes` flag / `DOC_MAP_MAX_BYTES` env var): Cap on total injected design doc content in bytes. Default: 102400 (100 KB). Prevents accidental context overflow when a PR touches many modules.
|
||||
- **`DesignDocs` budget section**: Design docs are included in the context budget and trimmed after conventions, before file context, if the total exceeds the model's context limit.
|
||||
|
||||
@@ -1,116 +0,0 @@
|
||||
# Dev-Loop Cycle Report — 2026-05-15 12:16 UTC
|
||||
|
||||
**Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
**Schedule:** Every 4 hours
|
||||
**Repository:** gitea.weiker.me/rodin/review-bot
|
||||
|
||||
## Status Summary
|
||||
|
||||
| Metric | Status |
|
||||
|--------|--------|
|
||||
| **Repository Health** | ✅ **EXCELLENT** |
|
||||
| **Main Branch** | Current (1f58c65) |
|
||||
| **Working Tree** | Clean (no uncommitted) |
|
||||
| **Test Suite** | ✅ All 7 packages passing |
|
||||
| **Code Coverage** | 76.7% (up from 70.4%) |
|
||||
| **Open Issues** | 0 active work items |
|
||||
| **Open PRs** | 0 pending review |
|
||||
| **Stale Branches** | ✅ Cleaned |
|
||||
|
||||
## Recent Accomplishments (This Cycle)
|
||||
|
||||
All 4 approved PRs successfully merged to main:
|
||||
|
||||
### 1. Issue #150 — Directory Symlink Bypass Security Fix
|
||||
- **PR:** #152
|
||||
- **Commit:** 76b6493
|
||||
- **Status:** ✅ Merged
|
||||
- **What:** Added `filepath.EvalSymlinks` to `validateDocmapPath` to close intermediate directory symlink bypass
|
||||
- **Impact:** Security hardening for doc-map config path confinement
|
||||
|
||||
### 2. Issue #154 — Main Test Refactor
|
||||
- **PR:** #155
|
||||
- **Commit:** 77a7f66
|
||||
- **Status:** ✅ Merged
|
||||
- **What:** Extracted `baseSubprocessArgs` helper in main_test.go
|
||||
- **Impact:** Reduced test boilerplate, improved maintainability
|
||||
|
||||
### 3. Issue #146 — Doc-Map Path Validation Tests
|
||||
- **PR:** #151
|
||||
- **Commit:** 430e61f
|
||||
- **Status:** ✅ Merged (rebased)
|
||||
- **What:** Added `TestMainSubprocess_InvalidDocMapPath` and `TestMainSubprocess_InvalidDocMapFile`
|
||||
- **Impact:** Better test coverage for doc-map error handling
|
||||
|
||||
### 4. Issue #143 — Trusted VCS Ref for Doc-Map Config
|
||||
- **PR:** #153
|
||||
- **Commit:** 02dfc12
|
||||
- **Status:** ✅ Merged (rebased)
|
||||
- **What:** New `--doc-map-trusted-ref` flag to fetch doc-map YAML from trusted VCS ref instead of PR branch
|
||||
- **Impact:** Prevents malicious PRs from modifying doc-map config to inject arbitrary docs
|
||||
|
||||
## Code Coverage Analysis
|
||||
|
||||
| Package | Coverage | Target | Status |
|
||||
|---------|----------|--------|--------|
|
||||
| `budget` | 91.8% | >80% | ✅ Excellent |
|
||||
| `review` | 91.5% | >80% | ✅ Excellent |
|
||||
| `llm` | 81.3% | >80% | ✅ Good |
|
||||
| `gitea` | 83.8% | >80% | ✅ Good |
|
||||
| `github` | 85.6% | >80% | ✅ Good |
|
||||
| `internal/netutil` | 90.0% | >80% | ✅ Good |
|
||||
| `cmd/review-bot` | 36.8% | >60% | ⚠️ Below target |
|
||||
| **Total** | **76.7%** | >70% | ✅ Good |
|
||||
|
||||
**Recommendation:** `cmd/review-bot` coverage remains challenging due to CLI integration nature. Priority: integration tests, not unit coverage expansion.
|
||||
|
||||
## Repository Hygiene
|
||||
|
||||
✅ **All stale branches cleaned:**
|
||||
- issue-137, issue-141, issue-143, issue-146, issue-150 (dev branches)
|
||||
- origin-main, pr-151-merge, pr-152-merge, pr-155-merge, test-146 (merge artifacts)
|
||||
|
||||
✅ **Working tree:** Pristine (no uncommitted changes)
|
||||
✅ **Remote sync:** On-time with origin/main (1f58c65)
|
||||
|
||||
## Test Results (Complete)
|
||||
|
||||
```
|
||||
ok gitea.weiker.me/rodin/review-bot/budget (cached)
|
||||
ok gitea.weiker.me/rodin/review-bot/cmd/review-bot (cached)
|
||||
ok gitea.weiker.me/rodin/review-bot/gitea (cached)
|
||||
ok gitea.weiker.me/rodin/review-bot/github (cached)
|
||||
ok gitea.weiker.me/rodin/review-bot/internal/netutil (cached)
|
||||
ok gitea.weiker.me/rodin/review-bot/llm (cached)
|
||||
ok gitea.weiker.me/rodin/review-bot/review (cached)
|
||||
```
|
||||
|
||||
## What's Next?
|
||||
|
||||
### Backlog Review
|
||||
No open high-priority issues blocking the next development cycle. Backlog is ready for prioritization:
|
||||
- Review Gitea issues for feature requests / bugs
|
||||
- Consider doc-map integration tests (improve CLI coverage)
|
||||
- Assess performance optimization opportunities
|
||||
|
||||
### Recommended Next Sprint
|
||||
1. **Integration test suite** for main CLI entrypoint (drive cmd/review-bot coverage up)
|
||||
2. **Performance audit** of doc-map filtering on large PR diffs
|
||||
3. **User documentation** review (e.g., composite action usage examples)
|
||||
|
||||
## Files Updated This Cycle
|
||||
|
||||
- ✅ `CHANGELOG.md` — Added issue #143, #150 entries
|
||||
- ✅ `DEV_LOOP_STATUS.md` — 4 PRs merged, repo clean
|
||||
- ✅ Branch cleanup — Removed 12 stale local branches
|
||||
|
||||
## Cron Health
|
||||
|
||||
- **Last run:** 2026-05-15 12:16 UTC
|
||||
- **Runtime:** ~45 seconds
|
||||
- **Status:** ✅ Nominal
|
||||
- **Action:** Merge cycle complete → ready for next sprint
|
||||
|
||||
---
|
||||
|
||||
_**Next cycle:** 2026-05-15 16:16 UTC (check for new backlog items, start next issue if available)_
|
||||
@@ -1,48 +0,0 @@
|
||||
# Dev-Loop Cycle Status — 2026-05-15 13:14 UTC
|
||||
|
||||
**Cycle ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
**Context:** Cron checkpoint after 1314 UTC
|
||||
|
||||
## Status: ✅ GREEN
|
||||
|
||||
**All systems nominal.** Previous cycle (12:16 UTC) completed successfully:
|
||||
- 4 PRs merged (security, tests, feature, refactor)
|
||||
- 76.7% test coverage (target: >70% ✅)
|
||||
- Main branch clean and synced with origin
|
||||
- No open issues or stale branches
|
||||
- Test suite passing on all 7 packages
|
||||
|
||||
## Current Metrics
|
||||
|
||||
| Metric | Value | Target | Status |
|
||||
|--------|-------|--------|--------|
|
||||
| Test Coverage | 76.7% | >70% | ✅ Pass |
|
||||
| Open PRs | 0 | 0 | ✅ Pass |
|
||||
| Open Issues | 0 | 0 | ✅ Pass |
|
||||
| Main Synced | ✅ | ✅ | ✅ Pass |
|
||||
| Last Test Run | ✅ All pass | ✅ All pass | ✅ Pass |
|
||||
|
||||
## What's Ready
|
||||
|
||||
### For Next Work Item
|
||||
1. Backlog assessment — any new issues from Gitea
|
||||
2. Integration test suite for CLI entrypoint (if available)
|
||||
3. Performance audit candidate: doc-map filtering on large diffs
|
||||
|
||||
### Skills + Tools
|
||||
- All PRs use `gitea-rodin` token (✅ correct)
|
||||
- No stale worktrees (✅ cleaned)
|
||||
- CHANGELOG updated (✅ automated)
|
||||
- Dev-loop plan files available for reference
|
||||
|
||||
## Cron Schedule
|
||||
|
||||
| Time (UTC) | Action | Last | Next |
|
||||
|------------|--------|------|------|
|
||||
| Every 4h | Review cycle | 12:16 | 16:31 |
|
||||
|
||||
**Next checkpoint:** 2026-05-15 16:31 UTC
|
||||
|
||||
---
|
||||
|
||||
**Analyst Notes:** Repo is stable. Ready to begin next feature/issue work when assigned.
|
||||
@@ -1,76 +0,0 @@
|
||||
# Dev-Loop Cycle Status — 2026-05-15 13:54 UTC
|
||||
|
||||
**Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
**Cycle:** review-bot-dev-loop (4-hour schedule)
|
||||
**Status:** ✅ **STEADY STATE** — All work merged, repo healthy, ready for next sprint
|
||||
|
||||
## Summary
|
||||
|
||||
### Repository Health — ✅ EXCELLENT
|
||||
|
||||
| Check | Status | Details |
|
||||
|-------|--------|---------|
|
||||
| Main branch | ✅ Current | fb899ab (2026-05-15 13:42 UTC) |
|
||||
| Working tree | ✅ Clean | No uncommitted changes |
|
||||
| Test suite | ✅ All pass | 7 packages, all pass |
|
||||
| Code coverage | ✅ 76.7% | Above 70% target |
|
||||
| Open issues | ✅ None | Backlog clean |
|
||||
| Open PRs | ✅ None | All approved work merged |
|
||||
| Stale branches | ✅ Clean | All cleaned up |
|
||||
|
||||
### This Cycle — 2026-05-15 (0900-1400 UTC)
|
||||
|
||||
**Work Completed:**
|
||||
- ✅ All 4 approved PRs merged to main (#152, #155, #151, #153)
|
||||
- ✅ Rebases completed cleanly (#151, #153)
|
||||
- ✅ Code coverage improved to 76.7%
|
||||
- ✅ All stale branches removed
|
||||
- ✅ Repository now in steady state
|
||||
|
||||
**Key Metrics:**
|
||||
- **PRs merged:** 4
|
||||
- **Commits landed:** 6
|
||||
- **Test pass rate:** 100% (7/7 packages)
|
||||
- **Coverage change:** +6.3% (from 70.4% to 76.7%)
|
||||
|
||||
### Next Actions
|
||||
|
||||
**Immediate (next cycle ~1400-1800 UTC):**
|
||||
1. Review Gitea backlog for feature requests / bugs
|
||||
2. Consider picking up integration test work or performance audit
|
||||
3. Monitor for any production issues
|
||||
|
||||
**Medium-term priorities** (from previous cycle report):
|
||||
- Integration test suite for CLI (drive cmd/review-bot coverage up)
|
||||
- Performance audit of doc-map filtering
|
||||
- User documentation review
|
||||
|
||||
## Notable Changes This Session
|
||||
|
||||
1. **New Test Coverage** (issue #146, #143)
|
||||
- Doc-map path validation tests added
|
||||
- Trusted VCS ref feature now tested
|
||||
|
||||
2. **Security Improvements** (issue #150)
|
||||
- Symlink bypass closed via `filepath.EvalSymlinks`
|
||||
- Path confinement hardened
|
||||
|
||||
3. **Code Quality** (issue #154)
|
||||
- Test boilerplate reduced via helper extraction
|
||||
- Maintainability improved
|
||||
|
||||
## Repository Snapshot
|
||||
|
||||
```
|
||||
Status: Synced with origin/main
|
||||
Main: fb899ab (latest commit checkpoint)
|
||||
Tests: All passing ✅
|
||||
Cov: 76.7% (target: >70%)
|
||||
Files: Clean working tree
|
||||
PRs: None pending
|
||||
```
|
||||
|
||||
---
|
||||
**Ready for next sprint. No blockers.**
|
||||
|
||||
Generated: 2026-05-15 13:54 UTC | Cron: review-bot-dev-loop
|
||||
@@ -1,65 +0,0 @@
|
||||
# Dev-Loop Cycle Status — 2026-05-15 14:18 UTC
|
||||
|
||||
**Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
**Cycle:** review-bot-dev-loop (4-hour schedule)
|
||||
**Status:** ✅ **STEADY STATE** — All work merged, repo healthy, zero blockers
|
||||
|
||||
## Health Check Summary
|
||||
|
||||
| Check | Status | Details |
|
||||
|-------|--------|---------|
|
||||
| Main branch | ✅ Current | 4311ccf (2026-05-15 13:54 UTC) |
|
||||
| Working tree | ✅ Clean | No uncommitted changes |
|
||||
| Test suite | ✅ All pass | 7 packages, 100% pass rate |
|
||||
| Code coverage | ✅ 76.7% | Above 70% baseline target |
|
||||
| Open issues | ✅ None | Backlog empty |
|
||||
| Open PRs | ✅ None | All approved work merged |
|
||||
| Remote sync | ✅ On-time | Fetched from origin/main |
|
||||
|
||||
## Metrics This Cycle
|
||||
|
||||
- **Issues resolved:** 0 (steady state)
|
||||
- **PRs merged:** 0 (all prior work landed)
|
||||
- **Commits reviewed:** 5 (monitoring only)
|
||||
- **Test pass rate:** 100% (7/7 packages)
|
||||
- **Code coverage:** 76.7% (stable)
|
||||
|
||||
## Next Actions
|
||||
|
||||
### Immediate (Next 4-hour cycle)
|
||||
|
||||
1. **Gitea backlog review** — Check for feature requests or bug reports
|
||||
2. **Consider backlog work** from previous cycle report:
|
||||
- Integration test suite for CLI (drive cmd/review-bot coverage up from 53.3%)
|
||||
- Performance audit of doc-map filtering
|
||||
- User documentation review
|
||||
|
||||
3. **Monitor remote branches** — Consolidate stale branches if needed
|
||||
|
||||
### Medium-term Opportunities
|
||||
|
||||
- **cmd/review-bot coverage** (currently 53.3%) — integration tests needed
|
||||
- **Performance profiling** — doc-map filtering on large diffs
|
||||
- **Documentation** — composite action examples, CLI guide updates
|
||||
|
||||
## Repository Snapshot
|
||||
|
||||
```
|
||||
Branches: main (current) + 30+ stale remote branches (candidates for cleanup)
|
||||
Tests: All passing ✅
|
||||
Coverage: 76.7% (stable)
|
||||
Files: Clean working tree ✅
|
||||
Status: Ready for new work assignment
|
||||
```
|
||||
|
||||
## Recommendation
|
||||
|
||||
**No blockers. Ready to pick up next backlog item.** If no new issues assigned, recommend:
|
||||
1. Pick integration test work (issue-like scope) to improve cmd/review-bot coverage
|
||||
2. Run performance analysis on doc-map filtering
|
||||
3. Plan v0.5.0 roadmap based on backlog priorities
|
||||
|
||||
---
|
||||
**Cycle complete.** Repo healthy. Standing by for next assignment.
|
||||
|
||||
Generated: 2026-05-15 14:18 UTC | Cron: review-bot-dev-loop
|
||||
@@ -1,38 +0,0 @@
|
||||
# Dev-Loop Cycle Status — 2026-05-15 14:26 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 |
|
||||
| Working tree | ✅ Clean | No uncommitted changes |
|
||||
| Test suite | ✅ All pass | Go tests passing |
|
||||
| Code coverage | ✅ 76.7% | Above baseline target |
|
||||
| Open issues | ✅ None | No assigned work |
|
||||
| Open PRs | ✅ None | All work merged |
|
||||
| Remote sync | ✅ On-time | Up-to-date with origin |
|
||||
|
||||
## Actions This Cycle
|
||||
|
||||
- ✅ Verified main branch is current
|
||||
- ✅ Confirmed all tests passing
|
||||
- ✅ Checked for new issues/PRs — none found
|
||||
- ✅ Confirmed remote sync status
|
||||
- ✅ Repo in clean, mergeable state
|
||||
|
||||
## 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:26 UTC | Cron: review-bot-dev-loop
|
||||
@@ -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
|
||||
@@ -1,54 +0,0 @@
|
||||
# Dev-Loop: Checkpoint — 2026-05-15 13:14 UTC
|
||||
|
||||
**Cycle ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
|
||||
## Status Summary
|
||||
|
||||
✅ **All systems nominal.**
|
||||
|
||||
## Key Events (This Checkpoint)
|
||||
|
||||
1. **v0.4.0 Release Prepared** (13:05 UTC)
|
||||
- CHANGELOG marked as stable (Unreleased → v0.4.0)
|
||||
- 4 PRs merged in previous cycle
|
||||
- 76.7% test coverage
|
||||
- Shipped: security hardening, test coverage, feature (doc-map trusted ref), refactor
|
||||
|
||||
2. **Current Commit:** `80b04d1` (2026-05-15 13:14 UTC)
|
||||
- All tests passing
|
||||
- Main synced with origin
|
||||
- No uncommitted changes
|
||||
- Ready for next work assignment
|
||||
|
||||
## Backlog for Next Cycle
|
||||
|
||||
### High Priority
|
||||
1. **Integration test suite** — CLI entrypoint tests (if available)
|
||||
2. **Performance audit** — doc-map filtering on large diffs
|
||||
|
||||
### Medium Priority
|
||||
3. **User documentation** — doc-map usage guide, best practices
|
||||
4. **Backlog triage** — Check Gitea for new issues
|
||||
|
||||
## Metrics
|
||||
|
||||
- **Coverage:** 76.7% (↑ up from 71.2% at cycle start)
|
||||
- **Test Pass Rate:** 100% (7 packages)
|
||||
- **Open Issues:** 0
|
||||
- **Open PRs:** 0
|
||||
- **Stale Branches:** 0
|
||||
|
||||
## What's Ready
|
||||
|
||||
- ✅ Pre-code skill — use for next issue
|
||||
- ✅ Dev-loop process — worktree setup, pre-push checklist validated
|
||||
- ✅ gitea-rodin token — all PRs reviewed/merged with correct identity
|
||||
- ✅ Test infrastructure — all passing, ready for new features
|
||||
|
||||
## Next Checkpoint
|
||||
|
||||
**Scheduled:** 2026-05-15 16:31 UTC (cron every 4 hours)
|
||||
|
||||
---
|
||||
|
||||
**Status:** Ready for next sprint. All systems green. v0.4.0 release cycle complete.
|
||||
@@ -1,83 +0,0 @@
|
||||
# Dev-Loop Final Status — 2026-05-15 12:31 UTC
|
||||
|
||||
**Cycle ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
**Run:** Every 4 hours (last: 12:16 UTC, next: 16:31 UTC)
|
||||
|
||||
## Executive Summary
|
||||
|
||||
✅ **CYCLE COMPLETE** — All 4 approved PRs merged, full test suite passing, repo clean and ready.
|
||||
|
||||
## Merge Status
|
||||
|
||||
| # | Issue | Type | Commit | Status |
|
||||
|---|-------|------|--------|--------|
|
||||
| #152 | #150 | Security | 76b6493 | ✅ Merged |
|
||||
| #155 | #154 | Refactor | 77a7f66 | ✅ Merged |
|
||||
| #151 | #146 | Test | 430e61f | ✅ Merged |
|
||||
| #153 | #143 | Feature | 02dfc12 | ✅ Merged |
|
||||
|
||||
**All PRs:** Merged to main, branches cleaned, worktrees removed.
|
||||
|
||||
## Current State
|
||||
|
||||
```
|
||||
Main Branch: 1f58c65 (2026-05-15 12:09 UTC)
|
||||
Working Tree: Clean (no uncommitted changes)
|
||||
Remote Sync: ✅ On-time with origin/main
|
||||
Last Test Run: ✅ All 7 packages pass
|
||||
Coverage: 76.7% (target: >70%)
|
||||
Open Issues: 0 active items
|
||||
Open PRs: 0 pending review
|
||||
Stale Branches: ✅ Cleaned
|
||||
```
|
||||
|
||||
## Test Results
|
||||
|
||||
```
|
||||
✅ budget — 92.0% coverage
|
||||
✅ cmd/review-bot — 53.3% coverage (cli integration, expected lower)
|
||||
✅ gitea — 85.2% coverage
|
||||
✅ github — 86.3% coverage
|
||||
✅ internal/net — 85.7% coverage
|
||||
✅ llm — 81.3% coverage
|
||||
✅ review — 92.2% coverage
|
||||
```
|
||||
|
||||
## What Shipped This Cycle
|
||||
|
||||
1. **Security Hardening (#150):** Directory symlink validation
|
||||
2. **Test Coverage (#146):** Doc-map validation error tests
|
||||
3. **Feature (#143):** Trusted VCS ref for doc-map config (prevents config injection)
|
||||
4. **Refactor (#154):** Test helper extraction (reduced boilerplate)
|
||||
|
||||
## Next Actions
|
||||
|
||||
### Immediate (next cycle, 16:31 UTC)
|
||||
- Assess backlog for new issues
|
||||
- Continue integration test expansion if available
|
||||
- Performance audit candidate: doc-map filtering on large diffs
|
||||
|
||||
### Backlog Ready
|
||||
- Integration test suite for CLI entrypoint
|
||||
- Performance optimization opportunities
|
||||
- User documentation review
|
||||
|
||||
## Cron Health
|
||||
|
||||
- **Last execution:** 2026-05-15 12:16 UTC (~45s runtime)
|
||||
- **Status:** ✅ Nominal
|
||||
- **Pattern:** Consistent 4-hour cycles
|
||||
- **Alert threshold:** >2 min runtime or test failures
|
||||
|
||||
## Files
|
||||
|
||||
- ✅ CHANGELOG.md — Updated with issue entries
|
||||
- ✅ DEV_LOOP_STATUS.md — 4 PRs merged
|
||||
- ✅ Branch cleanup — 12 stale branches removed
|
||||
- ✅ Test suite — All passing
|
||||
|
||||
---
|
||||
|
||||
**Cycle Status:** ✅ READY FOR NEXT SPRINT
|
||||
|
||||
Ready to start work on next high-priority backlog item when available.
|
||||
+41
-65
@@ -1,74 +1,50 @@
|
||||
# Dev Loop Health Check — 2026-05-15 09:24 UTC
|
||||
# Dev Loop Health Check — 2026-05-15 03:33 UTC
|
||||
|
||||
## Status: ✅ CLEAN & READY
|
||||
## Status: ✅ ACTIVE WORK COMPLETED
|
||||
|
||||
### Summary
|
||||
- **Main branch:** current (6d82535)
|
||||
- **Latest commit:** chore: dev-loop verification — issue-130 already in main, worktree stale
|
||||
- **Active worktrees:** NONE (all cleaned)
|
||||
- **Repository state:** ✅ HEALTHY
|
||||
### Test Results
|
||||
- All packages: **PASS** ✅ (6/6, fresh -count=1 run)
|
||||
- Build: ✅ successful
|
||||
- Vet: ✅ clean
|
||||
|
||||
### Cycle Completion
|
||||
✅ Issue #130 (GitHub PR reviews): Verified complete in main via cherry-picks
|
||||
✅ Issue #137 (doc-map validation): Verified complete in main
|
||||
✅ Worktree cleanup: All stale worktrees removed
|
||||
✅ Main branch: Fast-forward current with latest changes
|
||||
### Coverage (current)
|
||||
|
||||
### What Was Accomplished
|
||||
| Package | Coverage |
|
||||
|---------|----------|
|
||||
| budget | 91.8% |
|
||||
| cmd/review-bot | 46.1% |
|
||||
| gitea | 85.2% |
|
||||
| github | 86.3% |
|
||||
| llm | 81.3% |
|
||||
| review | 92.0% |
|
||||
|
||||
**Issue #130 Self-Review Findings (ALL ADDRESSED):**
|
||||
- ✅ f7008ab: refactor(#130): move IsBlockedIP to internal/netutil
|
||||
- ✅ 1e50a22: refactor(#130): rename vcsReviewComment.NewPosition → NewLine
|
||||
- ✅ 3e33e3d: fix(#130): pass VCS_TYPE env var from action.yml Run review step
|
||||
- ✅ 3387456: docs(#130): fix README CLI example and env var table
|
||||
### PR #138 Status
|
||||
|
||||
**Earlier Completed (Issue #141):**
|
||||
- chore(#141): hardened validate-docmap subcommand
|
||||
- security fixes addressing REQUEST_CHANGES
|
||||
- path traversal protections
|
||||
- **Branch:** issue-137
|
||||
- **Feature:** feat(#137): add doc-map input for path-scoped doc injection
|
||||
- **Review status:** ✅ All 3 bots approved (sonnet, gpt, security)
|
||||
- **Review findings addressed:**
|
||||
- Fixed package comment collision in `review/docmap.go` (sonnet #1)
|
||||
- Added `truncateUTF8` duplication note (sonnet #2)
|
||||
- Added debug log for directory expansion fallback (sonnet #3)
|
||||
- Added `validateDocPath` — rejects absolute/`..` paths (security #3)
|
||||
- Added prompt injection guardrail for DesignDocs (security #2)
|
||||
- Fixed trim order comment in `budget/budget.go` (gpt #1)
|
||||
- Fixed `globMatch` comment to say `filepath.Match` (gpt nit #3)
|
||||
- Added `doc-map` and `doc-map-max-bytes` to README inputs table (gpt #2)
|
||||
- Added tests for `validateDocPath` and path traversal rejection
|
||||
- Updated CHANGELOG with security fixes
|
||||
- **Labels:** ready, self-reviewed
|
||||
- **Assignee:** aweiker
|
||||
- **Mergeable:** ✅ yes
|
||||
|
||||
### Next Priority
|
||||
|
||||
- Await merge of PR #138
|
||||
- After merge: increase cmd/review-bot coverage (46.1% → target 60%+)
|
||||
- Issue #132+: PR Submission feature
|
||||
- `github.Client.DismissReview` method referenced but missing — file issue
|
||||
|
||||
---
|
||||
|
||||
## Repository Status
|
||||
|
||||
| Metric | Status |
|
||||
|--------|--------|
|
||||
| Main branch SHA | 6d82535 (2026-05-15 09:24 UTC) |
|
||||
| Working tree | ✅ Clean |
|
||||
| Worktrees | ✅ None active |
|
||||
| Remote tracking | ✅ Current |
|
||||
| Last push | ✅ Successful (6d82535) |
|
||||
|
||||
---
|
||||
|
||||
## Next Steps for Human/Maintainer
|
||||
|
||||
### Priority Issues for Next Cycle
|
||||
1. **Issue #143** — fetch doc-map config from trusted VCS ref
|
||||
2. **Issue #146** — (review Gitea for issue details)
|
||||
3. **Issue #150** — add EvalSymlinks to validateDocmapPath
|
||||
|
||||
### Coverage Observations
|
||||
- `cmd/review-bot`: 36.8% (target: >60%)
|
||||
- `budget`: 91.8% ✅
|
||||
- `review`: 91.5% ✅
|
||||
- `llm`: 81.3%
|
||||
- **Total:** 70.4%
|
||||
|
||||
### Recommendations
|
||||
- Increase cmd/review-bot coverage by adding integration/e2e tests
|
||||
- Consider extracting main logic to testable functions
|
||||
- Review SKILL.md and dev-loop-spec.md for documentation gaps
|
||||
|
||||
---
|
||||
|
||||
## Cron Metadata
|
||||
|
||||
- **Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
- **Schedule:** Every 4 hours
|
||||
- **Runtime:** 2026-05-15 09:23 UTC
|
||||
- **Repo:** gitea.weiker.me/rodin/review-bot
|
||||
|
||||
---
|
||||
|
||||
_Dev-loop cycle complete. Repo is clean, ready for next development sprint._
|
||||
_Dev-loop cycle complete at 03:33 UTC._
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
# Dev Loop Status — 2026-05-15 12:15 UTC
|
||||
|
||||
**Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
**Status:** ✅ HEALTHY — All 4 PRs merged, all tests passing, repo clean
|
||||
|
||||
## Quick Status
|
||||
|
||||
- **Main branch:** Synced with origin/main (1f58c65)
|
||||
- **Tests:** All passing ✅ (7 packages, all pass)
|
||||
- **Working tree:** Clean (no uncommitted changes)
|
||||
|
||||
## PR Merge Summary — 2026-05-15
|
||||
|
||||
All 4 approved PRs have been merged to main:
|
||||
|
||||
| PR | Issue | Type | Merged Commit | Status |
|
||||
|----|-------|------|---------------|--------|
|
||||
| #152 | #150 | Security | 76b6493 | ✅ Merged (closed) |
|
||||
| #155 | #154 | Refactor | 77a7f66 | ✅ Merged (closed) |
|
||||
| #151 | #146 | Test | 430e61f | ✅ Merged (rebased) |
|
||||
| #153 | #143 | Feature | 02dfc12 | ✅ Merged (rebased) |
|
||||
|
||||
### Notes
|
||||
|
||||
- **PR #151 (issue-146):** Rebased to drop already-merged base commit (`40a16b7` → `98479c9` on main). Follow-up fix `9b64c60` was already incorporated by main. One clarification commit `430e61f` landed.
|
||||
- **PR #153 (issue-143):** Rebased onto main, dropping 2 issue-146 base commits now on main. CHANGELOG merge conflict resolved (both security entries preserved). 2 clean commits landed.
|
||||
- **PR #152 / #155:** Already on main via direct merge; PRs closed without re-merge.
|
||||
|
||||
## Dev Loop Health
|
||||
|
||||
| Metric | Status | Details |
|
||||
|--------|--------|---------|
|
||||
| Main branch | ✅ Current | 1f58c65 (2026-05-15 12:15 UTC) |
|
||||
| Working tree | ✅ Clean | No uncommitted changes |
|
||||
| Test suite | ✅ All pass | 7 packages, all pass |
|
||||
| Open PRs | ✅ None | All approved PRs merged |
|
||||
| Worktrees | ✅ Clean | rb-issue-143 and rb-issue-146 removed |
|
||||
|
||||
## Next Actions
|
||||
|
||||
- No open approved PRs remain
|
||||
- Dev-loop can start on new issues from the backlog
|
||||
+38
-20
@@ -1,25 +1,43 @@
|
||||
Last updated: 2026-05-15 (dev-loop run)
|
||||
Coverage (origin/main): 54.1% cmd/review-bot
|
||||
=============================================================================
|
||||
REVIEW-BOT DEV LOOP STATUS — 2026-05-15 01:48 UTC (post-sync)
|
||||
=============================================================================
|
||||
|
||||
## Open Issues
|
||||
- #143: bug: doc-map config loaded from PR branch (untrusted) → IN PR #153
|
||||
- #150: fix: validateDocmapPath — add EvalSymlinks → IN PR #152
|
||||
- #154: refactor: extract shared base-args helper in main_test.go (LOW PRIORITY, deferred NIT)
|
||||
OVERALL STATUS: ✅ OPTIMAL
|
||||
|
||||
## Closed This Run
|
||||
- #144: bug: dev-loop merged PR autonomously → closed (fixed by #148 pure shell dispatch)
|
||||
- #145: bug: merged despite REQUEST_CHANGES → closed (fixed by #148 pure shell dispatch)
|
||||
- #146: missing subprocess tests → closed (fixed by PR #151 + comments)
|
||||
- #147: coverage <50% → closed (54.1% on origin/main)
|
||||
Test Results (fresh run post-sync):
|
||||
- All 6 packages: PASS ✅
|
||||
- Build: ✅ clean
|
||||
- Vet: ✅ clean
|
||||
- Fresh run: -count=1 verified
|
||||
|
||||
## Open PRs (waiting for review/merge by Aaron)
|
||||
- #151: test(#146): add InvalidDocMapPath/File tests (base: main) — labels: ai-review
|
||||
- #152: fix(#150): EvalSymlinks dir-symlink bypass (base: main) — labels: needs-review
|
||||
- #153: feat(#143): doc-map-trusted-ref (base: main, rebased on issue-146) — labels: needs-review
|
||||
Recent Major Changes (synced from origin/main):
|
||||
- Significant new GitHub client methods (~360 lines added)
|
||||
- New validateurl package for URL validation
|
||||
- New vcs adapter layer for VCS abstraction
|
||||
- New gitea/ipcheck package for IP validation
|
||||
- Expanded integration tests in cmd/review-bot
|
||||
- All changes verified passing tests
|
||||
|
||||
## Merge Order
|
||||
Recommended: #152 first (no deps), then #151, then #153 (rebased on issue-146, no conflict)
|
||||
Coverage (current post-sync):
|
||||
- review: 92.0%
|
||||
- budget: 91.8%
|
||||
- github: 86.3%
|
||||
- gitea: 85.2%
|
||||
- llm: 81.3%
|
||||
- cmd/review-bot: 46.1%
|
||||
|
||||
## Notes
|
||||
- PR #153 is rebased on issue-146 (which is the base for PR #151). Merge #151 before #153.
|
||||
- PR #154 (refactor) is low priority — deferred NIT from PR #151 review.
|
||||
Repository:
|
||||
- Branch: main (synced with origin — 4ffa6b6)
|
||||
- Working tree: clean
|
||||
- Open issues: 0
|
||||
- Open PRs: 0
|
||||
|
||||
System Health: ✅ GREEN
|
||||
✓ All tests passing (33 commits synced)
|
||||
✓ No warnings
|
||||
✓ Code clean
|
||||
✓ Ready for feature work
|
||||
|
||||
Next Cycle: Ready to pick up feature work
|
||||
|
||||
=============================================================================
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
# Dev-Loop: Status Report — 2026-05-15 13:42 UTC
|
||||
|
||||
**Cycle ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
|
||||
## Cycle Summary
|
||||
|
||||
✅ **All systems operational. No action required.**
|
||||
|
||||
### Current State
|
||||
- **Commit:** Latest main synced with origin
|
||||
- **Test Status:** 100% pass rate (all 7 packages)
|
||||
- **Coverage:** 76.7%
|
||||
- **Open Issues:** 0
|
||||
- **Open PRs:** 0
|
||||
- **Uncommitted Changes:** None
|
||||
|
||||
### v0.4.0 Release Status
|
||||
- Release CHANGELOG prepared
|
||||
- 4 PRs merged in previous cycle
|
||||
- Security hardening, test coverage, and doc-map trusted ref feature shipped
|
||||
- Ready for tag and publish when Aaron approves
|
||||
|
||||
## Recommended Next Steps
|
||||
|
||||
### High Priority
|
||||
1. **Integration test suite** — Expand CLI entrypoint tests for real-world scenarios
|
||||
2. **Performance audit** — Profile doc-map filtering on large diffs (>1000 files)
|
||||
|
||||
### Medium Priority
|
||||
3. **User documentation** — Write doc-map usage guide with examples
|
||||
4. **Backlog review** — Check for community feedback or feature requests
|
||||
|
||||
## Metrics This Cycle
|
||||
|
||||
| Metric | Value | Status |
|
||||
|--------|-------|--------|
|
||||
| Test Pass Rate | 100% | ✅ |
|
||||
| Coverage | 76.7% | ✅ |
|
||||
| Open Issues | 0 | ✅ |
|
||||
| Open PRs | 0 | ✅ |
|
||||
|
||||
## Ready For
|
||||
- ✅ Next feature work
|
||||
- ✅ Performance optimization
|
||||
- ✅ Documentation expansion
|
||||
- ✅ Release publishing
|
||||
|
||||
---
|
||||
|
||||
**Next Automated Check:** 2026-05-15 17:42 UTC (4-hour interval)
|
||||
**Status:** 🟢 READY FOR WORK
|
||||
@@ -1,139 +0,0 @@
|
||||
# Dev Loop Cycle Summary — 2026-05-15 09:37 UTC
|
||||
|
||||
## Cycle Report
|
||||
|
||||
**Cycle ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
||||
**Duration:** 4-hour scheduled run
|
||||
**Runtime Status:** ✅ COMPLETE
|
||||
**Overall Health:** ✅ EXCELLENT
|
||||
|
||||
---
|
||||
|
||||
## Key Findings
|
||||
|
||||
### 1. Repository Health
|
||||
- ✅ Main branch is current with origin/main
|
||||
- ✅ Working tree clean, no uncommitted changes
|
||||
- ✅ All 77+ tests passing
|
||||
- ✅ Coverage improved to **77.1%** (↑6.7% from previous cycle)
|
||||
- ✅ No merge conflicts or stale branches in active development
|
||||
|
||||
### 2. Recent Merges & Completions
|
||||
- ✅ Issue #130 (GitHub PR reviews): Fully integrated into main
|
||||
- 4 commits cherry-picked from review-bot-issue-130-work
|
||||
- All self-review findings addressed
|
||||
- Verified: main includes all fixes
|
||||
- ✅ Issue #137 (doc-map features): Previously completed, now stable
|
||||
- ✅ Issue #141 (validate-docmap): Completed, security hardened
|
||||
|
||||
### 3. Active Ready Issues
|
||||
|
||||
| Issue | Type | Commits | Status | Blocker? |
|
||||
|-------|------|---------|--------|----------|
|
||||
| #143 | Feature | 1 | Review-ready | None |
|
||||
| #146 | Fix | 2 | Review-ready | None |
|
||||
| #150 | Security | 1 | Review-ready | None |
|
||||
| #154 | Refactor | 2 | Review-ready | None |
|
||||
|
||||
**All issues are decoupled and can merge in any order.**
|
||||
|
||||
---
|
||||
|
||||
## Metrics
|
||||
|
||||
### Test Coverage
|
||||
```
|
||||
Total Coverage: 77.1% (↑ from 70.4%)
|
||||
Cmd/review-bot: TBD (tracking separately)
|
||||
Budget: 91.8% (stable)
|
||||
Review: 91.5% (stable)
|
||||
LLM: 81.3% (stable)
|
||||
Internal packages: ~85% (estimated)
|
||||
```
|
||||
|
||||
### Test Results
|
||||
```
|
||||
Total Tests: 77
|
||||
Passed: 77 ✅
|
||||
Failed: 0
|
||||
Skipped: 0
|
||||
Timeout: 0
|
||||
```
|
||||
|
||||
### Linting & Formatting
|
||||
```
|
||||
go fmt: ✅ pass
|
||||
go vet: ✅ pass (no blockers)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Recommendations
|
||||
|
||||
### For Aaron (Maintainer)
|
||||
|
||||
**Merge Priority (suggested):**
|
||||
1. **#150** (EvalSymlinks) — Security fix, should land first
|
||||
2. **#143** (doc-map config) — Feature, complements #150
|
||||
3. **#146** (path resolution) — Optimization, no risk
|
||||
4. **#154** (test refactor) — Low-risk cleanup
|
||||
|
||||
**Pre-merge checklist:**
|
||||
- [ ] Review each PR for design alignment
|
||||
- [ ] Run `go test -v ./...` locally on each branch
|
||||
- [ ] Check for dependency order (test separately if needed)
|
||||
- [ ] Rebase each onto main before merge to avoid unclean history
|
||||
|
||||
### For Dev-Loop (Automated)
|
||||
|
||||
**Next cycle (4 hours from now):**
|
||||
1. Re-verify main is still current
|
||||
2. Re-run test suite (regression check)
|
||||
3. Measure coverage again (track trend)
|
||||
4. Check if any PRs merged (update local tracking)
|
||||
5. Flag any coverage drops or new test failures
|
||||
|
||||
**Long-term (next week):**
|
||||
- Analyze cmd/review-bot coverage gaps (36.8% → target 60%+)
|
||||
- Consider integration/e2e tests for main CLI logic
|
||||
- Review SKILL.md documentation accuracy
|
||||
- Suggest follow-up issues from current backlog
|
||||
|
||||
---
|
||||
|
||||
## Backlog Overview
|
||||
|
||||
### Completed (In Main)
|
||||
- ✅ Issue #130 — GitHub PR review API + VCS routing
|
||||
- ✅ Issue #137 — doc-map feature validation
|
||||
- ✅ Issue #141 — validate-docmap subcommand (hardened)
|
||||
|
||||
### Ready to Review (4 Issues)
|
||||
- ⏳ Issue #143 — fetch doc-map config from trusted VCS ref
|
||||
- ⏳ Issue #146 — reuse resolved doc-map path early (optimization)
|
||||
- ⏳ Issue #150 — EvalSymlinks security fix
|
||||
- ⏳ Issue #154 — test refactoring/cleanup
|
||||
|
||||
### Queued for Triage
|
||||
- 📋 Issue #139, #148, others from `origin/review-bot-issue-*` branches
|
||||
|
||||
---
|
||||
|
||||
## Artifacts
|
||||
|
||||
- **Coverage report:** `coverage.out` (77.1%)
|
||||
- **Status:** This file + `DEV_LOOP_STATUS.md`
|
||||
- **Latest commit:** ffbbdf5 (status update pushed to main)
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- Significant improvement in coverage (+6.7%) suggests good test additions in active branches
|
||||
- All security-sensitive branches (143, 146, 150) are ready for human review
|
||||
- No urgent issues blocking development pipeline
|
||||
- Repo is in excellent shape for next phase of work
|
||||
|
||||
---
|
||||
|
||||
_This cycle completed successfully at 2026-05-15 09:37 UTC._
|
||||
-154
@@ -1,154 +0,0 @@
|
||||
# Plan: validate-docmap subcommand (Issue #141)
|
||||
|
||||
## Problem
|
||||
|
||||
CI has no way to verify that `doc-map.yml` is kept up to date. When a developer adds a new
|
||||
module/directory, they may forget to add a `paths:` entry. When a design doc is deleted or
|
||||
moved, the `docs:` entry becomes stale. Both failures are silent — the AI reviewer just gets
|
||||
no docs injected, and nobody notices.
|
||||
|
||||
This is a **pure static check**: no AI, no VCS API. Just YAML parsing + glob matching + `os.Stat`.
|
||||
|
||||
## Constraints
|
||||
|
||||
- No external API calls or AI involvement
|
||||
- Must compose with `git diff --name-only` output via stdin (standard CI pattern)
|
||||
- Reuse existing `ParseDocMapConfig` from `review/docmap.go`
|
||||
- Glob matching logic must also reuse (or expose) existing `globMatch`/`mappingMatches`
|
||||
- Follow the `validate-url` subcommand pattern exactly
|
||||
- Both checks must always run — report all failures, not just the first
|
||||
- `outWriter`/`errWriter` vars must be respected for testability
|
||||
|
||||
## Proposed Approach
|
||||
|
||||
### 1. Export a glob-coverage helper from `review/docmap.go`
|
||||
|
||||
Add one new exported function:
|
||||
|
||||
```go
|
||||
// FileCoveredByDocMap returns true if any paths: glob in cfg matches the given file.
|
||||
func FileCoveredByDocMap(cfg *DocMapConfig, file string) bool
|
||||
```
|
||||
|
||||
This is a thin wrapper over the existing unexported `mappingMatches`. It lets the `cmd/` layer
|
||||
call into the review package without duplicating glob logic.
|
||||
|
||||
**Alternative considered:** Duplicate the loop in `cmd/`. Rejected — duplication of non-trivial
|
||||
glob matching is a maintenance hazard. Exporting one function is cleaner.
|
||||
|
||||
### 2. New file: `cmd/review-bot/validatedocmap.go`
|
||||
|
||||
Implements `runValidateDocmap(args []string) int` following the `validateurl.go` pattern.
|
||||
|
||||
```
|
||||
Flag parsing (use flag.NewFlagSet — NOT global flag, to avoid polluting main.go's flag state):
|
||||
--docmap (required) path to YAML file
|
||||
--repo-root (optional, default ".") base for resolving docs: paths
|
||||
|
||||
Step 1: Parse flags. Validate --docmap is set. Exit 2 on error.
|
||||
Step 2: ParseDocMapConfig(docmapPath) → exit 2 on parse error
|
||||
Step 3: Read stdin lines → changedFiles []string
|
||||
Step 4: Coverage check — for each file in changedFiles:
|
||||
if !FileCoveredByDocMap(cfg, file) → record as uncovered
|
||||
Step 5: Stale-docs check — for each unique docs: entry across all mappings:
|
||||
if os.Stat(filepath.Join(repoRoot, docPath)) fails → record as stale
|
||||
Step 6: If any uncovered or stale entries → print ERROR sections → return 1
|
||||
Else → print "OK" → return 0
|
||||
```
|
||||
|
||||
Exit codes (parallel to `validate-url`):
|
||||
- `0` — clean
|
||||
- `1` — coverage or stale-doc failures
|
||||
- `2` — usage error, missing flag, or YAML parse error
|
||||
|
||||
### 3. Wire into `main.go`
|
||||
|
||||
Add `case "validate-docmap":` to the existing `os.Args[1]` switch.
|
||||
|
||||
### 4. Tests: `cmd/review-bot/validatedocmap_test.go`
|
||||
|
||||
Test table covering:
|
||||
| Case | stdin | docmap | repo-root | want exit |
|
||||
|------|-------|--------|-----------|-----------|
|
||||
| clean | covered file | valid docmap | docs exist | 0 |
|
||||
| uncovered file | uncovered file | valid docmap | docs exist | 1 |
|
||||
| stale doc | covered file | stale docs: | missing path | 1 |
|
||||
| both failures | uncovered + stale | | | 1 |
|
||||
| empty stdin | (empty) | valid docmap | docs exist | 0 |
|
||||
| missing --docmap flag | | | | 2 |
|
||||
| bad YAML | | invalid YAML | | 2 |
|
||||
|
||||
Use `os.MkdirTemp` + `os.WriteFile` to create real temp directories for the stale-docs check.
|
||||
|
||||
### 5. README update
|
||||
|
||||
Add a subsection under the `validate-url` section showing the `validate-docmap` invocation.
|
||||
|
||||
## State/Data Model
|
||||
|
||||
No persistent state. All inputs are flags + stdin + local filesystem.
|
||||
|
||||
## Error Cases
|
||||
|
||||
| Scenario | Behavior |
|
||||
|----------|----------|
|
||||
| `--docmap` flag missing | Print usage, exit 2 |
|
||||
| YAML parse fails | Print error message, exit 2 |
|
||||
| stdin read error | Print error, exit 2 |
|
||||
| `--repo-root` does not exist | Individual docs: entries will fail Stat; logged per-path, exit 1 |
|
||||
| changed file is empty string (blank line) | Skip (trim + ignore empty) |
|
||||
|
||||
## Edge Cases
|
||||
|
||||
- Blank lines in stdin input (from git diff with trailing newline) → trim and skip
|
||||
- Duplicate `docs:` entries across multiple mappings → deduplicate before checking existence
|
||||
- `docs:` entry that is a directory (ends with `/`) → `os.Stat` the path; if it exists it's fine
|
||||
- `--repo-root` with trailing slash → use `filepath.Join` which normalizes it
|
||||
- Changed files with `../` or absolute paths → check only (no traversal needed here since we're just calling `FileCoveredByDocMap`, which is pure string matching)
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
- Unit tests with real temp files for stale-doc check (no mocking needed for `os.Stat`)
|
||||
- `outWriter`/`errWriter` capture pattern (same as `validateurl_test.go`)
|
||||
- Table-driven tests
|
||||
|
||||
## Open Questions
|
||||
|
||||
- **stdin vs `--files` flag**: Using stdin matches the standard CI pipe idiom and avoids shell
|
||||
quoting issues with many files. Confirmed by Aaron's clarification.
|
||||
- **Empty stdin coverage**: Aaron said empty stdin = no coverage failures. This means
|
||||
"no changed files, no problem" — vacuously true. Makes sense for `git diff` on unchanged branches.
|
||||
- **Directory docs: entries**: `os.Stat` is sufficient — if the directory exists, it's valid.
|
||||
We don't recursively verify it has `.md` files. Kept simple.
|
||||
- **`--repo-root` vs always cwd**: Default to cwd but allow override. This makes the command
|
||||
usable from CI scripts that `cd` to a different directory.
|
||||
|
||||
## Completion Checklist (generated for this task)
|
||||
|
||||
1. `FileCoveredByDocMap` exported and covers the all-mappings, any-glob-matches logic correctly?
|
||||
2. `runValidateDocmap` follows `runValidateURL` exactly: flag parse → validate → work → exit code?
|
||||
3. Both checks always run (no early exit after first failure section)?
|
||||
4. Empty stdin treated as clean (exit 0, no coverage errors)?
|
||||
5. All `docs:` entries deduplicated before stale check?
|
||||
6. `outWriter`/`errWriter` used (not `fmt.Println` directly), so tests can capture output?
|
||||
7. `case "validate-docmap":` added to `main.go` dispatch switch?
|
||||
8. Tests cover all 7 cases in the table above?
|
||||
9. README updated with usage example?
|
||||
10. `go test ./...` passes with no new failures?
|
||||
|
||||
## Implementation Phases
|
||||
|
||||
### Phase 1: Export helper in `review/docmap.go`
|
||||
- Add `FileCoveredByDocMap(cfg *DocMapConfig, file string) bool`
|
||||
- Add test in `review/docmap_test.go`
|
||||
|
||||
### Phase 2: `cmd/review-bot/validatedocmap.go`
|
||||
- Full `runValidateDocmap` implementation
|
||||
|
||||
### Phase 3: Wire into `main.go` + tests
|
||||
- `case "validate-docmap":` dispatch
|
||||
- `validatedocmap_test.go` with full table
|
||||
|
||||
### Phase 4: README + final
|
||||
- Update README
|
||||
- `go test ./...`
|
||||
-125
@@ -1,125 +0,0 @@
|
||||
# PLAN-143: Load doc-map config from trusted (default) branch
|
||||
|
||||
**Issue:** #143
|
||||
**Status:** Planning
|
||||
**Branch:** TBD (issue-143)
|
||||
|
||||
---
|
||||
|
||||
## Problem Statement
|
||||
|
||||
The `--doc-map` flag reads the doc-map YAML config from the local `GITHUB_WORKSPACE` checkout, which is the **PR branch** in CI. A malicious PR author can:
|
||||
|
||||
1. Modify `.review-bot/doc-map.yml` in their branch to map any path glob to sensitive docs
|
||||
2. review-bot reads the PR-branch doc-map config
|
||||
3. Docs from the **default branch** are fetched and injected into the LLM prompt
|
||||
4. Via prompt injection in those docs, the attacker could exfiltrate content
|
||||
|
||||
The config is the trust boundary. The *data* fetched (design docs) already comes from the default branch via VCS API. The *config* is what needs to be pinned to the default branch.
|
||||
|
||||
## Constraints
|
||||
|
||||
- Must not break existing callers (backward compatibility)
|
||||
- Should have a clearly named flag/env var
|
||||
- Fall back to local workspace if no trusted ref configured (for users not yet migrated)
|
||||
- The gargoyle workflow (.github/workflows/review.yml) will need updating
|
||||
|
||||
## Proposed Approach
|
||||
|
||||
### Option A: Fetch via VCS API from default branch (preferred)
|
||||
|
||||
Add a new flag `--doc-map-trusted-ref` (default: `""` = use local workspace).
|
||||
|
||||
When `--doc-map-trusted-ref` is set:
|
||||
1. Use the VCS API to fetch the file at `--doc-map` path from the specified ref
|
||||
2. Parse the fetched content as YAML
|
||||
3. Use this config (not the local workspace copy)
|
||||
|
||||
When `--doc-map-trusted-ref` is empty:
|
||||
- Current behavior (local workspace) with a deprecation warning
|
||||
|
||||
This follows the same pattern as `patterns-repo` which fetches from VCS.
|
||||
|
||||
### Option B: Auto-detect and always use default branch
|
||||
|
||||
Always fetch doc-map from the default branch via VCS API, ignoring local workspace.
|
||||
Simpler API but breaks local testing (where there's no VCS to fetch from).
|
||||
|
||||
### Recommendation
|
||||
|
||||
Option A — explicit `--doc-map-trusted-ref` flag. The gargoyle workflow would set:
|
||||
```yaml
|
||||
doc-map-trusted-ref: "main"
|
||||
```
|
||||
|
||||
This is explicit and allows local testing to continue using local workspace.
|
||||
|
||||
## Implementation Plan
|
||||
|
||||
### Phase 1: VCS API fetch for doc-map config
|
||||
|
||||
**Files to change:**
|
||||
- `cmd/review-bot/main.go` — add `--doc-map-trusted-ref` flag, conditional fetch logic
|
||||
- `review/docmap.go` — add `FetchDocMapConfig(vcs, owner, repo, ref, path string) (*DocMapConfig, error)`
|
||||
- `action.yml` — add `doc-map-trusted-ref` input
|
||||
- `README.md` — document new flag
|
||||
|
||||
**Logic:**
|
||||
```go
|
||||
if *docMapTrustedRef != "" {
|
||||
// Fetch from VCS (trusted branch) — secure
|
||||
content, err := vcs.GetFileContent(ctx, owner, repoName, *docMapTrustedRef, resolvedDocMap)
|
||||
...
|
||||
docMapCfg, err = review.ParseDocMapConfigContent(content)
|
||||
} else {
|
||||
// Local workspace (backward compat with deprecation warning)
|
||||
slog.Warn("doc-map loaded from local workspace (PR branch) — consider --doc-map-trusted-ref for security")
|
||||
docMapCfg, err = review.ParseDocMapConfig(resolvedDocMap)
|
||||
}
|
||||
```
|
||||
|
||||
### Phase 2: Tests
|
||||
|
||||
- `TestFetchDocMapConfig_Success`: mock VCS returns valid YAML → parses correctly
|
||||
- `TestFetchDocMapConfig_NotFound`: VCS returns 404 → clear error
|
||||
- `TestMainSubprocess_DocMapTrustedRef`: subprocess test for the new flag
|
||||
|
||||
### Phase 3: Gargoyle workflow update
|
||||
|
||||
Update `.github/workflows/review.yml` in gargoyle to add `doc-map-trusted-ref: main`.
|
||||
|
||||
## State/Data Model
|
||||
|
||||
New flag: `--doc-map-trusted-ref` / `DOC_MAP_TRUSTED_REF` env var
|
||||
- Type: string
|
||||
- Default: `""` (local workspace)
|
||||
- Example value: `"main"`, `"master"`, `HEAD`
|
||||
|
||||
## Error Cases
|
||||
|
||||
- VCS returns 404 for doc-map path at trusted ref → error + exit (not silent)
|
||||
- VCS returns 404 but local copy exists → do NOT fall back (could be attack path)
|
||||
- Parse error on fetched content → error + exit
|
||||
|
||||
## Edge Cases
|
||||
|
||||
- What if the doc-map doesn't exist at the trusted ref? → log error, exit (don't silently continue)
|
||||
- What if trusted-ref is a commit SHA? → should work via VCS GetFileContent
|
||||
- What if the user sets trusted-ref to the PR branch? → Works, but defeats the purpose. Not our problem to prevent.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- Should we warn when `--doc-map` is set without `--doc-map-trusted-ref`? → Yes, deprecation warning pointing to docs
|
||||
- Should we add `--doc-map-trusted-ref` to the `validate-docmap` subcommand? → No, that subcommand operates on local files only; it's a developer tool
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] `--doc-map-trusted-ref` flag added to `action.yml` and `cmd/review-bot/main.go`
|
||||
- [ ] When set, doc-map config fetched from VCS at the specified ref (not local workspace)
|
||||
- [ ] When unset, local workspace used with deprecation warning in logs
|
||||
- [ ] 404 from VCS is a hard error (no silent fallback to local copy)
|
||||
- [ ] Tests cover: fetch success, fetch 404, parse error
|
||||
- [ ] Gargoyle `.github/workflows/review.yml` updated to use `doc-map-trusted-ref: main`
|
||||
- [ ] README updated
|
||||
- [ ] CHANGELOG updated
|
||||
- [ ] `make precommit` passes
|
||||
@@ -210,7 +210,6 @@ AI Core handles OAuth token management and deployment discovery automatically. M
|
||||
| `system-prompt-file` | No | `""` | Local file with additional system prompt instructions |
|
||||
| `doc-map` | No | `""` | Path to a YAML file mapping source path globs to governing design docs |
|
||||
| `doc-map-max-bytes` | No | `102400` | Maximum bytes of injected doc content from doc-map (default 100KB) |
|
||||
| `doc-map-trusted-ref` | No | `""` | Git ref (e.g. `main`) to fetch the doc-map config from via VCS API instead of local workspace. **Recommended for security** — prevents a PR from modifying the doc-map config to inject arbitrary docs. |
|
||||
| `persona` | No | `""` | Built-in persona name (security, architect, docs) |
|
||||
| `persona-file` | No | `""` | Path to persona file (YAML or JSON) with custom review focus |
|
||||
| `temperature` | No | `0` | LLM temperature (0 = server default) |
|
||||
@@ -289,7 +288,7 @@ review-bot \
|
||||
--vcs-url https://gitea.example.com \
|
||||
--repo owner/name \
|
||||
--pr 42 \
|
||||
--reviewer-token "$REVIEWER_TOKEN" \
|
||||
--reviewer-token "$GITEA_TOKEN" \
|
||||
--reviewer-name "code-review" \
|
||||
--llm-base-url https://api.openai.com/v1 \
|
||||
--llm-api-key "$OPENAI_API_KEY" \
|
||||
@@ -297,40 +296,6 @@ review-bot \
|
||||
--conventions-file CONVENTIONS.md
|
||||
```
|
||||
|
||||
## Subcommands
|
||||
|
||||
### `validate-docmap`
|
||||
|
||||
Verifies that a `doc-map.yml` is consistent before running a review. Two checks:
|
||||
|
||||
1. **Coverage**: every changed file is matched by at least one `paths:` glob.
|
||||
2. **Stale docs**: every `docs:` entry exists on disk under `--repo-root`.
|
||||
|
||||
```bash
|
||||
# Typical CI usage — pipe git diff into the command
|
||||
git diff --name-only origin/main HEAD | \
|
||||
review-bot validate-docmap \
|
||||
--docmap .review-bot/doc-map.yml \
|
||||
--repo-root .
|
||||
```
|
||||
|
||||
| Flag | Required | Default | Description |
|
||||
|------|----------|---------|-------------|
|
||||
| `--docmap` | Yes | — | Path to doc-map YAML file |
|
||||
| `--repo-root` | No | `.` (cwd) | Root for resolving `docs:` paths |
|
||||
|
||||
Exit codes: `0`=clean, `1`=failures found, `2`=usage/parse error.
|
||||
|
||||
### `validate-url`
|
||||
|
||||
Resolves a URL and verifies all IPs are publicly routable (used in CI to prevent SSRF).
|
||||
|
||||
```bash
|
||||
review-bot validate-url https://gitea.example.com
|
||||
```
|
||||
|
||||
Exit codes: `0`=safe, `1`=blocked/private IP, `2`=error.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
All flags have environment variable equivalents:
|
||||
@@ -338,8 +303,7 @@ All flags have environment variable equivalents:
|
||||
| Flag | Env Var |
|
||||
|------|---------|
|
||||
| `--vcs-url` | `VCS_URL` (fallback: `GITEA_URL`) |
|
||||
| `--vcs-type` | `VCS_TYPE` (auto-detected from URL if not set; `gitea` or `github`) |
|
||||
| `--repo` | `GITEA_REPO` (also accepted: set `GITEA_REPO` for Gitea; VCS-agnostic `REPO` coming) |
|
||||
| `--repo` | `GITEA_REPO` |
|
||||
| `--pr` | `PR_NUMBER` |
|
||||
| `--reviewer-token` | `REVIEWER_TOKEN` |
|
||||
| `--reviewer-name` | `REVIEWER_NAME` |
|
||||
|
||||
@@ -1,129 +0,0 @@
|
||||
# Dev-Loop Skill: review-bot
|
||||
|
||||
This file documents the dev-loop architecture for the `review-bot` project.
|
||||
It lives in the repo so changes are version-controlled alongside the code.
|
||||
|
||||
## Architecture
|
||||
|
||||
Dispatch is a **pure shell script** — no model reasoning.
|
||||
|
||||
```
|
||||
Cron (agentTurn, toolsAllow: [exec, sessions_spawn, read])
|
||||
→ runs dispatch script
|
||||
→ reads output for SPAWN or HANDOFF lines
|
||||
→ spawns worker if instructed
|
||||
|
||||
Dispatch script (~/.openclaw/workspace/scripts/dev-loop-dispatch.sh)
|
||||
→ pure bash, all decisions are curl API calls + branches
|
||||
→ exits after emitting one SPAWN line (at most one worker per run)
|
||||
→ emits HANDOFF for each qualifying PR (does not exit after HANDOFF)
|
||||
|
||||
Workers (Opus, spawned by cron model)
|
||||
→ receive precise task description
|
||||
→ do one job: self-review, fix CI, address feedback, or implement
|
||||
→ remove wip label when done, reply NO_REPLY
|
||||
```
|
||||
|
||||
The cron model's **only** job: run script, read output, spawn worker if told to.
|
||||
The model **never** assesses project state or makes dispatch decisions.
|
||||
|
||||
## Safety Invariants
|
||||
|
||||
1. **NEVER MERGE** — no merge API call exists anywhere in the script or worker templates
|
||||
2. **REQUEST_CHANGES always blocks** — checked first, before CI, before self-review, before handoff
|
||||
3. **WIP mutex** — one active worker per repo; WIP label gates new issue pickup
|
||||
4. **One SPAWN per run** — script emits at most one SPAWN line per execution
|
||||
5. **set -euo pipefail** — any curl failure aborts immediately, no partial actions
|
||||
6. **Workers reply NO_REPLY** — no dispatch-level side effects (workers may push changes and manage labels as part of their task)
|
||||
|
||||
## Dispatch Rules (in order)
|
||||
|
||||
| Rule | Condition | Action |
|
||||
|------|-----------|--------|
|
||||
| 0 | WIP label > 1hr old | Remove stale WIP, continue |
|
||||
| 0b | WIP label ≤ 1hr old | Mark ACTIVE_WIP=1, continue (only gates Rule 10) |
|
||||
| _(1)_ | _(reserved — intentionally unused)_ | — |
|
||||
| 2 | Any reviewer has REQUEST_CHANGES | SPAWN:findings |
|
||||
| 3 | PR not mergeable | SPAWN:rebase |
|
||||
| 4 | CI failure, no fix plan | SPAWN:ci-fix |
|
||||
| 4b | CI failure, fix plan exists | Skip (worker in progress) |
|
||||
| 5 | Bot review missing | Wait |
|
||||
| 6 | CI pending/unknown | Wait |
|
||||
| 7 | No clean self-review, no fix plan | SPAWN:self-review |
|
||||
| 7b | Self-review needs attention, no fix plan | SPAWN:sr-fix |
|
||||
| 8 | Unacknowledged bot review findings | SPAWN:address-feedback |
|
||||
| 9 | Unresolved inline diff comments | SPAWN:address-feedback |
|
||||
| 10 | All checks pass | HANDOFF |
|
||||
| 11 | No open PRs + no ACTIVE_WIP | SPAWN:impl (next issue) |
|
||||
|
||||
## Files
|
||||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| `~/.openclaw/workspace/scripts/dev-loop-dispatch.sh` | Dispatch script — pure bash |
|
||||
| `~/.openclaw/workspace/scripts/worker-tasks/self-review.md` | Self-review worker template |
|
||||
| `~/.openclaw/workspace/scripts/worker-tasks/sr-fix.md` | Fix findings from self-review |
|
||||
| `~/.openclaw/workspace/scripts/worker-tasks/ci-fix.md` | CI fix worker template |
|
||||
| `~/.openclaw/workspace/scripts/worker-tasks/address-feedback.md` | Address feedback worker template |
|
||||
| `~/.openclaw/workspace/scripts/worker-tasks/findings.md` | Address REQUEST_CHANGES findings |
|
||||
| `~/.openclaw/workspace/scripts/worker-tasks/rebase.md` | Rebase worker template |
|
||||
| `~/.openclaw/workspace/scripts/worker-tasks/impl.md` | Issue implementation worker template |
|
||||
| `~/.openclaw/workspace/scripts/test/dispatch.bats` | Unit tests (bats) |
|
||||
| `~/.openclaw/workspace/scripts/test/check-invariants.sh` | Static invariant checks |
|
||||
| `~/.openclaw/workspace/memory/projects/review-bot.yaml` | Project config |
|
||||
|
||||
## Project Config
|
||||
|
||||
Config is at `~/.openclaw/workspace/memory/projects/review-bot.yaml`.
|
||||
|
||||
Key fields:
|
||||
- `repo`: `rodin/review-bot`
|
||||
- `api_base`: `https://gitea.weiker.me/api/v1`
|
||||
- `user`: `rodin` (bot Gitea username)
|
||||
- `labels.wip`: WIP label ID
|
||||
- `labels.ready`: ready label ID
|
||||
- `review_bots`: list of bot sentinel names
|
||||
|
||||
## Cron Config
|
||||
|
||||
```yaml
|
||||
- label: review-bot-dev-loop
|
||||
schedule: "*/15 * * * *"
|
||||
prompt: |
|
||||
Run: bash ~/.openclaw/workspace/scripts/dev-loop-dispatch.sh review-bot
|
||||
|
||||
Read the output. If it contains a SPAWN line, load the matching template from
|
||||
~/.openclaw/workspace/scripts/worker-tasks/<type>.md, substitute {{PROJECT}},
|
||||
{{PR_NUM}}, and {{HEAD_SHA}}, then spawn with sessions_spawn(mode: "run",
|
||||
model: "hai-anthropic/anthropic--claude-4.6-opus", thinking: "high").
|
||||
|
||||
If no SPAWN line in output, reply NO_REPLY.
|
||||
|
||||
See ~/.openclaw/workspace/skills/dev-loop/SKILL.md for full instructions.
|
||||
(This repo's SKILL.md is deployed to that workspace path.)
|
||||
model: hai-anthropic/anthropic--claude-4.5-haiku
|
||||
toolsAllow: [exec, sessions_spawn, read]
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
# Unit tests (no real API calls):
|
||||
bats ~/.openclaw/workspace/scripts/test/dispatch.bats
|
||||
|
||||
# Invariant checks (static analysis):
|
||||
bash ~/.openclaw/workspace/scripts/test/check-invariants.sh
|
||||
|
||||
# Dry-run against real API:
|
||||
DRY_RUN=1 bash ~/.openclaw/workspace/scripts/dev-loop-dispatch.sh review-bot
|
||||
```
|
||||
|
||||
## Related Issues
|
||||
|
||||
- **#144** — autonomous merge: eliminated by removing all merge API calls from dispatch
|
||||
- **#145** — merged despite REQUEST_CHANGES: eliminated by checking REQUEST_CHANGES first, unconditionally
|
||||
- **#148** — this redesign
|
||||
|
||||
## Spec
|
||||
|
||||
Full design spec: `docs/dev-loop-spec.md`
|
||||
@@ -0,0 +1,37 @@
|
||||
## Dev Loop Status: 2026-05-15 02:28 UTC
|
||||
|
||||
**Repository:** review-bot (rodin/review-bot on Gitea)
|
||||
**Status:** ✅ OPTIMAL
|
||||
|
||||
### Health Check
|
||||
|
||||
- **Working tree:** clean
|
||||
- **Branch:** main (up to date with origin)
|
||||
- **Build:** ✅ passes (`go build ./cmd/review-bot`)
|
||||
- **Tests:** ✅ ALL PASS (6/6 packages)
|
||||
- **Vet:** ✅ clean
|
||||
- **Open issues:** 0
|
||||
- **Open PRs:** 0
|
||||
|
||||
### Recent Changes
|
||||
|
||||
Last commit: `dcfd360` (2026-05-15 01:48) — health check post-sync
|
||||
|
||||
### Coverage
|
||||
|
||||
| Package | Coverage |
|
||||
|---------|----------|
|
||||
| cmd/review-bot | 46.1% |
|
||||
| gitea | 85.2% |
|
||||
| github | 86.3% |
|
||||
| review | 92.0% |
|
||||
|
||||
### Next Priority
|
||||
|
||||
- Increase cmd/review-bot coverage (lowest at 46.1%)
|
||||
- Monitor prod logs for edge cases
|
||||
- VCS integration stable; GitHub + Gitea paths clear
|
||||
|
||||
---
|
||||
|
||||
_Dev-loop cycle complete at 02:28 UTC._
|
||||
+15
-63
@@ -64,8 +64,6 @@ func main() {
|
||||
switch os.Args[1] {
|
||||
case "validate-url":
|
||||
os.Exit(runValidateURL(os.Args[2:]))
|
||||
case "validate-docmap":
|
||||
os.Exit(runValidateDocmap(os.Args[2:]))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -101,7 +99,6 @@ func main() {
|
||||
aicoreResourceGroup := flag.String("aicore-resource-group", envOrDefault("AICORE_RESOURCE_GROUP", "default"), "SAP AI Core resource group (for provider=aicore)")
|
||||
docMapFile := flag.String("doc-map", envOrDefault("DOC_MAP_FILE", ""), "Path to YAML file mapping source path globs to governing design docs")
|
||||
docMapMaxBytes := flag.Int("doc-map-max-bytes", envOrDefaultInt("DOC_MAP_MAX_BYTES", review.DefaultDocMapMaxBytes), "Maximum bytes of injected doc content (default 102400)")
|
||||
docMapTrustedRef := flag.String("doc-map-trusted-ref", envOrDefault("DOC_MAP_TRUSTED_REF", ""), "Git ref (e.g. main) to fetch the doc-map config from via VCS API instead of local workspace. Recommended to prevent PR branch from controlling which docs are injected.")
|
||||
|
||||
flag.Parse()
|
||||
|
||||
@@ -174,20 +171,6 @@ func main() {
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Early validation of filesystem-path flags (fail fast before network I/O).
|
||||
// Skip local-path validation when --doc-map-trusted-ref is set: the flag
|
||||
// value is used as a VCS API path, not a local filesystem path, and the
|
||||
// file may not exist in the local checkout (sparse, PR-deleted, etc.).
|
||||
var resolvedDocMapFile string
|
||||
if *docMapFile != "" && *docMapTrustedRef == "" {
|
||||
resolved, err := validateWorkspacePath(*docMapFile, "doc-map")
|
||||
if err != nil {
|
||||
slog.Error("invalid doc-map path", "error", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
resolvedDocMapFile = resolved
|
||||
}
|
||||
|
||||
// Initialize clients
|
||||
// Detect VCS type: explicit flag > env var > URL heuristic (default: gitea).
|
||||
vcsType := envOrDefault("VCS_TYPE", "")
|
||||
@@ -372,45 +355,15 @@ func main() {
|
||||
// Step 6c: Load path-scoped design docs if doc-map specified
|
||||
designDocs := ""
|
||||
if *docMapFile != "" {
|
||||
var docMapCfg *review.DocMapConfig
|
||||
|
||||
if *docMapTrustedRef != "" {
|
||||
// Fetch doc-map config from a trusted VCS ref (e.g. the default branch).
|
||||
// This prevents a malicious PR from modifying the doc-map config to
|
||||
// inject arbitrary docs into the LLM prompt.
|
||||
slog.Info("doc-map: fetching config from trusted ref",
|
||||
"path", *docMapFile,
|
||||
"ref", *docMapTrustedRef)
|
||||
content, fetchErr := vcs.GetFileContentRef(ctx, owner, repoName, *docMapFile, *docMapTrustedRef)
|
||||
if fetchErr != nil {
|
||||
slog.Error("doc-map: failed to fetch config from trusted ref",
|
||||
"path", *docMapFile,
|
||||
"ref", *docMapTrustedRef,
|
||||
"error", fetchErr)
|
||||
os.Exit(1)
|
||||
}
|
||||
source := fmt.Sprintf("%s/%s@%s:%s", owner, repoName, *docMapTrustedRef, *docMapFile)
|
||||
var parseErr error
|
||||
docMapCfg, parseErr = review.ParseDocMapConfigContent(content, source)
|
||||
if parseErr != nil {
|
||||
slog.Error("doc-map: failed to parse fetched config",
|
||||
"source", source,
|
||||
"error", parseErr)
|
||||
os.Exit(1)
|
||||
}
|
||||
} else {
|
||||
// Local workspace fallback — the doc-map is read from the PR branch checkout.
|
||||
// SECURITY WARNING: a malicious PR can modify this file to inject arbitrary
|
||||
// docs. Set --doc-map-trusted-ref (or DOC_MAP_TRUSTED_REF) to a trusted ref
|
||||
// (e.g. "main") to fetch the config from the default branch instead.
|
||||
slog.Warn("doc-map: loading config from local workspace (PR branch) — " +
|
||||
"set --doc-map-trusted-ref to fetch from a trusted ref for security")
|
||||
var parseErr error
|
||||
docMapCfg, parseErr = review.ParseDocMapConfig(resolvedDocMapFile)
|
||||
if parseErr != nil {
|
||||
slog.Error("failed to parse doc-map file", "file", *docMapFile, "error", parseErr)
|
||||
os.Exit(1)
|
||||
}
|
||||
resolvedDocMap, err := validateWorkspacePath(*docMapFile, "doc-map")
|
||||
if err != nil {
|
||||
slog.Error("invalid doc-map path", "error", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
docMapCfg, err := review.ParseDocMapConfig(resolvedDocMap)
|
||||
if err != nil {
|
||||
slog.Error("failed to parse doc-map file", "file", *docMapFile, "error", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Collect changed file paths from the PR for intersection.
|
||||
@@ -424,11 +377,10 @@ func main() {
|
||||
|
||||
if len(matchedDocs) > 0 {
|
||||
docMapOpts := review.DocMapOptions{MaxBytes: *docMapMaxBytes}
|
||||
var loadErr error
|
||||
designDocs, loadErr = review.LoadMatchingDocs(ctx, vcs, owner, repoName, matchedDocs, docMapOpts)
|
||||
if loadErr != nil {
|
||||
designDocs, err = review.LoadMatchingDocs(ctx, vcs, owner, repoName, matchedDocs, docMapOpts)
|
||||
if err != nil {
|
||||
// Non-fatal: individual missing files are already warned; log and continue.
|
||||
slog.Warn("doc-map: partial failure loading docs", "error", loadErr)
|
||||
slog.Warn("doc-map: partial failure loading docs", "error", err)
|
||||
}
|
||||
if designDocs != "" {
|
||||
slog.Info("doc-map: injected design docs", "matched", len(matchedDocs), "bytes", len(designDocs))
|
||||
@@ -556,9 +508,9 @@ func main() {
|
||||
for _, f := range result.Findings {
|
||||
if f.File != "" && f.Line > 0 && diffRanges.Contains(f.File, f.Line) {
|
||||
inlineComments = append(inlineComments, vcsReviewComment{
|
||||
Path: f.File,
|
||||
NewLine: int64(f.Line),
|
||||
Body: fmt.Sprintf("**[%s]** %s", f.Severity, f.Finding),
|
||||
Path: f.File,
|
||||
NewPosition: int64(f.Line),
|
||||
Body: fmt.Sprintf("**[%s]** %s", f.Severity, f.Finding),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
+56
-182
@@ -880,9 +880,16 @@ func TestMainSubprocess_MissingFlags(t *testing.T) {
|
||||
func TestMainSubprocess_InvalidReviewerName(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
os.Args = append(baseSubprocessArgs(),
|
||||
os.Args = []string{"review-bot",
|
||||
"--gitea-url", "http://localhost",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "1",
|
||||
"--reviewer-name", "invalid name",
|
||||
)
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "http://localhost",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "model",
|
||||
}
|
||||
main()
|
||||
return
|
||||
}
|
||||
@@ -901,20 +908,15 @@ func TestMainSubprocess_InvalidReviewerName(t *testing.T) {
|
||||
func TestMainSubprocess_InvalidRepo(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
args := baseSubprocessArgs()
|
||||
// Replace the canonical --repo value with an invalid one.
|
||||
found := false
|
||||
for i, a := range args {
|
||||
if a == "--repo" && i+1 < len(args) {
|
||||
args[i+1] = "invalidrepo"
|
||||
found = true
|
||||
break
|
||||
}
|
||||
os.Args = []string{"review-bot",
|
||||
"--gitea-url", "http://localhost",
|
||||
"--repo", "invalidrepo",
|
||||
"--pr", "1",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "http://localhost",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "model",
|
||||
}
|
||||
if !found {
|
||||
t.Fatal("baseSubprocessArgs() does not contain --repo; test is broken")
|
||||
}
|
||||
os.Args = args
|
||||
main()
|
||||
return
|
||||
}
|
||||
@@ -933,20 +935,15 @@ func TestMainSubprocess_InvalidRepo(t *testing.T) {
|
||||
func TestMainSubprocess_InvalidPRNumber(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
args := baseSubprocessArgs()
|
||||
// Replace the canonical --pr value with a non-numeric string.
|
||||
found := false
|
||||
for i, a := range args {
|
||||
if a == "--pr" && i+1 < len(args) {
|
||||
args[i+1] = "notanumber"
|
||||
found = true
|
||||
break
|
||||
}
|
||||
os.Args = []string{"review-bot",
|
||||
"--gitea-url", "http://localhost",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "notanumber",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "http://localhost",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "model",
|
||||
}
|
||||
if !found {
|
||||
t.Fatal("baseSubprocessArgs() does not contain --pr; test is broken")
|
||||
}
|
||||
os.Args = args
|
||||
main()
|
||||
return
|
||||
}
|
||||
@@ -965,9 +962,16 @@ func TestMainSubprocess_InvalidPRNumber(t *testing.T) {
|
||||
func TestMainSubprocess_InvalidTemperature(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
os.Args = append(baseSubprocessArgs(),
|
||||
os.Args = []string{"review-bot",
|
||||
"--gitea-url", "http://localhost",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "1",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "http://localhost",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "model",
|
||||
"--llm-temperature", "5.0",
|
||||
)
|
||||
}
|
||||
main()
|
||||
return
|
||||
}
|
||||
@@ -986,9 +990,16 @@ func TestMainSubprocess_InvalidTemperature(t *testing.T) {
|
||||
func TestMainSubprocess_InvalidProvider(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
os.Args = append(baseSubprocessArgs(),
|
||||
os.Args = []string{"review-bot",
|
||||
"--gitea-url", "http://localhost",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "1",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "http://localhost",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "model",
|
||||
"--llm-provider", "invalid-provider",
|
||||
)
|
||||
}
|
||||
main()
|
||||
return
|
||||
}
|
||||
@@ -1004,25 +1015,6 @@ func TestMainSubprocess_InvalidProvider(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// baseSubprocessArgs returns the base set of required flags for subprocess tests
|
||||
// that need a fully-configured main() invocation. Each test appends its own
|
||||
// test-specific flags on top of this base.
|
||||
//
|
||||
// Using a helper here means that when the set of required flags changes, only
|
||||
// this function needs updating (instead of every test that passes all flags).
|
||||
func baseSubprocessArgs() []string {
|
||||
return []string{
|
||||
"review-bot",
|
||||
"--vcs-url", "https://gitea.example.com",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "1",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "https://api.example.com",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "gpt-4",
|
||||
}
|
||||
}
|
||||
|
||||
// cleanEnv returns environ without any GITEA/LLM/REVIEWER/VCS env vars that would
|
||||
// interfere with testing missing-flag scenarios.
|
||||
func cleanEnv() []string {
|
||||
@@ -1397,14 +1389,13 @@ func TestFetchPatterns_MultipleRepos(t *testing.T) {
|
||||
func TestMainSubprocess_MissingLLMBaseURL(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
// Note: cannot use baseSubprocessArgs() here because --llm-base-url and
|
||||
// --llm-api-key are intentionally omitted to test the missing-URL error.
|
||||
os.Args = []string{"review-bot",
|
||||
"--vcs-url", "https://gitea.example.com",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "1",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-model", "gpt-4",
|
||||
// --llm-base-url and --llm-api-key intentionally omitted
|
||||
}
|
||||
main()
|
||||
return
|
||||
@@ -1426,8 +1417,6 @@ func TestMainSubprocess_MissingLLMBaseURL(t *testing.T) {
|
||||
func TestMainSubprocess_MissingAICoreCredentials(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
// Note: cannot use baseSubprocessArgs() here because aicore provider
|
||||
// does not require --llm-base-url / --llm-api-key; those are omitted.
|
||||
os.Args = []string{"review-bot",
|
||||
"--vcs-url", "https://gitea.example.com",
|
||||
"--repo", "owner/repo",
|
||||
@@ -1457,10 +1446,17 @@ func TestMainSubprocess_MissingAICoreCredentials(t *testing.T) {
|
||||
func TestMainSubprocess_ConflictingPersonaFlags(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
os.Args = append(baseSubprocessArgs(),
|
||||
os.Args = []string{"review-bot",
|
||||
"--vcs-url", "https://gitea.example.com",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "1",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "https://api.example.com",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "gpt-4",
|
||||
"--persona", "security",
|
||||
"--persona-file", "custom.json",
|
||||
)
|
||||
}
|
||||
main()
|
||||
return
|
||||
}
|
||||
@@ -1481,9 +1477,9 @@ func TestMainSubprocess_ConflictingPersonaFlags(t *testing.T) {
|
||||
func TestMainSubprocess_DeprecatedGiteaURLEnv(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
// Note: cannot use baseSubprocessArgs() here because --vcs-url must be
|
||||
// omitted — this test verifies that GITEA_URL env var is picked up as a
|
||||
// deprecated fallback when --vcs-url is absent.
|
||||
// Set required flags but omit --vcs-url; GITEA_URL should be picked up.
|
||||
// The test will exit with an error after VCS init (no PR to fetch), but
|
||||
// the deprecation warning must appear.
|
||||
os.Args = []string{"review-bot",
|
||||
// No --vcs-url: should fall back to GITEA_URL env var
|
||||
"--repo", "owner/repo",
|
||||
@@ -1510,125 +1506,3 @@ func TestMainSubprocess_DeprecatedGiteaURLEnv(t *testing.T) {
|
||||
t.Errorf("expected deprecation warning for GITEA_URL, got: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
// TestMainSubprocess_InvalidDocMapPath confirms that --doc-map with a path traversal
|
||||
// attempt is rejected before any network I/O.
|
||||
func TestMainSubprocess_InvalidDocMapPath(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
os.Args = []string{"review-bot",
|
||||
"--vcs-url", "https://gitea.example.com",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "1",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "https://api.example.com",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "gpt-4",
|
||||
"--doc-map", "../../../etc/passwd",
|
||||
}
|
||||
main()
|
||||
return
|
||||
}
|
||||
|
||||
cmd := exec.Command(os.Args[0], "-test.run=TestMainSubprocess_InvalidDocMapPath")
|
||||
// t.TempDir() is evaluated here in the outer process, producing a real directory
|
||||
// that is passed as the GITHUB_WORKSPACE env var string to the subprocess.
|
||||
cmd.Env = append(cleanEnv(),
|
||||
"TEST_SUBPROCESS_MAIN=1",
|
||||
"GITHUB_WORKSPACE="+t.TempDir(),
|
||||
)
|
||||
out, err := cmd.CombinedOutput()
|
||||
if err == nil {
|
||||
t.Fatal("expected non-zero exit with path traversal doc-map, got success")
|
||||
}
|
||||
output := string(out)
|
||||
if !strings.Contains(output, "doc-map") {
|
||||
t.Errorf("expected error mentioning doc-map, got: %s", output)
|
||||
}
|
||||
if !strings.Contains(output, "resolves outside workspace") {
|
||||
t.Errorf("expected error about path traversal, got: %s", output)
|
||||
}
|
||||
}
|
||||
|
||||
// TestMainSubprocess_InvalidDocMapFile confirms that --doc-map with a nonexistent file
|
||||
// is rejected before any network I/O.
|
||||
func TestMainSubprocess_InvalidDocMapFile(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
os.Args = []string{"review-bot",
|
||||
"--vcs-url", "https://gitea.example.com",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "1",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "https://api.example.com",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "gpt-4",
|
||||
"--doc-map", "nonexistent.yml",
|
||||
}
|
||||
main()
|
||||
return
|
||||
}
|
||||
|
||||
cmd := exec.Command(os.Args[0], "-test.run=TestMainSubprocess_InvalidDocMapFile")
|
||||
// t.TempDir() is evaluated here in the outer process, producing a real directory
|
||||
// that is passed as the GITHUB_WORKSPACE env var string to the subprocess.
|
||||
cmd.Env = append(cleanEnv(),
|
||||
"TEST_SUBPROCESS_MAIN=1",
|
||||
"GITHUB_WORKSPACE="+t.TempDir(),
|
||||
)
|
||||
out, err := cmd.CombinedOutput()
|
||||
if err == nil {
|
||||
t.Fatal("expected non-zero exit with nonexistent doc-map file, got success")
|
||||
}
|
||||
output := string(out)
|
||||
if !strings.Contains(output, "doc-map") {
|
||||
t.Errorf("expected error mentioning doc-map, got: %s", output)
|
||||
}
|
||||
if !strings.Contains(output, "failed to resolve") {
|
||||
t.Errorf("expected error about failed resolution, got: %s", output)
|
||||
}
|
||||
}
|
||||
|
||||
// TestMainSubprocess_DocMapTrustedRefSkipsLocalValidation confirms that
|
||||
// --doc-map-trusted-ref bypasses local filesystem validation for --doc-map.
|
||||
// When the trusted-ref flag is set, the doc-map value is used as a VCS API
|
||||
// path; a nonexistent local file must not cause an early exit before network I/O.
|
||||
func TestMainSubprocess_DocMapTrustedRefSkipsLocalValidation(t *testing.T) {
|
||||
if os.Getenv("TEST_SUBPROCESS_MAIN") == "1" {
|
||||
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||
os.Args = []string{"review-bot",
|
||||
"--vcs-url", "https://gitea.example.com",
|
||||
"--repo", "owner/repo",
|
||||
"--pr", "1",
|
||||
"--reviewer-token", "tok",
|
||||
"--llm-base-url", "https://api.example.com",
|
||||
"--llm-api-key", "key",
|
||||
"--llm-model", "gpt-4",
|
||||
"--doc-map", "nonexistent-local.yml",
|
||||
"--doc-map-trusted-ref", "main",
|
||||
}
|
||||
main()
|
||||
return
|
||||
}
|
||||
|
||||
cmd := exec.Command(os.Args[0], "-test.run=TestMainSubprocess_DocMapTrustedRefSkipsLocalValidation")
|
||||
cmd.Env = append(cleanEnv(),
|
||||
"TEST_SUBPROCESS_MAIN=1",
|
||||
"GITHUB_WORKSPACE="+t.TempDir(),
|
||||
)
|
||||
out, err := cmd.CombinedOutput()
|
||||
output := string(out)
|
||||
|
||||
// The test must fail (network I/O or VCS API failure) but must NOT
|
||||
// fail with the local filesystem validation error.
|
||||
// "failed to resolve" would indicate the early validateWorkspacePath ran —
|
||||
// that would be the bug this test is catching.
|
||||
if strings.Contains(output, "failed to resolve") {
|
||||
t.Errorf("--doc-map-trusted-ref should skip local path validation, but got filesystem error: %s", output)
|
||||
}
|
||||
|
||||
// It must still exit non-zero (real VCS call to example.com will fail).
|
||||
if err == nil {
|
||||
t.Fatal("expected non-zero exit when VCS API is unreachable, got success")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,284 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"gitea.weiker.me/rodin/review-bot/review"
|
||||
)
|
||||
|
||||
// maxDocmapBytes is the maximum size of the doc-map YAML file that will be
|
||||
// read. Files larger than this are rejected before reading to prevent memory
|
||||
// exhaustion from an oversized PR-controlled file.
|
||||
const maxDocmapBytes int64 = 10 * 1024 * 1024 // 10 MB
|
||||
|
||||
// validateDocmapPath checks that localPath is safe to read as the doc-map
|
||||
// file. It enforces three invariants before the file is opened:
|
||||
//
|
||||
// 1. The path resolves to a regular file within resolvedRoot (path
|
||||
// confinement): prevents a PR-controlled --docmap from reading arbitrary
|
||||
// host files via absolute paths or ".." traversal.
|
||||
// 2. The path is not a symlink: prevents denial-of-service via /dev/zero or
|
||||
// information disclosure via symlinks that point outside the workspace.
|
||||
// 3. The file does not exceed maxDocmapBytes: prevents memory exhaustion
|
||||
// from an oversized but legitimately committed doc-map file.
|
||||
//
|
||||
// resolvedRoot must already be an absolute, symlink-free path (obtained from
|
||||
// filepath.Abs + filepath.EvalSymlinks).
|
||||
func validateDocmapPath(localPath, resolvedRoot string) error {
|
||||
// Resolve the docmap path to an absolute path.
|
||||
absPath, err := filepath.Abs(localPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot resolve path: %w", err)
|
||||
}
|
||||
|
||||
// Resolve ALL symlink components, not just the final one.
|
||||
// os.Lstat only avoids following the *final* path component; intermediate
|
||||
// directory symlinks are still followed. EvalSymlinks resolves every
|
||||
// component, closing the directory-symlink bypass: a PR that commits
|
||||
// .review-bot/ as a directory symlink pointing outside the repo would
|
||||
// otherwise pass the filepath.Rel confinement check because the textual
|
||||
// path is inside the root while the actual destination is not.
|
||||
resolvedPath, err := filepath.EvalSymlinks(absPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot resolve path (symlink): %w", err)
|
||||
}
|
||||
|
||||
// Lstat the resolved path — at this point resolvedPath is symlink-free, so
|
||||
// ModeSymlink will never be set. We keep the check as defense-in-depth.
|
||||
fi, err := os.Lstat(resolvedPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot stat file: %w", err)
|
||||
}
|
||||
|
||||
// Defense-in-depth: reject any remaining symlink indicator.
|
||||
if fi.Mode()&os.ModeSymlink != 0 {
|
||||
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
|
||||
// symlink inside the repo cannot carry the path outside the root.
|
||||
rel, err := filepath.Rel(resolvedRoot, resolvedPath)
|
||||
if err != nil || rel == ".." || strings.HasPrefix(rel, ".."+string(os.PathSeparator)) {
|
||||
return fmt.Errorf("path must be within --repo-root")
|
||||
}
|
||||
|
||||
// Enforce size cap before reading to prevent memory exhaustion.
|
||||
if fi.Size() > maxDocmapBytes {
|
||||
return fmt.Errorf("file size %d bytes exceeds %d-byte limit", fi.Size(), maxDocmapBytes)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// runValidateDocmap implements the `review-bot validate-docmap` subcommand.
|
||||
//
|
||||
// It reads changed file paths from stdin (one per line, as produced by
|
||||
// `git diff --name-only`), parses a doc-map YAML file, and performs two checks:
|
||||
//
|
||||
// 1. Coverage check: every changed file must be matched by at least one
|
||||
// paths: glob in the docmap. Fails if any file is uncovered.
|
||||
//
|
||||
// 2. Stale-docs check: every docs: entry in the docmap must exist on disk
|
||||
// (relative to --repo-root). Fails if any path is missing.
|
||||
//
|
||||
// Both checks always run — all failures are reported before exiting.
|
||||
//
|
||||
// Exit codes:
|
||||
//
|
||||
// 0 — clean (all files covered, all docs exist)
|
||||
// 1 — one or more coverage or stale-doc failures
|
||||
// 2 — usage error, missing flag, or YAML parse error
|
||||
func runValidateDocmap(args []string) int {
|
||||
fs := flag.NewFlagSet("validate-docmap", flag.ContinueOnError)
|
||||
fs.SetOutput(errWriter)
|
||||
|
||||
docmapFlag := fs.String("docmap", "", "Path to doc-map YAML file (required)")
|
||||
repoRootFlag := fs.String("repo-root", ".", "Repo root for resolving docs: paths (default: cwd)")
|
||||
|
||||
if err := fs.Parse(args); err != nil {
|
||||
// flag.ContinueOnError already wrote the error to errWriter.
|
||||
return 2
|
||||
}
|
||||
|
||||
if *docmapFlag == "" {
|
||||
fmt.Fprintln(errWriter, "Error: --docmap is required")
|
||||
fmt.Fprintln(errWriter, "")
|
||||
fmt.Fprintln(errWriter, "usage: review-bot validate-docmap --docmap <path> [--repo-root <dir>]")
|
||||
fmt.Fprintln(errWriter, " Changed files are read from stdin, one per line.")
|
||||
fmt.Fprintln(errWriter, " Example: git diff --name-only origin/main HEAD | review-bot validate-docmap --docmap .review-bot/doc-map.yml")
|
||||
return 2
|
||||
}
|
||||
|
||||
// Resolve repoRoot first — the docmap path is validated against it below.
|
||||
// Use an absolute, symlink-free path so a symlinked --repo-root cannot
|
||||
// bypass the escape guard in validateDocmapPath or checkStaleDocs.
|
||||
absRoot, err := filepath.Abs(*repoRootFlag)
|
||||
if err != nil {
|
||||
fmt.Fprintf(errWriter, "Error: failed to resolve --repo-root %q: %v\n", *repoRootFlag, err)
|
||||
return 2
|
||||
}
|
||||
resolvedRoot, err := filepath.EvalSymlinks(absRoot)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
fmt.Fprintf(errWriter, "Error: --repo-root %q does not exist\n", *repoRootFlag)
|
||||
} else {
|
||||
fmt.Fprintf(errWriter, "Error: failed to resolve --repo-root %q: %v\n", *repoRootFlag, err)
|
||||
}
|
||||
return 2
|
||||
}
|
||||
|
||||
// Harden the docmap file path before reading it. The --docmap flag value
|
||||
// may reference a PR-controlled file (e.g. .review-bot/doc-map.yml).
|
||||
// Validate that it:
|
||||
// 1. Resolves within resolvedRoot (prevent reading arbitrary host files).
|
||||
// 2. Is not a symlink (prevent /dev/zero or symlink-based host probing).
|
||||
// 3. Does not exceed maxDocmapBytes (prevent memory exhaustion from an
|
||||
// oversized committed file).
|
||||
if err := validateDocmapPath(*docmapFlag, resolvedRoot); err != nil {
|
||||
fmt.Fprintf(errWriter, "Error: --docmap %q is invalid: %v\n", *docmapFlag, err)
|
||||
return 2
|
||||
}
|
||||
|
||||
// Parse docmap YAML.
|
||||
cfg, err := review.ParseDocMapConfig(*docmapFlag)
|
||||
if err != nil {
|
||||
fmt.Fprintf(errWriter, "Error: failed to parse docmap %q: %v\n", *docmapFlag, err)
|
||||
return 2
|
||||
}
|
||||
|
||||
// Read changed files from stdin.
|
||||
changedFiles, err := readLines(os.Stdin)
|
||||
if err != nil {
|
||||
fmt.Fprintf(errWriter, "Error: failed to read stdin: %v\n", err)
|
||||
return 2
|
||||
}
|
||||
|
||||
failed := false
|
||||
|
||||
// --- Check 1: Coverage ---
|
||||
// Note: an empty docmap (no mappings) means every changed file is
|
||||
// uncovered — there are no patterns to match against. This is intentional:
|
||||
// if you declare a doc-map, every changed file must be accounted for.
|
||||
// On empty stdin the check is vacuously true (no files to cover).
|
||||
var uncovered []string
|
||||
for _, f := range changedFiles {
|
||||
// Normalize Windows-style backslashes to forward slashes so that
|
||||
// changed-file paths from git on Windows match doc-map globs.
|
||||
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) {
|
||||
uncovered = append(uncovered, f)
|
||||
}
|
||||
}
|
||||
if len(uncovered) > 0 {
|
||||
failed = true
|
||||
fmt.Fprintln(errWriter, "ERROR: changed files with no docmap coverage:")
|
||||
for _, f := range uncovered {
|
||||
fmt.Fprintf(errWriter, " %s\n", f)
|
||||
}
|
||||
}
|
||||
|
||||
// --- Check 2: Stale docs ---
|
||||
// checkStaleDocs validates each path before touching the filesystem; see
|
||||
// its documentation for the path-traversal hardening applied.
|
||||
staleDocs := checkStaleDocs(cfg, resolvedRoot)
|
||||
if len(staleDocs) > 0 {
|
||||
failed = true
|
||||
fmt.Fprintln(errWriter, "ERROR: stale docmap entries (paths do not exist):")
|
||||
for _, d := range staleDocs {
|
||||
fmt.Fprintf(errWriter, " %s\n", d)
|
||||
}
|
||||
}
|
||||
|
||||
if failed {
|
||||
return 1
|
||||
}
|
||||
|
||||
fmt.Fprintln(outWriter, "OK: docmap is valid")
|
||||
return 0
|
||||
}
|
||||
|
||||
// checkStaleDocs returns deduplicated docs: entries that do not exist under
|
||||
// repoRoot.
|
||||
//
|
||||
// Path-traversal hardening: each docPath is validated with
|
||||
// review.ValidateDocPath (rejects absolute paths and ".." segments) and then
|
||||
// confined to repoRoot via filepath.Clean + filepath.Rel before os.Lstat is
|
||||
// called. Symlinks are treated as stale — a CI tool running against
|
||||
// PR-controlled content must not follow symlinks that could probe arbitrary
|
||||
// host paths. Paths that fail any check are treated as invalid (reported as
|
||||
// stale) without following any symlinks.
|
||||
func checkStaleDocs(cfg *review.DocMapConfig, repoRoot string) []string {
|
||||
seen := make(map[string]struct{})
|
||||
var stale []string
|
||||
|
||||
for _, mapping := range cfg.Mappings {
|
||||
for _, docPath := range mapping.Docs {
|
||||
if docPath == "" {
|
||||
continue
|
||||
}
|
||||
if _, ok := seen[docPath]; ok {
|
||||
continue
|
||||
}
|
||||
seen[docPath] = struct{}{}
|
||||
|
||||
// Guard 1: reject absolute paths and ".." segments sourced from
|
||||
// PR-controlled YAML before joining with repoRoot.
|
||||
if err := review.ValidateDocPath(docPath); err != nil {
|
||||
stale = append(stale, docPath)
|
||||
continue
|
||||
}
|
||||
|
||||
// Guard 2: verify the cleaned joined path does not escape repoRoot.
|
||||
// filepath.Clean resolves any remaining ".." after the join; the
|
||||
// filepath.Rel check confirms the path is still under repoRoot.
|
||||
fullPath := filepath.Clean(filepath.Join(repoRoot, filepath.FromSlash(docPath)))
|
||||
rel, err := filepath.Rel(repoRoot, fullPath)
|
||||
if err != nil || rel == ".." || strings.HasPrefix(rel, ".."+string(os.PathSeparator)) {
|
||||
stale = append(stale, docPath)
|
||||
continue
|
||||
}
|
||||
|
||||
// Use Lstat (not Stat) so symlinks are never followed. A symlink
|
||||
// under repoRoot could point anywhere on the host, allowing a
|
||||
// malicious PR to probe file existence. Treat symlinks as stale.
|
||||
fi, err := os.Lstat(fullPath)
|
||||
if err != nil {
|
||||
stale = append(stale, docPath)
|
||||
continue
|
||||
}
|
||||
if fi.Mode()&os.ModeSymlink != 0 {
|
||||
stale = append(stale, docPath)
|
||||
}
|
||||
}
|
||||
}
|
||||
return stale
|
||||
}
|
||||
|
||||
// readLines reads all non-empty trimmed lines from r.
|
||||
func readLines(r io.Reader) ([]string, error) {
|
||||
scanner := bufio.NewScanner(r)
|
||||
var lines []string
|
||||
for scanner.Scan() {
|
||||
line := strings.TrimSpace(scanner.Text())
|
||||
if line != "" {
|
||||
lines = append(lines, line)
|
||||
}
|
||||
}
|
||||
return lines, scanner.Err()
|
||||
}
|
||||
@@ -1,651 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// makeDocmapYAML writes a YAML string to a temp file and returns its path.
|
||||
// The file is created in t.TempDir() — use makeDocmapInDir when the docmap
|
||||
// must be located inside a specific repo-root directory.
|
||||
func makeDocmapYAML(t *testing.T, content string) string {
|
||||
t.Helper()
|
||||
f, err := os.CreateTemp(t.TempDir(), "doc-map-*.yml")
|
||||
if err != nil {
|
||||
t.Fatalf("CreateTemp: %v", err)
|
||||
}
|
||||
defer f.Close()
|
||||
if _, err := f.WriteString(content); err != nil {
|
||||
t.Fatalf("WriteString: %v", err)
|
||||
}
|
||||
return f.Name()
|
||||
}
|
||||
|
||||
// makeDocmapInDir writes a YAML string to a file inside dir and returns the
|
||||
// file path. Use this instead of makeDocmapYAML when also passing --repo-root,
|
||||
// because validateDocmapPath requires the docmap to be within the repo root.
|
||||
func makeDocmapInDir(t *testing.T, dir, content string) string {
|
||||
t.Helper()
|
||||
if err := os.MkdirAll(filepath.Join(dir, ".review-bot"), 0o755); err != nil {
|
||||
t.Fatalf("MkdirAll: %v", err)
|
||||
}
|
||||
path := filepath.Join(dir, ".review-bot", "doc-map.yml")
|
||||
if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
|
||||
t.Fatalf("WriteFile: %v", err)
|
||||
}
|
||||
return path
|
||||
}
|
||||
|
||||
// makeDocFile creates a file (and any parent dirs) at the given path relative to dir.
|
||||
func makeDocFile(t *testing.T, dir, rel string) {
|
||||
t.Helper()
|
||||
full := filepath.Join(dir, rel)
|
||||
if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil {
|
||||
t.Fatalf("MkdirAll: %v", err)
|
||||
}
|
||||
if err := os.WriteFile(full, []byte("# doc\n"), 0o644); err != nil {
|
||||
t.Fatalf("WriteFile: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// captureOutput redirects outWriter/errWriter to buffers for the duration of f.
|
||||
func captureOutput(f func()) (stdout, stderr string) {
|
||||
var outBuf, errBuf bytes.Buffer
|
||||
origOut, origErr := outWriter, errWriter
|
||||
outWriter = &outBuf
|
||||
errWriter = &errBuf
|
||||
defer func() {
|
||||
outWriter = origOut
|
||||
errWriter = origErr
|
||||
}()
|
||||
f()
|
||||
return outBuf.String(), errBuf.String()
|
||||
}
|
||||
|
||||
func TestRunValidateDocmap_Clean(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
makeDocFile(t, dir, "docs/foo.md")
|
||||
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/foo/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
`)
|
||||
|
||||
// A covered file with all docs existing → clean.
|
||||
code, stdout, _ := stdinValidateDocmap(t,
|
||||
"lib/foo/bar.ex\n",
|
||||
[]string{"--docmap", docmap, "--repo-root", dir},
|
||||
)
|
||||
if code != 0 {
|
||||
t.Errorf("expected exit 0 for clean, got %d", code)
|
||||
}
|
||||
if !strings.Contains(stdout, "OK") {
|
||||
t.Errorf("expected 'OK' in stdout, got %q", stdout)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunValidateDocmap_MissingDocmapFlag(t *testing.T) {
|
||||
var code int
|
||||
_, stderr := captureOutput(func() {
|
||||
code = runValidateDocmap([]string{})
|
||||
})
|
||||
if code != 2 {
|
||||
t.Errorf("expected exit 2 for missing --docmap, got %d", code)
|
||||
}
|
||||
if !strings.Contains(stderr, "--docmap") {
|
||||
t.Errorf("expected --docmap in stderr, got %q", stderr)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunValidateDocmap_BadYAML(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
docmap := makeDocmapInDir(t, dir, "mappings: [{{invalid")
|
||||
var code int
|
||||
_, stderr := captureOutput(func() {
|
||||
code = runValidateDocmap([]string{"--docmap", docmap, "--repo-root", dir})
|
||||
})
|
||||
if code != 2 {
|
||||
t.Errorf("expected exit 2 for bad YAML, got %d", code)
|
||||
}
|
||||
if !strings.Contains(stderr, "failed to parse") {
|
||||
t.Errorf("expected parse error in stderr, got %q", stderr)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunValidateDocmap_StaleDocs(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
// docs/foo.md does NOT exist on disk.
|
||||
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/foo/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
`)
|
||||
|
||||
var code int
|
||||
_, stderr := captureOutput(func() {
|
||||
code = runValidateDocmap([]string{
|
||||
"--docmap", docmap,
|
||||
"--repo-root", dir,
|
||||
})
|
||||
})
|
||||
if code != 1 {
|
||||
t.Errorf("expected exit 1 for stale docs, got %d", code)
|
||||
}
|
||||
if !strings.Contains(stderr, "docs/foo.md") {
|
||||
t.Errorf("expected stale path in stderr, got %q", stderr)
|
||||
}
|
||||
if !strings.Contains(stderr, "stale docmap") {
|
||||
t.Errorf("expected 'stale docmap' in stderr, got %q", stderr)
|
||||
}
|
||||
}
|
||||
|
||||
// stdinValidateDocmap runs runValidateDocmap with a synthetic stdin.
|
||||
//
|
||||
// Implementation note: we write stdinContent to a temp file and point
|
||||
// os.Stdin at it. The defer f.Close() fires after stdinValidateDocmap
|
||||
// returns, which is after runValidateDocmap has finished reading stdin
|
||||
// synchronously — so the file is not closed while still in use.
|
||||
// Tests must not call t.Parallel() while sharing the global os.Stdin.
|
||||
func stdinValidateDocmap(t *testing.T, stdinContent string, args []string) (code int, stdout, stderr string) {
|
||||
t.Helper()
|
||||
// Write stdin content to a temp file and redirect os.Stdin.
|
||||
f, err := os.CreateTemp(t.TempDir(), "stdin-*")
|
||||
if err != nil {
|
||||
t.Fatalf("CreateTemp for stdin: %v", err)
|
||||
}
|
||||
defer f.Close()
|
||||
if _, err := f.WriteString(stdinContent); err != nil {
|
||||
t.Fatalf("WriteString for stdin: %v", err)
|
||||
}
|
||||
if _, err := f.Seek(0, 0); err != nil {
|
||||
t.Fatalf("Seek for stdin: %v", err)
|
||||
}
|
||||
|
||||
origStdin := os.Stdin
|
||||
os.Stdin = f
|
||||
defer func() { os.Stdin = origStdin }()
|
||||
|
||||
stdout, stderr = captureOutput(func() {
|
||||
code = runValidateDocmap(args)
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
func TestRunValidateDocmap_UncoveredFile(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
makeDocFile(t, dir, "docs/foo.md")
|
||||
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/foo/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
`)
|
||||
|
||||
code, _, stderr := stdinValidateDocmap(t,
|
||||
"lib/bar/uncovered.ex\n",
|
||||
[]string{"--docmap", docmap, "--repo-root", dir},
|
||||
)
|
||||
if code != 1 {
|
||||
t.Errorf("expected exit 1 for uncovered file, got %d", code)
|
||||
}
|
||||
if !strings.Contains(stderr, "lib/bar/uncovered.ex") {
|
||||
t.Errorf("expected uncovered file in stderr, got %q", stderr)
|
||||
}
|
||||
if !strings.Contains(stderr, "no docmap coverage") {
|
||||
t.Errorf("expected 'no docmap coverage' in stderr, got %q", stderr)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunValidateDocmap_BothFailures(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
// docs/foo.md intentionally missing
|
||||
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/foo/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
`)
|
||||
|
||||
code, _, stderr := stdinValidateDocmap(t,
|
||||
"lib/bar/uncovered.ex\n",
|
||||
[]string{"--docmap", docmap, "--repo-root", dir},
|
||||
)
|
||||
if code != 1 {
|
||||
t.Errorf("expected exit 1 for both failures, got %d", code)
|
||||
}
|
||||
if !strings.Contains(stderr, "no docmap coverage") {
|
||||
t.Errorf("expected coverage error in stderr, got %q", stderr)
|
||||
}
|
||||
if !strings.Contains(stderr, "stale docmap") {
|
||||
t.Errorf("expected stale-docs error in stderr, got %q", stderr)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunValidateDocmap_EmptyStdin(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
makeDocFile(t, dir, "docs/foo.md")
|
||||
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/foo/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
`)
|
||||
|
||||
code, stdout, _ := stdinValidateDocmap(t,
|
||||
"",
|
||||
[]string{"--docmap", docmap, "--repo-root", dir},
|
||||
)
|
||||
if code != 0 {
|
||||
t.Errorf("expected exit 0 for empty stdin, got %d", code)
|
||||
}
|
||||
if !strings.Contains(stdout, "OK") {
|
||||
t.Errorf("expected 'OK' in stdout, got %q", stdout)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunValidateDocmap_BlankLinesSkipped(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
makeDocFile(t, dir, "docs/foo.md")
|
||||
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/foo/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
`)
|
||||
|
||||
// stdin with only blank lines → effectively empty, should be clean
|
||||
code, stdout, _ := stdinValidateDocmap(t,
|
||||
"\n \n\n",
|
||||
[]string{"--docmap", docmap, "--repo-root", dir},
|
||||
)
|
||||
if code != 0 {
|
||||
t.Errorf("expected exit 0 for blank-only stdin, got %d", code)
|
||||
}
|
||||
if !strings.Contains(stdout, "OK") {
|
||||
t.Errorf("expected 'OK' in stdout for blank-only stdin, got %q", stdout)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunValidateDocmap_DuplicateDocsDeduped(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
// docs/shared.md intentionally missing — but it appears in TWO mappings.
|
||||
// Should appear only once in stale list.
|
||||
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/foo/**"
|
||||
docs:
|
||||
- docs/shared.md
|
||||
- paths:
|
||||
- "lib/bar/**"
|
||||
docs:
|
||||
- docs/shared.md
|
||||
`)
|
||||
|
||||
code, _, stderr := stdinValidateDocmap(t,
|
||||
"",
|
||||
[]string{"--docmap", docmap, "--repo-root", dir},
|
||||
)
|
||||
if code != 1 {
|
||||
t.Errorf("expected exit 1 for stale doc, got %d", code)
|
||||
}
|
||||
count := strings.Count(stderr, "docs/shared.md")
|
||||
if count != 1 {
|
||||
t.Errorf("expected docs/shared.md to appear exactly once in stderr (deduplicated), got %d occurrences: %q", count, stderr)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCheckStaleDocs_PathTraversal verifies that checkStaleDocs rejects
|
||||
// traversal and absolute paths without touching the host filesystem.
|
||||
func TestCheckStaleDocs_PathTraversal(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
|
||||
// Baseline: a valid doc that exists.
|
||||
makeDocFile(t, dir, "docs/valid.md")
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
docPath string
|
||||
wantStale bool
|
||||
}{
|
||||
{"dot-dot traversal", "../../etc/passwd", true},
|
||||
{"dot-dot single", "../outside", true},
|
||||
{"absolute path", "/etc/passwd", true},
|
||||
{"valid present path", "docs/valid.md", false},
|
||||
{"valid missing path", "docs/missing.md", true},
|
||||
}
|
||||
|
||||
for _, tc := range tests {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/**"
|
||||
docs:
|
||||
- `+tc.docPath+`
|
||||
`)
|
||||
code, _, stderr := stdinValidateDocmap(t,
|
||||
"",
|
||||
[]string{"--docmap", docmap, "--repo-root", dir},
|
||||
)
|
||||
|
||||
if tc.wantStale {
|
||||
if code != 1 {
|
||||
t.Errorf("path %q: expected exit 1 (stale/invalid), got %d; stderr: %q", tc.docPath, code, stderr)
|
||||
}
|
||||
} else {
|
||||
if code != 0 {
|
||||
t.Errorf("path %q: expected exit 0 (valid), got %d; stderr: %q", tc.docPath, code, stderr)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestCheckStaleDocs_SymlinkOutside verifies that a symlink under repoRoot
|
||||
// pointing outside the repo is treated as stale (not followed).
|
||||
func TestCheckStaleDocs_SymlinkOutside(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
|
||||
// Create a symlink inside repoRoot pointing to a file outside the repo.
|
||||
// We point at /etc/hostname (exists on Linux CI) but the test does not
|
||||
// depend on that file existing — Lstat must reject the symlink itself.
|
||||
linkPath := filepath.Join(dir, "docs", "secret.md")
|
||||
if err := os.MkdirAll(filepath.Dir(linkPath), 0o755); err != nil {
|
||||
t.Fatalf("MkdirAll: %v", err)
|
||||
}
|
||||
if err := os.Symlink("/etc/hostname", linkPath); err != nil {
|
||||
t.Fatalf("Symlink: %v", err)
|
||||
}
|
||||
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/**"
|
||||
docs:
|
||||
- docs/secret.md
|
||||
`)
|
||||
|
||||
code, _, stderr := stdinValidateDocmap(t,
|
||||
"",
|
||||
[]string{"--docmap", docmap, "--repo-root", dir},
|
||||
)
|
||||
if code != 1 {
|
||||
t.Errorf("expected exit 1 for symlink doc, got %d; stderr: %q", code, stderr)
|
||||
}
|
||||
if !strings.Contains(stderr, "docs/secret.md") {
|
||||
t.Errorf("expected stale path in stderr, got %q", stderr)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCheckStaleDocs_SymlinkInsideRepo verifies that a symlink pointing to
|
||||
// another file *within* the repo is also treated as stale. We refuse all
|
||||
// symlinks regardless of target to keep the check simple and safe.
|
||||
func TestCheckStaleDocs_SymlinkInsideRepo(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
|
||||
// Real doc file.
|
||||
makeDocFile(t, dir, "docs/real.md")
|
||||
|
||||
// Symlink inside repo pointing at the real file.
|
||||
linkPath := filepath.Join(dir, "docs", "link.md")
|
||||
if err := os.Symlink(filepath.Join(dir, "docs", "real.md"), linkPath); err != nil {
|
||||
t.Fatalf("Symlink: %v", err)
|
||||
}
|
||||
|
||||
docmap := makeDocmapInDir(t, dir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/**"
|
||||
docs:
|
||||
- docs/link.md
|
||||
`)
|
||||
|
||||
code, _, stderr := stdinValidateDocmap(t,
|
||||
"",
|
||||
[]string{"--docmap", docmap, "--repo-root", dir},
|
||||
)
|
||||
if code != 1 {
|
||||
t.Errorf("expected exit 1 for symlink doc (even intra-repo), got %d; stderr: %q", code, stderr)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRunValidateDocmap_SymlinkRepoRoot verifies that a --repo-root that is
|
||||
// itself a symlink to a valid directory resolves correctly.
|
||||
func TestRunValidateDocmap_SymlinkRepoRoot(t *testing.T) {
|
||||
realDir := t.TempDir()
|
||||
makeDocFile(t, realDir, "docs/foo.md")
|
||||
|
||||
// Create a symlink pointing at realDir.
|
||||
symlinkDir := filepath.Join(t.TempDir(), "link-root")
|
||||
if err := os.Symlink(realDir, symlinkDir); err != nil {
|
||||
t.Fatalf("Symlink: %v", err)
|
||||
}
|
||||
|
||||
// Place the docmap inside realDir so it passes the confinement check.
|
||||
// (symlinkDir resolves to realDir, so files inside realDir are also inside
|
||||
// the resolved repo-root.)
|
||||
docmap := makeDocmapInDir(t, realDir, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
`)
|
||||
|
||||
// Using the symlinked repo-root: the real doc exists → should be clean.
|
||||
code, stdout, stderr := stdinValidateDocmap(t,
|
||||
"lib/foo.go\n",
|
||||
[]string{"--docmap", docmap, "--repo-root", symlinkDir},
|
||||
)
|
||||
if code != 0 {
|
||||
t.Errorf("expected exit 0 for symlinked repo-root with existing doc, got %d; stderr: %q", code, stderr)
|
||||
}
|
||||
if !strings.Contains(stdout, "OK") {
|
||||
t.Errorf("expected 'OK' in stdout, got %q", stdout)
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateDocmapPath_Symlink verifies that --docmap pointing at a symlink
|
||||
// whose resolved target is outside --repo-root is rejected (prevents reading
|
||||
// arbitrary host files via PR-controlled symlinks).
|
||||
//
|
||||
// Note: after the EvalSymlinks fix (issue #150), in-repo symlinks whose
|
||||
// targets also reside within the repo root are now allowed — the confinement
|
||||
// check is applied to the resolved path, not the symlink entry itself. The
|
||||
// security invariant is: the resolved destination must be within the root.
|
||||
func TestValidateDocmapPath_Symlink(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
outside := t.TempDir()
|
||||
|
||||
// Create a docmap file OUTSIDE the repo root to serve as the symlink
|
||||
// target. EvalSymlinks will resolve to this path, which the Rel check
|
||||
// must then reject.
|
||||
if err := os.MkdirAll(filepath.Join(outside, ".review-bot"), 0o755); err != nil {
|
||||
t.Fatalf("MkdirAll: %v", err)
|
||||
}
|
||||
outsideDocmap := filepath.Join(outside, ".review-bot", "doc-map.yml")
|
||||
if err := os.WriteFile(outsideDocmap, []byte("mappings: []\n"), 0o644); err != nil {
|
||||
t.Fatalf("WriteFile: %v", err)
|
||||
}
|
||||
|
||||
// Create a symlink inside dir pointing to the file outside the repo.
|
||||
if err := os.MkdirAll(filepath.Join(dir, ".review-bot"), 0o755); err != nil {
|
||||
t.Fatalf("MkdirAll: %v", err)
|
||||
}
|
||||
symlinkPath := filepath.Join(dir, ".review-bot", "doc-map-link.yml")
|
||||
if err := os.Symlink(outsideDocmap, symlinkPath); err != nil {
|
||||
t.Fatalf("Symlink: %v", err)
|
||||
}
|
||||
|
||||
code, _, stderr := stdinValidateDocmap(t,
|
||||
"",
|
||||
[]string{"--docmap", symlinkPath, "--repo-root", dir},
|
||||
)
|
||||
if code != 2 {
|
||||
t.Errorf("expected exit 2 for out-of-repo symlink docmap, got %d; stderr: %q", code, stderr)
|
||||
}
|
||||
if !strings.Contains(stderr, "invalid") && !strings.Contains(stderr, "repo-root") {
|
||||
t.Errorf("expected confinement rejection in stderr, got %q", stderr)
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateDocmapPath_OutsideRepoRoot verifies that --docmap pointing
|
||||
// outside --repo-root is rejected (prevents reading arbitrary host files).
|
||||
func TestValidateDocmapPath_OutsideRepoRoot(t *testing.T) {
|
||||
repoDir := t.TempDir()
|
||||
|
||||
// Create a docmap in a separate temp dir (outside the repo root).
|
||||
outside := makeDocmapYAML(t, `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
`)
|
||||
|
||||
code, _, stderr := stdinValidateDocmap(t,
|
||||
"",
|
||||
[]string{"--docmap", outside, "--repo-root", repoDir},
|
||||
)
|
||||
if code != 2 {
|
||||
t.Errorf("expected exit 2 for docmap outside repo-root, got %d; stderr: %q", code, stderr)
|
||||
}
|
||||
if !strings.Contains(stderr, "invalid") && !strings.Contains(stderr, "repo-root") {
|
||||
t.Errorf("expected confinement rejection in stderr, got %q", stderr)
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateDocmapPath_SizeLimit verifies that --docmap files exceeding
|
||||
// maxDocmapBytes are rejected before reading (prevents memory exhaustion).
|
||||
func TestValidateDocmapPath_SizeLimit(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
|
||||
// Write a file larger than maxDocmapBytes.
|
||||
bigPath := filepath.Join(dir, ".review-bot", "big-doc-map.yml")
|
||||
if err := os.MkdirAll(filepath.Dir(bigPath), 0o755); err != nil {
|
||||
t.Fatalf("MkdirAll: %v", err)
|
||||
}
|
||||
// Exceed the limit by one byte.
|
||||
bigContent := make([]byte, maxDocmapBytes+1)
|
||||
if err := os.WriteFile(bigPath, bigContent, 0o644); err != nil {
|
||||
t.Fatalf("WriteFile: %v", err)
|
||||
}
|
||||
|
||||
code, _, stderr := stdinValidateDocmap(t,
|
||||
"",
|
||||
[]string{"--docmap", bigPath, "--repo-root", dir},
|
||||
)
|
||||
if code != 2 {
|
||||
t.Errorf("expected exit 2 for oversized docmap, got %d; stderr: %q", code, stderr)
|
||||
}
|
||||
if !strings.Contains(stderr, "limit") && !strings.Contains(stderr, "size") && !strings.Contains(stderr, "invalid") {
|
||||
t.Errorf("expected size limit error in stderr, got %q", stderr)
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateDocmapPath_DirSymlinkBypass verifies that a directory-symlink
|
||||
// inside the repo pointing outside cannot be used to read arbitrary host files.
|
||||
//
|
||||
// Attack vector: a PR commits .review-bot/ as a directory symlink targeting a
|
||||
// directory outside the repo. The textual path of the docmap file is inside
|
||||
// the repo root, so the old Rel-only check passed — but the actual file is
|
||||
// outside. This is closed by calling EvalSymlinks on the full path before the
|
||||
// confinement check.
|
||||
func TestValidateDocmapPath_DirSymlinkBypass(t *testing.T) {
|
||||
repoDir := t.TempDir()
|
||||
outsideDir := t.TempDir()
|
||||
|
||||
// Secret file outside the repo.
|
||||
secretPath := filepath.Join(outsideDir, "secret.yml")
|
||||
if err := os.WriteFile(secretPath, []byte("mappings: []\n"), 0o644); err != nil {
|
||||
t.Fatalf("WriteFile: %v", err)
|
||||
}
|
||||
|
||||
// Create .review-bot/ as a directory symlink pointing outside the repo.
|
||||
reviewBotDir := filepath.Join(repoDir, ".review-bot")
|
||||
if err := os.Symlink(outsideDir, reviewBotDir); err != nil {
|
||||
t.Skipf("cannot create dir symlink (platform may not support it): %v", err)
|
||||
}
|
||||
|
||||
// Textually inside repo — .review-bot/secret.yml — but resolves outside.
|
||||
attackPath := filepath.Join(repoDir, ".review-bot", "secret.yml")
|
||||
|
||||
// Resolve repoDir to a symlink-free path, as runValidateDocmap does.
|
||||
resolvedRoot, err := filepath.EvalSymlinks(repoDir)
|
||||
if err != nil {
|
||||
t.Fatalf("EvalSymlinks(repoDir): %v", err)
|
||||
}
|
||||
|
||||
if err := validateDocmapPath(attackPath, resolvedRoot); err == nil {
|
||||
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)
|
||||
}
|
||||
}
|
||||
@@ -9,7 +9,7 @@ import (
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gitea.weiker.me/rodin/review-bot/internal/netutil"
|
||||
"gitea.weiker.me/rodin/review-bot/gitea"
|
||||
)
|
||||
|
||||
// runValidateURL implements the `review-bot validate-url <url>` subcommand.
|
||||
@@ -114,7 +114,7 @@ func validateURL(rawURL string) error {
|
||||
}
|
||||
|
||||
for _, a := range addrs {
|
||||
if netutil.IsBlockedIP(a.IP) {
|
||||
if gitea.IsBlockedIP(a.IP) {
|
||||
return &validateError{
|
||||
code: 1,
|
||||
message: fmt.Sprintf("blocked: %q resolves to private/reserved IP %s", host, a.IP),
|
||||
|
||||
@@ -83,9 +83,9 @@ type vcsCommitStatus struct {
|
||||
|
||||
// vcsReviewComment is an inline review comment.
|
||||
type vcsReviewComment struct {
|
||||
Path string
|
||||
NewLine int64 // absolute line number on the new (right) side of the diff, used by both Gitea and GitHub adapters
|
||||
Body string
|
||||
Path string
|
||||
NewPosition int64 // Gitea: absolute line; GitHub: diff hunk position
|
||||
Body string
|
||||
}
|
||||
|
||||
// vcsReview is a submitted PR review.
|
||||
@@ -176,7 +176,7 @@ func (a *giteaVCSAdapter) GetAllFilesInPath(ctx context.Context, owner, repo, pa
|
||||
func (a *giteaVCSAdapter) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []vcsReviewComment) (*vcsReview, error) {
|
||||
gc := make([]gitea.ReviewComment, len(comments))
|
||||
for i, c := range comments {
|
||||
gc[i] = gitea.ReviewComment{Path: c.Path, NewPosition: c.NewLine, Body: c.Body}
|
||||
gc[i] = gitea.ReviewComment{Path: c.Path, NewPosition: c.NewPosition, Body: c.Body}
|
||||
}
|
||||
r, err := a.c.PostReview(ctx, owner, repo, number, event, body, commitID, gc)
|
||||
if err != nil {
|
||||
@@ -311,12 +311,14 @@ func (a *githubVCSAdapter) GetAllFilesInPath(ctx context.Context, owner, repo, p
|
||||
func (a *githubVCSAdapter) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []vcsReviewComment) (*vcsReview, error) {
|
||||
gc := make([]github.ReviewComment, len(comments))
|
||||
for i, c := range comments {
|
||||
// GitHub inline comments use Line+Side (absolute line on the RIGHT side).
|
||||
// NewLine from diff parsing gives absolute new-file line numbers.
|
||||
// GitHub inline comments use diff hunk "position", not absolute line numbers.
|
||||
// NewPosition from gitea diff parsing gives absolute line numbers, which
|
||||
// will not match GitHub's position values. For initial GitHub support, we
|
||||
// attach comments with Line+Side (absolute line on the RIGHT side) instead.
|
||||
// Comments that cannot be mapped will be omitted (GitHub rejects invalid positions).
|
||||
gc[i] = github.ReviewComment{
|
||||
Path: c.Path,
|
||||
Line: c.NewLine,
|
||||
Line: c.NewPosition,
|
||||
Side: "RIGHT",
|
||||
Body: c.Body,
|
||||
}
|
||||
|
||||
@@ -1,278 +0,0 @@
|
||||
# Dev-Loop Dispatch Spec
|
||||
|
||||
**Version:** 1.0
|
||||
**Status:** Implemented
|
||||
**Implements:** Issue #148
|
||||
|
||||
This document is the authoritative spec for the review-bot dev-loop dispatch architecture.
|
||||
The dispatch script (`~/.openclaw/workspace/scripts/dev-loop-dispatch.sh`) and its tests
|
||||
are validated against the rules and invariants in this document.
|
||||
|
||||
---
|
||||
|
||||
## 1. Overview
|
||||
|
||||
The dev-loop is a 15-minute cron that advances the state of open pull requests and picks up
|
||||
new issues when there is nothing in review. It is designed for **zero human intervention**
|
||||
in the normal flow and **hard stops at key safety boundaries**.
|
||||
|
||||
### Architecture
|
||||
|
||||
```
|
||||
Cron (15-min cadence)
|
||||
→ exec: bash dev-loop-dispatch.sh <project>
|
||||
→ read stdout for SPAWN/HANDOFF lines
|
||||
→ if SPAWN: load worker template, spawn subagent
|
||||
→ if HANDOFF: log, do nothing else
|
||||
→ if neither: NO_REPLY
|
||||
```
|
||||
|
||||
The cron model has **no ambient knowledge** of the project state. All state is derived
|
||||
from the dispatch script's output, which in turn comes from live API calls.
|
||||
|
||||
---
|
||||
|
||||
## 2. Inputs
|
||||
|
||||
### Project Config
|
||||
|
||||
```yaml
|
||||
# memory/projects/<project>.yaml
|
||||
repo: rodin/review-bot # <owner>/<repo>
|
||||
api_base: https://gitea.../v1 # API base URL
|
||||
token_path: ~/.openclaw/... # path to bearer token
|
||||
user: rodin # bot Gitea username
|
||||
labels:
|
||||
wip: <id>
|
||||
ready: <id>
|
||||
review_bots: # sentinel names in review bodies
|
||||
- sonnet
|
||||
- gpt
|
||||
- security
|
||||
```
|
||||
|
||||
### Script Arguments
|
||||
|
||||
```bash
|
||||
bash dev-loop-dispatch.sh <project> # normal run
|
||||
DRY_RUN=1 bash dev-loop-dispatch.sh <project> # dry-run (no mutations)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. State
|
||||
|
||||
The dispatch script is **stateless per run**. All state lives in the Gitea API:
|
||||
|
||||
| State | API location |
|
||||
|-------|-------------|
|
||||
| Open PRs | `GET /repos/:repo/pulls?state=open` |
|
||||
| PR labels | `GET /repos/:repo/issues/:n/labels` |
|
||||
| PR reviews | `GET /repos/:repo/pulls/:n/reviews` |
|
||||
| CI status | `GET /repos/:repo/commits/:sha/status` |
|
||||
| Issue comments | `GET /repos/:repo/issues/:n/comments` |
|
||||
| Inline diff comments | `GET /repos/:repo/pulls/:n/comments` |
|
||||
| Issue timeline | `GET /repos/:repo/issues/:n/timeline` |
|
||||
|
||||
No file-based state. No cron-to-cron carry-over.
|
||||
|
||||
---
|
||||
|
||||
## 4. Output Protocol
|
||||
|
||||
The script emits structured lines to stdout. Stderr is diagnostic logging.
|
||||
|
||||
### `SPAWN:<type>:<number>:<sha>`
|
||||
|
||||
A worker is needed. The cron model reads this and spawns a subagent using the
|
||||
template at `worker-tasks/<type>.md`.
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| `type` | Worker type: `self-review`, `ci-fix`, `address-feedback`, `findings`, `rebase`, `impl` |
|
||||
| `number` | PR number (or issue number for `impl`) |
|
||||
| `sha` | HEAD SHA of the PR (empty for `impl`) |
|
||||
|
||||
At most **one SPAWN** is emitted per script run.
|
||||
|
||||
### `HANDOFF:<pr_num>`
|
||||
|
||||
All checks passed for `pr_num`. The script applied the `ready` label and assigned
|
||||
to the human reviewer. The cron model logs this and takes no further action.
|
||||
|
||||
Multiple HANDOFFs may be emitted in one run (one per qualifying PR).
|
||||
|
||||
---
|
||||
|
||||
## 5. Dispatch Rules
|
||||
|
||||
Rules are evaluated **in order** for each open PR. The first matching condition wins.
|
||||
Only one SPAWN is emitted per full pass.
|
||||
|
||||
### Rule 0: WIP Cleanup
|
||||
|
||||
For each open PR with a `wip` label:
|
||||
|
||||
1. Find the timestamp when the label was most recently applied (via timeline events)
|
||||
2. If age > 1hr: **remove the label** (stale lock — worker likely crashed)
|
||||
3. If age ≤ 1hr: **set ACTIVE_WIP=1** (do not exit, only gates Rule 10)
|
||||
|
||||
### Rule 2: REQUEST_CHANGES Blocks
|
||||
|
||||
**ALWAYS evaluated before any other per-PR rule.**
|
||||
|
||||
For each reviewer, take their **latest** review state. If any reviewer's latest
|
||||
state is `REQUEST_CHANGES`:
|
||||
|
||||
→ Acquire WIP label on this PR
|
||||
→ Emit `SPAWN:findings:<pr_num>:<head_sha>`
|
||||
→ Continue to next PR (but only one SPAWN total)
|
||||
|
||||
This rule cannot be bypassed by any condition. There is no waiver mechanism.
|
||||
|
||||
### Rule 3: Merge Conflicts
|
||||
|
||||
If `mergeable == false`:
|
||||
|
||||
→ Acquire WIP
|
||||
→ Emit `SPAWN:rebase:<pr_num>:<head_sha>`
|
||||
|
||||
### Rule 4: CI Failure
|
||||
|
||||
If CI state is `failure` or `error`:
|
||||
|
||||
- If a fix plan comment exists for this HEAD SHA: **skip** (worker in progress)
|
||||
- Otherwise:
|
||||
|
||||
→ Acquire WIP
|
||||
→ Emit `SPAWN:ci-fix:<pr_num>:<head_sha>`
|
||||
|
||||
### Rule 5: Bot Reviews Missing
|
||||
|
||||
For each configured `review_bot`, check whether a review body contains the
|
||||
sentinel `<!-- review-bot:<name> -->`.
|
||||
|
||||
If any sentinel is missing: **wait** (continue to next PR, no SPAWN).
|
||||
|
||||
### Rule 6: CI Pending/Unknown
|
||||
|
||||
If CI state is `pending` or `unknown`: **wait**.
|
||||
|
||||
### Rule 7: Self-Review
|
||||
|
||||
Check for a self-review comment from the bot user against the current HEAD SHA:
|
||||
- Comment contains `Self-review against <head_sha>`
|
||||
|
||||
Sub-cases:
|
||||
- **Missing**: No self-review comment →
|
||||
→ Acquire WIP, emit `SPAWN:self-review:<pr_num>:<head_sha>`
|
||||
- **Needs attention** (`Assessment: ⚠️`): Found, but has findings:
|
||||
- Fix plan exists for HEAD SHA: skip
|
||||
- No fix plan: → Acquire WIP, emit `SPAWN:sr-fix:<pr_num>:<head_sha>`
|
||||
- **Clean** (`Assessment: ✅ Clean`): Continue to Rule 8
|
||||
|
||||
### Rule 8: Unacknowledged Bot Review Findings
|
||||
|
||||
For each **current** (contains `Evaluated against <head_short>`) APPROVED bot review
|
||||
that has a findings table:
|
||||
|
||||
A finding is **unacknowledged** if it does not appear as `Finding #N` in a fix plan
|
||||
comment from the bot user for this HEAD SHA.
|
||||
|
||||
If any unacknowledged findings exist:
|
||||
- Fix plan exists: skip
|
||||
- No fix plan: → Acquire WIP, emit `SPAWN:address-feedback:<pr_num>:<head_sha>`
|
||||
|
||||
### Rule 9: Unresolved Inline Diff Comments
|
||||
|
||||
An inline diff comment is **unresolved** if:
|
||||
1. `in_reply_to_id` is null (top-level comment)
|
||||
2. `resolver` is null (not formally resolved)
|
||||
3. No other comment has `in_reply_to_id` pointing to this comment (no reply)
|
||||
|
||||
If unresolved comments exist:
|
||||
- Fix plan exists: skip
|
||||
- No fix plan: → Acquire WIP, emit `SPAWN:address-feedback:<pr_num>:<head_sha>`
|
||||
|
||||
### Rule 10: Handoff
|
||||
|
||||
All rules above passed. Verify all bot reviews are current (contain `Evaluated against <head_short>`).
|
||||
|
||||
If all current:
|
||||
- Apply `ready` label
|
||||
- Assign to `aweiker`
|
||||
- Emit `HANDOFF:<pr_num>`
|
||||
- Continue evaluating remaining PRs (do NOT exit)
|
||||
|
||||
If already assigned to `aweiker`: skip (assume handoff was already performed; continue to next PR without emitting another HANDOFF).
|
||||
|
||||
### Rule 11: New Issue Pickup
|
||||
|
||||
Only runs if: no open PRs exist AND `ACTIVE_WIP == 0`.
|
||||
|
||||
Fetch open, unassigned issues. Priority: bugs first, then by number ascending.
|
||||
|
||||
Claim the issue (assign to bot user to prevent double-pick), then:
|
||||
→ Emit `SPAWN:impl:<issue_num>:`
|
||||
|
||||
---
|
||||
|
||||
## 6. Safety Invariants
|
||||
|
||||
These are statically checked by `~/.openclaw/workspace/scripts/test/check-invariants.sh` and enforced in all changes:
|
||||
|
||||
| ID | Invariant |
|
||||
|----|-----------|
|
||||
| S1 | Zero merge API calls in dispatch script (`/merge` does not appear) |
|
||||
| S2 | REQUEST_CHANGES check (Rule 2) appears before CI check (Rule 4) |
|
||||
| S3 | REQUEST_CHANGES check (Rule 2) appears before ready label application (Rule 10) |
|
||||
| S4 | No model/AI API references in dispatch script |
|
||||
| S5 | `set -euo pipefail` present |
|
||||
| S6 | Active WIP does not cause early exit (only sets ACTIVE_WIP flag) |
|
||||
| S7 | SPAWN:impl guarded by `ACTIVE_WIP == 0` check |
|
||||
| S8 | No merge calls in any worker template |
|
||||
|
||||
---
|
||||
|
||||
## 7. Error Handling
|
||||
|
||||
| Error | Behavior |
|
||||
|-------|----------|
|
||||
| `curl` returns error | `set -euo pipefail` aborts script — no partial actions |
|
||||
| `jq` parse error | Script aborts |
|
||||
| Worker crashes | WIP label left on PR; stale WIP cleanup (Rule 0) removes it after 1hr |
|
||||
| Race: two crons fire | WIP mutex prevents double-dispatch for same PR |
|
||||
| `sessions_spawn` fails | Worker not spawned; WIP label orphaned → cleaned in 1hr |
|
||||
| Config file missing | Exit code 2 with error message |
|
||||
|
||||
---
|
||||
|
||||
## 8. Worker Templates
|
||||
|
||||
Each worker receives a precise task description with substituted values:
|
||||
|
||||
| Template | Trigger | Key job |
|
||||
|----------|---------|---------|
|
||||
| `self-review.md` | No clean self-review | Post self-review comment, remove WIP |
|
||||
| `sr-fix.md` | Self-review needs attention | Address self-review findings, push, remove WIP |
|
||||
| `ci-fix.md` | CI failing | Diagnose, fix, push, remove WIP |
|
||||
| `address-feedback.md` | Unacknowledged findings or inline comments | Address feedback, push, remove WIP |
|
||||
| `findings.md` | REQUEST_CHANGES present | Address REQUEST_CHANGES, push, remove WIP |
|
||||
| `rebase.md` | Merge conflicts | Rebase on main, push, remove WIP |
|
||||
| `impl.md` | New issue | Implement feature/fix, open PR |
|
||||
|
||||
Workers **always** remove the WIP label on completion and reply `NO_REPLY`.
|
||||
|
||||
---
|
||||
|
||||
## 9. Fixes for Issues #144 and #145
|
||||
|
||||
**Issue #144** (autonomous merge):
|
||||
The dispatch script contains no merge API calls anywhere. The `~/.openclaw/workspace/scripts/test/check-invariants.sh`
|
||||
invariant `S1` verifies this. Workers do not receive merge instructions.
|
||||
|
||||
**Issue #145** (merged despite REQUEST_CHANGES):
|
||||
Rule 2 is the **first** rule evaluated per PR. It cannot be skipped, reasoned past,
|
||||
or bypassed. It is checked before CI, before self-review, before handoff. The check
|
||||
uses latest-per-reviewer state, so a reviewer who re-approved after REQUEST_CHANGES
|
||||
is correctly handled.
|
||||
+83
-14
@@ -1,22 +1,91 @@
|
||||
// Package gitea provides a client for the Gitea API.
|
||||
// ipcheck.go re-exports the IsBlockedIP function from internal/netutil for use
|
||||
// by this package's safe dialer (client.go) and for backward compatibility with
|
||||
// any callers that previously imported it from here.
|
||||
//
|
||||
// The implementation has moved to internal/netutil so it can be shared with the
|
||||
// validate-url subcommand (cmd/review-bot/validateurl.go) without creating a
|
||||
// dependency from VCS-generic code on the Gitea-specific package.
|
||||
// ipcheck.go implements IP-level SSRF protection by checking resolved addresses
|
||||
// against known blocked CIDR ranges (RFC1918, loopback, link-local, etc.).
|
||||
package gitea
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net"
|
||||
|
||||
"gitea.weiker.me/rodin/review-bot/internal/netutil"
|
||||
)
|
||||
|
||||
// IsBlockedIP reports whether ip is in a blocked address range.
|
||||
// It delegates to internal/netutil.IsBlockedIP; see that function for the full
|
||||
// list of blocked ranges and IPv6-mapped IPv4 normalization behavior.
|
||||
func IsBlockedIP(ip net.IP) bool {
|
||||
return netutil.IsBlockedIP(ip)
|
||||
// blockedCIDRStrings is the canonical list of CIDR strings that should never
|
||||
// be contacted by review-bot. See IsBlockedIP for the full list of covered
|
||||
// address families.
|
||||
//
|
||||
// These are hard-coded literals: any parse failure is a programming error.
|
||||
// Validity is verified by TestBlockedCIDRsValid in ipcheck_test.go.
|
||||
var blockedCIDRStrings = []string{
|
||||
// IPv4 loopback
|
||||
"127.0.0.0/8",
|
||||
// IPv4 unspecified / "this network"
|
||||
"0.0.0.0/8",
|
||||
// RFC1918 private ranges
|
||||
"10.0.0.0/8",
|
||||
"172.16.0.0/12",
|
||||
"192.168.0.0/16",
|
||||
// IPv4 link-local (APIPA, also used by AWS instance metadata 169.254.169.254)
|
||||
"169.254.0.0/16",
|
||||
// IPv4 shared address space (RFC6598, carrier-grade NAT)
|
||||
"100.64.0.0/10",
|
||||
// IPv4 multicast
|
||||
"224.0.0.0/4",
|
||||
// IPv4 reserved / broadcast
|
||||
"240.0.0.0/4",
|
||||
// IPv6 loopback
|
||||
"::1/128",
|
||||
// IPv6 unspecified
|
||||
"::/128",
|
||||
// IPv6 link-local
|
||||
"fe80::/10",
|
||||
// IPv6 unique local (ULA) — RFC4193
|
||||
"fc00::/7",
|
||||
// IPv6 multicast
|
||||
"ff00::/8",
|
||||
}
|
||||
|
||||
// blockedCIDRs is the parsed form of blockedCIDRStrings.
|
||||
// Any entry that fails to parse is recorded in blockedCIDRParseErrors instead
|
||||
// of panicking; tests verify this slice is always empty via TestBlockedCIDRsValid.
|
||||
var (
|
||||
blockedCIDRs []*net.IPNet
|
||||
blockedCIDRParseErrors []string
|
||||
)
|
||||
|
||||
func init() {
|
||||
blockedCIDRs = make([]*net.IPNet, 0, len(blockedCIDRStrings))
|
||||
for _, r := range blockedCIDRStrings {
|
||||
_, cidr, err := net.ParseCIDR(r)
|
||||
if err != nil {
|
||||
// Record the error rather than panicking; TestBlockedCIDRsValid
|
||||
// will catch this during tests, and the CI build will fail.
|
||||
blockedCIDRParseErrors = append(blockedCIDRParseErrors,
|
||||
fmt.Sprintf("ipcheck: invalid built-in CIDR %q: %v", r, err))
|
||||
continue
|
||||
}
|
||||
blockedCIDRs = append(blockedCIDRs, cidr)
|
||||
}
|
||||
}
|
||||
|
||||
// IsBlockedIP reports whether ip is in a blocked address range.
|
||||
// It is exported for use by the validate-url subcommand and tests outside
|
||||
// this package.
|
||||
//
|
||||
// IPv6-mapped IPv4 addresses (e.g. ::ffff:192.168.1.1) are normalized to their
|
||||
// IPv4 form before checking so that IPv4 CIDRs catch them.
|
||||
//
|
||||
// Based on:
|
||||
// - RFC1918 private ranges
|
||||
// - RFC5735 / RFC4193 special-use IPv4/IPv6 ranges
|
||||
// - RFC4291 IPv6 link-local / loopback
|
||||
func IsBlockedIP(ip net.IP) bool {
|
||||
// Normalize IPv6-mapped IPv4 addresses (::ffff:x.x.x.x) to plain IPv4.
|
||||
if v4 := ip.To4(); v4 != nil {
|
||||
ip = v4
|
||||
}
|
||||
for _, cidr := range blockedCIDRs {
|
||||
if cidr.Contains(ip) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
+132
-25
@@ -3,35 +3,142 @@ package gitea
|
||||
import (
|
||||
"net"
|
||||
"testing"
|
||||
|
||||
"gitea.weiker.me/rodin/review-bot/internal/netutil"
|
||||
)
|
||||
|
||||
// TestIsBlockedIPForwarding verifies that gitea.IsBlockedIP correctly forwards
|
||||
// to internal/netutil.IsBlockedIP. Full coverage of the blocking logic lives in
|
||||
// internal/netutil/ipcheck_test.go.
|
||||
func TestIsBlockedIPForwarding(t *testing.T) {
|
||||
cases := []struct {
|
||||
ip string
|
||||
blocked bool
|
||||
func TestIsBlockedIP(t *testing.T) {
|
||||
blocked := []struct {
|
||||
name string
|
||||
ip string
|
||||
}{
|
||||
{"127.0.0.1", true}, // loopback — must be blocked
|
||||
{"192.168.1.1", true}, // RFC1918 — must be blocked
|
||||
{"8.8.8.8", false}, // public — must not be blocked
|
||||
{"2001:4860:4860::8888", false}, // public IPv6 — must not be blocked
|
||||
// IPv4 loopback
|
||||
{"loopback 127.0.0.1", "127.0.0.1"},
|
||||
{"loopback 127.0.0.2", "127.0.0.2"},
|
||||
{"loopback 127.255.255.255", "127.255.255.255"},
|
||||
// IPv4 unspecified
|
||||
{"unspecified 0.0.0.0", "0.0.0.0"},
|
||||
{"unspecified 0.1.2.3", "0.1.2.3"},
|
||||
// RFC1918
|
||||
{"RFC1918 10.0.0.1", "10.0.0.1"},
|
||||
{"RFC1918 10.255.255.255", "10.255.255.255"},
|
||||
{"RFC1918 172.16.0.1", "172.16.0.1"},
|
||||
{"RFC1918 172.31.255.255", "172.31.255.255"},
|
||||
{"RFC1918 192.168.0.1", "192.168.0.1"},
|
||||
{"RFC1918 192.168.255.255", "192.168.255.255"},
|
||||
// Link-local (APIPA / AWS metadata)
|
||||
{"link-local 169.254.0.1", "169.254.0.1"},
|
||||
{"link-local 169.254.169.254", "169.254.169.254"},
|
||||
// Shared address space (carrier-grade NAT)
|
||||
{"CGN 100.64.0.1", "100.64.0.1"},
|
||||
{"CGN 100.127.255.255", "100.127.255.255"},
|
||||
// Multicast
|
||||
{"multicast 224.0.0.1", "224.0.0.1"},
|
||||
{"multicast 239.255.255.255", "239.255.255.255"},
|
||||
// Reserved
|
||||
{"reserved 240.0.0.1", "240.0.0.1"},
|
||||
{"broadcast 255.255.255.255", "255.255.255.255"},
|
||||
// IPv6 loopback
|
||||
{"IPv6 loopback ::1", "::1"},
|
||||
// IPv6 unspecified
|
||||
{"IPv6 unspecified ::", "::"},
|
||||
// IPv6 link-local
|
||||
{"IPv6 link-local fe80::1", "fe80::1"},
|
||||
{"IPv6 link-local fe80::dead:beef", "fe80::dead:beef"},
|
||||
// IPv6 ULA
|
||||
{"IPv6 ULA fc00::1", "fc00::1"},
|
||||
{"IPv6 ULA fd00::1", "fd00::1"},
|
||||
// IPv6 multicast
|
||||
{"IPv6 multicast ff02::1", "ff02::1"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
ip := net.ParseIP(tc.ip)
|
||||
if ip == nil {
|
||||
t.Fatalf("failed to parse IP %q", tc.ip)
|
||||
}
|
||||
got := IsBlockedIP(ip)
|
||||
want := netutil.IsBlockedIP(ip)
|
||||
if got != want {
|
||||
t.Errorf("gitea.IsBlockedIP(%q) = %v, netutil.IsBlockedIP = %v: forwarding mismatch", tc.ip, got, want)
|
||||
}
|
||||
if got != tc.blocked {
|
||||
t.Errorf("gitea.IsBlockedIP(%q) = %v, want %v", tc.ip, got, tc.blocked)
|
||||
|
||||
for _, tc := range blocked {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
ip := net.ParseIP(tc.ip)
|
||||
if ip == nil {
|
||||
t.Fatalf("failed to parse IP %q", tc.ip)
|
||||
}
|
||||
if !IsBlockedIP(ip) {
|
||||
t.Errorf("IsBlockedIP(%q) = false, want true", tc.ip)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
allowed := []struct {
|
||||
name string
|
||||
ip string
|
||||
}{
|
||||
{"public 8.8.8.8", "8.8.8.8"},
|
||||
{"public 1.1.1.1", "1.1.1.1"},
|
||||
{"public 198.51.100.1", "198.51.100.1"}, // RFC5737 TEST-NET-2 — a documentation-only range;
|
||||
// not assigned to any real host, but intentionally left unblocked here because
|
||||
// it has no special routing treatment (unlike RFC1918/loopback/link-local) and
|
||||
// blocking it would require tracking every RFC5737 range without meaningful
|
||||
// security benefit (no server should ever listen on a TEST-NET address).
|
||||
{"public 151.101.1.1", "151.101.1.1"}, // Fastly
|
||||
{"public IPv6 2001:4860:4860::8888", "2001:4860:4860::8888"}, // Google DNS
|
||||
{"public IPv6 2606:4700:4700::1111", "2606:4700:4700::1111"}, // Cloudflare DNS
|
||||
}
|
||||
|
||||
for _, tc := range allowed {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
ip := net.ParseIP(tc.ip)
|
||||
if ip == nil {
|
||||
t.Fatalf("failed to parse IP %q", tc.ip)
|
||||
}
|
||||
if IsBlockedIP(ip) {
|
||||
t.Errorf("IsBlockedIP(%q) = true, want false", tc.ip)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsBlockedIPv6MappedIPv4(t *testing.T) {
|
||||
// ::ffff:192.168.1.1 is an IPv6-mapped IPv4 address — should be blocked as RFC1918.
|
||||
// Construct it manually as a 16-byte IP.
|
||||
mapped := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 192, 168, 1, 1}
|
||||
if !IsBlockedIP(mapped) {
|
||||
t.Errorf("IsBlockedIP(::ffff:192.168.1.1) = false, want true (IPv6-mapped IPv4 must be normalized)")
|
||||
}
|
||||
|
||||
// ::ffff:8.8.8.8 — IPv6-mapped public IP — should be allowed.
|
||||
mappedPublic := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 8, 8, 8, 8}
|
||||
if IsBlockedIP(mappedPublic) {
|
||||
t.Errorf("IsBlockedIP(::ffff:8.8.8.8) = true, want false")
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsBlockedIPEdgeCases(t *testing.T) {
|
||||
// The boundary between RFC1918 and public ranges.
|
||||
// 172.15.255.255 is NOT private (just below 172.16.0.0/12).
|
||||
notPrivate := net.ParseIP("172.15.255.255")
|
||||
if IsBlockedIP(notPrivate) {
|
||||
t.Errorf("IsBlockedIP(172.15.255.255) = true, want false (outside 172.16.0.0/12)")
|
||||
}
|
||||
// 172.32.0.0 is NOT private (just above 172.31.255.255).
|
||||
notPrivate2 := net.ParseIP("172.32.0.0")
|
||||
if IsBlockedIP(notPrivate2) {
|
||||
t.Errorf("IsBlockedIP(172.32.0.0) = true, want false (outside 172.16.0.0/12)")
|
||||
}
|
||||
// CGN: 100.63.255.255 is NOT in 100.64.0.0/10.
|
||||
notCGN := net.ParseIP("100.63.255.255")
|
||||
if IsBlockedIP(notCGN) {
|
||||
t.Errorf("IsBlockedIP(100.63.255.255) = true, want false (outside 100.64.0.0/10)")
|
||||
}
|
||||
// CGN: 100.128.0.0 is NOT in 100.64.0.0/10.
|
||||
notCGN2 := net.ParseIP("100.128.0.0")
|
||||
if IsBlockedIP(notCGN2) {
|
||||
t.Errorf("IsBlockedIP(100.128.0.0) = true, want false (outside 100.64.0.0/10)")
|
||||
}
|
||||
}
|
||||
|
||||
// TestBlockedCIDRsValid verifies that all entries in blockedCIDRStrings parse
|
||||
// successfully. This catches programming errors in the CIDR list without
|
||||
// requiring a startup panic. The init() function records parse failures in
|
||||
// blockedCIDRParseErrors rather than panicking; this test makes those failures
|
||||
// visible as test failures during CI.
|
||||
func TestBlockedCIDRsValid(t *testing.T) {
|
||||
if len(blockedCIDRParseErrors) > 0 {
|
||||
for _, msg := range blockedCIDRParseErrors {
|
||||
t.Errorf("CIDR parse error: %s", msg)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,97 +0,0 @@
|
||||
// Package netutil provides shared network utilities for review-bot.
|
||||
// ipcheck.go implements IP-level SSRF protection by checking resolved addresses
|
||||
// against known blocked CIDR ranges (RFC1918, loopback, link-local, etc.).
|
||||
package netutil
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net"
|
||||
)
|
||||
|
||||
// blockedCIDRStrings is the canonical list of CIDR strings that should never
|
||||
// be contacted by review-bot. See IsBlockedIP for the full list of covered
|
||||
// address families.
|
||||
//
|
||||
// These are hard-coded literals: any parse failure is a programming error.
|
||||
// Validity is verified by TestBlockedCIDRsValid in ipcheck_test.go.
|
||||
var blockedCIDRStrings = []string{
|
||||
// IPv4 loopback
|
||||
"127.0.0.0/8",
|
||||
// IPv4 unspecified / "this network"
|
||||
"0.0.0.0/8",
|
||||
// RFC1918 private ranges
|
||||
"10.0.0.0/8",
|
||||
"172.16.0.0/12",
|
||||
"192.168.0.0/16",
|
||||
// IPv4 link-local (APIPA, also used by AWS instance metadata 169.254.169.254)
|
||||
"169.254.0.0/16",
|
||||
// IPv4 shared address space (RFC6598, carrier-grade NAT)
|
||||
"100.64.0.0/10",
|
||||
// IPv4 multicast
|
||||
"224.0.0.0/4",
|
||||
// IPv4 reserved / broadcast
|
||||
"240.0.0.0/4",
|
||||
// IPv6 loopback
|
||||
"::1/128",
|
||||
// IPv6 unspecified
|
||||
"::/128",
|
||||
// IPv6 link-local
|
||||
"fe80::/10",
|
||||
// IPv6 unique local (ULA) — RFC4193
|
||||
"fc00::/7",
|
||||
// IPv6 multicast
|
||||
"ff00::/8",
|
||||
}
|
||||
|
||||
// blockedCIDRs is the parsed form of blockedCIDRStrings.
|
||||
// Any entry that fails to parse is recorded in blockedCIDRParseErrors instead
|
||||
// of panicking; tests verify this slice is always empty via TestBlockedCIDRsValid.
|
||||
var (
|
||||
blockedCIDRs []*net.IPNet
|
||||
blockedCIDRParseErrors []string
|
||||
)
|
||||
|
||||
func init() {
|
||||
blockedCIDRs = make([]*net.IPNet, 0, len(blockedCIDRStrings))
|
||||
for _, r := range blockedCIDRStrings {
|
||||
_, cidr, err := net.ParseCIDR(r)
|
||||
if err != nil {
|
||||
// Record the error rather than panicking; TestBlockedCIDRsValid
|
||||
// will catch this during tests, and the CI build will fail.
|
||||
blockedCIDRParseErrors = append(blockedCIDRParseErrors,
|
||||
fmt.Sprintf("ipcheck: invalid built-in CIDR %q: %v", r, err))
|
||||
continue
|
||||
}
|
||||
blockedCIDRs = append(blockedCIDRs, cidr)
|
||||
}
|
||||
}
|
||||
|
||||
// BlockedCIDRParseErrors returns any errors encountered parsing the built-in
|
||||
// CIDR list. In correct code this will always be empty; tests assert it is.
|
||||
func BlockedCIDRParseErrors() []string {
|
||||
return blockedCIDRParseErrors
|
||||
}
|
||||
|
||||
// IsBlockedIP reports whether ip is in a blocked address range.
|
||||
// It is exported for use by the gitea package's safe dialer, the validate-url
|
||||
// subcommand, and tests outside this package.
|
||||
//
|
||||
// IPv6-mapped IPv4 addresses (e.g. ::ffff:192.168.1.1) are normalized to their
|
||||
// IPv4 form before checking so that IPv4 CIDRs catch them.
|
||||
//
|
||||
// Based on:
|
||||
// - RFC1918 private ranges
|
||||
// - RFC5735 / RFC4193 special-use IPv4/IPv6 ranges
|
||||
// - RFC4291 IPv6 link-local / loopback
|
||||
func IsBlockedIP(ip net.IP) bool {
|
||||
// Normalize IPv6-mapped IPv4 addresses (::ffff:x.x.x.x) to plain IPv4.
|
||||
if v4 := ip.To4(); v4 != nil {
|
||||
ip = v4
|
||||
}
|
||||
for _, cidr := range blockedCIDRs {
|
||||
if cidr.Contains(ip) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
@@ -1,142 +0,0 @@
|
||||
package netutil
|
||||
|
||||
import (
|
||||
"net"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestIsBlockedIP(t *testing.T) {
|
||||
blocked := []struct {
|
||||
name string
|
||||
ip string
|
||||
}{
|
||||
// IPv4 loopback
|
||||
{"loopback 127.0.0.1", "127.0.0.1"},
|
||||
{"loopback 127.0.0.2", "127.0.0.2"},
|
||||
{"loopback 127.255.255.255", "127.255.255.255"},
|
||||
// IPv4 unspecified
|
||||
{"unspecified 0.0.0.0", "0.0.0.0"},
|
||||
{"unspecified 0.1.2.3", "0.1.2.3"},
|
||||
// RFC1918
|
||||
{"RFC1918 10.0.0.1", "10.0.0.1"},
|
||||
{"RFC1918 10.255.255.255", "10.255.255.255"},
|
||||
{"RFC1918 172.16.0.1", "172.16.0.1"},
|
||||
{"RFC1918 172.31.255.255", "172.31.255.255"},
|
||||
{"RFC1918 192.168.0.1", "192.168.0.1"},
|
||||
{"RFC1918 192.168.255.255", "192.168.255.255"},
|
||||
// Link-local (APIPA / AWS metadata)
|
||||
{"link-local 169.254.0.1", "169.254.0.1"},
|
||||
{"link-local 169.254.169.254", "169.254.169.254"},
|
||||
// Shared address space (carrier-grade NAT)
|
||||
{"CGN 100.64.0.1", "100.64.0.1"},
|
||||
{"CGN 100.127.255.255", "100.127.255.255"},
|
||||
// Multicast
|
||||
{"multicast 224.0.0.1", "224.0.0.1"},
|
||||
{"multicast 239.255.255.255", "239.255.255.255"},
|
||||
// Reserved
|
||||
{"reserved 240.0.0.1", "240.0.0.1"},
|
||||
{"broadcast 255.255.255.255", "255.255.255.255"},
|
||||
// IPv6 loopback
|
||||
{"IPv6 loopback ::1", "::1"},
|
||||
// IPv6 unspecified
|
||||
{"IPv6 unspecified ::", "::"},
|
||||
// IPv6 link-local
|
||||
{"IPv6 link-local fe80::1", "fe80::1"},
|
||||
{"IPv6 link-local fe80::dead:beef", "fe80::dead:beef"},
|
||||
// IPv6 ULA
|
||||
{"IPv6 ULA fc00::1", "fc00::1"},
|
||||
{"IPv6 ULA fd00::1", "fd00::1"},
|
||||
// IPv6 multicast
|
||||
{"IPv6 multicast ff02::1", "ff02::1"},
|
||||
}
|
||||
|
||||
for _, tc := range blocked {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
ip := net.ParseIP(tc.ip)
|
||||
if ip == nil {
|
||||
t.Fatalf("failed to parse IP %q", tc.ip)
|
||||
}
|
||||
if !IsBlockedIP(ip) {
|
||||
t.Errorf("IsBlockedIP(%q) = false, want true", tc.ip)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
allowed := []struct {
|
||||
name string
|
||||
ip string
|
||||
}{
|
||||
{"public 8.8.8.8", "8.8.8.8"},
|
||||
{"public 1.1.1.1", "1.1.1.1"},
|
||||
{"public 198.51.100.1", "198.51.100.1"}, // RFC5737 TEST-NET-2 — a documentation-only range;
|
||||
// not assigned to any real host, but intentionally left unblocked here because
|
||||
// it has no special routing treatment (unlike RFC1918/loopback/link-local) and
|
||||
// blocking it would require tracking every RFC5737 range without meaningful
|
||||
// security benefit (no server should ever listen on a TEST-NET address).
|
||||
{"public 151.101.1.1", "151.101.1.1"}, // Fastly
|
||||
{"public IPv6 2001:4860:4860::8888", "2001:4860:4860::8888"}, // Google DNS
|
||||
{"public IPv6 2606:4700:4700::1111", "2606:4700:4700::1111"}, // Cloudflare DNS
|
||||
}
|
||||
|
||||
for _, tc := range allowed {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
ip := net.ParseIP(tc.ip)
|
||||
if ip == nil {
|
||||
t.Fatalf("failed to parse IP %q", tc.ip)
|
||||
}
|
||||
if IsBlockedIP(ip) {
|
||||
t.Errorf("IsBlockedIP(%q) = true, want false", tc.ip)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsBlockedIPv6MappedIPv4(t *testing.T) {
|
||||
// ::ffff:192.168.1.1 is an IPv6-mapped IPv4 address — should be blocked as RFC1918.
|
||||
// Construct it manually as a 16-byte IP.
|
||||
mapped := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 192, 168, 1, 1}
|
||||
if !IsBlockedIP(mapped) {
|
||||
t.Errorf("IsBlockedIP(::ffff:192.168.1.1) = false, want true (IPv6-mapped IPv4 must be normalized)")
|
||||
}
|
||||
|
||||
// ::ffff:8.8.8.8 — IPv6-mapped public IP — should be allowed.
|
||||
mappedPublic := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 8, 8, 8, 8}
|
||||
if IsBlockedIP(mappedPublic) {
|
||||
t.Errorf("IsBlockedIP(::ffff:8.8.8.8) = true, want false")
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsBlockedIPEdgeCases(t *testing.T) {
|
||||
// The boundary between RFC1918 and public ranges.
|
||||
// 172.15.255.255 is NOT private (just below 172.16.0.0/12).
|
||||
notPrivate := net.ParseIP("172.15.255.255")
|
||||
if IsBlockedIP(notPrivate) {
|
||||
t.Errorf("IsBlockedIP(172.15.255.255) = true, want false (outside 172.16.0.0/12)")
|
||||
}
|
||||
// 172.32.0.0 is NOT private (just above 172.31.255.255).
|
||||
notPrivate2 := net.ParseIP("172.32.0.0")
|
||||
if IsBlockedIP(notPrivate2) {
|
||||
t.Errorf("IsBlockedIP(172.32.0.0) = true, want false (outside 172.16.0.0/12)")
|
||||
}
|
||||
// CGN: 100.63.255.255 is NOT in 100.64.0.0/10.
|
||||
notCGN := net.ParseIP("100.63.255.255")
|
||||
if IsBlockedIP(notCGN) {
|
||||
t.Errorf("IsBlockedIP(100.63.255.255) = true, want false (outside 100.64.0.0/10)")
|
||||
}
|
||||
// CGN: 100.128.0.0 is NOT in 100.64.0.0/10.
|
||||
notCGN2 := net.ParseIP("100.128.0.0")
|
||||
if IsBlockedIP(notCGN2) {
|
||||
t.Errorf("IsBlockedIP(100.128.0.0) = true, want false (outside 100.64.0.0/10)")
|
||||
}
|
||||
}
|
||||
|
||||
// TestBlockedCIDRsValid verifies that all entries in blockedCIDRStrings parse
|
||||
// successfully. This catches programming errors in the CIDR list without
|
||||
// requiring a startup panic. The init() function records parse failures in
|
||||
// blockedCIDRParseErrors rather than panicking; this test makes those failures
|
||||
// visible as test failures during CI.
|
||||
func TestBlockedCIDRsValid(t *testing.T) {
|
||||
for _, msg := range BlockedCIDRParseErrors() {
|
||||
t.Errorf("CIDR parse error: %s", msg)
|
||||
}
|
||||
}
|
||||
+8
-40
@@ -52,48 +52,20 @@ func ParseDocMapConfig(localPath string) (*DocMapConfig, error) {
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read doc-map file %q: %w", localPath, err)
|
||||
}
|
||||
return parseDocMapBytes(data, localPath)
|
||||
}
|
||||
|
||||
// ParseDocMapConfigContent parses a doc-map YAML config from an in-memory
|
||||
// string. The source parameter is used only for error messages and log entries
|
||||
// (e.g. "owner/repo@main:.review-bot/doc-map.yml").
|
||||
//
|
||||
// Use this when the config content has been fetched from a trusted VCS ref
|
||||
// rather than read from the local workspace.
|
||||
func ParseDocMapConfigContent(content, source string) (*DocMapConfig, error) {
|
||||
data := []byte(content)
|
||||
return parseDocMapBytes(data, source)
|
||||
}
|
||||
|
||||
// parseDocMapBytes is the shared YAML parse implementation used by
|
||||
// ParseDocMapConfig and ParseDocMapConfigContent.
|
||||
func parseDocMapBytes(data []byte, source string) (*DocMapConfig, error) {
|
||||
var cfg DocMapConfig
|
||||
if err := yaml.UnmarshalWithOptions(data, &cfg, yaml.Strict()); err != nil {
|
||||
// Re-parse without strict mode to log which keys are unknown.
|
||||
var relaxed DocMapConfig
|
||||
if err2 := yaml.Unmarshal(data, &relaxed); err2 != nil {
|
||||
return nil, fmt.Errorf("parse doc-map YAML %q: %w", source, err)
|
||||
return nil, fmt.Errorf("parse doc-map YAML %q: %w", localPath, err)
|
||||
}
|
||||
slog.Warn("doc-map YAML contains unknown keys (ignored)", "file", source, "error", err)
|
||||
slog.Warn("doc-map YAML contains unknown keys (ignored)", "file", localPath, "error", err)
|
||||
cfg = relaxed
|
||||
}
|
||||
return &cfg, nil
|
||||
}
|
||||
|
||||
// FileCoveredByDocMap reports whether at least one paths: glob in any mapping
|
||||
// of cfg matches the given file path. It is used by static validation tooling
|
||||
// (e.g. the validate-docmap subcommand) to check per-file docmap coverage.
|
||||
func FileCoveredByDocMap(cfg *DocMapConfig, file string) bool {
|
||||
for _, mapping := range cfg.Mappings {
|
||||
if mappingMatches(mapping.Paths, []string{file}) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// MatchDocs returns deduplicated doc paths for the given changed file paths.
|
||||
// A mapping matches if any of its path globs matches any of the changed files.
|
||||
func MatchDocs(cfg *DocMapConfig, changedFiles []string) []string {
|
||||
@@ -273,7 +245,7 @@ type docEntry struct {
|
||||
// If the path is a directory, all .md files under it are returned.
|
||||
// If it's a file, a single entry is returned.
|
||||
func loadDocEntries(ctx context.Context, fetcher DocFetcher, owner, repo, docPath string) ([]docEntry, error) {
|
||||
if err := ValidateDocPath(docPath); err != nil {
|
||||
if err := validateDocPath(docPath); err != nil {
|
||||
return nil, fmt.Errorf("doc path %q rejected: %w", docPath, err)
|
||||
}
|
||||
|
||||
@@ -326,15 +298,11 @@ func readFileBytes(path string) ([]byte, error) {
|
||||
return os.ReadFile(path)
|
||||
}
|
||||
|
||||
// ValidateDocPath rejects doc paths that could cause path traversal
|
||||
// (absolute paths, any ".." segment, backslashes). Defense-in-depth: callers
|
||||
// must also confine the joined path to the repo root via filepath.Rel before
|
||||
// any filesystem access. Backslashes are rejected explicitly to prevent
|
||||
// Windows platform edge cases.
|
||||
func ValidateDocPath(p string) error {
|
||||
if strings.Contains(p, "\\") {
|
||||
return fmt.Errorf("backslashes not allowed in doc paths")
|
||||
}
|
||||
// validateDocPath rejects doc paths that could cause path traversal via the
|
||||
// VCS API (absolute paths, any ".." segment). Defense-in-depth: the VCS API
|
||||
// should already scope paths to the repo, but we validate locally to avoid
|
||||
// any quirk in backend path handling.
|
||||
func validateDocPath(p string) error {
|
||||
if filepath.IsAbs(p) {
|
||||
return fmt.Errorf("absolute paths not allowed")
|
||||
}
|
||||
|
||||
+3
-137
@@ -11,7 +11,7 @@ import (
|
||||
|
||||
// fakeDocFetcher is a mock DocFetcher for tests.
|
||||
type fakeDocFetcher struct {
|
||||
files map[string]string // path -> content
|
||||
files map[string]string // path -> content
|
||||
dirs map[string]map[string]string // dir path -> (file path -> content)
|
||||
}
|
||||
|
||||
@@ -384,7 +384,7 @@ func TestValidateDocPath(t *testing.T) {
|
||||
"a/b/c",
|
||||
}
|
||||
for _, p := range valid {
|
||||
if err := ValidateDocPath(p); err != nil {
|
||||
if err := validateDocPath(p); err != nil {
|
||||
t.Errorf("expected valid path %q to pass, got error: %v", p, err)
|
||||
}
|
||||
}
|
||||
@@ -395,13 +395,9 @@ func TestValidateDocPath(t *testing.T) {
|
||||
"docs/../../../etc/passwd",
|
||||
"../sibling-repo/file.md",
|
||||
"a/b/../c",
|
||||
// Backslashes must be rejected (Finding #3 — Windows platform edge cases).
|
||||
`docs\foo.md`,
|
||||
`docs\..\secret`,
|
||||
`\absolute`,
|
||||
}
|
||||
for _, p := range invalid {
|
||||
if err := ValidateDocPath(p); err == nil {
|
||||
if err := validateDocPath(p); err == nil {
|
||||
t.Errorf("expected path %q to be rejected, but it was accepted", p)
|
||||
}
|
||||
}
|
||||
@@ -424,27 +420,6 @@ func TestLoadMatchingDocs_PathTraversalRejected(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestValidateDocPath_Backslash verifies that backslash-bearing paths are
|
||||
// rejected to prevent Windows platform edge cases where a path separator
|
||||
// could be normalised differently by the host OS or VCS backend.
|
||||
func TestValidateDocPath_Backslash(t *testing.T) {
|
||||
backslashPaths := []string{
|
||||
`docs\foo.md`,
|
||||
`docs\subdir\file.md`,
|
||||
`\absolute`,
|
||||
}
|
||||
for _, p := range backslashPaths {
|
||||
if err := ValidateDocPath(p); err == nil {
|
||||
t.Errorf("expected backslash path %q to be rejected, but it was accepted", p)
|
||||
}
|
||||
}
|
||||
|
||||
// Sanity: forward-slash path must still be accepted.
|
||||
if err := ValidateDocPath("docs/foo.md"); err != nil {
|
||||
t.Errorf("expected forward-slash path to be accepted, got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================================
|
||||
// Helpers
|
||||
// ============================================================
|
||||
@@ -461,112 +436,3 @@ func writeTempYAML(t *testing.T, content string) string {
|
||||
}
|
||||
return filepath.Clean(f.Name())
|
||||
}
|
||||
|
||||
// ============================================================
|
||||
// FileCoveredByDocMap
|
||||
// ============================================================
|
||||
|
||||
func TestFileCoveredByDocMap(t *testing.T) {
|
||||
cfg := &DocMapConfig{
|
||||
Mappings: []DocMapping{
|
||||
{
|
||||
Paths: []string{"lib/foo/**", "lib/bar/*.go"},
|
||||
Docs: []string{"docs/foo.md"},
|
||||
},
|
||||
{
|
||||
Paths: []string{"cmd/**"},
|
||||
Docs: []string{"docs/cmd.md"},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
cases := []struct {
|
||||
file string
|
||||
covered bool
|
||||
}{
|
||||
{"lib/foo/baz.ex", true},
|
||||
{"lib/foo/sub/deep.ex", true},
|
||||
{"lib/bar/util.go", true},
|
||||
{"lib/bar/sub/util.go", false}, // *.go only matches one level
|
||||
{"cmd/main.go", true},
|
||||
{"cmd/sub/main.go", true},
|
||||
{"internal/secret.go", false},
|
||||
{"", false},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.file, func(t *testing.T) {
|
||||
got := FileCoveredByDocMap(cfg, tc.file)
|
||||
if got != tc.covered {
|
||||
t.Errorf("FileCoveredByDocMap(%q) = %v, want %v", tc.file, got, tc.covered)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFileCoveredByDocMap_EmptyConfig(t *testing.T) {
|
||||
cfg := &DocMapConfig{}
|
||||
if FileCoveredByDocMap(cfg, "lib/foo/bar.go") {
|
||||
t.Error("expected false for empty config, got true")
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================================
|
||||
// ParseDocMapConfigContent
|
||||
// ============================================================
|
||||
|
||||
func TestParseDocMapConfigContent_Valid(t *testing.T) {
|
||||
content := `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/foo/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
`
|
||||
cfg, err := ParseDocMapConfigContent(content, "owner/repo@main:.review-bot/doc-map.yml")
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if len(cfg.Mappings) != 1 {
|
||||
t.Fatalf("expected 1 mapping, got %d", len(cfg.Mappings))
|
||||
}
|
||||
if len(cfg.Mappings[0].Docs) != 1 || cfg.Mappings[0].Docs[0] != "docs/foo.md" {
|
||||
t.Errorf("unexpected mapping: %+v", cfg.Mappings[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseDocMapConfigContent_EmptyContent(t *testing.T) {
|
||||
cfg, err := ParseDocMapConfigContent("", "test-source")
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error for empty content: %v", err)
|
||||
}
|
||||
if len(cfg.Mappings) != 0 {
|
||||
t.Errorf("expected 0 mappings for empty content, got %d", len(cfg.Mappings))
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseDocMapConfigContent_InvalidYAML(t *testing.T) {
|
||||
_, err := ParseDocMapConfigContent("mappings: [{{invalid", "test-source")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for invalid YAML, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseDocMapConfigContent_UnknownKeys(t *testing.T) {
|
||||
content := `
|
||||
mappings:
|
||||
- paths:
|
||||
- "lib/**"
|
||||
docs:
|
||||
- docs/foo.md
|
||||
unknown_top_level_key: "should be warned but not fatal"
|
||||
`
|
||||
// Unknown top-level keys produce a warning but not an error.
|
||||
cfg, err := ParseDocMapConfigContent(content, "test-source")
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error for unknown keys: %v", err)
|
||||
}
|
||||
if len(cfg.Mappings) == 0 {
|
||||
t.Error("expected mappings to be parsed despite unknown key")
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user