Files
claude-config/bin/project_config/test_project_config.py
T

168 lines
7.2 KiB
Python

import pathlib
import subprocess
import sys
import tempfile
import unittest
sys.path.insert(0, str(pathlib.Path(__file__).resolve().parents[1]))
from failure import Failure
from test_env import isolated_env
from project_config.settings import load, ProjectConfig
TOOL = pathlib.Path(__file__).resolve().parents[1] / "project-config"
CLIENT = """checkout = "~/code/acme-billing"
plan = "folder:todo.md"
working-rules = "folder:AGENTS.md"
decisions = "folder:docs/decisions.md"
score-anchors = "folder:docs/score-anchors.md"
comprehension-history = "folder:docs/comprehension-history.md"
reading-cost = "folder:docs/reading-cost.md"
changelog = "checkout:CHANGELOG.md"
goals-and-audience = "folder:goals.md"
principles = "~/.claude/principles"
"""
class ConfigCase(unittest.TestCase):
def setUp(self) -> None:
made = tempfile.TemporaryDirectory()
self.addCleanup(made.cleanup)
self.home = pathlib.Path(made.name).resolve()
self.checkout = self.home / "code" / "acme-billing"
self.checkout.mkdir(parents=True)
def write(self, key: str, text: str) -> pathlib.Path:
folder = self.home / ".claude-projects" / key
folder.mkdir(parents=True)
(folder / "config.toml").write_text(text, encoding="utf-8")
return folder
class LoadTest(ConfigCase):
def failure(self, top: pathlib.Path | None = None) -> str:
found = load(top or self.checkout, self.checkout, self.home)
assert isinstance(found, Failure), found
return found.reason
def test_resolves_each_setting_by_its_prefix(self) -> None:
folder = self.write("acme", CLIENT)
self.write("other", CLIENT.replace("acme-billing", "other"))
found = load(self.checkout, self.checkout, self.home)
assert isinstance(found, ProjectConfig), found
self.assertEqual((found.key, found.folder), ("acme", folder))
self.assertEqual(found.paths["plan"], folder / "todo.md")
self.assertEqual(found.paths["decisions"], folder / "docs" / "decisions.md")
self.assertEqual(found.paths["changelog"], self.checkout / "CHANGELOG.md")
self.assertEqual(found.paths["principles"], self.home / ".claude" / "principles")
self.assertEqual(len(found.paths), 9)
def test_a_worktree_finds_the_main_checkouts_config_and_reads_its_own_files(self) -> None:
self.write("acme", CLIENT)
worktree = self.home / "code" / "acme-billing-item-3"
found = load(worktree, self.checkout, self.home)
assert isinstance(found, ProjectConfig), found
self.assertEqual(found.paths["changelog"], worktree / "CHANGELOG.md")
def test_an_absolute_checkout_and_path_are_taken_as_written(self) -> None:
self.write("acme", CLIENT.replace("~/code/acme-billing", str(self.checkout)).replace("~/.claude/principles", "/srv/principles"))
found = load(self.checkout, self.checkout, self.home)
assert isinstance(found, ProjectConfig), found
self.assertEqual(found.paths["principles"], pathlib.Path("/srv/principles"))
def test_no_config_fails_naming_the_checkout_and_the_file_to_write(self) -> None:
for write_other in (False, True):
with self.subTest(write_other=write_other):
if write_other:
self.write("other", CLIENT.replace("acme-billing", "other"))
reason = self.failure()
self.assertIn(str(self.checkout), reason)
self.assertIn("~/.claude-projects/<key>/config.toml", reason)
def test_every_missing_setting_is_named(self) -> None:
kept = "".join(line + "\n" for line in CLIENT.splitlines() if not line.startswith(("plan", "changelog", "principles")))
self.write("acme", kept)
reason = self.failure()
for name in ("plan", "changelog", "principles"):
self.assertIn(f"`{name}`", reason)
self.assertNotIn("`decisions`", reason)
self.assertIn("acme/config.toml", reason)
def test_every_fault_in_one_config_is_named_together(self) -> None:
cases = {
"an unknown setting": ('readme = "checkout:README.md"\n', "`readme`"),
"a path with no prefix": ('plan = "todo.md"\n', "`plan`"),
"a path with an unknown prefix": ('plan = "repo:todo.md"\n', "`plan`"),
"a value that is not text": ("plan = 3\n", "`plan`"),
"a path that leaves the folder": ('plan = "folder:../other/todo.md"\n', "`plan`"),
"a path that leaves the checkout": ('plan = "checkout:../todo.md"\n', "`plan`"),
"an empty path": ('plan = "folder:"\n', "`plan`"),
}
for case, (line, named) in cases.items():
with self.subTest(case=case), tempfile.TemporaryDirectory() as made:
self.home = pathlib.Path(made).resolve()
self.checkout = self.home / "code" / "acme-billing"
text = "".join(kept + "\n" for kept in CLIENT.splitlines() if not kept.startswith(("plan", "decisions")))
self.write("acme", text + line)
reason = self.failure()
self.assertIn(named, reason)
self.assertIn("`decisions`", reason)
def test_two_configs_naming_one_checkout_fail_naming_both(self) -> None:
self.write("acme", CLIENT)
self.write("acme-copy", CLIENT)
reason = self.failure()
self.assertIn("acme/config.toml", reason)
self.assertIn("acme-copy/config.toml", reason)
def test_a_config_that_cannot_be_read_fails_whichever_checkout_asks(self) -> None:
cases = {"not TOML": "checkout = ", "no checkout": 'plan = "folder:todo.md"\n', "a checkout that is not text": "checkout = 3\n", "a relative checkout": 'checkout = "code/acme"\n'}
for case, text in cases.items():
with self.subTest(case=case), tempfile.TemporaryDirectory() as made:
self.home = pathlib.Path(made).resolve()
self.write("acme", CLIENT)
self.write("broken", text)
self.assertIn("broken/config.toml", self.failure())
def test_a_folder_with_no_config_is_skipped(self) -> None:
self.write("acme", CLIENT)
(self.home / ".claude-projects" / "notes").mkdir()
self.assertIsInstance(load(self.checkout, self.checkout, self.home), ProjectConfig)
class ToolTest(ConfigCase):
def run_tool(self, *args: str, cwd: pathlib.Path | None = None) -> subprocess.CompletedProcess[str]:
return subprocess.run([sys.executable, str(TOOL), *args], cwd=cwd or self.checkout, env={**isolated_env(), "HOME": str(self.home)}, capture_output=True, text=True)
def setUp(self) -> None:
super().setUp()
subprocess.run(["git", "init", "-q", str(self.checkout)], check=True, env=isolated_env())
def test_prints_every_setting_or_the_one_asked_for(self) -> None:
folder = self.write("acme", CLIENT)
everything = self.run_tool()
self.assertEqual((everything.returncode, everything.stderr), (0, ""))
self.assertEqual(everything.stdout.splitlines()[0], f"plan: {folder}/todo.md")
self.assertEqual(len(everything.stdout.splitlines()), 9)
(self.checkout / "src").mkdir()
one = self.run_tool("changelog", cwd=self.checkout / "src")
self.assertEqual((one.returncode, one.stdout), (0, f"{self.checkout}/CHANGELOG.md\n"))
def test_fails_on_stderr(self) -> None:
cases = {"no config": ((), "no config names the checkout"), "an unknown setting": (("readme",), "usage:"), "two arguments": (("plan", "changelog"), "usage:")}
for case, (args, said) in cases.items():
with self.subTest(case=case):
ran = self.run_tool(*args)
self.assertEqual((ran.returncode, ran.stdout), (1, ""))
self.assertIn(said, ran.stderr)
def test_help_shows_a_config(self) -> None:
ran = self.run_tool("--help")
self.assertEqual(ran.returncode, 0)
self.assertIn('plan = "folder:todo.md"', ran.stdout)
if __name__ == "__main__":
unittest.main()