mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-11-11 12:33:53 -06:00
Abdessamad Derraz
964812f977
Comments, docstrings and test texts ended on tags that name private review notes no clone holds. The tags go, the facts stay. Test methods named after a finding number are named after what they hold. test_prose_style refuses a tag that comes back. install.py changes in comments only: its pin and the launcher index follow.
109 lines
4.5 KiB
Python
109 lines
4.5 KiB
Python
"""The one-line bootstraps the site serves at its own address.
|
|
|
|
`curl -fsSL https://abdess.github.io/retrobios/i | sh` and
|
|
`irm https://abdess.github.io/retrobios/i.ps1 | iex` fetch copies of
|
|
install.sh and install.ps1 written when the site is built. Each copy
|
|
downloads install.py from the commit the site is built from, the commit
|
|
whose bootstrap pins that installer's SHA-256. The site deploys minutes
|
|
after a push: until then it serves the previous commit's pair, never the
|
|
bootstrap of one commit with the installer of the next.
|
|
|
|
GitHub Pages serves both names as application/octet-stream (no type in
|
|
mime-db for .ps1 or for a bare name). curl ignores the type, and
|
|
Invoke-RestMethod reads any type that is neither JSON nor XML as text.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import hashlib
|
|
import os
|
|
import re
|
|
import subprocess
|
|
from pathlib import Path
|
|
|
|
from artifacts import write_if_changed
|
|
|
|
REPO_RAW = "https://raw.githubusercontent.com/Abdess/retrobios"
|
|
SH_NAME = "i"
|
|
PS1_NAME = "i.ps1"
|
|
|
|
# Served name: the bootstrap it copies and the one line naming the
|
|
# installer's address there.
|
|
SOURCES: dict[str, tuple[str, re.Pattern[str]]] = {
|
|
SH_NAME: ("install.sh", re.compile(r'^(DEFAULT_INSTALL_URL=")[^"]*(")', re.M)),
|
|
PS1_NAME: ("install.ps1", re.compile(r'^(\s*\$defaultInstallUrl = ")[^"]*(")', re.M)),
|
|
}
|
|
# The line each bootstrap says a refused installer with, and the pin.
|
|
ADVICE: dict[str, re.Pattern[str]] = {
|
|
SH_NAME: re.compile(r'^(MISMATCH_ADVICE=")[^"]*(")', re.M),
|
|
PS1_NAME: re.compile(r'^(\s*\$mismatchAdvice = ")[^"]*(")', re.M),
|
|
}
|
|
PIN: dict[str, re.Pattern[str]] = {
|
|
SH_NAME: re.compile(r'^DEFAULT_INSTALL_SHA256="([0-9a-f]{64})"', re.M),
|
|
PS1_NAME: re.compile(r'^\s*\$defaultInstallSha256 = "([0-9a-f]{64})"', re.M),
|
|
}
|
|
# What the served copy says of a refused installer. It names a commit's
|
|
# install.py, which never changes, and both downloaders fail on a short
|
|
# transfer before the hash is read: neither a cut download nor caches of
|
|
# two ages explain a mismatch there.
|
|
SERVED_ADVICE = ("The file was changed on its way here, most often by a proxy or an "
|
|
"antivirus that rewrites downloads. Run the command again from another "
|
|
"network, or with that web protection paused.")
|
|
|
|
|
|
def build_commit(root: Path) -> str:
|
|
"""The commit the site is built from: GITHUB_SHA in CI, HEAD locally."""
|
|
commit = os.environ.get("GITHUB_SHA", "").strip()
|
|
if not commit:
|
|
commit = subprocess.run(
|
|
["git", "rev-parse", "HEAD"], cwd=root, check=True,
|
|
capture_output=True, text=True,
|
|
).stdout.strip()
|
|
if not re.fullmatch(r"[0-9a-f]{40}", commit):
|
|
raise ValueError(f"not a commit id: {commit!r}")
|
|
return commit
|
|
|
|
|
|
def installer_url(commit: str) -> str:
|
|
return f"{REPO_RAW}/{commit}/install.py"
|
|
|
|
|
|
def served_text(name: str, root: Path, commit: str) -> str:
|
|
"""The bootstrap served as name, its installer read from commit and its
|
|
advice fitted to that. A pin that is not the SHA-256 of root's
|
|
install.py stops the build: published, that copy refused every install
|
|
until the next good deploy, where a failed build keeps the last good
|
|
pair served."""
|
|
source, line = SOURCES[name]
|
|
text = (root / source).read_text(encoding="utf-8")
|
|
pinned = PIN[name].findall(text)
|
|
if len(pinned) != 1:
|
|
raise ValueError(f"{source}: {len(pinned)} installer pins, expected one")
|
|
actual = hashlib.sha256((root / "install.py").read_bytes()).hexdigest()
|
|
if pinned[0] != actual:
|
|
raise ValueError(f"{source} pins {pinned[0][:12]}, install.py is {actual[:12]}: "
|
|
"re-pin the bootstrap before the site serves it")
|
|
served, count = line.subn(
|
|
lambda m: f"{m.group(1)}{installer_url(commit)}{m.group(2)}", text
|
|
)
|
|
if count != 1:
|
|
raise ValueError(f"{source}: {count} installer address lines, expected one")
|
|
served, count = ADVICE[name].subn(
|
|
lambda m: f"{m.group(1)}{SERVED_ADVICE}{m.group(2)}", served
|
|
)
|
|
if count != 1:
|
|
raise ValueError(f"{source}: {count} mismatch advice lines, expected one")
|
|
return served
|
|
|
|
|
|
def write_bootstraps(public: Path, root: Path, commit: str | None = None) -> list[Path]:
|
|
"""Write every served bootstrap at the root of the site's public folder."""
|
|
commit = commit or build_commit(root)
|
|
public.mkdir(parents=True, exist_ok=True)
|
|
written = []
|
|
for name in SOURCES:
|
|
path = public / name
|
|
write_if_changed(str(path), served_text(name, root, commit))
|
|
written.append(path)
|
|
return written
|