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

refactor: post-review hardening pass

Browse Source 
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:
Tomas Mirchev
2026-05-14 00:23:06 +03:00
parent 6a0eb9f6ef
commit 6b7a48bb20
32 changed files with 239 additions and 181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
tests/e2e/test_dotfiles_e2e.py
View File

@@ -53,6 +53,9 @@ def test_dotfiles_init_and_link_in_container():
# Run flow inside the container against the mounted example repo.
# `flow dotfiles init` clones, so we need a real git remote — turn
# the read-only example mount into a bare-ish working repo first.
# --skip system avoids the _root/ paths which would try to sudo-link
# over /etc/hostname; we already cover the link path on non-system
# packages.
script = (
"set -eux; "
"cp -r /example /home/flowuser/dotfiles-src; "
@@ -62,7 +65,14 @@ def test_dotfiles_init_and_link_in_container():
"git -c user.email=e2e@example.com -c user.name=e2e commit -q -m initial; "
"cd /home/flowuser; "
"flow dotfiles init --repo /home/flowuser/dotfiles-src; "
"flow dotfiles link --profile linux-auto --dry-run; "
"flow dotfiles link --profile linux-auto --skip system; "
# Verify real symlinks were created and point into the dotfiles dir.
"test -L /home/flowuser/.zshrc; "
"test -L /home/flowuser/.gitconfig; "
"readlink /home/flowuser/.zshrc | grep -q '/dotfiles/_shared/zsh/.zshrc'; "
"readlink /home/flowuser/.gitconfig | grep -q '/dotfiles/_shared/git/.gitconfig'; "
# Idempotency: rerun should be a no-op.
"flow dotfiles link --profile linux-auto --skip system; "
"flow dotfiles status"
)
result = subprocess.run(

2
tests/test_core_config.py
View File

@@ -1,7 +1,5 @@
"""Tests for flow.core.config."""
from pathlib import Path
import pytest
from flow.core.config import AppConfig, load_config, load_manifest

2
tests/test_core_platform.py
View File

@@ -1,7 +1,5 @@
"""Tests for flow.core.platform."""
import os
import pytest
from flow.core.platform import PlatformInfo, detect_context, detect_platform

6
tests/test_core_runtime.py
View File

@@ -2,7 +2,6 @@
import json
import os
from pathlib import Path
import pytest
@@ -25,11 +24,6 @@ class TestFileSystem:
fs.write_text(path, "hello")
assert fs.read_text(path) == "hello"
def test_read_text_default(self, tmp_path):
fs = FileSystem()
path = tmp_path / "missing.txt"
assert fs.read_text(path, default="fallback") == "fallback"
def test_write_and_read_json(self, tmp_path):
fs = FileSystem()
path = tmp_path / "data.json"

2
tests/test_core_yaml.py
View File

@@ -1,7 +1,5 @@
"""Tests for flow.core.yaml."""
from pathlib import Path
import pytest
from flow.core.errors import ConfigError

12
tests/test_domain_bootstrap_planning.py
View File

@@ -5,7 +5,7 @@ import inspect
import pytest
from flow.core.errors import ConfigError
from flow.domain.bootstrap.models import BootstrapAction, Profile
from flow.domain.bootstrap.models import Profile
from flow.domain.bootstrap.planning import parse_profile, plan_bootstrap
@@ -65,7 +65,7 @@ class TestPlanBootstrap:
def test_basic_plan(self):
profile = Profile(
name="test", os="linux", arch=None,
name="test", os="linux",
hostname="my-host", locale="en_US.UTF-8",
shell="zsh", ssh_keys=[], runcmd=[],
packages=["fd"], env_required=[],
@@ -81,7 +81,7 @@ class TestPlanBootstrap:
def test_missing_env_raises(self):
profile = Profile(
name="test", os="linux", arch=None,
name="test", os="linux",
hostname=None, locale=None, shell=None,
ssh_keys=[], runcmd=[], packages=[],
env_required=["REQUIRED_VAR"],
@@ -91,7 +91,7 @@ class TestPlanBootstrap:
def test_runcmd_produces_action(self):
profile = Profile(
name="test", os="linux", arch=None,
name="test", os="linux",
hostname=None, locale=None, shell=None,
ssh_keys=[], runcmd=["echo hello", "echo world"],
packages=[], env_required=[],
@@ -102,7 +102,7 @@ class TestPlanBootstrap:
def test_post_link_produces_action(self):
profile = Profile(
name="test", os="linux", arch=None,
name="test", os="linux",
hostname=None, locale=None, shell=None,
ssh_keys=[], runcmd=[], packages=[], env_required=[],
post_link="echo done",
@@ -112,7 +112,7 @@ class TestPlanBootstrap:
def test_ssh_keys_action(self):
profile = Profile(
name="test", os="linux", arch=None,
name="test", os="linux",
hostname=None, locale=None, shell=None,
ssh_keys=[{"path": "~/.ssh/id", "type": "ed25519"}],
runcmd=[], packages=[], env_required=[],

2
tests/test_domain_containers.py
View File

@@ -2,7 +2,7 @@
from pathlib import Path
from flow.domain.containers.models import ContainerSpec, ImageRef, Mount
from flow.domain.containers.models import ImageRef, Mount
from flow.domain.containers.resolution import (
build_container_spec,
container_name,

28
tests/test_domain_dotfiles_models.py
View File

@@ -2,14 +2,14 @@
from pathlib import Path
import pytest
from flow.core.errors import ConfigError
from flow.domain.dotfiles.models import (
LinkOp,
LinkPlan,
LinkTarget,
LinkedState,
ModuleRef,
Package,
PlanSummary,
)
@@ -45,3 +45,25 @@ def test_package_has_id():
pkg = Package(name="zsh", layer="_shared", package_id="_shared/zsh",
source_dir=Path("/dots/_shared/zsh"), module=None, local_files=())
assert pkg.package_id == "_shared/zsh"
def test_linked_state_corrupt_missing_field_raises():
data = {
"version": 2,
"links": {
"_shared/zsh": {
"/home/u/.zshrc": {
# missing "from_module"
"source": "/dots/_shared/zsh/.zshrc",
"needs_sudo": False,
},
},
},
}
with pytest.raises(ConfigError, match="from_module"):
LinkedState.from_dict(data)
def test_linked_state_unsupported_version_raises():
with pytest.raises(ConfigError, match="version 1"):
LinkedState.from_dict({"version": 1, "links": {}})

1
tests/test_domain_dotfiles_planning.py
View File

@@ -4,7 +4,6 @@ from pathlib import Path
from typing import Optional
from flow.domain.dotfiles.models import (
LinkOp,
LinkTarget,
LinkedState,
)

11
tests/test_domain_dotfiles_resolution.py
View File

@@ -5,7 +5,7 @@ from pathlib import Path
import pytest
from flow.core.errors import PlanConflict
from flow.domain.dotfiles.models import LinkTarget, ModuleRef, Package
from flow.domain.dotfiles.models import ModuleRef, Package
from flow.domain.dotfiles.resolution import resolve_all_targets, resolve_package_targets
RESERVED_ROOT = "_root"
@@ -56,6 +56,15 @@ class TestResolvePackageTargets:
targets = resolve_package_targets(pkg, HOME, {"_root"})
assert len(targets) == 0
def test_bare_root_marker_raises(self):
"""A package containing a file literally named `_root` (no children)
should be rejected, not silently dropped."""
pkg = _pkg("bad", files=[
(Path("/dots/_shared/bad/_root"), Path("_root")),
])
with pytest.raises(PlanConflict, match="_root"):
resolve_package_targets(pkg, HOME, set())
def test_skip_package_by_name(self):
pkg = _pkg("nvim", files=[
(Path("/dots/_shared/nvim/.config/nvim/init.lua"), Path(".config/nvim/init.lua")),

4
tests/test_domain_packages.py
View File

@@ -1,12 +1,8 @@
"""Tests for packages catalog and resolution."""
import pytest
from flow.core.errors import ConfigError, FlowError
from flow.domain.packages.catalog import normalize_profile_entry, parse_catalog
from flow.domain.packages.planning import plan_install
from flow.domain.packages.resolution import (
binary_template_context,
detect_package_manager,
pm_cask_install_command,
pm_install_command,

2
tests/test_domain_remote.py
View File

@@ -4,7 +4,7 @@ import pytest
from flow.core.config import TargetConfig
from flow.core.errors import FlowError
from flow.domain.remote.models import SSHCommand, Target
from flow.domain.remote.models import Target
from flow.domain.remote.resolution import (
build_ssh_command,
list_targets,

10
tests/test_service_bootstrap.py
View File

@@ -96,21 +96,21 @@ class TestBootstrapService:
def test_unknown_phase_raises(self):
from flow.domain.bootstrap.models import BootstrapAction, BootstrapPlan
from flow.domain.bootstrap.models import VALID_PHASES
manifest = {"profiles": {"work": {"os": "linux"}}}
ctx = _make_ctx(manifest)
svc = BootstrapService(ctx)
# Forge an action with a phase that VALID_PHASES contains but the
# dispatch can't handle (shouldn't happen, but tests the explicit guard).
# Use a phase NOT in VALID_PHASES first to confirm the "Unknown" branch.
# Forge an action with a phase the dispatcher doesn't handle.
# The trailing raise in _execute_action is the single source of
# truth for unhandled phases — adding a phase to VALID_PHASES
# without a handler should surface here.
action = BootstrapAction.__new__(BootstrapAction)
object.__setattr__(action, "phase", "no-such-phase")
object.__setattr__(action, "description", "")
object.__setattr__(action, "commands", ())
object.__setattr__(action, "needs_sudo", False)
plan = BootstrapPlan(profile="work", actions=(), packages_to_install=())
with pytest.raises(FlowError, match="Unknown bootstrap phase"):
with pytest.raises(FlowError, match="Unhandled bootstrap phase"):
svc._execute_action(action, plan, "work")
def test_run_uses_dotfiles_profile_override(self, monkeypatch):

69
tests/test_service_dotfiles.py
View File

@@ -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()

1
tests/test_service_projects.py
View File

@@ -1,7 +1,6 @@
"""Tests for ProjectService."""
import subprocess
from pathlib import Path
from flow.core.config import AppConfig, FlowContext
from flow.core.console import Console

20
tests/test_template.py
View File

@@ -5,25 +5,7 @@ import os
import pytest
from flow.core.errors import ConfigError
from flow.core.template import substitute, substitute_template
class TestSubstitute:
def test_replaces_dollar_var(self):
assert substitute("hello $NAME", {"NAME": "world"}) == "hello world"
def test_replaces_braced_var(self):
assert substitute("hello ${NAME}", {"NAME": "world"}) == "hello world"
def test_falls_back_to_env(self, monkeypatch):
monkeypatch.setenv("FOO", "bar")
assert substitute("$FOO", {}) == "bar"
def test_preserves_unknown_vars(self):
assert substitute("$UNKNOWN", {}) == "$UNKNOWN"
def test_non_string_passthrough(self):
assert substitute(42, {}) == 42
from flow.core.template import substitute_template
class TestSubstituteTemplate: