hermes-agent/tests/tools/test_local_env_windows_msys.py
Brooklyn Nicholson 4a58e22e99 fix(windows): put Git Bash coreutils on PATH for the non-login fallback
#63955 made Hermes survive a broken `bash -l` (Ainz's `Directory
\drivers\etc does not exist`) by falling back to non-login `bash -c`.
But a non-login shell never sources /etc/profile, so it never gets
`…\usr\bin` on PATH — and that dir holds every coreutil the file/terminal
tools shell out to (cat, mktemp, mv, wc, head, stat, chmod, mkdir, find).
Result: `write_file` returned bytes_written:0 with an EMPTY error (the
failure text went to a missing binary's stderr) and terminal commands
exited 127. The survive-broken-login-bash fix was only half-done: it
stopped crashing but silently failed every write.

Derive Git Bash's bin dirs (mingw64/bin, usr/bin, bin, …) from the
resolved bash.exe and prepend them to the subprocess PATH on Windows, in
/etc/profile precedence order so coreutils win over same-named System32
tools (find.exe, sort.exe) inside the shell. No-op off Windows and when a
login snapshot is healthy (the snapshot re-exports the full PATH inside
the shell), so this only bites on the broken-login fallback path.

Adds _git_bash_bin_dirs() (derivation, cached) + _prepend_git_bash_dirs()
(PATH merge), plus regression tests for PortableGit/MinGit layouts and
the run-env injection ordering.
2026-07-13 20:00:38 -04:00

509 lines
22 KiB
Python

"""Tests for the Windows / Git Bash MSYS-path normalization in
``LocalEnvironment``.
Background
----------
On Windows, ``pwd -P`` inside Git Bash emits paths like
``/c/Users/NVIDIA``. ``subprocess.Popen(..., cwd=...)`` only accepts
native Windows paths (``C:\\Users\\NVIDIA``), and the validation done
by ``_resolve_safe_cwd`` was also checking the MSYS form against
``os.path.isdir``, which returns ``False`` on Windows. The combined
effect was a warning logged on every single terminal call:
LocalEnvironment cwd '/c/Users/NVIDIA' is missing on disk;
falling back to '/' so terminal commands keep working.
These tests fake the Windows env on Linux CI by patching ``_IS_WINDOWS``
and ``os.path.isdir`` so the MSYS path tests as "missing" exactly like
on the real OS.
"""
import os
from unittest.mock import patch
from tools.environments.base import BaseEnvironment
from tools.environments import local as local_mod
from tools.environments.local import (
LocalEnvironment,
_bash_safe_path,
_git_bash_bin_dirs,
_make_run_env,
_msys_to_windows_path,
_prepend_git_bash_dirs,
_quote_bash_path,
_resolve_safe_cwd,
_sanitize_subprocess_env,
_windows_to_msys_path,
hermes_subprocess_env,
)
# ---------------------------------------------------------------------------
# _msys_to_windows_path — pure-function unit tests
# ---------------------------------------------------------------------------
class TestMsysToWindowsPath:
def test_noop_on_non_windows(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", False)
# On a non-Windows host the function must never rewrite the path
# — POSIX-style paths are real paths there.
assert _msys_to_windows_path("/c/Users/NVIDIA") == "/c/Users/NVIDIA"
assert _msys_to_windows_path("/home/teknium") == "/home/teknium"
def test_translates_drive_path(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _msys_to_windows_path("/c/Users/NVIDIA") == r"C:\Users\NVIDIA"
assert _msys_to_windows_path("/d/Projects/foo bar") == r"D:\Projects\foo bar"
def test_translates_bare_drive_root(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
# Bare "/c" alone should resolve to the drive root.
assert _msys_to_windows_path("/c") == "C:\\"
# Trailing slash on the drive letter is also a root.
assert _msys_to_windows_path("/c/") == "C:\\"
def test_idempotent_on_already_windows_path(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _msys_to_windows_path(r"C:\Users\NVIDIA") == r"C:\Users\NVIDIA"
def test_does_not_translate_multi_char_first_segment(self, monkeypatch):
"""``/tmp/foo`` and ``/home/x`` must NOT be misread as drive paths
just because they start with ``/`` and a single letter — the regex
only matches when the first segment is exactly one character."""
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _msys_to_windows_path("/tmp/foo") == "/tmp/foo"
assert _msys_to_windows_path("/home/x") == "/home/x"
# /mnt/<name>/... only translates when <name> is a single drive letter.
assert _msys_to_windows_path("/mnt/home/x") == "/mnt/home/x"
def test_translates_cygdrive_and_wsl_mnt_forms(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _msys_to_windows_path("/cygdrive/c/Users/NVIDIA") == r"C:\Users\NVIDIA"
assert _msys_to_windows_path("/mnt/d/Projects/foo") == r"D:\Projects\foo"
assert _msys_to_windows_path("/cygdrive/c") == "C:\\"
assert _msys_to_windows_path("/mnt/c/") == "C:\\"
def test_empty_string(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _msys_to_windows_path("") == ""
# ---------------------------------------------------------------------------
# _windows_to_msys_path — reverse translation for bash builtin cd
# ---------------------------------------------------------------------------
class TestWindowsToMsysPath:
def test_noop_on_non_windows(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", False)
assert _windows_to_msys_path(r"C:\Users\NVIDIA") == r"C:\Users\NVIDIA"
def test_translates_backslash_path(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _windows_to_msys_path(r"C:\Users\NVIDIA") == "/c/Users/NVIDIA"
assert _windows_to_msys_path(r"D:\Projects\foo bar") == "/d/Projects/foo bar"
def test_translates_forward_slash_native_path(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _windows_to_msys_path("C:/Users/NVIDIA") == "/c/Users/NVIDIA"
def test_translates_drive_root(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _windows_to_msys_path(r"C:\\") == "/c/"
assert _windows_to_msys_path("D:/") == "/d/"
def test_does_not_translate_non_drive_path(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _windows_to_msys_path("/tmp/foo") == "/tmp/foo"
assert _windows_to_msys_path(r"\\server\share") == r"\\server\share"
# ---------------------------------------------------------------------------
# _bash_safe_path / _quote_bash_path — shell-script interpolation
# ---------------------------------------------------------------------------
class TestBashSafePath:
def test_native_windows_path_becomes_msys(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _bash_safe_path(r"C:\Users\alice\notes.txt") == "/c/Users/alice/notes.txt"
def test_forward_slash_native_path_becomes_msys(self, monkeypatch):
"""Production get_temp_dir emits C:/... — still needs /c/... rewrite."""
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert (
_bash_safe_path("C:/Users/Alexander/.hermes/cache/terminal/hermes-snap-x.sh")
== "/c/Users/Alexander/.hermes/cache/terminal/hermes-snap-x.sh"
)
def test_mixed_msys_path_normalizes_backslashes(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
mixed = r"/c/Users/Alexander\Documents\NewTEST\readme.txt"
assert _bash_safe_path(mixed) == "/c/Users/Alexander/Documents/NewTEST/readme.txt"
def test_noop_off_windows(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", False)
path = r"/c/Users\Alexander\Documents"
assert _bash_safe_path(path) == path
def test_quote_bash_path_quotes_mixed_windows_path(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
quoted = _quote_bash_path(
r"C:\Users\Alexander\AppData\Local\Temp\hermes-snap-abc.sh"
)
assert "/c/Users/Alexander/AppData/Local/Temp/hermes-snap-abc.sh" in quoted
assert "\\" not in quoted
# ---------------------------------------------------------------------------
# _resolve_safe_cwd — Windows fast path
# ---------------------------------------------------------------------------
class TestResolveSafeCwdWindows:
def test_msys_path_resolves_to_native_when_native_exists(
self, monkeypatch, tmp_path,
):
"""The whole point of this fix: a Git Bash ``/c/Users/x`` value
should resolve to its native equivalent if that native dir exists,
WITHOUT falling back to the temp dir."""
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
# tmp_path is a real native dir on the test host. Build a fake
# MSYS form pointing at it and prove the resolver finds it.
native = str(tmp_path)
# Construct a synthetic MSYS form for whatever tmp_path is.
# On Linux CI tmp_path is /tmp/... ; the resolver shouldn't even
# try to translate that (regex won't match), so emulate the
# mapping by pointing the translator at the real native dir.
with patch.object(
local_mod, "_msys_to_windows_path", return_value=native
):
assert _resolve_safe_cwd("/c/whatever") == native
# ---------------------------------------------------------------------------
# End-to-end: _update_cwd via marker file (Windows simulation)
# ---------------------------------------------------------------------------
class TestUpdateCwdWindowsMsys:
def test_marker_file_msys_path_stored_in_native_form(
self, monkeypatch, tmp_path,
):
"""When Git Bash writes ``/c/Users/x`` to the cwd marker file on
Windows, ``_update_cwd`` must translate to native form before
validating and storing — otherwise ``os.path.isdir`` rejects a
perfectly real directory."""
original = tmp_path / "starting"
original.mkdir()
# Fake Windows for the test
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
with patch.object(
LocalEnvironment, "init_session", autospec=True, return_value=None
):
env = LocalEnvironment(cwd=str(original), timeout=10)
# Pretend Git Bash wrote an MSYS path that maps to tmp_path/"next"
new_dir = tmp_path / "next"
new_dir.mkdir()
with open(env._cwd_file, "w") as f:
f.write("/c/whatever/from/bash")
# Translate the synthetic MSYS string to the real native dir.
def fake_translate(p):
if p == "/c/whatever/from/bash":
return str(new_dir)
return p
with patch.object(local_mod, "_msys_to_windows_path", side_effect=fake_translate):
env._update_cwd({"output": "", "returncode": 0})
assert env.cwd == str(new_dir)
# ---------------------------------------------------------------------------
# End-to-end: _extract_cwd_from_output rollback when marker is invalid
# ---------------------------------------------------------------------------
class TestExtractCwdFromOutputWindowsMsys:
def test_stale_msys_marker_does_not_clobber_cwd(self, monkeypatch, tmp_path):
"""When the cwd marker in stdout points at a non-existent path,
``LocalEnvironment._extract_cwd_from_output`` must roll back to
the previous cwd instead of propagating a bad value."""
original = tmp_path / "starting"
original.mkdir()
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
with patch.object(
LocalEnvironment, "init_session", autospec=True, return_value=None
):
env = LocalEnvironment(cwd=str(original), timeout=10)
marker = env._cwd_marker
result = {
"output": f"some command output\n{marker}/c/no/such/path{marker}\n",
"returncode": 0,
}
# Translation produces a path that doesn't exist on disk → rollback.
with patch.object(
local_mod,
"_msys_to_windows_path",
return_value=str(tmp_path / "definitely-does-not-exist"),
):
env._extract_cwd_from_output(result)
assert env.cwd == str(original)
def test_valid_msys_marker_normalized_to_native(self, monkeypatch, tmp_path):
original = tmp_path / "starting"
original.mkdir()
new_dir = tmp_path / "next"
new_dir.mkdir()
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
with patch.object(
LocalEnvironment, "init_session", autospec=True, return_value=None
):
env = LocalEnvironment(cwd=str(original), timeout=10)
marker = env._cwd_marker
result = {
"output": f"x\n{marker}/c/whatever{marker}\n",
"returncode": 0,
}
with patch.object(local_mod, "_msys_to_windows_path", return_value=str(new_dir)):
env._extract_cwd_from_output(result)
assert env.cwd == str(new_dir)
# ---------------------------------------------------------------------------
# MSYS_NO_PATHCONV — native Windows command flags (#56700)
# ---------------------------------------------------------------------------
class TestWindowsMsysPathconvDefaults:
def test_make_run_env_sets_msys_no_pathconv_on_windows(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
run_env = _make_run_env({})
assert run_env.get("MSYS_NO_PATHCONV") == "1"
def test_sanitize_subprocess_env_sets_msys_no_pathconv_on_windows(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
env = _sanitize_subprocess_env({})
assert env.get("MSYS_NO_PATHCONV") == "1"
def test_hermes_subprocess_env_sets_msys_no_pathconv_on_windows(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
env = hermes_subprocess_env()
assert env.get("MSYS_NO_PATHCONV") == "1"
def test_no_pathconv_not_set_on_posix(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", False)
assert "MSYS_NO_PATHCONV" not in _make_run_env({})
def test_respects_user_override(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
run_env = _make_run_env({"MSYS_NO_PATHCONV": "0"})
assert run_env.get("MSYS_NO_PATHCONV") == "0"
def test_msys2_arg_conv_excl_set_on_windows(self, monkeypatch):
# MSYS2-proper / Cygwin bash ignore MSYS_NO_PATHCONV; they honor
# MSYS2_ARG_CONV_EXCL. Both must be set on every env builder.
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
assert _make_run_env({}).get("MSYS2_ARG_CONV_EXCL") == "*"
assert _sanitize_subprocess_env({}).get("MSYS2_ARG_CONV_EXCL") == "*"
assert hermes_subprocess_env().get("MSYS2_ARG_CONV_EXCL") == "*"
def test_msys2_arg_conv_excl_not_set_on_posix(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", False)
assert "MSYS2_ARG_CONV_EXCL" not in _make_run_env({})
def test_msys2_arg_conv_excl_respects_user_override(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
run_env = _make_run_env({"MSYS2_ARG_CONV_EXCL": "/custom"})
assert run_env.get("MSYS2_ARG_CONV_EXCL") == "/custom"
# ---------------------------------------------------------------------------
# Git Bash coreutils on PATH — non-login ``bash -c`` fallback (empty
# write_file error / terminal exit 127 when login bash is broken)
# ---------------------------------------------------------------------------
class TestGitBashCoreutilsOnPath:
def _fake_isdir(self, existing):
existing = {e.replace("\\", "/") for e in existing}
return lambda p: p.replace("\\", "/") in existing
def test_derives_dirs_from_portablegit_layout(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
monkeypatch.setattr(local_mod, "_git_bash_bin_dirs_cache", None)
monkeypatch.setattr(local_mod, "_find_bash", lambda: "/pg/bin/bash.exe")
existing = {"/pg/mingw64/bin", "/pg/usr/bin", "/pg/bin"}
monkeypatch.setattr(local_mod.os.path, "isdir", self._fake_isdir(existing))
dirs = _git_bash_bin_dirs()
# usr/bin is the load-bearing coreutils dir; mingw64 precedes it.
assert "/pg/usr/bin" in dirs
assert dirs.index("/pg/mingw64/bin") < dirs.index("/pg/usr/bin")
# Non-existent dirs (mingw32, usr/local/bin) are excluded.
assert "/pg/mingw32/bin" not in dirs
def test_derives_dirs_from_mingit_usr_bin_layout(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
monkeypatch.setattr(local_mod, "_git_bash_bin_dirs_cache", None)
monkeypatch.setattr(local_mod, "_find_bash", lambda: "/mg/usr/bin/bash.exe")
existing = {"/mg/usr/bin", "/mg/mingw64/bin"}
monkeypatch.setattr(local_mod.os.path, "isdir", self._fake_isdir(existing))
dirs = _git_bash_bin_dirs()
# MinGit ships bash under usr\bin; root must still resolve to /mg.
assert "/mg/usr/bin" in dirs
assert "/mg/mingw64/bin" in dirs
def test_empty_off_windows(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", False)
monkeypatch.setattr(local_mod, "_git_bash_bin_dirs_cache", None)
assert _git_bash_bin_dirs() == []
def test_empty_when_bash_unresolvable(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
monkeypatch.setattr(local_mod, "_git_bash_bin_dirs_cache", None)
def boom():
raise RuntimeError("Git Bash not found")
monkeypatch.setattr(local_mod, "_find_bash", boom)
assert _git_bash_bin_dirs() == []
def test_prepend_is_idempotent(self, monkeypatch):
# Simulate Windows' ``;`` separator so drive-letter colons in fake
# paths don't collide with the POSIX ``:`` pathsep on the test host.
monkeypatch.setattr(os, "pathsep", ";")
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
monkeypatch.setattr(local_mod, "_git_bash_bin_dirs_cache", ["/pg/usr/bin", "/pg/bin"])
already = r"/pg/usr/bin;C:\Windows\System32;/pg/bin"
assert _prepend_git_bash_dirs(already) == already
def test_make_run_env_prepends_coreutils_on_windows(self, monkeypatch):
monkeypatch.setattr(os, "pathsep", ";")
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
monkeypatch.setattr(local_mod, "_git_bash_bin_dirs_cache", ["/pg/mingw64/bin", "/pg/usr/bin"])
run_env = _make_run_env({"PATH": r"C:\Windows\System32"})
path = run_env.get("PATH") or run_env.get("Path")
entries = path.split(";")
# Coreutils dirs land before System32 so bash resolves cat/find/sort
# to the GNU tools, not the same-named Windows executables.
assert "/pg/usr/bin" in entries
assert entries.index("/pg/usr/bin") < entries.index(r"C:\Windows\System32")
def test_make_run_env_noop_on_posix(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", False)
monkeypatch.setattr(local_mod, "_git_bash_bin_dirs_cache", None)
run_env = _make_run_env({"PATH": "/usr/bin:/bin"})
# No Windows git dirs injected on POSIX.
assert "mingw64" not in run_env["PATH"]
# ---------------------------------------------------------------------------
# Command wrapping — native Windows cwd must be Git Bash-friendly for cd
# ---------------------------------------------------------------------------
class TestWrapCommandWindowsNativeCwd:
def test_wrap_command_converts_native_cwd_for_builtin_cd(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
with patch.object(
LocalEnvironment, "init_session", autospec=True, return_value=None
):
env = LocalEnvironment(cwd=r"C:\Users\liush", timeout=10)
env._snapshot_ready = True
wrapped = env._wrap_command("pwd", r"C:\Users\liush")
assert "builtin cd -- /c/Users/liush || exit 126" in wrapped
assert r"builtin cd -- C:\Users\liush || exit 126" not in wrapped
def test_init_session_bootstrap_converts_native_cwd_for_cd(self, monkeypatch):
"""The snapshot bootstrap ``cd`` must also use the Git-Bash path form,
not just ``_wrap_command`` — otherwise ``pwd -P`` captures the login
shell's directory instead of ``terminal.cwd`` on Windows."""
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
captured = {}
def fake_run_bash(self, cmd_string, *, login=False, timeout=120, stdin_data=None):
captured.setdefault("script", cmd_string) # bootstrap only; ignore the failure-path probe
raise RuntimeError("stop after capturing bootstrap")
monkeypatch.setattr(LocalEnvironment, "_run_bash", fake_run_bash)
# init_session swallows the exception and falls back; we only need the
# captured bootstrap script to assert the cd target was converted.
LocalEnvironment(cwd=r"C:\Users\liush", timeout=10)
assert "builtin cd -- /c/Users/liush 2>/dev/null || true" in captured["script"]
assert r"C:\Users\liush" not in captured["script"]
def test_init_session_bootstrap_quotes_snapshot_paths_in_msys_form(self, monkeypatch):
"""Snapshot paths must reach bash as /c/... — C:/... still trips MSYS
arg conversion during bash -l and surfaces as \\drivers\\etc."""
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
captured = {}
def fake_run_bash(self, cmd_string, *, login=False, timeout=120, stdin_data=None):
captured.setdefault("script", cmd_string) # bootstrap only; ignore the failure-path probe
raise RuntimeError("stop after capturing bootstrap")
monkeypatch.setattr(LocalEnvironment, "_run_bash", fake_run_bash)
# Production shape: get_temp_dir forces forward slashes but keeps C:.
snap = "C:/Users/Alexander/.hermes/cache/terminal/hermes-snap-deadbeef.sh"
with patch.object(LocalEnvironment, "__init__", lambda self, **kw: None):
env = LocalEnvironment.__new__(LocalEnvironment)
BaseEnvironment.__init__(
env,
cwd=r"C:\Users\Alexander\Documents",
timeout=10,
)
env._snapshot_path = snap
env._cwd_file = snap + ".cwd"
env.init_session()
script = captured["script"]
assert "/c/Users/Alexander/.hermes/cache/terminal/hermes-snap-deadbeef.sh" in script
assert "C:/Users/Alexander" not in script
assert r"C:\Users\Alexander" not in script
def test_init_session_bootstrap_rewrites_backslash_snapshot_paths(self, monkeypatch):
monkeypatch.setattr(local_mod, "_IS_WINDOWS", True)
captured = {}
def fake_run_bash(self, cmd_string, *, login=False, timeout=120, stdin_data=None):
captured.setdefault("script", cmd_string) # bootstrap only; ignore the failure-path probe
raise RuntimeError("stop after capturing bootstrap")
monkeypatch.setattr(LocalEnvironment, "_run_bash", fake_run_bash)
snap = r"C:\Users\Alexander\AppData\Local\Temp\hermes-snap-deadbeef.sh"
with patch.object(LocalEnvironment, "__init__", lambda self, **kw: None):
env = LocalEnvironment.__new__(LocalEnvironment)
BaseEnvironment.__init__(
env,
cwd=r"C:\Users\Alexander\Documents",
timeout=10,
)
env._snapshot_path = snap
env._cwd_file = snap + ".cwd"
env.init_session()
script = captured["script"]
assert "/c/Users/Alexander/AppData/Local/Temp/hermes-snap-deadbeef.sh" in script
assert r"C:\Users\Alexander\AppData" not in script