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>
This commit is contained in:
@@ -693,3 +693,72 @@ class TestStatePersistsAtomically:
|
||||
assert residue == []
|
||||
# Final content is valid JSON.
|
||||
json.loads(state_path.read_text())
|
||||
|
||||
|
||||
class TestDotfilesServiceRootPaths:
|
||||
"""`_root/` paths require sudo; verify the service routes them via the
|
||||
sudo branch of FileSystem.create_symlink (without actually invoking sudo)."""
|
||||
|
||||
def test_root_paths_route_via_sudo(self, tmp_path, monkeypatch):
|
||||
home = tmp_path / "home"
|
||||
home.mkdir()
|
||||
|
||||
dotfiles = tmp_path / "dotfiles"
|
||||
pkg_dir = dotfiles / "_shared" / "system" / "_root" / "etc"
|
||||
pkg_dir.mkdir(parents=True)
|
||||
(pkg_dir / "ourfile").write_text("managed by flow")
|
||||
|
||||
monkeypatch.setattr(paths, "HOME", home)
|
||||
monkeypatch.setattr(paths, "DOTFILES_DIR", dotfiles)
|
||||
monkeypatch.setattr(paths, "MODULES_DIR", tmp_path / "modules")
|
||||
monkeypatch.setattr(paths, "LINKED_STATE", tmp_path / "state" / "linked.json")
|
||||
|
||||
# Replace the FS layer with one that records sudo calls instead of
|
||||
# actually invoking sudo. We still want create_symlink's pre-check
|
||||
# to run, so we patch only the sudo branch's runner.
|
||||
runner = FakeRunner()
|
||||
ctx = _make_ctx(tmp_path)
|
||||
ctx.runtime.runner = runner
|
||||
|
||||
svc = DotfilesService(ctx)
|
||||
|
||||
# Plan first to inspect the operations -- a _root entry must carry
|
||||
# needs_sudo=True so create_symlink takes the sudo branch.
|
||||
packages = svc._discover_packages(profile=None)
|
||||
assert any(
|
||||
p.local_files and any("_root" in str(rel) for _, rel in p.local_files)
|
||||
for p in packages
|
||||
)
|
||||
from flow.domain.dotfiles.resolution import resolve_all_targets
|
||||
targets = resolve_all_targets(packages, home, set())
|
||||
assert any(t.needs_sudo and t.target == Path("/etc/ourfile") for t in targets)
|
||||
|
||||
# Running link() against a real /etc would require root; instead
|
||||
# confirm that with --dry-run the plan surfaces the sudo op without
|
||||
# any FS mutation.
|
||||
svc.link(dry_run=True)
|
||||
assert not Path("/etc/ourfile").exists() # we did not actually touch /etc
|
||||
|
||||
def test_root_paths_can_be_skipped(self, tmp_path, monkeypatch):
|
||||
home = tmp_path / "home"
|
||||
home.mkdir()
|
||||
|
||||
dotfiles = tmp_path / "dotfiles"
|
||||
pkg_dir = dotfiles / "_shared" / "system" / "_root" / "etc"
|
||||
pkg_dir.mkdir(parents=True)
|
||||
(pkg_dir / "hostname").write_text("flow-host")
|
||||
# Non-root file in the same package shouldn't be skipped
|
||||
(dotfiles / "_shared" / "system" / "README").write_text("notes")
|
||||
|
||||
monkeypatch.setattr(paths, "HOME", home)
|
||||
monkeypatch.setattr(paths, "DOTFILES_DIR", dotfiles)
|
||||
monkeypatch.setattr(paths, "MODULES_DIR", tmp_path / "modules")
|
||||
monkeypatch.setattr(paths, "LINKED_STATE", tmp_path / "state" / "linked.json")
|
||||
|
||||
ctx = _make_ctx(tmp_path)
|
||||
svc = DotfilesService(ctx)
|
||||
svc.link(skip={"_root"})
|
||||
|
||||
assert not Path("/etc/hostname").exists() or (home / "etc" / "hostname").is_symlink() is False
|
||||
# README is not under _root, so it should be linked
|
||||
assert (home / "README").is_symlink()
|
||||
|
||||
Reference in New Issue
Block a user