mirror of
https://github.com/got-feedBack/feedBack.git
synced 2026-08-11 03:09:57 +00:00
70dbe45e27
lib/builtin_content.py (321 lines moved). server.py 2,418 -> 2,098.
The calibration/diagnostic sloppaks and the starter library: _copy_builtin_packs,
_write_builtin_pack, the two seed helpers, their source tables, and the seed marker.
━━━ THE ONE SIGNATURE CHANGE, AND WHY THE CARVE IS UNSAFE WITHOUT IT ━━━
server.py has:
def _feedBack_server_root() -> Path:
return Path(__file__).resolve().parent
That is correct IN server.py: the repo root in dev, resources/feedBack when bundled — the
tree that actually holds docs/ and data/.
Move that body into lib/ unchanged and it keeps working, silently, and returns lib/. There
is no docs/diagnostics under lib/, so every seed would find nothing, log "source missing"
at debug, and return. Nothing raises. Nothing fails. The starter library simply never
appears, and the calibration sloppak is never seeded — on a fresh install, in the field.
A verbatim move whose MEANING changed because __file__ did.
So this module cannot compute a root: `server_root` is a PARAMETER, and server.py — the
only place that legitimately knows where it lives — passes it in. The trap is now
structurally impossible rather than merely avoided. (_copy_builtin_packs already took the
root that way; the two seed helpers now do too.)
Everything else is byte-identical. CONFIG_DIR is read late as appstate.config_dir and the
DLC root through dlc_paths._get_dlc_dir — the same seam every router in lib/routers/ uses,
late-bound because tests monkeypatch it.
━━━ PYFLAKES FOUND THREE MISSING IMPORTS THE TESTS WOULD HAVE FOUND ONE AT A TIME ━━━
The moved code uses `secrets`, `stat` and `tempfile`; none was in my import block. Each is
a NameError on a live path. `python3 -m pyflakes` names all three in one shot — this is the
Python twin of the no-undef gate that guarded every frontend carve, and it should run on
every server.py slice from here.
It also flagged a PRE-EXISTING one I deliberately did not touch: server.py's
TuningProviderRegistry.get_merged() calls `logger.exception(...)` in an except handler and
there is no `logger` in the module (it is `log`). So a raising tuning provider takes down
the merged-tunings call for everyone, with a NameError naming the wrong problem. Filed as
issue #899 rather than smuggled into a carve whose whole value is being behaviour-neutral.
The constants lost their underscore prefix: they cross a module boundary now (the seed
tests read them), so `_BUILTIN_STARTER_SOURCES` was a lie.
pytest 2397, pyflakes 0, Codex 0. Guarded by the plugin_context contract test (#898).
Refs #48
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
128 lines
4.8 KiB
Python
128 lines
4.8 KiB
Python
"""Tests for builtin diagnostic sloppak seeding into DLC."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import importlib
|
|
import os
|
|
import sys
|
|
import time
|
|
|
|
import builtin_content
|
|
import pytest
|
|
|
|
|
|
@pytest.fixture()
|
|
def server_mod(tmp_path, monkeypatch, isolate_logging):
|
|
monkeypatch.setenv("CONFIG_DIR", str(tmp_path))
|
|
monkeypatch.delenv("DLC_DIR", raising=False)
|
|
sys.modules.pop("server", None)
|
|
mod = importlib.import_module("server")
|
|
yield mod
|
|
|
|
|
|
def test_seed_creates_builtin_diagnostic_sloppak(tmp_path, server_mod):
|
|
"""First seed copies the bundled sloppak into diagnostics-builtin/."""
|
|
dlc = tmp_path / "dlc"
|
|
dlc.mkdir()
|
|
source = server_mod._feedBack_server_root() / builtin_content.BUILTIN_DIAGNOSTIC_SOURCES[0][1]
|
|
if not source.is_file():
|
|
pytest.skip(f"source sloppak not present in checkout: {source}")
|
|
|
|
builtin_content.seed_builtin_diagnostic_sloppaks(server_mod._feedBack_server_root(), dlc)
|
|
|
|
dest = dlc / builtin_content.BUILTIN_DIAGNOSTIC_SUBDIR / builtin_content.BUILTIN_DIAGNOSTIC_SOURCES[0][0]
|
|
assert dest.is_file()
|
|
assert dest.stat().st_size == source.stat().st_size
|
|
|
|
|
|
def test_seed_is_idempotent_when_destination_exists(tmp_path, server_mod):
|
|
"""Second seed leaves an up-to-date destination unchanged."""
|
|
dlc = tmp_path / "dlc"
|
|
dlc.mkdir()
|
|
source = server_mod._feedBack_server_root() / builtin_content.BUILTIN_DIAGNOSTIC_SOURCES[0][1]
|
|
if not source.is_file():
|
|
pytest.skip(f"source sloppak not present in checkout: {source}")
|
|
|
|
builtin_content.seed_builtin_diagnostic_sloppaks(server_mod._feedBack_server_root(), dlc)
|
|
dest = dlc / builtin_content.BUILTIN_DIAGNOSTIC_SUBDIR / builtin_content.BUILTIN_DIAGNOSTIC_SOURCES[0][0]
|
|
first_mtime = dest.stat().st_mtime_ns
|
|
first_size = dest.stat().st_size
|
|
|
|
builtin_content.seed_builtin_diagnostic_sloppaks(server_mod._feedBack_server_root(), dlc)
|
|
|
|
assert dest.stat().st_mtime_ns == first_mtime
|
|
assert dest.stat().st_size == first_size
|
|
|
|
|
|
def test_seed_skips_when_destination_is_newer(tmp_path, server_mod):
|
|
"""An existing newer destination is not overwritten."""
|
|
dlc = tmp_path / "dlc"
|
|
dlc.mkdir()
|
|
source = server_mod._feedBack_server_root() / builtin_content.BUILTIN_DIAGNOSTIC_SOURCES[0][1]
|
|
if not source.is_file():
|
|
pytest.skip(f"source sloppak not present in checkout: {source}")
|
|
dest_dir = dlc / builtin_content.BUILTIN_DIAGNOSTIC_SUBDIR
|
|
dest_dir.mkdir(parents=True)
|
|
dest_name = builtin_content.BUILTIN_DIAGNOSTIC_SOURCES[0][0]
|
|
dest = dest_dir / dest_name
|
|
dest.write_bytes(b"user-owned diagnostic copy")
|
|
future = time.time() + 3600
|
|
os.utime(dest, (future, future))
|
|
|
|
builtin_content.seed_builtin_diagnostic_sloppaks(server_mod._feedBack_server_root(), dlc)
|
|
|
|
assert dest.read_bytes() == b"user-owned diagnostic copy"
|
|
|
|
|
|
def test_seed_refuses_to_follow_symlink_destination(tmp_path, server_mod):
|
|
"""A symlink at the destination is skipped, not written through."""
|
|
dlc = tmp_path / "dlc"
|
|
dlc.mkdir()
|
|
source = server_mod._feedBack_server_root() / builtin_content.BUILTIN_DIAGNOSTIC_SOURCES[0][1]
|
|
if not source.is_file():
|
|
pytest.skip(f"source sloppak not present in checkout: {source}")
|
|
|
|
outside = tmp_path / "outside.txt"
|
|
outside.write_bytes(b"do not overwrite me")
|
|
dest_dir = dlc / builtin_content.BUILTIN_DIAGNOSTIC_SUBDIR
|
|
dest_dir.mkdir(parents=True)
|
|
dest = dest_dir / builtin_content.BUILTIN_DIAGNOSTIC_SOURCES[0][0]
|
|
dest.symlink_to(outside)
|
|
|
|
builtin_content.seed_builtin_diagnostic_sloppaks(server_mod._feedBack_server_root(), dlc)
|
|
|
|
# The symlink target must be untouched and the link left as-is.
|
|
assert outside.read_bytes() == b"do not overwrite me"
|
|
assert dest.is_symlink()
|
|
|
|
|
|
def test_seed_refuses_symlinked_seed_directory(tmp_path, server_mod):
|
|
"""A symlinked diagnostics-builtin directory is skipped entirely."""
|
|
dlc = tmp_path / "dlc"
|
|
dlc.mkdir()
|
|
outside_dir = tmp_path / "outside_dir"
|
|
outside_dir.mkdir()
|
|
(dlc / builtin_content.BUILTIN_DIAGNOSTIC_SUBDIR).symlink_to(
|
|
outside_dir, target_is_directory=True
|
|
)
|
|
|
|
builtin_content.seed_builtin_diagnostic_sloppaks(server_mod._feedBack_server_root(), dlc)
|
|
|
|
# Nothing was written through the directory symlink into the link target.
|
|
assert list(outside_dir.iterdir()) == []
|
|
|
|
|
|
def test_seed_missing_source_does_not_crash(tmp_path, server_mod, monkeypatch):
|
|
"""Missing bundled source logs and returns without raising."""
|
|
dlc = tmp_path / "dlc"
|
|
dlc.mkdir()
|
|
monkeypatch.setattr(
|
|
builtin_content,
|
|
"BUILTIN_DIAGNOSTIC_SOURCES",
|
|
[("missing.sloppak", "docs/diagnostics/does-not-exist.sloppak")],
|
|
)
|
|
|
|
builtin_content.seed_builtin_diagnostic_sloppaks(server_mod._feedBack_server_root(), dlc)
|
|
|
|
assert not (dlc / builtin_content.BUILTIN_DIAGNOSTIC_SUBDIR / "missing.sloppak").exists()
|