"""scripts/check-work-docs.py의 시험. 고장 낸 지침 배치에서 실패하고, 맞는 배치에서 통과하는지 본다. python3 -m unittest discover -s scripts/tests """ from __future__ import annotations import importlib.util import io import sys import tempfile import unittest from contextlib import redirect_stderr, redirect_stdout from pathlib import Path SCRIPTS = Path(__file__).resolve().parent.parent _spec = importlib.util.spec_from_file_location("check_work_docs", SCRIPTS / "check-work-docs.py") check_work_docs = importlib.util.module_from_spec(_spec) sys.modules["check_work_docs"] = check_work_docs _spec.loader.exec_module(check_work_docs) PLAYBOOK = "".join(f"## {heading}\n\n- 한 줄.\n\n" for heading in check_work_docs.SKELETON) class Repository: """A throwaway repository with the smallest work manual the checker accepts.""" def __init__(self) -> None: self._directory = tempfile.TemporaryDirectory() self.root = Path(self._directory.name) self.write("AGENTS.md", "# 정본\n\n- 지도 한 줄.\n") self.write("CLAUDE.md", "@AGENTS.md\n\n- Claude 전용 한 줄.\n") self.write("docs/work/README.md", "# 작업 매뉴얼\n") self.write("docs/work/evidence.md", "# 근거\n\n`1101/05-18`은 여기에 둔다.\n") for name in check_work_docs.PLAYBOOKS: self.write(f"docs/work/{name}", f"# {name}\n\n{PLAYBOOK}") for name in check_work_docs.REFERENCES: self.write(f"docs/work/{name}", "# 참고\n") self.write("src/app/AGENTS.md", "# app\n\n- 지역 규칙.\n") self.write("src/app/CLAUDE.md", "@AGENTS.md\n") self.saved = {name: getattr(check_work_docs, name) for name in ("REPO_ROOT", "MAP", "CLAUDE_ENTRY", "WORK", "README")} check_work_docs.REPO_ROOT = self.root check_work_docs.MAP = self.root / "AGENTS.md" check_work_docs.CLAUDE_ENTRY = self.root / "CLAUDE.md" check_work_docs.WORK = self.root / "docs/work" check_work_docs.README = check_work_docs.WORK / "README.md" def write(self, path: str, text: str) -> None: target = self.root / path target.parent.mkdir(parents=True, exist_ok=True) target.write_text(text, encoding="utf-8") def run(self) -> tuple[int, str]: out, err = io.StringIO(), io.StringIO() argv = sys.argv sys.argv = ["check-work-docs.py"] try: with redirect_stdout(out), redirect_stderr(err): code = check_work_docs.main() finally: sys.argv = argv return code, err.getvalue() def close(self) -> None: for name, value in self.saved.items(): setattr(check_work_docs, name, value) self._directory.cleanup() class CheckWorkDocsTest(unittest.TestCase): def setUp(self) -> None: self.repo = Repository() self.addCleanup(self.repo.close) def assertFailsWith(self, fragment: str) -> None: code, err = self.repo.run() self.assertEqual(code, 1, err) self.assertIn(fragment, err) def test_the_smallest_valid_manual_passes(self) -> None: self.assertEqual(self.repo.run(), (0, "")) def test_a_map_over_forty_lines_fails(self) -> None: self.repo.write("AGENTS.md", "# 정본\n" + "- 줄.\n" * 40) self.assertFailsWith("AGENTS.md: 41 lines, limit 40") def test_a_claude_entry_over_ten_lines_fails(self) -> None: self.repo.write("CLAUDE.md", "@AGENTS.md\n" + "- 줄.\n" * 10) self.assertFailsWith("CLAUDE.md: 11 lines, limit 10") def test_a_claude_entry_that_does_not_import_the_map_fails(self) -> None: self.repo.write("CLAUDE.md", "# 지도\n\n@AGENTS.md\n") self.assertFailsWith("CLAUDE.md: the first line must be '@AGENTS.md'") def test_the_entry_path_counts_the_map_the_claude_entry_the_readme_and_one_playbook(self) -> None: # Each file's own limit keeps the sum under ENTRY_PATH_LIMIT today, so lower it to see the sum. lines = sum(len((self.repo.root / name).read_text(encoding="utf-8").splitlines()) for name in ("AGENTS.md", "CLAUDE.md", "docs/work/README.md", "docs/work/improve.md")) original = check_work_docs.ENTRY_PATH_LIMIT check_work_docs.ENTRY_PATH_LIMIT = lines - 1 self.addCleanup(setattr, check_work_docs, "ENTRY_PATH_LIMIT", original) self.assertFailsWith(f"docs/work/improve.md: entry path AGENTS.md + CLAUDE.md + docs/work/README.md + this file is {lines} lines") def test_a_folder_rule_book_without_its_claude_import_fails(self) -> None: self.repo.write("src/web/AGENTS.md", "# web\n") self.assertFailsWith("src/web/CLAUDE.md: missing; it must be the one line '@AGENTS.md'") def test_a_folder_claude_file_that_holds_rules_fails(self) -> None: self.repo.write("src/app/CLAUDE.md", "@AGENTS.md\n\n- 여기에도 규칙을 쓴다.\n") self.assertFailsWith("src/app/CLAUDE.md: must be exactly '@AGENTS.md'") def test_a_folder_claude_file_without_a_rule_book_fails(self) -> None: self.repo.write("src/old/CLAUDE.md", "@AGENTS.md\n") self.assertFailsWith("src/old/CLAUDE.md: imports src/old/AGENTS.md, which does not exist") def test_build_output_is_not_a_folder_rule_book(self) -> None: self.repo.write("src/app/build/tmp/AGENTS.md", "# 복사본\n") self.assertEqual(self.repo.run()[0], 0) def test_a_history_id_in_a_folder_rule_book_fails(self) -> None: self.repo.write("src/app/AGENTS.md", "# app\n\n- 리뷰 05-18에서 정했다.\n") self.assertFailsWith("src/app/AGENTS.md:3") def test_a_history_id_in_a_claude_rule_skill_or_agent_fails(self) -> None: for path in (".claude/rules/x.md", ".claude/skills/x/SKILL.md", ".claude/agents/x.md"): with self.subTest(path=path): self.repo.write(path, "# 규칙\n\n- RR-03-03에서 고쳤다.\n") self.assertFailsWith(f"{path}:3") (self.repo.root / path).unlink() def test_local_claude_state_is_not_checked(self) -> None: self.repo.write(".claude/worktrees/other/AGENTS.md", "# 다른 worktree\n\n- 리뷰 05-18.\n") self.assertEqual(self.repo.run()[0], 0) def test_a_broken_link_in_a_folder_rule_book_fails(self) -> None: self.repo.write("src/app/AGENTS.md", "# app\n\n[설계](README.md)\n") self.assertFailsWith("src/app/AGENTS.md:3: broken relative link 'README.md'") if __name__ == "__main__": unittest.main()