Skeleton: roledesk on desk and pipeline from ../news
Package layers models, config, storage, jobs, web, cli, held by tests/test_architecture.py with desk and pipeline as external trees and plugins/ limited to desk. roles.yaml is the default config, roledesk.db its own file, port 8790. create_app mounts pipeline.web.connect over Jobs(config.database); `roledesk job pull` drains a no-op pull and `roledesk db init` creates the file. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
commit
36dbcbb29e
20 files changed
+2320
No files matched your search
@@ -0,0 +1,153 @@
|
||||
"""The package boundaries, held as a test rather than as a convention.
|
||||
|
||||
Adapted from news/tests/test_architecture.py. One tree of our own, `roledesk`,
|
||||
and two external ones, `desk` and `pipeline`, imported from ../news.
|
||||
|
||||
1. **Direction.** Within `roledesk`, a package imports only from packages below
|
||||
it in `LAYERS`. `desk` and `pipeline` may be imported by any of them.
|
||||
2. **Doors.** From outside a package, only `<tree>.<package>` is imported, and
|
||||
only names it lists in `__all__`. `desk.tools` has no door of its own, so
|
||||
there the door is the tool: `desk.tools.<tool>`, one level, no deeper.
|
||||
3. **Plugins.** A file under `plugins/` imports `desk` and nothing else from
|
||||
these trees. A plugin is app-agnostic; it never sees `roledesk`.
|
||||
|
||||
Tests are held to none of this.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import ast
|
||||
import importlib
|
||||
import importlib.util
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
|
||||
#: Bottom to top. `cli` is the entry point and may reach anything.
|
||||
LAYERS = ["models", "config", "storage", "jobs", "web", "cli"]
|
||||
APP = "roledesk"
|
||||
EXTERNAL = {"desk", "pipeline"}
|
||||
TREES = {APP} | EXTERNAL
|
||||
|
||||
|
||||
def _is_module(name: str) -> bool:
|
||||
try:
|
||||
return importlib.util.find_spec(name) is not None
|
||||
except ModuleNotFoundError:
|
||||
return False
|
||||
|
||||
|
||||
def _imports(source: str) -> list[tuple[int, str, list[str]]]:
|
||||
"""Every import of one of `TREES`: (line, module, names). `from x import y`
|
||||
where `x.y` is a module is folded into `x.y` with no names, since that is
|
||||
what it reaches for."""
|
||||
found: list[tuple[int, str, list[str]]] = []
|
||||
for node in ast.walk(ast.parse(source)):
|
||||
if isinstance(node, ast.Import):
|
||||
found += [(node.lineno, a.name, []) for a in node.names
|
||||
if a.name.split(".")[0] in TREES]
|
||||
elif isinstance(node, ast.ImportFrom) and node.level == 0 \
|
||||
and (module := node.module or "").split(".")[0] in TREES:
|
||||
names = []
|
||||
for a in node.names:
|
||||
if _is_module(f"{module}.{a.name}"):
|
||||
found.append((node.lineno, f"{module}.{a.name}", []))
|
||||
else:
|
||||
names.append(a.name)
|
||||
if names:
|
||||
found.append((node.lineno, module, names))
|
||||
return found
|
||||
|
||||
|
||||
def _door_violation(module: str, names: list[str]) -> str | None:
|
||||
"""Why this import is not through a door, or None if it is."""
|
||||
parts = module.split(".")
|
||||
depth = 3 if parts[:2] == ["desk", "tools"] else 2
|
||||
if len(parts) > depth:
|
||||
return f"reaches past {'.'.join(parts[:depth])}"
|
||||
exported = getattr(importlib.import_module(module), "__all__", None)
|
||||
hidden = [n for n in names if exported is not None and n not in exported]
|
||||
return f"{', '.join(hidden)} is not in {module}.__all__" if hidden else None
|
||||
|
||||
|
||||
def _package(path: Path) -> str:
|
||||
"""`roledesk/storage/store.py` -> "storage"; `roledesk/cli.py` -> "cli";
|
||||
the tree's own `__init__.py` -> "" (a door, exempt from direction)."""
|
||||
rel = path.relative_to(ROOT).parts
|
||||
name = rel[1].removesuffix(".py") if len(rel) > 1 else ""
|
||||
return "" if name == "__init__" else name
|
||||
|
||||
|
||||
APP_FILES = sorted(p for p in (ROOT / APP).rglob("*.py") if "__pycache__" not in p.parts)
|
||||
PLUGIN_FILES = sorted((ROOT / "plugins").glob("*.py"))
|
||||
|
||||
|
||||
def _outside(here: str, source: str):
|
||||
"""Imports in a file of package `here` that cross a package boundary."""
|
||||
for line, module, names in _imports(source):
|
||||
parts = module.split(".")
|
||||
if parts[0] == APP and len(parts) > 1 and parts[1] == here:
|
||||
continue
|
||||
yield line, module, names
|
||||
|
||||
|
||||
def direction_violations(here: str, source: str) -> list[str]:
|
||||
wrong = []
|
||||
for line, module, _ in _outside(here, source):
|
||||
parts = module.split(".")
|
||||
if parts[0] != APP or not here or len(parts) < 2 or parts[1] not in LAYERS:
|
||||
continue
|
||||
if LAYERS.index(parts[1]) >= LAYERS.index(here):
|
||||
wrong.append(f"line {line}: {module} is not below roledesk.{here}")
|
||||
return wrong
|
||||
|
||||
|
||||
def plugin_violations(source: str) -> list[str]:
|
||||
wrong = []
|
||||
for line, module, names in _imports(source):
|
||||
if module.split(".")[0] != "desk":
|
||||
wrong.append(f"line {line}: {module} (a plugin imports desk only)")
|
||||
elif reason := _door_violation(module, names):
|
||||
wrong.append(f"line {line}: {module} ({reason})")
|
||||
return wrong
|
||||
|
||||
|
||||
@pytest.mark.parametrize("path", APP_FILES, ids=lambda p: str(p.relative_to(ROOT)))
|
||||
def test_a_package_imports_only_from_below_it(path: Path) -> None:
|
||||
wrong = direction_violations(_package(path), path.read_text(encoding="utf-8"))
|
||||
assert not wrong, "\n".join(wrong)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("path", APP_FILES, ids=lambda p: str(p.relative_to(ROOT)))
|
||||
def test_a_package_is_reached_only_through_its_door(path: Path) -> None:
|
||||
source = path.read_text(encoding="utf-8")
|
||||
wrong = [f"line {line}: {reason}"
|
||||
for line, module, names in _outside(_package(path), source)
|
||||
if (reason := _door_violation(module, names))]
|
||||
assert not wrong, "\n".join(wrong)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("path", PLUGIN_FILES, ids=lambda p: p.name)
|
||||
def test_a_plugin_knows_only_desk(path: Path) -> None:
|
||||
wrong = plugin_violations(path.read_text(encoding="utf-8"))
|
||||
assert not wrong, "\n".join(wrong)
|
||||
|
||||
|
||||
def test_the_rules_catch_what_they_are_for() -> None:
|
||||
"""The checker itself, on sources that break each rule."""
|
||||
assert plugin_violations("from roledesk.storage import Store")
|
||||
assert plugin_violations("from pipeline import job")
|
||||
assert plugin_violations("from desk.sources.base import Source")
|
||||
assert not plugin_violations("from desk.sources import Source, Item")
|
||||
|
||||
assert direction_violations("storage", "from roledesk.web import create_app")
|
||||
assert direction_violations("storage", "from roledesk import jobs")
|
||||
assert not direction_violations("jobs", "from roledesk.storage import Store")
|
||||
assert not direction_violations("models", "from pipeline import job")
|
||||
|
||||
assert _door_violation("roledesk.storage.store", ["Store"])
|
||||
assert _door_violation("desk.tools.video.marks", [])
|
||||
assert _door_violation("pipeline", ["not_exported_name"])
|
||||
assert not _door_violation("pipeline.web", ["connect"])
|
||||
Reference in new issue
Block a user