|
| 1 | +#!/usr/bin/env python3 |
| 2 | +"""Fail a PR that changes bundled extension content without a version bump. |
| 3 | +
|
| 4 | +Update offers from `specify extension update` are version-driven: an |
| 5 | +extension is offered (and installed) only when the semver in |
| 6 | +`extensions/catalog.json` exceeds the installed copy's registered |
| 7 | +version. A content change shipped without a version bump is therefore |
| 8 | +never delivered automatically (#4345) — a bump is what makes a change |
| 9 | +actually reach existing installs, and this guard is what makes the bump |
| 10 | +non-optional. |
| 11 | +
|
| 12 | +This check enforces two invariants on the extensions listed in |
| 13 | +`extensions/catalog.json`: |
| 14 | +
|
| 15 | +1. Any change to a file under `extensions/<id>/` must increase the |
| 16 | + `version:` in that extension's `extension.yml` (PEP 440 comparison, |
| 17 | + the same semantics `extension update` uses), and the resulting |
| 18 | + version must itself parse as PEP 440 — including for a brand-new |
| 19 | + extension, since the CLI rejects a manifest whose version it cannot |
| 20 | + parse. |
| 21 | +2. Every `version` in `extensions/catalog.json` must parse as PEP 440 |
| 22 | + (`extension update` skips entries it cannot parse), and for entries |
| 23 | + with an in-repo directory it must equal a likewise-valid |
| 24 | + `extension.version` in the manifest (the catalog is what update |
| 25 | + checks compare against, and the update preflight rejects a manifest |
| 26 | + whose version differs from the catalog's). This runs over every |
| 27 | + catalog entry, so catalog-only (hosted) entries and catalog-only |
| 28 | + promotions of existing directories are covered too. |
| 29 | +
|
| 30 | +Usage: |
| 31 | + check_extension_version_bump.py BASE_REF [HEAD_REF] |
| 32 | +
|
| 33 | +BASE_REF is a git ref/SHA for the PR base (must be fetchable with |
| 34 | +`git show`). HEAD_REF defaults to the working tree's HEAD. Exits 0 when |
| 35 | +all invariants hold, 1 otherwise, printing one line per violation. |
| 36 | +
|
| 37 | +Extensions under `extensions/` that are not in the catalog (the |
| 38 | +`selftest` fixture and the `template` scaffold) are exempt: no update |
| 39 | +flow is driven by their versions. |
| 40 | +""" |
| 41 | + |
| 42 | +from __future__ import annotations |
| 43 | + |
| 44 | +import json |
| 45 | +import subprocess |
| 46 | +import sys |
| 47 | +from pathlib import PurePosixPath |
| 48 | + |
| 49 | +import yaml |
| 50 | +from packaging.version import InvalidVersion, Version |
| 51 | + |
| 52 | +EXTENSIONS_ROOT = "extensions" |
| 53 | +CATALOG_PATH = f"{EXTENSIONS_ROOT}/catalog.json" |
| 54 | + |
| 55 | + |
| 56 | +def _changed_paths(base_ref: str, head_ref: str) -> list[str]: |
| 57 | + """Paths under extensions/ that differ between *base_ref* and *head_ref*. |
| 58 | +
|
| 59 | + Uses NUL-delimited output (``-z``): without it git C-quotes any path |
| 60 | + containing non-ASCII or control characters (``"extensions/x/caf\\303\\251"``, |
| 61 | + quotes included), so the leading component would no longer equal |
| 62 | + ``extensions`` and that change would silently escape the guard. Paths |
| 63 | + are decoded with surrogateescape so an undecodable byte can never crash |
| 64 | + the check; only the ASCII ``extensions/<id>/`` prefix is interpreted. |
| 65 | + """ |
| 66 | + raw = subprocess.run( |
| 67 | + [ |
| 68 | + "git", "diff", "--name-only", "-z", "--no-renames", |
| 69 | + base_ref, head_ref, "--", EXTENSIONS_ROOT, |
| 70 | + ], |
| 71 | + check=True, |
| 72 | + capture_output=True, |
| 73 | + ).stdout |
| 74 | + return [ |
| 75 | + chunk.decode("utf-8", errors="surrogateescape") |
| 76 | + for chunk in raw.split(b"\0") |
| 77 | + if chunk |
| 78 | + ] |
| 79 | + |
| 80 | + |
| 81 | +def _show(ref: str, path: str) -> str | None: |
| 82 | + """Return the file's content at *ref*, or None when absent there.""" |
| 83 | + result = subprocess.run( |
| 84 | + ["git", "show", f"{ref}:{path}"], capture_output=True, text=True |
| 85 | + ) |
| 86 | + return result.stdout if result.returncode == 0 else None |
| 87 | + |
| 88 | + |
| 89 | +def _manifest_version(manifest_text: str, origin: str) -> str: |
| 90 | + data = yaml.safe_load(manifest_text) |
| 91 | + if not isinstance(data, dict) or not isinstance(data.get("extension"), dict): |
| 92 | + raise ValueError(f"{origin}: manifest is not a mapping with an 'extension' block") |
| 93 | + version = data["extension"].get("version") |
| 94 | + if not isinstance(version, str) or not version.strip(): |
| 95 | + raise ValueError(f"{origin}: extension.version is missing or not a string") |
| 96 | + return version.strip() |
| 97 | + |
| 98 | + |
| 99 | +def main(argv: list[str]) -> int: |
| 100 | + if len(argv) < 2 or len(argv) > 3: |
| 101 | + print(__doc__, file=sys.stderr) |
| 102 | + return 2 |
| 103 | + base_ref = argv[1] |
| 104 | + head_ref = argv[2] if len(argv) == 3 else "HEAD" |
| 105 | + |
| 106 | + catalog_text = _show(head_ref, CATALOG_PATH) |
| 107 | + if catalog_text is None: |
| 108 | + print(f"::error::{CATALOG_PATH} is missing at {head_ref}") |
| 109 | + return 1 |
| 110 | + catalog = json.loads(catalog_text) |
| 111 | + catalog_entries = catalog.get("extensions", {}) |
| 112 | + |
| 113 | + errors: list[str] = [] |
| 114 | + |
| 115 | + # -- Invariant 1: content change requires a version bump --------------- |
| 116 | + changed_ids = { |
| 117 | + parts[1] |
| 118 | + for path in _changed_paths(base_ref, head_ref) |
| 119 | + if len(parts := PurePosixPath(path).parts) >= 3 and parts[0] == EXTENSIONS_ROOT |
| 120 | + } |
| 121 | + |
| 122 | + for ext_id in sorted(changed_ids): |
| 123 | + if ext_id not in catalog_entries: |
| 124 | + continue # not driven by `extension update` (selftest, template) |
| 125 | + manifest_path = f"{EXTENSIONS_ROOT}/{ext_id}/extension.yml" |
| 126 | + head_manifest = _show(head_ref, manifest_path) |
| 127 | + if head_manifest is None: |
| 128 | + continue # extension removed in this PR |
| 129 | + try: |
| 130 | + head_version = _manifest_version(head_manifest, f"{head_ref}:{manifest_path}") |
| 131 | + except ValueError as exc: |
| 132 | + errors.append(str(exc)) |
| 133 | + continue |
| 134 | + |
| 135 | + # Parse the head version before the new-extension early return: the |
| 136 | + # CLI's ExtensionManifest rejects a version packaging cannot parse and |
| 137 | + # `extension update` skips catalog entries whose version is invalid, |
| 138 | + # so a new extension shipped with e.g. "not-a-version" in both places |
| 139 | + # would be uninstallable even though the catalog check below (plain |
| 140 | + # string equality) passes. Same PEP 440 semantics as the CLI, so |
| 141 | + # prereleases and other accepted forms are handled identically. |
| 142 | + try: |
| 143 | + head_parsed = Version(head_version) |
| 144 | + except InvalidVersion as exc: |
| 145 | + errors.append( |
| 146 | + f"{manifest_path}: extension.version {head_version!r} is not a valid " |
| 147 | + f"PEP 440 version ({exc}); the CLI rejects this manifest." |
| 148 | + ) |
| 149 | + continue |
| 150 | + |
| 151 | + base_manifest = _show(base_ref, manifest_path) |
| 152 | + if base_manifest is None: |
| 153 | + continue # new extension; any valid initial version is fine |
| 154 | + try: |
| 155 | + base_version = _manifest_version(base_manifest, f"{base_ref}:{manifest_path}") |
| 156 | + except ValueError as exc: |
| 157 | + errors.append(str(exc)) |
| 158 | + continue |
| 159 | + |
| 160 | + # Compare with the same PEP 440 semantics the extension update and |
| 161 | + # install code use, so prereleases and other accepted forms cannot |
| 162 | + # bypass the guard (e.g. 2.0.0 -> 1.0.0rc1 is a downgrade). An |
| 163 | + # unparseable base version fails closed. |
| 164 | + try: |
| 165 | + base_parsed = Version(base_version) |
| 166 | + except InvalidVersion as exc: |
| 167 | + errors.append( |
| 168 | + f"{manifest_path}: could not compare versions " |
| 169 | + f"{base_version!r} -> {head_version!r}: {exc}" |
| 170 | + ) |
| 171 | + continue |
| 172 | + if head_parsed <= base_parsed: |
| 173 | + errors.append( |
| 174 | + f"{manifest_path}: files under {EXTENSIONS_ROOT}/{ext_id}/ changed but " |
| 175 | + f"extension.version did not increase ({base_version} -> {head_version}). " |
| 176 | + f"Installed copies only receive changes when the version is bumped." |
| 177 | + ) |
| 178 | + |
| 179 | + # -- Invariant 2: catalog versions are valid and match the manifests ---- |
| 180 | + # Runs over every catalog entry, changed or not: a catalog-only entry |
| 181 | + # (hosted elsewhere) never has files under extensions/<id>/, and a |
| 182 | + # catalog-only promotion of an existing uncataloged directory never |
| 183 | + # enters Invariant 1, so neither would otherwise have its version parsed. |
| 184 | + for ext_id, entry in sorted(catalog_entries.items()): |
| 185 | + catalog_version = entry.get("version") if isinstance(entry, dict) else None |
| 186 | + if not isinstance(catalog_version, str) or not catalog_version.strip(): |
| 187 | + errors.append(f"{CATALOG_PATH}: entry '{ext_id}' has no string 'version'") |
| 188 | + continue |
| 189 | + # `extension update` skips a catalog entry whose version packaging |
| 190 | + # cannot parse, so an invalid catalog version is never offered. |
| 191 | + try: |
| 192 | + Version(catalog_version) |
| 193 | + except InvalidVersion as exc: |
| 194 | + errors.append( |
| 195 | + f"{CATALOG_PATH}: entry '{ext_id}' version {catalog_version!r} is not a " |
| 196 | + f"valid PEP 440 version ({exc}); `extension update` skips such entries." |
| 197 | + ) |
| 198 | + continue |
| 199 | + |
| 200 | + manifest_path = f"{EXTENSIONS_ROOT}/{ext_id}/extension.yml" |
| 201 | + head_manifest = _show(head_ref, manifest_path) |
| 202 | + if head_manifest is None: |
| 203 | + continue # catalog-only entry (e.g. hosted elsewhere); version checked above |
| 204 | + try: |
| 205 | + manifest_version = _manifest_version(head_manifest, f"{head_ref}:{manifest_path}") |
| 206 | + except ValueError as exc: |
| 207 | + errors.append(str(exc)) |
| 208 | + continue |
| 209 | + try: |
| 210 | + Version(manifest_version) |
| 211 | + except InvalidVersion as exc: |
| 212 | + errors.append( |
| 213 | + f"{manifest_path}: extension.version {manifest_version!r} is not a valid " |
| 214 | + f"PEP 440 version ({exc}); the CLI rejects this manifest." |
| 215 | + ) |
| 216 | + continue |
| 217 | + if catalog_version != manifest_version: |
| 218 | + errors.append( |
| 219 | + f"{CATALOG_PATH}: entry '{ext_id}' has version {catalog_version!r} but " |
| 220 | + f"{manifest_path} declares {manifest_version!r}. `extension update` " |
| 221 | + f"compares against the catalog, so the two must move together." |
| 222 | + ) |
| 223 | + |
| 224 | + for error in errors: |
| 225 | + print(f"::error::{error}") |
| 226 | + if not errors: |
| 227 | + print("Extension version guard: all invariants hold.") |
| 228 | + return 1 if errors else 0 |
| 229 | + |
| 230 | + |
| 231 | +if __name__ == "__main__": |
| 232 | + sys.exit(main(sys.argv)) |
0 commit comments