"""Service guarantees for the shared editor buffer and explicit CAS save.""" import concurrent.futures from dataclasses import asdict from unittest.mock import patch from helpers import SiteTestCase from site_engine.errors import ConflictError, EngineError from site_engine.parsing.yamlio import YamlError, load_yaml from site_engine.services.auth import AuditLog, Principal from site_engine.services.documents import AuditCommitError, EditorContext from site_engine.services.entries import EntryService from site_engine.services.pages import PageService class DocumentTests(SiteTestCase): def setUp(self): super().setUp() self.audit = AuditLog(self.tmp / "audit.jsonl") self.context = EditorContext(Principal("editor", "session"), "127.0.0.1") self.svc = PageService(self.site, self.audit) def test_read_and_buffer_do_not_write(self): s = self.svc.get("index") original = (self.site / s.path).read_bytes() t = self.svc.transform_buffer( "index", s.source, s.etag, {"type": "metadata", "values": {"title": "Unsaved"}}, 9 ) self.assertTrue(t.report.ok, asdict(t.report)) self.assertEqual(t.model["meta"]["title"], "Unsaved") self.assertEqual(t.etag, s.etag) self.assertEqual(t.revision, 9) self.assertEqual((self.site / s.path).read_bytes(), original) self.assertFalse((self.site / ".engine").exists()) self.assertFalse(self.audit.path.exists()) self.svc.overlay("index", t.source, s.etag) self.assertEqual((self.site / s.path).read_bytes(), original) def test_exact_source_save_history_and_single_audit(self): s = self.svc.get("index") source = s.source.replace("title:", "# original comment\ntitle:", 1) saved = self.svc.save_source("index", source, s.etag, self.context) self.assertEqual((self.site / s.path).read_bytes(), source.encode()) self.assertEqual(saved.source, source) self.assertNotEqual(saved.etag, s.etag) self.assertEqual(len(self.audit.path.read_text().splitlines()), 1) self.assertTrue(list((self.site / ".engine/history").rglob("*.md"))) with self.assertRaises(ConflictError): self.svc.save_source("index", s.source, s.etag, self.context) self.assertEqual(len(self.audit.path.read_text().splitlines()), 1) def test_invalid_text_never_writes_or_histories(self): s = self.svc.get("index") bad = "---\ntitle: first\ntitle: duplicate\n---\n" result = self.svc.validate_source("index", bad, s.etag) self.assertIsNone(result.model) self.assertEqual(result.source, bad) with self.assertRaises(EngineError): self.svc.save_source("index", bad, s.etag, self.context) self.assertEqual(self.svc.get("index").source, s.source) self.assertFalse((self.site / ".engine/history").exists()) def test_two_writers_only_one_commits(self): s = self.svc.get("index") def write(title): t = self.svc.transform_buffer( "index", s.source, s.etag, {"type": "metadata", "values": {"title": title}} ) try: self.svc.save_source("index", t.source, s.etag, self.context) return "saved" except ConflictError: return "conflict" with concurrent.futures.ThreadPoolExecutor(2) as pool: outcomes = list(pool.map(write, ("A", "B"))) self.assertCountEqual(outcomes, ["saved", "conflict"]) def test_current_layout_schema_is_checked_under_lock(self): s = self.svc.get("index") self.write("layouts/default/layout.yaml", "id: default\nregions:\n other: {}\n") with self.assertRaises(EngineError): self.svc.save_source("index", s.source, s.etag, self.context) self.assertEqual((self.site / s.path).read_text(), s.source) def test_nested_page_and_create_draft(self): s = self.svc.create("nested/test", "Nested", None, self.context) self.assertEqual(s.model["meta"]["status"], "draft") self.assertEqual(self.svc.get("nested/test").etag, s.etag) with self.assertRaises(ConflictError): self.svc.create("nested/test", "Again", None, self.context) for bad in ("../outside", "/absolute", "new", "a/blocks", "a//b"): with self.assertRaises(EngineError): self.svc.create(bad, "Bad", None, self.context) def test_blocks_round_trip_and_read_only_layout(self): s = self.svc.get("index") for action in ( {"type": "toggle", "block_id": "b_hero"}, {"type": "move", "block_id": "b_hero", "direction": "down"}, ): s = self.svc.transform_buffer("index", s.source, s.etag, action) self.assertTrue(s.report.ok, asdict(s.report)) denied = self.svc.transform_buffer( "index", s.source, s.etag, {"type": "delete", "block_id": "missing_fixed"} ) self.assertFalse(denied.report.ok) self.assertEqual(denied.source, s.source) def test_entry_fields_identity_and_exact_save(self): svc = EntryService(self.site, self.audit, "services") s = svc.get("bots") t = svc.transform_buffer( "bots", s.source, s.etag, {"type": "entry_fields", "values": {"title": "Buffer entry"}, "body": "Markdown\n"}, ) self.assertTrue(t.report.ok, asdict(t.report)) self.assertEqual(svc.get("bots").source, s.source) saved = svc.save_source("bots", t.source, t.etag, self.context) self.assertEqual(saved.model["body"], "Markdown\n") self.assertFalse( svc.validate_source( "bots", saved.source.replace("status:", "slug: another\nstatus:", 1), saved.etag ).report.ok ) def test_duplicate_subtree_generates_ids_preserves_sources_and_does_not_write(self): from site_engine.core.page_ops import all_ids from site_engine.parsing import frontmatter self.write( "fragments/slot_probe/fragment.yaml", "id: slot_probe\nname: Slots\ncategory: test\nfields: []\nslots:\n main: {}\n", ) self.write("fragments/slot_probe/template.html.j2", "{{ slots.main }}") snapshot = self.svc.get("index") meta, body = frontmatter.parse(snapshot.source) hero = meta["regions"]["main"][0] hero["anchor"] = "hero-anchor" hero["props"]["title"] = {"bind": "page.title"} parent = { "id": "b_parent", "fragment": "slot_probe", "anchor": "parent-anchor", "hidden": True, "note": "Keep me", "slots": {"main": [hero]}, } meta["regions"]["main"][0] = parent source = frontmatter.dumps(meta, body) result = self.svc.transform_buffer( "index", source, snapshot.etag, {"type": "duplicate", "block_id": "b_parent"}, 7 ) self.assertTrue(result.report.ok, asdict(result.report)) original, clone = result.model["meta"]["regions"]["main"][:2] self.assertEqual(original, parent) self.assertNotEqual(clone["id"], parent["id"]) self.assertRegex(clone["id"], r"^slot_probe_[a-z0-9]{5}$") self.assertRegex(clone["slots"]["main"][0]["id"], r"^hero_[a-z0-9]{5}$") self.assertNotEqual(clone["slots"]["main"][0]["id"], hero["id"]) self.assertNotIn("anchor", clone) self.assertNotIn("anchor", clone["slots"]["main"][0]) self.assertEqual(clone["slots"]["main"][0]["props"], hero["props"]) self.assertEqual(clone["note"], "Keep me") self.assertTrue(clone["hidden"]) self.assertEqual(len(all_ids(result.model["meta"])), len(all_ids(meta)) + 2) self.assertEqual(self.svc.get("index").source, snapshot.source) self.assertEqual(result.revision, 7) self.assertFalse(self.audit.path.exists()) def test_catalog_props_are_validated_and_fixed_blocks_cannot_duplicate(self): snapshot = self.svc.get("index") action = { "type": "add", "fragment": "hero", "region": "main", "props": {"title": "Catalog title"}, } result = self.svc.transform_buffer("index", snapshot.source, snapshot.etag, action) self.assertTrue(result.report.ok, asdict(result.report)) self.assertEqual( result.model["meta"]["regions"]["main"][-1]["props"]["title"], "Catalog title" ) for denied in ( {"type": "duplicate", "block_id": "lh_header"}, dict(action, region="header"), dict(action, props={"title": 42}), ): refused = self.svc.transform_buffer("index", snapshot.source, snapshot.etag, denied) self.assertFalse(refused.report.ok) self.assertEqual(refused.source, snapshot.source) self.assertIsNotNone(refused.model) self.assertEqual(self.svc.get("index").source, snapshot.source) def test_audit_failure_reports_committed_snapshot(self): s = self.svc.get("index") with ( patch.object(self.audit, "write", side_effect=OSError("disk")), self.assertRaises(AuditCommitError) as raised, ): self.svc.save_source("index", s.source, s.etag, self.context) self.assertEqual(raised.exception.snapshot.etag, self.svc.get("index").etag) def test_duplicates_and_aliases_rejected(self): for text in ( "a: 1\na: 2", "a:\n b: 1\n b: 2", "a: &x value\nb: *x", "[" * 2000 + "0" + "]" * 2000, ): with self.assertRaises(YamlError): load_yaml(text) def test_scope_cannot_be_bypassed_through_symlink_or_traversal(self): from site_engine.errors import UnsafePathError target = self.site / "layouts/default/layout.html.j2" original = target.read_bytes() link = self.site / "pages/code.md" link.symlink_to(target) for rel in ("pages/code.md", "pages/../layouts/default/layout.html.j2"): with self.assertRaises(UnsafePathError): self.svc.content.write(rel, "code changed", "absent") self.assertEqual(target.read_bytes(), original) def test_invalid_structural_action_retains_valid_input(self): s = self.svc.get("index") t = self.svc.transform_buffer( "index", s.source, s.etag, {"type": "add", "fragment": "hero", "region": "missing"} ) self.assertFalse(t.report.ok) self.assertEqual(t.source, s.source) self.assertIsNotNone(t.model) def test_nested_slots_queries_and_bindings_survive_constructor(self): self.write( "fragments/slot_probe/fragment.yaml", "id: slot_probe\nname: Slots\ncategory: test\nfields: []\nslots:\n main: {}\n", ) self.write("fragments/slot_probe/template.html.j2", "
{{ slots.main }}
") from site_engine.parsing import frontmatter s = self.svc.get("index") meta, body = frontmatter.parse(s.source) original = meta["regions"]["main"][0] meta["regions"]["main"][0] = { "id": "b_parent", "fragment": "slot_probe", "slots": {"main": [original]}, } source = frontmatter.dumps(meta, body) t = self.svc.transform_buffer( "index", source, s.etag, {"type": "toggle", "block_id": "b_hero"} ) self.assertTrue(t.report.ok, asdict(t.report)) hero = t.model["meta"]["regions"]["main"][0]["slots"]["main"][0] self.assertTrue(hero["hidden"]) self.assertEqual(hero["props"], original["props"]) self.assertEqual(t.model["meta"]["regions"]["main"][1], meta["regions"]["main"][1]) cycle = self.svc.transform_buffer( "index", t.source, s.etag, {"type": "move", "block_id": "b_parent", "before": "b_hero"} ) self.assertFalse(cycle.report.ok) self.assertEqual(cycle.source, t.source)