"""Страховка от ошибок упаковки, из-за которых пользователь получал неверные пути в 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()