mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-10 14:27:00 -04:00
b618d2d11a
```markdown
## Description
When `headroom wrap claude` registers RTK hooks, the generated `~/.claude/hooks/rtk-rewrite.sh` script uses a bare `rtk` command that depends on PATH lookup. Since `~/.headroom/bin` is not automatically added to PATH, the hook fails silently and token compression never occurs.
After `register_claude_hooks()` succeeds, a new helper `_patch_rtk_hook_absolute_path()` reads the generated hook script and replaces bare `rtk` references with the absolute binary path (e.g. `/home/user/.headroom/bin/rtk`). The patch is idempotent and only writes back if content actually changed. Paths containing spaces or shell-special characters are safely quoted via `shlex.quote()` before being inserted into the script.
## Type of Change
- [x] Bug fix (non-breaking change that fixes an issue)
## Changes Made
- Added `_patch_rtk_hook_absolute_path(rtk_path, hook_script_path)` in `headroom/cli/wrap.py`
- Called it immediately after `register_claude_hooks()` succeeds in `_setup_rtk()`
- Uses `shlex.quote()` to safely handle absolute paths containing spaces or shell-special characters
- Added regression test `tests/test_cli/test_wrap_rtk_hook_patch.py` covering the basic patch, the space-in-path case, idempotency, missing hook file, and non-bare `rtk` tokens
## Testing
- [x] Manual testing performed
### Test Output
```
python3 -m pytest tests/test_cli/test_wrap_rtk_hook_patch.py -v
============ test session starts ============
collected 5 items
tests/test_cli/test_wrap_rtk_hook_patch.py::test_patches_bare_rtk_to_absolute_path
PASSED [ 20%]
tests/test_cli/test_wrap_rtk_hook_patch.py::test_quotes_path_containing_spaces
PASSED [ 40%]
tests/test_cli/test_wrap_rtk_hook_patch.py::test_idempotent_second_run_is_noop
PASSED [ 60%]
tests/test_cli/test_wrap_rtk_hook_patch.py::test_missing_hook_script_is_noop
PASSED [ 80%]
tests/test_cli/test_wrap_rtk_hook_patch.py::test_does_not_touch_words_containing_rtk
PASSED [100%]
============= 5 passed in 0.73s =============
```
## Real Behavior Proof
- Environment: Linux, Python 3.14.4, pytest 9.1.0, headroom repo at commit d5987fb2
- Exact command / steps: `python3 -m pytest tests/test_cli/test_wrap_rtk_hook_patch.py -v`
- Observed result: All 5 tests passed — test_patches_bare_rtk_to_absolute_path, test_quotes_path_containing_spaces, test_idempotent_second_run_is_noop, test_missing_hook_script_is_noop, test_does_not_touch_words_containing_rtk (5 passed in 0.73s)
- Not tested: End-to-end test against a real `rtk init --global --auto-patch` run on macOS/Windows; only the patch function itself is unit-tested
## Review Readiness
- [x] I have performed a self-review
- [x] This PR is ready for human review
Fixes #487
```
---------
Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
93 lines
3.2 KiB
Python
93 lines
3.2 KiB
Python
"""Tests for ``_patch_rtk_hook_absolute_path``.
|
|
|
|
``rtk init --global --auto-patch`` writes ``~/.claude/hooks/rtk-rewrite.sh``
|
|
with a bare ``rtk`` command that depends on PATH lookup. Since
|
|
``~/.headroom/bin`` is not automatically added to PATH, that lookup fails
|
|
silently and token compression never occurs (see issue #487).
|
|
|
|
``_patch_rtk_hook_absolute_path`` rewrites bare ``rtk`` tokens in the
|
|
generated hook script to the absolute, shell-quoted path of the rtk binary
|
|
that Headroom manages.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import shlex
|
|
from pathlib import Path
|
|
|
|
from headroom.cli.wrap import _patch_rtk_hook_absolute_path
|
|
|
|
|
|
def test_patches_bare_rtk_to_absolute_path(tmp_path: Path) -> None:
|
|
hook_script = tmp_path / "rtk-rewrite.sh"
|
|
hook_script.write_text(
|
|
'#!/bin/sh\nif command -v rtk >/dev/null 2>&1; then\n exec rtk rewrite "$@"\nfi\n'
|
|
)
|
|
|
|
rtk_path = Path("/home/user/.headroom/bin/rtk")
|
|
changed = _patch_rtk_hook_absolute_path(rtk_path, hook_script)
|
|
|
|
content = hook_script.read_text()
|
|
quoted = shlex.quote(str(rtk_path))
|
|
|
|
assert changed is True
|
|
assert f"exec {quoted} rewrite" in content
|
|
|
|
|
|
def test_quotes_path_containing_spaces(tmp_path: Path) -> None:
|
|
"""Paths with spaces (e.g. /Users/Alice Smith/...) must be shell-quoted."""
|
|
hook_script = tmp_path / "rtk-rewrite.sh"
|
|
hook_script.write_text(
|
|
'#!/bin/sh\nif command -v rtk >/dev/null 2>&1; then\n exec rtk rewrite "$@"\nfi\n'
|
|
)
|
|
|
|
rtk_path = Path("/Users/Alice Smith/.headroom/bin/rtk")
|
|
changed = _patch_rtk_hook_absolute_path(rtk_path, hook_script)
|
|
|
|
content = hook_script.read_text()
|
|
quoted = shlex.quote(str(rtk_path))
|
|
|
|
assert changed is True
|
|
assert f"exec {quoted} rewrite" in content
|
|
# The raw, unquoted path must never appear unescaped in the script.
|
|
assert "exec /Users/Alice Smith/.headroom/bin/rtk rewrite" not in content
|
|
|
|
|
|
def test_idempotent_second_run_is_noop(tmp_path: Path) -> None:
|
|
hook_script = tmp_path / "rtk-rewrite.sh"
|
|
hook_script.write_text('exec rtk rewrite "$@"\n')
|
|
|
|
rtk_path = Path("/home/user/.headroom/bin/rtk")
|
|
|
|
first = _patch_rtk_hook_absolute_path(rtk_path, hook_script)
|
|
content_after_first = hook_script.read_text()
|
|
|
|
second = _patch_rtk_hook_absolute_path(rtk_path, hook_script)
|
|
content_after_second = hook_script.read_text()
|
|
|
|
assert first is True
|
|
assert second is False
|
|
assert content_after_first == content_after_second
|
|
|
|
|
|
def test_missing_hook_script_is_noop(tmp_path: Path) -> None:
|
|
missing = tmp_path / "does-not-exist.sh"
|
|
rtk_path = Path("/home/user/.headroom/bin/rtk")
|
|
|
|
changed = _patch_rtk_hook_absolute_path(rtk_path, missing)
|
|
|
|
assert changed is False
|
|
assert not missing.exists()
|
|
|
|
|
|
def test_does_not_touch_words_containing_rtk(tmp_path: Path) -> None:
|
|
"""Tokens like 'rtkfoo' or an already-absolute '/some/path/rtk' are left alone."""
|
|
hook_script = tmp_path / "rtk-rewrite.sh"
|
|
original = '#!/bin/sh\necho rtkfoo\nexec /already/absolute/rtk rewrite "$@"\n'
|
|
hook_script.write_text(original)
|
|
|
|
rtk_path = Path("/home/user/.headroom/bin/rtk")
|
|
changed = _patch_rtk_hook_absolute_path(rtk_path, hook_script)
|
|
|
|
assert changed is False
|
|
assert hook_script.read_text() == original
|