fix(tests): canonicalize the temp repo path in the integration helper - #200
Conversation
cmd_clean --merged uses nested registered worktree path failed on macOS and passed in CI. setup_integration_repo took its path straight from mktemp -d, which on macOS returns /var/folders/... while /var is a symlink to /private/var. git canonicalizes when it registers a worktree, so the hook received /private/var/... and the assertion compared it against the /var/... spelling. Verified this is the test's expectation being wrong rather than a product bug: passing /var/... to `git worktree add` makes git itself register /private/var/..., so the canonical path a hook receives is git's own behavior. Resolving the path in the helper fixes it for every integration test rather than patching the one assertion. Linux is unaffected, since mktemp -d returns /tmp with no symlink to resolve. Full suite now passes locally: 561/561, previously 560/561.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 100 included reviews per hour; 98 remain after this review. WalkthroughThe integration helper now canonicalizes temporary repository paths before storing them. This aligns macOS paths with Git’s registered worktree paths. The changelog documents the fix. Product code remains unchanged. ChangesIntegration test path canonicalization
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Bug fix · Severity of issue fixed: Low Suggested reviewers: Merge Risk: ⚪ Minimal · up to This test-only change aligns macOS path spellings without changing product behavior. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
A rabbit hops where temp paths wind Comment |
* Detect and recover locked worktree entries with missing directories (coderabbitai#182) git worktree prune skips locked entries by design, so a locked worktree whose directory was deleted (e.g. a crashed agent session) lingers in the registry and keeps its branch checked out. clean now detects this, offers to unlock and prune (auto-confirmed by --force/--yes, previewed by --dry-run), and prints the manual recovery command when declined. * feat(clean): support closed PR cleanup (coderabbitai#183) * feat(clean): support closed PR cleanup Assisted-by: pi:gpt-5.5 Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> * fix(clean): address closed cleanup review nits Assisted-by: pi:gpt-5.5 Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> * fix(clean): match GitLab head_sha fallback Assisted-by: pi:gpt-5.5 Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> --------- Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> * Release v2.8.0 * Replace Homebrew bump action with direct formula update (coderabbitai#184) * Replace Homebrew bump action with direct formula update * Allow manual formula bump via workflow_dispatch * Return non-zero when git gtr rm fails (coderabbitai#190) * Fix rm exit status on removal failures * Test public rm failure status * chore: prepare v2.8.1 release * fix(copy): bound includeDirs discovery (coderabbitai#191) * fix(copy): bound includeDirs discovery * test(copy): allow filesystem result order * fix(copy): preserve basename fallback * chore: prepare v2.8.2 release * feat: inherit sparse-checkout in new worktrees (coderabbitai#186) * feat: inherit sparse-checkout in new worktrees When creating a new worktree from one with sparse-checkout enabled, the new worktree inherits the cone pattern automatically. Controlled by gtr.sparse.inherit config (default on) and --sparse/--no-sparse flags. Adds reusable helpers for sparse-checkout replication. * fix(sparse): address CodeRabbit review feedback on sparse-checkout inheritance - Preserve slash-separated branch paths in _worktree_path_for_ref - Allow fallback to top-level worktree when matching worktree is not sparse - Add Git 2.25+ guard for sparse-checkout support with full checkout fallback - Fix non-cone mode to use init --no-cone (git defaults to cone mode) - Improve error handling: failed sparse inheritance now falls back to full checkout and hard-errors if that fails, instead of leaving --no-checkout worktree empty - Add tests for slash refs, non-cone inheritance, and sparse config precedence * fix: harden sparse-checkout inheritance * fix: support pre-2.20 config lookup * fix: align sparse sources with git refs --------- Co-authored-by: Tom Elizaga <tom.elizaga@gmail.com> * Add PR worktree checkout command (coderabbitai#187) * feat: add pull request worktree command Assisted-by: pi:gpt-5.5 Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> * fix: make pr worktrees gh-aware Assisted-by: pi:gpt-5.5 Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> * fix: harden pr worktree checkout Assisted-by: pi:gpt-5.5 Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> * fix: address pr review feedback Assisted-by: pi:gpt-5.5 Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> --------- Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> Co-authored-by: Tom Elizaga <tom.elizaga@gmail.com> * Run CI on fork pull requests (coderabbitai#185) * Run CI on fork pull requests * fix(ci): minimize fork pull request permissions * chore: prepare v2.9.0 release * feat: add machine-readable worktree creation for agents (coderabbitai#192) Adds stable porcelain output and hook disposition reporting for shell-native agent integrations, with tests and documentation. * chore: prepare v2.10.0 release * Refresh editor and AI adapter guidance (coderabbitai#193) * Refresh editor and AI adapter guidance * Address PR review: mark legacy adapter rows * chore: prepare v2.11.0 release * Use preinstalled ShellCheck in CI (coderabbitai#194) ci: use preinstalled ShellCheck * docs: add maintainers section to README (coderabbitai#195) The repository has a CODEOWNERS entry but nothing in the README identifies who maintains the project, so anyone landing on it has to check the contributors graph to find out. Also links the contributor list, since much of the adapter, platform and shell-integration surface came from outside contributions. * fix: make GTR_DEBUG actually report the failing location (coderabbitai#199) bin/git-gtr installed an ERR trap when GTR_DEBUG was set but ran under 'set -e' alone. An ERR trap is inherited by functions, command substitutions and subshells only under 'set -E', and every command runs inside main() and a cmd_* handler, so the trap never fired. Switch the option line to 'set -eE'. With no ERR trap installed the option has no effect, so the default path is unchanged. Adds tests/debug_trap.bats covering the function and subshell contexts, plus silence on success, on a handled error path, and when GTR_DEBUG is unset. * docs: refresh agent guides, README flags, and troubleshooting for v2.11 (coderabbitai#197) Brings AGENTS.md, CLAUDE.md, README and the docs/ pages in line with what shipped in v2.9 through v2.11. Fixes two errors: AGENTS.md pointed at a nonexistent adapters/ai/Codex.sh, and docs/troubleshooting.md told users to run 'bash -x git gtr', which cannot work because git is a binary. The architecture diagram there also had bin/git-gtr and bin/gtr the wrong way round. Adds --sparse/--no-sparse to the README, the missing GTR_* fallback variables and the direct-read variables to docs/configuration.md, and a side-effect section to docs/agent-usage.md. AGENTS.md and CLAUDE.md now cover pr, trust, clean --closed, sparse inheritance, postCd dispatch and the current test layout. * docs: rewrite Copilot instructions and align contributor guides with the current layout (coderabbitai#198) The Copilot instructions predated the lib/ modularization: they described bin/gtr as a 961-line monolith with an 'open' command, cmd_* functions inside bin/gtr, six lib files, and GTR_VERSION on line 8. Rewritten as a condensed guide matching bin/git-gtr, the ten lib modules plus 18 command files, the adapter registry, pr/trust/cd handling, the --porcelain contract and the CI gates. The per-pattern instruction files and CONTRIBUTING.md told contributors to hand-edit the three completion files, which are generated by scripts/generate-completions.sh and verified by CI. Every such place now says to edit the source and regenerate. Also corrects four claims an independent verification pass disproved: the GTR_DEBUG behavior, the postCd dispatch paths, what 'git gtr completion zsh' prints, and the cmd_<command> dispatch rule. * chore: prepare v2.11.1 release * fix(tests): canonicalize the temp repo path in the integration helper (coderabbitai#200) setup_integration_repo took its path straight from mktemp -d, which on macOS returns /var/folders/... while /var is a symlink to /private/var. git canonicalizes when it registers a worktree, so the preRemove hook received the /private/var spelling and 'cmd_clean --merged uses nested registered worktree path' compared it against the /var one. This is the test's expectation being wrong rather than a product bug: passing a /var path to 'git worktree add' makes git itself register the resolved one. Resolving the path once in the helper fixes it for every integration test. Linux is unaffected, since mktemp -d returns /tmp with no symlink, which is why CI stayed green. Local suite now passes 561/561, previously 560/561. * chore: normalize Windows shell execution for TigerEye (cherry picked from commit 26ceb92) * fix: make trust hashing portable and fail closed (#3) Bead: TE-7sebjb (cherry picked from commit 11a06a8) --------- Co-authored-by: Tom Elizaga <tom.elizaga@gmail.com> Co-authored-by: scarf <greenscarf005@gmail.com> Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> Co-authored-by: Adam Wettreich <80975389+adamwett@users.noreply.github.com> Co-authored-by: BashNetCorp <your.email@example.com>
Description
cmd_clean --merged uses nested registered worktree pathfails on macOS and passes in CI.setup_integration_repotook its path straight frommktemp -d, which on macOS returns/var/folders/...while/varis a symlink to/private/var. git canonicalizes when it registers a worktree, so thepreRemovehook received the/private/varspelling and the assertion compared it against the/varone:Resolving the path once in the helper fixes it for every integration test rather than patching the single assertion. Linux is unaffected, because
mktemp -dreturns/tmpwith no symlink to resolve, which is why CI was green throughout.Motivation
The suite was permanently red on macOS, which trains contributors to ignore failures and hides real regressions behind an expected one.
Type of Change
This is the test being wrong, not the product
Worth stating explicitly, since "make the failing assertion pass" can hide a defect. Passing a
/varpath togit worktree addmakes git itself register the resolved one:So the canonical path a hook receives is git's own behavior and the correct thing for
cmd_cleanto pass along. The test's expectation was the part that was wrong.Testing
Tested on:
Linux coverage comes from the CI Tests job on this PR.
Automated gates
bats tests/— 561 of 561 pass, up from 560 of 561. This is the first fully green local run.shellcheck bin/gtr bin/git-gtr lib/*.sh lib/commands/*.sh adapters/editor/*.sh adapters/ai/*.sh— clean../scripts/generate-completions.sh --check— up to date.Teardown still removes the temporary directories; no strays remain after a run.
Breaking Changes
None. Test-only; no shipped code paths change.
Checklist
cd -P … && pwdmatches the existing idiom inbin/gtrandbin/git-gtr)--checkpasses)git gtrand./bin/gtr🤖 Generated with Claude Code
Summary by CodeRabbit
Bug Fixes
Documentation