|
| 1 | +#!/usr/bin/env python3 |
| 2 | +"""Updater tests for installers/update.py — fully offline (network + install injected). |
| 3 | +
|
| 4 | +Builds a synthetic classroom ZIP (single root, skills + installers + a matching |
| 5 | +distribution_files.json), fakes the GitHub API (digest = the ZIP's sha256) and the byte |
| 6 | +download, and mocks the install step (so no real host dir is touched). Covers the happy |
| 7 | +path + the supply-chain guards (digest mismatch, fail-closed no-digest, traversal, symlink, |
| 8 | +duplicate, unexpected file, hash/size mismatch, zip-bomb caps, draft/prerelease) and the |
| 9 | +check_update cache/semver logic. Run: python3 installers/tests/test_update.py |
| 10 | +""" |
| 11 | +from __future__ import annotations |
| 12 | + |
| 13 | +import hashlib |
| 14 | +import io |
| 15 | +import json |
| 16 | +import os |
| 17 | +import sys |
| 18 | +import tempfile |
| 19 | +import zipfile |
| 20 | +from pathlib import Path |
| 21 | + |
| 22 | +HERE = Path(__file__).resolve().parent |
| 23 | +sys.path.insert(0, str(HERE.parent)) |
| 24 | +import update as U # noqa: E402 |
| 25 | +import medsci_txn # noqa: E402 |
| 26 | + |
| 27 | +PASS = 0 |
| 28 | +FAIL = 0 |
| 29 | +ROOT = "medsci-skills-classroom-2.0.0" |
| 30 | + |
| 31 | + |
| 32 | +def check(label, cond): |
| 33 | + global PASS, FAIL |
| 34 | + print(f" {'PASS' if cond else 'FAIL'} {label}") |
| 35 | + PASS += (1 if cond else 0) |
| 36 | + FAIL += (0 if cond else 1) |
| 37 | + |
| 38 | + |
| 39 | +def _sha(b: bytes) -> str: |
| 40 | + return hashlib.sha256(b).hexdigest() |
| 41 | + |
| 42 | + |
| 43 | +def build_payload(tmp: Path) -> dict[str, bytes]: |
| 44 | + """Return {relpath: bytes} for a minimal valid classroom payload (skills + installers + |
| 45 | + README_FIRST), with metadata/distribution_files.json matching the skills/installers/readme.""" |
| 46 | + files: dict[str, bytes] = {} |
| 47 | + files["README_FIRST.md"] = b"# MedSci Skills\n" |
| 48 | + files["skills/demo/SKILL.md"] = b"# demo\n" |
| 49 | + files["skills/demo/x.txt"] = b"data\n" |
| 50 | + # ship the real installer modules so an extracted install.py would be runnable + the updater |
| 51 | + # can self-install (update.py + medsci_txn.py) from the payload. |
| 52 | + for n in ("install.py", "medsci_txn.py", "update.py"): |
| 53 | + files[f"installers/{n}"] = (HERE.parent / n).read_bytes() |
| 54 | + # inventory excludes the metadata manifests themselves (matches gen scope) |
| 55 | + inv = [{"path": p, "size": len(b), "sha256": _sha(b)} for p, b in sorted(files.items())] |
| 56 | + files["metadata/distribution_files.json"] = (json.dumps({"schema_version": 1, "files": inv}) + "\n").encode() |
| 57 | + files["metadata/distribution_manifest.json"] = (json.dumps( |
| 58 | + {"schema_version": 1, "version": "2.0.0", "owned_skills": ["demo"]}) + "\n").encode() |
| 59 | + return files |
| 60 | + |
| 61 | + |
| 62 | +def make_zip(files: dict[str, bytes], root: str = ROOT, extra: dict[str, bytes] | None = None, |
| 63 | + symlink: str | None = None, dup: bool = False) -> bytes: |
| 64 | + buf = io.BytesIO() |
| 65 | + with zipfile.ZipFile(buf, "w", zipfile.ZIP_DEFLATED) as zf: |
| 66 | + for rel, b in files.items(): |
| 67 | + zf.writestr(f"{root}/{rel}", b) |
| 68 | + for rel, b in (extra or {}).items(): |
| 69 | + zf.writestr(f"{root}/{rel}", b) |
| 70 | + if symlink: |
| 71 | + info = zipfile.ZipInfo(f"{root}/{symlink}") |
| 72 | + info.external_attr = (0o120777 << 16) # symlink mode |
| 73 | + zf.writestr(info, "skills/demo") |
| 74 | + if dup: |
| 75 | + zf.writestr(f"{root}/skills/DEMO/SKILL.md", b"dup\n") # case-insensitive dup of skills/demo |
| 76 | + return buf.getvalue() |
| 77 | + |
| 78 | + |
| 79 | +def fake_api(zip_bytes: bytes, asset="medsci-skills-classroom-macos.zip", tag="v2.0.0", |
| 80 | + draft=False, prerelease=False, digest=True): |
| 81 | + def get_json(_url): |
| 82 | + a = {"name": asset, "browser_download_url": "https://release-assets.githubusercontent.com/x.zip"} |
| 83 | + if digest: |
| 84 | + a["digest"] = "sha256:" + _sha(zip_bytes) |
| 85 | + return {"tag_name": tag, "draft": draft, "prerelease": prerelease, "assets": [a]} |
| 86 | + return get_json |
| 87 | + |
| 88 | + |
| 89 | +def run(): |
| 90 | + asset = "medsci-skills-classroom-macos.zip" |
| 91 | + with tempfile.TemporaryDirectory(prefix="medsci-upd-") as tmp: |
| 92 | + base = Path(tmp) |
| 93 | + files = build_payload(base) |
| 94 | + zbytes = make_zip(files) |
| 95 | + |
| 96 | + # --- happy path: resolve + verify + safe-extract + install (mocked) + updater home --- |
| 97 | + home = base / "home" |
| 98 | + installs = [] |
| 99 | + rc = U.do_update(home, lambda m: None, |
| 100 | + get_json=fake_api(zbytes, asset=asset), |
| 101 | + get_bytes=lambda url: zbytes, |
| 102 | + asset_name=asset, |
| 103 | + run_install=lambda inst: installs.append(inst) or 0) |
| 104 | + check("happy path returns tag v2.0.0", rc["tag"] == "v2.0.0") |
| 105 | + check("happy path called the extracted installer", len(installs) == 1 and installs[0].name == "install.py") |
| 106 | + check("updater installed to ~/.medsci-skills/updater/", (home / "updater" / "update.py").is_file()) |
| 107 | + |
| 108 | + # --- fail closed: no digest --- |
| 109 | + try: |
| 110 | + U.resolve_latest(fake_api(zbytes, asset=asset, digest=False), asset) |
| 111 | + check("no-digest fails closed", False) |
| 112 | + except U.UpdateError: |
| 113 | + check("no-digest fails closed", True) |
| 114 | + |
| 115 | + # --- draft/prerelease excluded --- |
| 116 | + for flag in ("draft", "prerelease"): |
| 117 | + try: |
| 118 | + U.resolve_latest(fake_api(zbytes, asset=asset, **{flag: True}), asset) |
| 119 | + check(f"{flag} release rejected", False) |
| 120 | + except U.UpdateError: |
| 121 | + check(f"{flag} release rejected", True) |
| 122 | + |
| 123 | + # --- digest mismatch (tampered bytes) --- |
| 124 | + try: |
| 125 | + U.do_update(home, lambda m: None, get_json=fake_api(zbytes, asset=asset), |
| 126 | + get_bytes=lambda url: zbytes + b"X", asset_name=asset, run_install=lambda i: 0) |
| 127 | + check("digest mismatch aborts", False) |
| 128 | + except U.UpdateError: |
| 129 | + check("digest mismatch aborts", True) |
| 130 | + |
| 131 | + # --- safe_extract guards (extract a verified zip's bytes directly) --- |
| 132 | + _, inv = U.read_inventory_from_zip(zbytes) |
| 133 | + |
| 134 | + def extracts_ok(zb): |
| 135 | + d = base / ("ex-%d" % len(os.listdir(base))) |
| 136 | + d.mkdir() |
| 137 | + U.safe_extract(zb, d, U.read_inventory_from_zip(zb)[1]) |
| 138 | + |
| 139 | + def rejects(label, zb): |
| 140 | + try: |
| 141 | + d = base / ("rej-%d" % len(os.listdir(base))) |
| 142 | + d.mkdir() |
| 143 | + U.safe_extract(zb, d, inv) |
| 144 | + check(label, False) |
| 145 | + except U.UpdateError: |
| 146 | + check(label, True) |
| 147 | + |
| 148 | + check("clean zip extracts", (extracts_ok(zbytes) is None)) |
| 149 | + rejects("traversal entry rejected", make_zip(files, extra={"../evil.txt": b"x"})) |
| 150 | + rejects("unexpected file (not in inventory) rejected", make_zip(files, extra={"skills/demo/EXTRA.bin": b"x"})) |
| 151 | + rejects("symlink entry rejected", make_zip(files, symlink="link")) |
| 152 | + rejects("case-insensitive duplicate rejected", make_zip(files, dup=True)) |
| 153 | + # hash/size mismatch: change a payload file's bytes but keep the old inventory |
| 154 | + tampered = dict(files) |
| 155 | + tampered["skills/demo/x.txt"] = b"TAMPERED-DIFFERENT-LENGTH" |
| 156 | + rejects("payload hash/size mismatch rejected", make_zip(tampered)) |
| 157 | + |
| 158 | + # zip-bomb caps |
| 159 | + old_entries, old_total = U.MAX_ENTRIES, U.MAX_TOTAL_UNCOMPRESSED |
| 160 | + try: |
| 161 | + U.MAX_TOTAL_UNCOMPRESSED = 10 |
| 162 | + rejects("total-size cap rejects", zbytes) |
| 163 | + finally: |
| 164 | + U.MAX_TOTAL_UNCOMPRESSED = old_total |
| 165 | + try: |
| 166 | + U.MAX_ENTRIES = 1 |
| 167 | + rejects("entry-count cap rejects", zbytes) |
| 168 | + finally: |
| 169 | + U.MAX_ENTRIES = old_entries |
| 170 | + |
| 171 | + # --- check_update semver + cache --- |
| 172 | + h2 = base / "home2" |
| 173 | + medsci_txn.atomic_write_json(h2 / "targets" / "claude" / "state.json", {"installed_version": "1.0.0"}) |
| 174 | + rc = U.check_update(h2, get_json=fake_api(zbytes, asset=asset, tag="v2.0.0"), asset_name=asset, force=True) |
| 175 | + check("check_update: newer -> UPDATE_AVAILABLE", rc == U.CHK_UPDATE_AVAILABLE) |
| 176 | + rc = U.check_update(h2, get_json=fake_api(zbytes, asset=asset, tag="v1.0.0"), asset_name=asset, force=True) |
| 177 | + check("check_update: same -> UP_TO_DATE", rc == U.CHK_UP_TO_DATE) |
| 178 | + # cache fresh -> no network call |
| 179 | + called = {"n": 0} |
| 180 | + def counting(_u): |
| 181 | + called["n"] += 1 |
| 182 | + return fake_api(zbytes, asset=asset, tag="v2.0.0")(_u) |
| 183 | + U.check_update(h2, get_json=counting, asset_name=asset, force=True) # populates cache |
| 184 | + U.check_update(h2, get_json=counting, asset_name=asset) # should use cache |
| 185 | + check("check_update: fresh cache avoids 2nd network call", called["n"] == 1) |
| 186 | + # unknown local |
| 187 | + rc = U.check_update(base / "home_empty", get_json=fake_api(zbytes, asset=asset), asset_name=asset, force=True) |
| 188 | + check("check_update: unknown install -> UNKNOWN_LOCAL", rc == U.CHK_UNKNOWN_LOCAL) |
| 189 | + # network failure |
| 190 | + def boom(_u): |
| 191 | + raise U.UpdateError("offline") |
| 192 | + rc = U.check_update(h2, get_json=boom, asset_name=asset, force=True) |
| 193 | + check("check_update: network failure -> NETWORK_FAILURE", rc == U.CHK_NETWORK_FAILURE) |
| 194 | + |
| 195 | + print("----") |
| 196 | + print(f"test_update: {PASS} passed, {FAIL} failed") |
| 197 | + return 1 if FAIL else 0 |
| 198 | + |
| 199 | + |
| 200 | +if __name__ == "__main__": |
| 201 | + sys.exit(run()) |
0 commit comments