Files
ai-job-search/tests/test_check_framework_version.py
T
Timofei ErokhinandClaude Sonnet 5 27a9b4a91d fix(check_framework_version): decode git diff output as UTF-8 (#511)
* fix(check_framework_version): decode git diff output as UTF-8

run_git() passed subprocess.run(text=True) with no explicit encoding,
so it fell back to the host locale's default codec - cp1252 on
Windows - instead of UTF-8. Any non-ASCII byte in a modified
framework file's diff (e.g. an em dash in a profile edit) then raised
UnicodeDecodeError before the gate could evaluate the change, instead
of a pass/fail verdict. Reproduced on a real Windows checkout.

Pin encoding="utf-8" on the subprocess.run() call. Added a regression
test that patches subprocess.run and asserts run_git() always passes
encoding="utf-8" - confirmed it fails against the pre-fix code and
passes against the fix.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* fix(check_framework_version): address review on UTF-8 decode fix

Per MadsLorentzen's review on PR #511:
- Add errors="replace" alongside encoding="utf-8" on the subprocess.run()
  call, matching the convention used elsewhere in this repo (robots_check.py).
- Correct the docstring: an em dash does not crash the un-pinned decode
  (cp1252 maps it fine); the actual trigger is a byte cp1252 leaves
  undefined, e.g. Cyrillic Ё/ё, much CJK, or Á-class Latin.
- Correct "profile file" to "framework file" - the tool only diffs the
  framework's own directories, not arbitrary profile files.
- Add a CHANGELOG entry under [Unreleased] / Fixed naming the tool and test.

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-02 20:03:35 +02:00

150 lines
5.5 KiB
Python

"""Guards for tools/check_framework_version.py - the CI gate itself.
This gate is what stops a PR from editing a profile-bearing framework
file without bumping `framework_version` (the fork-rebase safety marker).
It ran in CI with zero tests, so a one-line mutation
(`return meaningful_changes > 0` -> `return False`) disabled it while
the whole suite stayed green (review finding F22, 2026-08-19). A broken
guard is silent by construction: nothing fails, it just stops catching.
Each test builds an isolated git repo with the script copied inside it
(the script resolves ROOT from __file__), so the real repo is never read
or written.
"""
import os
import shutil
import subprocess
import sys
import tempfile
import unittest
import unittest.mock
from pathlib import Path
REPO_ROOT = Path(__file__).resolve().parent.parent
SCRIPT = REPO_ROOT / "tools" / "check_framework_version.py"
FRONTMATTER = "---\nframework_version: 1.0.0\n---\n"
BODY = "# Test framework file\n\nOriginal guidance sentence.\n"
class CheckerRepoFixture(unittest.TestCase):
def setUp(self):
self.root = Path(tempfile.mkdtemp())
self.addCleanup(shutil.rmtree, self.root, ignore_errors=True)
tools = self.root / "tools"
tools.mkdir()
shutil.copy(SCRIPT, tools / "check_framework_version.py")
self.skill_dir = self.root / ".claude" / "skills" / "job-application-assistant"
self.skill_dir.mkdir(parents=True)
self.framework_file = self.skill_dir / "01-test-profile.md"
self.framework_file.write_text(FRONTMATTER + BODY, encoding="utf-8")
self.git("init", "-q")
self.git("add", "-A")
self.git("commit", "-q", "-m", "base")
def git(self, *args):
subprocess.run(
["git", "-c", "user.name=test", "-c", "user.email=test@example.com", *args],
cwd=self.root,
check=True,
capture_output=True,
text=True,
)
def run_checker(self):
# Strip GitHub Actions variables so get_base_commit() takes the
# local path (uncommitted changes vs HEAD) regardless of where the
# test suite itself runs.
env = {k: v for k, v in os.environ.items() if not k.startswith("GITHUB_")}
return subprocess.run(
[sys.executable, str(self.root / "tools" / "check_framework_version.py")],
capture_output=True,
text=True,
env=env,
)
class FrameworkVersionGateTests(CheckerRepoFixture):
def test_clean_tree_passes(self):
result = self.run_checker()
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
self.assertIn("Framework Version Check: OK", result.stdout)
def test_unbumped_edit_fails(self):
self.framework_file.write_text(
FRONTMATTER + BODY + "\nA new sentence without a version bump.\n",
encoding="utf-8",
)
result = self.run_checker()
self.assertEqual(result.returncode, 1, result.stdout + result.stderr)
self.assertIn("modified without bumping 'framework_version'", result.stdout)
def test_bumped_edit_passes(self):
bumped = FRONTMATTER.replace("1.0.0", "1.0.1")
self.framework_file.write_text(
bumped + BODY + "\nA new sentence with a version bump.\n",
encoding="utf-8",
)
result = self.run_checker()
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
def test_file_without_version_marker_fails(self):
(self.skill_dir / "02-unmarked.md").write_text(
"# No frontmatter at all\n", encoding="utf-8"
)
result = self.run_checker()
self.assertEqual(result.returncode, 1, result.stdout + result.stderr)
self.assertIn("missing 'framework_version'", result.stdout)
class RunGitEncodingTests(unittest.TestCase):
"""run_git() must decode `git diff` output as UTF-8 explicitly, not via
whatever `subprocess.run(text=True)` falls back to on the host locale.
On a real Windows checkout, the un-pinned call decodes as cp1252 (the
locale default there) and a byte cp1252 leaves undefined - e.g.
Cyrillic Ё/ё, much CJK, or Á-class Latin - in a framework file's diff
raises UnicodeDecodeError before the gate ever evaluates the change
(reported 2026-10-01, reproduced on Windows with Cyrillic Ё). An em
dash does not trigger this - cp1252 maps it fine. `LC_ALL`/`LANG` don't
influence this on Windows, so the regression is pinned directly against
the subprocess.run() call rather than by trying to simulate the OS
locale."""
def test_run_git_pins_utf8_encoding(self):
import importlib.util
spec = importlib.util.spec_from_file_location(
"check_framework_version", SCRIPT
)
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
with unittest.mock.patch.object(module.subprocess, "run") as mock_run:
mock_run.return_value = subprocess.CompletedProcess(
args=["git"], returncode=0, stdout="", stderr=""
)
module.run_git(["diff", "-U0", "HEAD"])
_, kwargs = mock_run.call_args
self.assertEqual(
kwargs.get("encoding"),
"utf-8",
"run_git() must pass encoding=\"utf-8\" to subprocess.run() - "
"omitting it falls back to the host locale's default codec "
"(cp1252 on Windows), which crashes on non-ASCII diff content.",
)
if __name__ == "__main__":
unittest.main()