Files
flow/tests/test_domain_dotfiles_planning.py
Tomas Mirchev 6b7a48bb20 refactor: post-review hardening pass
Independent re-audit surfaced 11 follow-ups across two layers of review
(my fresh-eyes read + a parallel agent pass). Bundled into a single
commit because changes are small and intertwined.

Symlink / state consistency:
- FileSystem.same_symlink now uses raw readlink() instead of resolve().
  Aligns the three sites that ask "is this our link?" (_load_state,
  _check_overwrite_safe, remove_symlink) on a single rule: exact-readlink
  match. Following symlink chains would let externally-modified links
  pass as ours and be silently overwritten.
- LinkedState.from_dict raises ConfigError on missing required fields
  instead of .get(..., False) silent defaults. Matches InstalledState.
- LinkOp.source is now consistently None for remove_link ops; the
  service derives expected_source from current.links. Removes the
  asymmetry between in-state and orphan-broken removal ops.
- _apply_plan: rename shadowing local from link_target to spec.

Fail loud:
- _xdg() now treats XDG_CONFIG_HOME="" the same as unset. Previously
  an empty env var produced Path("") and state files were written to
  $PWD instead of ~/.local/state/flow.
- _resolve_target raises PlanConflict when a package contains a bare
  _root entry (no path components) instead of silently dropping it.
- _strip_prefix raises FlowError when a declared install path does not
  start with its section's expected prefix (e.g. etc/foo under install.bin).

Speculative abstraction removed (CLAUDE.md):
- core.template.substitute (the $VAR form) had no production callers --
  deleted along with its tests; only the {{var}} form remains.
- SetupModule base class -- five subclasses, no shared behaviour, no
  polymorphic call site. Deleted.
- Profile.arch -- parsed but never read. Deleted.
- PackagePlan.pm_command -- set but never read. Deleted (service
  recomputes pm_install_command at the call site).
- FileSystem.ensure_dir(mode=...), .copy_file(sudo=...), .read_text(
  default=...) -- no callers. Deleted along with their test.
- bootstrap _execute_action: the upfront `phase not in VALID_PHASES`
  check duplicated the trailing exhaustive raise. Kept the trailing
  raise as the single source of truth; phase set still documented in
  VALID_PHASES.

Completion ctx threading:
- Removed _config()/_manifest() helpers that re-loaded from disk on
  every completion call. _list_targets, _list_namespaces, _list_platforms,
  _list_bootstrap_profiles, _list_manifest_packages now take ctx and
  read from ctx.config / ctx.manifest.

Test coverage and e2e:
- e2e container test exercises a real `flow dotfiles link` (no dry-run)
  and asserts the resulting symlinks point into the dotfiles dir;
  reruns to verify idempotency.
- New tests: LinkedState corrupt-state ConfigError, LinkedState bad-version
  ConfigError, bare-_root PlanConflict, service-level _root path routing
  + skip semantics.
- 11 stale test imports removed (pyflakes clean across src/ + tests/).

357 unit tests + 1 e2e (gated) all pass.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-14 00:23:06 +03:00

161 lines
5.9 KiB
Python

"""Tests for dotfiles link planning."""
from pathlib import Path
from typing import Optional
from flow.domain.dotfiles.models import (
LinkTarget,
LinkedState,
)
from flow.domain.dotfiles.planning import plan_link, plan_unlink
def _lt(target, source="/a", pkg="_shared/zsh", module=False, sudo=False):
return LinkTarget(
source=Path(source), target=Path(target),
package=pkg, from_module=module, needs_sudo=sudo,
)
def _fs_check_none(path: Path) -> Optional[str]:
"""Fake filesystem_check: nothing exists."""
return None
def _fs_check_file(path: Path) -> Optional[str]:
"""Fake: everything is a file."""
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, _no_link_target)
assert len(plan.operations) == 1
assert plan.operations[0].type == "create_link"
assert plan.summary.added == 1
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, _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, _no_link_target)
assert len(plan.operations) == 1
assert plan.operations[0].type == "remove_link"
assert plan.summary.removed == 1
def test_changed_source_produces_remove_then_create(self):
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, _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.added == 0
assert plan.summary.removed == 0
def test_unmanaged_file_at_target_is_conflict(self):
desired = [_lt("/home/x/.zshrc")]
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, _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", _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):
lt = _lt("/home/x/.zshrc")
current = LinkedState(links={Path("/home/x/.zshrc"): lt})
plan = plan_unlink(current, packages=None)
assert len(plan.operations) == 1
assert plan.operations[0].type == "remove_link"
def test_unlink_specific_package(self):
zsh = _lt("/home/x/.zshrc", pkg="_shared/zsh")
git = _lt("/home/x/.gitconfig", pkg="_shared/git")
current = LinkedState(links={
Path("/home/x/.zshrc"): zsh,
Path("/home/x/.gitconfig"): git,
})
plan = plan_unlink(current, packages=["_shared/zsh"])
assert len(plan.operations) == 1
assert plan.operations[0].target == Path("/home/x/.zshrc")
def test_unlink_by_basename(self):
zsh = _lt("/home/x/.zshrc", pkg="_shared/zsh")
current = LinkedState(links={Path("/home/x/.zshrc"): zsh})
plan = plan_unlink(current, packages=["zsh"])
assert len(plan.operations) == 1