"""What has to be true about the repository itself, not about the code in it. Three facts that are invisible until they cost a deployment: a PowerShell script that will not parse, a folder that is not in the wheel, and a container missing a package the app imports. """ from __future__ import annotations import tomllib from pathlib import Path import pytest ROOT = Path(__file__).resolve().parent.parent SCRIPTS = sorted((ROOT / "deploy").rglob("*.ps1")) @pytest.mark.parametrize("script", SCRIPTS, ids=lambda p: p.name) def test_powershell_scripts_are_ascii(script: Path): """Windows PowerShell 5.1 reads a BOM-less file as Windows-1252. So an em dash becomes three characters, the last of which is a closing quote: the string ends in the middle of itself and the script fails to parse before it runs a line. It happened on a comment nobody thought was code. Write `--`, `->`, `...`. """ raw = script.read_bytes() bad = [(i, b) for i, b in enumerate(raw) if b > 0x7F] assert not bad, ( f"{script.relative_to(ROOT)} has non-ASCII bytes at offsets " f"{[i for i, _ in bad[:5]]} -- PowerShell 5.1 will mis-read them" ) def test_there_are_scripts_to_check(): """A parametrised test over an empty list passes by saying nothing.""" assert SCRIPTS, "no .ps1 found under deploy/ -- did the copy go wrong?" def test_pyproject_packages_the_module_folders(): data = tomllib.loads((ROOT / "pyproject.toml").read_text(encoding="utf-8")) include = data["tool"]["setuptools"]["packages"]["find"]["include"] for pattern in ("app*", "pipeline*", "auth*"): assert pattern in include, f"{pattern} is missing: an install would leave it out" def test_no_test_folder_travels_into_the_image(): """`COPY auth auth` copies `auth/tests` with it unless the ignore file says otherwise, and a module folder added later brings its own. Nothing breaks when they arrive, which is why nobody notices: the image is just carrying a test suite, its fixtures and whatever they import, in a container on a server. One line per folder, next to the recipe. """ ignored = {line.strip() for line in (ROOT / "deploy" / "Dockerfile.dockerignore") .read_text(encoding="utf-8").splitlines()} for folder in sorted(p.parent for p in ROOT.glob("*/tests")): name = f"{folder.name}/tests" assert name in ignored, f"{name} is not in Dockerfile.dockerignore" def test_the_dockerfile_copies_the_module_folders(): """`COPY app app` alone builds an image whose app cannot import its queue. The failure is at startup, in a container, on a server -- which is the worst of the three places to find out. """ dockerfile = (ROOT / "deploy" / "Dockerfile").read_text(encoding="utf-8") lines = [line.strip() for line in dockerfile.splitlines()] for folder in ("pipeline", "auth"): copies = [line for line in lines if line == f"COPY {folder} {folder}"] assert len(copies) == 2, ( f"expected `COPY {folder} {folder}` in both stages, found {len(copies)}")