tm0/flow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(dotfiles): make symlink handling robust and fix _module checkout

Browse Source 
- Atomic state writes (tempfile + os.replace) so a crash mid-write cannot
  corrupt linked.json.
- Managed-symlink guards in FileSystem.create_symlink and the new
  remove_symlink: refuse to overwrite or delete a path unless it is
  absent or already a symlink pointing to the expected source. Stops
  silent user-file deletion in the plan/apply race window.
- plan_link adopts orphan symlinks whose readlink already matches the
  desired source, so a partial-apply failure can be recovered by rerun.
- _load_state warns loudly on each stale entry it drops, and status()
  no longer rewrites linked.json as a side effect of read.
- _apply_plan dispatches exhaustively; unknown LinkOp types raise.
- Remove _checkout_module_ref early-return for branch == "main" -- it
  assumed the remote default was main, breaking master-default repos.
  Always run the explicit checkout (idempotent).
- Warn when a module's cache_dir is absent during link, suggesting
  flow dotfiles repos pull.
- LinkOp.type and ModuleRef.ref_type tightened to Literal[...]; dead
  "create_dir" enum value removed from the model.

Tests: +29 covering atomic writes, overwrite guards, remove_symlink
semantics, orphan adoption (match/mismatch), partial-failure rerun,
status read-only, branch/tag/commit checkout argv, uncloned-module
warning, stale-state warnings.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Tomas Mirchev
2026-05-14 00:01:46 +03:00
parent 78f95bc88e
commit c0e2758057
7 changed files with 582 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
tests/test_domain_dotfiles_planning.py
View File

@@ -28,10 +28,15 @@ def _fs_check_file(path: Path) -> Optional[str]:
return "file"
def _no_link_target(path: Path) -> Optional[Path]:
"""Default fake link_target: no symlink anywhere."""
return None
class TestPlanLink:
def test_new_target_creates_link(self):
desired = [_lt("/home/x/.zshrc")]
plan = plan_link(desired, LinkedState(), _fs_check_none)
plan = plan_link(desired, LinkedState(), _fs_check_none, _no_link_target)
assert len(plan.operations) == 1
assert plan.operations[0].type == "create_link"
assert plan.summary.added == 1
@@ -39,14 +44,14 @@ class TestPlanLink:
def test_existing_correct_link_unchanged(self):
lt = _lt("/home/x/.zshrc")
current = LinkedState(links={Path("/home/x/.zshrc"): lt})
plan = plan_link([lt], current, _fs_check_none)
plan = plan_link([lt], current, _fs_check_none, _no_link_target)
assert len(plan.operations) == 0
assert plan.summary.unchanged == 1
def test_stale_link_removed(self):
old = _lt("/home/x/.old")
current = LinkedState(links={Path("/home/x/.old"): old})
plan = plan_link([], current, _fs_check_none)
plan = plan_link([], current, _fs_check_none, _no_link_target)
assert len(plan.operations) == 1
assert plan.operations[0].type == "remove_link"
assert plan.summary.removed == 1
@@ -55,7 +60,7 @@ class TestPlanLink:
old = _lt("/home/x/.zshrc", source="/old")
new = _lt("/home/x/.zshrc", source="/new")
current = LinkedState(links={Path("/home/x/.zshrc"): old})
plan = plan_link([new], current, _fs_check_none)
plan = plan_link([new], current, _fs_check_none, _no_link_target)
types = [op.type for op in plan.operations]
assert types == ["remove_link", "create_link"]
assert plan.summary.updated == 1
@@ -64,25 +69,71 @@ class TestPlanLink:
def test_unmanaged_file_at_target_is_conflict(self):
desired = [_lt("/home/x/.zshrc")]
plan = plan_link(desired, LinkedState(), _fs_check_file)
plan = plan_link(desired, LinkedState(), _fs_check_file, _no_link_target)
assert len(plan.conflicts) == 1
assert ".zshrc" in plan.conflicts[0]
def test_module_targets_counted(self):
desired = [_lt("/home/x/.config/nvim/init.lua", module=True)]
plan = plan_link(desired, LinkedState(), _fs_check_none)
plan = plan_link(desired, LinkedState(), _fs_check_none, _no_link_target)
assert plan.summary.from_modules == 1
def test_broken_symlink_is_repaired(self):
lt = _lt("/home/x/.zshrc")
current = LinkedState(links={Path("/home/x/.zshrc"): lt})
plan = plan_link([lt], current, lambda p: "broken_symlink")
plan = plan_link(
[lt], current, lambda p: "broken_symlink", _no_link_target,
)
types = [op.type for op in plan.operations]
assert types == ["remove_link", "create_link"]
assert plan.summary.updated == 1
assert plan.summary.unchanged == 0
def test_orphan_symlink_matching_source_is_adopted(self):
"""Untracked symlink that already points at the desired source counts
as unchanged, not a conflict. Enables partial-failure rerun."""
desired = [_lt("/home/x/.zshrc", source="/dots/.zshrc")]
plan = plan_link(
desired,
LinkedState(),
lambda p: "symlink",
lambda p: Path("/dots/.zshrc"),
)
assert plan.conflicts == ()
assert plan.operations == ()
assert plan.summary.unchanged == 1
assert plan.summary.added == 0
def test_orphan_symlink_pointing_elsewhere_is_conflict(self):
"""Untracked symlink that points at the wrong source is still a
conflict -- we don't silently retarget unmanaged links."""
desired = [_lt("/home/x/.zshrc", source="/dots/.zshrc")]
plan = plan_link(
desired,
LinkedState(),
lambda p: "symlink",
lambda p: Path("/elsewhere/.zshrc"),
)
assert len(plan.conflicts) == 1
assert plan.summary.added == 0
assert plan.summary.unchanged == 0
def test_orphan_module_symlink_counts_as_module(self):
"""Adopted orphan symlinks for module files still count toward
from_modules in the summary."""
desired = [
_lt("/home/x/.config/nvim/init.lua", source="/cache/init.lua", module=True),
]
plan = plan_link(
desired,
LinkedState(),
lambda p: "symlink",
lambda p: Path("/cache/init.lua"),
)
assert plan.summary.unchanged == 1
assert plan.summary.from_modules == 1
class TestPlanUnlink:
def test_unlink_all(self):