Update with last fixes

This commit is contained in:
Alexey Dudin
2026-11-11 18:43:40 +03:00
parent 53980a5558
commit 58cc8090a9
24 changed files with 832 additions and 50 deletions
+10 -1
View File
@@ -16,7 +16,7 @@ class AdminHandlersTest(SiteTestCase):
super().setUp()
self.clock = Clock()
self.auth = AuthService(make_cfg(), self.tmp / "state", clock=self.clock)
self.h = AdminHandlers(self.auth, self.site)
self.h = AdminHandlers(self.auth, self.site, self.tmp / "dist")
def cookie_value(self, result):
header = result.cookies[0]
@@ -91,6 +91,15 @@ class AdminHandlersTest(SiteTestCase):
self.assertIn("name='csrf'", result.body)
self.assertIn("no-store", result.headers["Cache-Control"])
def test_dashboard_shows_the_absolute_paths_in_use(self):
body = self.h.dashboard(self.login()).body
for path in (self.site.resolve(), (self.tmp / "dist").resolve(), (self.tmp / "state").resolve()):
self.assertIn(str(path), body)
def test_missing_site_error_names_the_absolute_path(self):
(self.site / "site.yaml").unlink()
self.assertIn(str(self.site.resolve()), self.h.dashboard(self.login()).body)
def test_dashboard_shows_broken_site_instead_of_crashing(self):
(self.site / "site.yaml").unlink()
result = self.h.dashboard(self.login())
+17
View File
@@ -134,6 +134,23 @@ class RoutesWiringTest(SiteTestCase):
self.assertEqual((out.status_code, out.headers["Location"]), (303, "/admin/login"))
self.assertIn("Max-Age=0", out.headers.appended[0][1])
def test_annotations_are_real_types(self):
"""Регрессия: с `from __future__ import annotations` и локальным импортом Request FastAPI не разрешает
аннотацию, считает `request` query-параметром и отвечает 422 {"loc": ["query", "request"]}."""
import typing
from pathlib import Path
source = (Path(__file__).resolve().parent.parent / "src/site_engine/web/admin/routes.py").read_text(encoding="utf-8")
import re
self.assertIsNone(re.search(r"^from __future__ import annotations", source, re.M))
for key, fn in self.router.routes.items():
hints = typing.get_type_hints(fn) # как это делает FastAPI: имена берутся из globals модуля
if "request" in hints:
self.assertIs(hints["request"], FakeRequest, key)
self.assertFalse(any(isinstance(v, str) for v in fn.__annotations__.values()), key)
def test_static_and_login_page_routes(self):
css = self.route("GET", "/admin/static/{name}")("admin.css")
self.assertTrue(css.media_type.startswith("text/css"))
+16
View File
@@ -64,6 +64,22 @@ class ConfigTest(unittest.TestCase):
with self.assertRaises(ConfigError, msg=str(patch)):
AuthConfig.from_env({**self.ENV, **patch})
def test_trailing_comment_or_quotes_in_env_are_rejected_not_silently_accepted(self):
h, s = self.ENV["SITE_ADMIN_PASSWORD_HASH"], self.ENV["SITE_SECRET_KEY"]
for patch in ({"SITE_ADMIN_PASSWORD_HASH": h + " # site-engine hash-password"},
{"SITE_ADMIN_PASSWORD_HASH": f'"{h}"'}, {"SITE_ADMIN_PASSWORD_HASH": f"'{h}'"},
{"SITE_SECRET_KEY": s + " # gen-secret"}, {"SITE_SECRET_KEY": f'"{s}"'},
{"SITE_COOKIE_SECURE": "1 # только http"}, {"SITE_COOKIE_SECURE": "maybe"},
{"SITE_SESSION_HOURS": "8 # часов"}, {"SITE_ADMIN_LOGIN": "admin # мой"},
{"SITE_PUBLIC_HOST": "admin.example.com # прокси"}):
with self.assertRaises(ConfigError, msg=str(patch)) as ctx:
AuthConfig.from_env({**self.ENV, **patch})
self.assertIn("кавычки или комментарий", str(ctx.exception))
def test_valid_host_and_flags(self):
cfg = AuthConfig.from_env({**self.ENV, "SITE_PUBLIC_HOST": "admin.example.com:8443", "SITE_COOKIE_SECURE": "false"})
self.assertEqual((cfg.public_host, cfg.cookie_secure), ("admin.example.com:8443", False))
def test_cookie_secure_can_be_disabled_for_local_dev(self):
self.assertFalse(AuthConfig.from_env({**self.ENV, "SITE_COOKIE_SECURE": "0"}).cookie_secure)
+50
View File
@@ -0,0 +1,50 @@
import tempfile
import unittest
from pathlib import Path
from site_engine.web.config import SitePaths
DOCKER_ENV = {"SITE_ROOT": "/data/site", "SITE_DIST": "/data/dist", "SITE_STATE_DIR": "/data/state"}
OLD_ENV_EXAMPLE = {"SITE_ROOT": "examples/studio-site", "SITE_DIST": "dist"} # строки, которые когда-то были включены в .env.example
class SitePathsTest(unittest.TestCase):
def test_docker_defaults_resolve_inside_the_data_volume(self):
p = SitePaths.from_env(DOCKER_ENV, cwd=Path("/app"))
self.assertEqual((p.root, p.dist, p.state), (Path("/data/site"), Path("/data/dist"), Path("/data/state")))
self.assertEqual(p.relative, ())
def test_leftover_relative_paths_from_old_env_are_called_out(self):
env = {**DOCKER_ENV, **OLD_ENV_EXAMPLE}
p = SitePaths.from_env(env, cwd=Path("/app"))
self.assertEqual((p.root, p.dist), (Path("/app/examples/studio-site"), Path("/app/dist")))
text = "\n".join(p.problems(env))
for needle in ("SITE_ROOT=examples/studio-site", "/app/examples/studio-site", "SITE_DIST=dist", "/app/dist",
"Удалите строку из .env", "каталога сайта нет"):
self.assertIn(needle, text)
def test_state_defaults_to_dot_engine_inside_site(self):
p = SitePaths.from_env({"SITE_ROOT": "/srv/site", "SITE_DIST": "/srv/dist"}, cwd=Path("/app"))
self.assertEqual(p.state, Path("/srv/site/.engine"))
def test_no_problems_for_a_healthy_layout(self):
with tempfile.TemporaryDirectory() as tmp:
(Path(tmp) / "site").mkdir()
(Path(tmp) / "site" / "site.yaml").write_text("name: x\n", encoding="utf-8")
env = {"SITE_ROOT": f"{tmp}/site", "SITE_DIST": f"{tmp}/dist", "SITE_STATE_DIR": f"{tmp}/state"}
self.assertEqual(SitePaths.from_env(env).problems(env), [])
def test_missing_site_yaml_and_dist_inside_root(self):
with tempfile.TemporaryDirectory() as tmp:
env = {"SITE_ROOT": tmp, "SITE_DIST": f"{tmp}/dist"}
text = "\n".join(SitePaths.from_env(env).problems(env))
self.assertIn("нет site.yaml", text)
self.assertIn("внутри SITE_ROOT", text)
def test_relative_paths_resolve_against_cwd_for_local_runs(self):
p = SitePaths.from_env({"SITE_ROOT": "examples/studio-site", "SITE_DIST": "dist"}, cwd=Path("/work/project"))
self.assertEqual((p.root, p.dist), (Path("/work/project/examples/studio-site"), Path("/work/project/dist")))
if __name__ == "__main__":
unittest.main()
+54
View File
@@ -0,0 +1,54 @@
"""Регрессия: в установленный пакет (Docker-образ, wheel) должны попасть шаблоны и статика админки,
встроенные фрагменты и стили. Раньше package-data включал только builtin/."""
import fnmatch
import glob
import shutil
import subprocess
import sys
import tempfile
import tomllib
import unittest
import zipfile
from pathlib import Path
ROOT = Path(__file__).resolve().parent.parent
PKG = ROOT / "src" / "site_engine"
class PackagingTest(unittest.TestCase):
def test_package_data_patterns_cover_every_runtime_file(self):
patterns = tomllib.loads((ROOT / "pyproject.toml").read_text(encoding="utf-8"))["tool"]["setuptools"]["package-data"]["site_engine"]
runtime = [p for sub in ("builtin", "web/admin/templates", "web/admin/static") for p in (PKG / sub).rglob("*")
if p.is_file() and p.suffix != ".pyc" and "__pycache__" not in p.parts]
self.assertGreater(len(runtime), 50)
uncovered = [str(p.relative_to(PKG)) for p in runtime
if not any(fnmatch.fnmatch(p.relative_to(PKG).as_posix(), pat.replace("**/*", "*")) for pat in patterns)]
self.assertEqual(uncovered, [])
def test_built_wheel_contains_templates_static_and_fragments(self):
try:
import setuptools # noqa: F401
except ImportError:
self.skipTest("нет setuptools")
before = {name: (ROOT / name).exists() for name in ("build", "src/site_engine.egg-info")}
with tempfile.TemporaryDirectory() as tmp:
project = Path(tmp) / "project"
shutil.copytree(ROOT, project, ignore=shutil.ignore_patterns(
"build", "*.egg-info", "__pycache__", ".git", "tests", "docs", "examples", "dist", ".engine"))
result = subprocess.run([sys.executable, "-m", "pip", "wheel", str(project), "--no-deps", "--no-build-isolation",
"-q", "-w", str(Path(tmp) / "out")], capture_output=True, text=True, timeout=180)
wheels = glob.glob(f"{tmp}/out/*.whl")
if result.returncode != 0 or not wheels:
self.skipTest(f"wheel не собрался в этом окружении: {result.stderr[-200:]}")
names = zipfile.ZipFile(wheels[0]).namelist()
after = {name: (ROOT / name).exists() for name in before}
self.assertEqual(after, before, "сборка wheel не должна оставлять мусор в рабочем каталоге")
for needed in ("site_engine/web/admin/templates/login.html.j2", "site_engine/web/admin/templates/page_edit.html.j2",
"site_engine/web/admin/static/admin.css", "site_engine/builtin/base.css",
"site_engine/builtin/fragments/hero/template.html.j2"):
self.assertIn(needed, names)
if __name__ == "__main__":
unittest.main()
+113
View File
@@ -0,0 +1,113 @@
"""Страховка от ошибок упаковки, из-за которых пользователь получал неверные пути в Docker."""
import re
import shutil
import subprocess
import tempfile
import unittest
from pathlib import Path
from site_engine.services.auth import AuthConfig, ConfigError
from site_engine.web.config import SitePaths
ROOT = Path(__file__).resolve().parent.parent
GOOD_HASH = "scrypt$32768$8$1$aGVsbG8$d29ybGQ"
OLD_ENV_EXAMPLE = """# Каталоги
SITE_ROOT=examples/studio-site
SITE_DIST=dist
SITE_ADMIN_LOGIN=admin
SITE_ADMIN_PASSWORD_HASH= # site-engine hash-password
SITE_SECRET_KEY= # site-engine gen-secret (не короче 32 символов)
SITE_COOKIE_SECURE=1 # 0 только для локальной разработки по http
"""
def parse_docker_env_file(text: str) -> dict[str, str]:
"""Как `docker run --env-file`: строки с # в начале пропускаются, значение — всё после первого «=»,
кавычки и комментарии в конце строки не обрабатываются."""
env = {}
for line in text.splitlines():
if line.strip() and not line.lstrip().startswith("#") and "=" in line:
key, value = line.split("=", 1)
env[key] = value
return env
class EnvExampleTest(unittest.TestCase):
def test_env_example_lives_in_the_project_root_only(self):
self.assertTrue((ROOT / ".env.example").is_file())
self.assertFalse((ROOT / "src" / ".env.example").exists())
def test_env_example_has_no_path_overrides(self):
env = parse_docker_env_file((ROOT / ".env.example").read_text(encoding="utf-8"))
for name in ("SITE_ROOT", "SITE_DIST", "SITE_STATE_DIR", "SITE_DB"):
self.assertNotIn(name, env)
def test_filled_env_example_works_exactly_as_docker_reads_it(self):
text = (ROOT / ".env.example").read_text(encoding="utf-8")
text = text.replace("SITE_ADMIN_PASSWORD_HASH=", f"SITE_ADMIN_PASSWORD_HASH={GOOD_HASH}")
text = text.replace("SITE_SECRET_KEY=", "SITE_SECRET_KEY=" + "k" * 43)
env = parse_docker_env_file(text)
cfg = AuthConfig.from_env(env)
self.assertEqual((cfg.login, cfg.cookie_secure, cfg.session_hours), ("admin", True, 8.0))
self.assertEqual(SitePaths.from_env({**{"SITE_ROOT": "/data/site", "SITE_DIST": "/data/dist"}, **env}).relative, ())
def test_old_env_example_would_have_failed_loudly_instead_of_silently(self):
text = OLD_ENV_EXAMPLE.replace("SITE_ADMIN_PASSWORD_HASH= #", f"SITE_ADMIN_PASSWORD_HASH={GOOD_HASH} #")
text = text.replace("SITE_SECRET_KEY= #", "SITE_SECRET_KEY=" + "k" * 43 + " #")
with self.assertRaises(ConfigError):
AuthConfig.from_env(parse_docker_env_file(text))
class IgnoreRulesTest(unittest.TestCase):
"""Пакет `site_engine.build` (конвейер сборки) раньше мог попасть под правило `build/` без привязки к корню."""
PACKAGE_FILES = ("src/site_engine/build/pipeline.py", "src/site_engine/build/__init__.py",
"src/site_engine/web/admin/templates/login.html.j2", "src/site_engine/builtin/base.css")
def test_source_package_exists(self):
for rel in self.PACKAGE_FILES:
self.assertTrue((ROOT / rel).is_file(), rel)
def test_gitignore_patterns_for_build_and_dist_are_anchored_to_the_root(self):
lines = [l.strip() for l in (ROOT / ".gitignore").read_text(encoding="utf-8").splitlines()]
for bad in ("build/", "dist/", "build", "dist"):
self.assertNotIn(bad, lines)
for good in ("/build/", "/dist/"):
self.assertIn(good, lines)
@unittest.skipUnless(shutil.which("git"), "git недоступен")
def test_git_does_not_ignore_the_source_package(self):
with tempfile.TemporaryDirectory() as tmp:
subprocess.run(["git", "init", "-q", tmp], check=True)
shutil.copy(ROOT / ".gitignore", Path(tmp) / ".gitignore")
for rel in self.PACKAGE_FILES:
result = subprocess.run(["git", "-C", tmp, "check-ignore", "-q", rel])
self.assertEqual(result.returncode, 1, f"{rel} игнорируется git")
for rel in ("build/lib/x.py", "dist/current/index.html"):
self.assertEqual(subprocess.run(["git", "-C", tmp, "check-ignore", "-q", rel]).returncode, 0, rel)
class DockerfileTest(unittest.TestCase):
def setUp(self):
self.text = (ROOT / "Dockerfile").read_text(encoding="utf-8")
def test_all_paths_point_inside_one_data_volume(self):
for pair in ("SITE_ROOT=/data/site", "SITE_DIST=/data/dist", "SITE_STATE_DIR=/data/state"):
self.assertIn(pair, self.text)
self.assertEqual(re.findall(r"^VOLUME .*$", self.text, re.M), ['VOLUME ["/data"]'])
def test_env_file_is_never_copied_into_the_image(self):
self.assertIn(".env", (ROOT / ".dockerignore").read_text(encoding="utf-8").splitlines())
self.assertNotRegex(self.text, r"COPY\s+.*\.env")
class ReadmeTest(unittest.TestCase):
def test_readme_docker_command_matches_the_dockerfile(self):
readme = (ROOT / "README.md").read_text(encoding="utf-8")
self.assertIn('-v "$PWD/data:/data"', readme)
self.assertNotIn("/data/dist\" site-engine", readme) # прежняя схема с двумя томами
if __name__ == "__main__":
unittest.main()
+49
View File
@@ -0,0 +1,49 @@
import unittest
from helpers import NOW, SiteTestCase
from site_engine.build.pipeline import build_site
from site_engine.services.publish import rollback
from site_engine.web.static_site import resolve_site_file
class StaticSiteTest(SiteTestCase):
def test_unpublished(self):
self.assertEqual(resolve_site_file(self.out, "/"), ("unpublished", None))
def test_pages_assets_redirects_and_404(self):
build_site(self.site, self.out, now=NOW)
cur = (self.out / "current").resolve()
self.assertEqual(resolve_site_file(self.out, "/"), ("file", cur / "index.html"))
self.assertEqual(resolve_site_file(self.out, "/services/"), ("file", cur / "services" / "index.html"))
self.assertEqual(resolve_site_file(self.out, "/services"), ("redirect", "/services/"))
self.assertEqual(resolve_site_file(self.out, "/assets/hero.svg")[0], "file")
self.assertEqual(resolve_site_file(self.out, "/nope/"), ("not_found", None))
self.assertEqual(resolve_site_file(self.out, "/drafts/next/"), ("not_found", None))
def test_custom_404_page_is_used(self):
self.write("pages/404.md", "---\ntitle: Не найдено\nstatus: published\nregions:\n main:\n - {id: b_h, fragment: page_header, props: {title: Нет такой страницы}}\n---\n")
build_site(self.site, self.out, now=NOW)
kind, target = resolve_site_file(self.out, "/missing/")
self.assertEqual((kind, target.name), ("not_found", "404.html"))
def test_traversal_and_service_files_are_not_served(self):
build_site(self.site, self.out, now=NOW)
for path in ("/../../etc/passwd", "/..%2f..%2fetc/passwd", "/assets/../../x", "/_forms/consultation@d409cada0967.json",
"/_forms/", "/manifest.json", "/redirects.map", "//etc/passwd", "/\x00"):
self.assertEqual(resolve_site_file(self.out, path)[0], "not_found", path)
def test_publish_and_rollback_are_visible_without_restart(self):
first = build_site(self.site, self.out, now=NOW)
self.edit("pages/privacy.md", "Текст политики", "Версия два")
second = build_site(self.site, self.out, now=NOW.replace(minute=30))
page = lambda: resolve_site_file(self.out, "/privacy/")[1].read_text(encoding="utf-8")
self.assertIn("Версия два", page())
rollback(self.out, first.build_id)
self.assertNotIn("Версия два", page())
rollback(self.out, second.build_id)
self.assertIn("Версия два", page())
if __name__ == "__main__":
unittest.main()