|
| 1 | +# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +"""Check protobuf compatibility under the current, tag-defined release train.""" |
| 5 | + |
| 6 | +import argparse |
| 7 | +import io |
| 8 | +import os |
| 9 | +import subprocess |
| 10 | +import sys |
| 11 | +import tarfile |
| 12 | +import tempfile |
| 13 | +from pathlib import Path |
| 14 | + |
| 15 | +from release import _parse_prerelease_tag, _parse_semver_tag |
| 16 | + |
| 17 | + |
| 18 | +def git(*args: str) -> str: |
| 19 | + return subprocess.run( |
| 20 | + ["git", *args], check=True, capture_output=True, text=True |
| 21 | + ).stdout.strip() |
| 22 | + |
| 23 | + |
| 24 | +def train_policy(ref: str, release: str | None) -> tuple[str, str, bool]: |
| 25 | + tags = git("tag", "--merged", ref, "--list", "v*").splitlines() |
| 26 | + stable = sorted( |
| 27 | + (version, tag) |
| 28 | + for tag in tags |
| 29 | + if tag != release and (version := _parse_semver_tag(tag)) |
| 30 | + ) |
| 31 | + if release is None: |
| 32 | + prereleases = sorted( |
| 33 | + (version, tag) for tag in tags if (version := _parse_prerelease_tag(tag)) |
| 34 | + ) |
| 35 | + if not prereleases or (stable and prereleases[-1][0][:3] <= stable[-1][0]): |
| 36 | + return "", "none", False |
| 37 | + release = prereleases[-1][1] |
| 38 | + |
| 39 | + if not stable: |
| 40 | + raise ValueError("No previous stable release baseline is available.") |
| 41 | + previous, baseline = stable[-1] |
| 42 | + prerelease = _parse_prerelease_tag(release) |
| 43 | + version = prerelease[:3] if prerelease else _parse_semver_tag(release) |
| 44 | + if version is None or not release.startswith("v"): |
| 45 | + raise ValueError(f"Invalid release tag: {release}") |
| 46 | + if version <= previous: |
| 47 | + raise ValueError(f"Release {release} must be newer than stable {baseline}.") |
| 48 | + train = "v" + ".".join(map(str, version)) |
| 49 | + allows_breaks = version[:2] > previous[:2] |
| 50 | + return baseline, f"{train} (latest stable: {baseline})", allows_breaks |
| 51 | + |
| 52 | + |
| 53 | +def export_proto(ref: str, destination: Path) -> None: |
| 54 | + archive = subprocess.check_output( |
| 55 | + ["git", "archive", ref, "--", "buf.yaml", "proto"] |
| 56 | + ) |
| 57 | + with tarfile.open(fileobj=io.BytesIO(archive)) as snapshot: |
| 58 | + snapshot.extractall(destination, filter="data") |
| 59 | + |
| 60 | + |
| 61 | +def compare(candidate: str, baseline: str, allows_breaks: bool) -> int: |
| 62 | + with tempfile.TemporaryDirectory(prefix="openshell-proto-") as directory: |
| 63 | + root = Path(directory) |
| 64 | + export_proto(baseline, root / "before") |
| 65 | + export_proto(candidate, root / "after") |
| 66 | + error_format = ( |
| 67 | + "github-actions" if os.environ.get("GITHUB_ACTIONS") == "true" else "text" |
| 68 | + ) |
| 69 | + # Buf also returns 100 for compiler diagnostics. Validate both snapshots |
| 70 | + # before treating that status from `breaking` as an allowed API change. |
| 71 | + for snapshot in ("before", "after"): |
| 72 | + subprocess.run( |
| 73 | + [ |
| 74 | + "buf", |
| 75 | + "build", |
| 76 | + "proto", |
| 77 | + "--error-format", |
| 78 | + error_format, |
| 79 | + "-o", |
| 80 | + os.devnull, |
| 81 | + ], |
| 82 | + cwd=root / snapshot, |
| 83 | + check=True, |
| 84 | + ) |
| 85 | + result = subprocess.run( |
| 86 | + [ |
| 87 | + "buf", |
| 88 | + "breaking", |
| 89 | + "proto", |
| 90 | + "--against", |
| 91 | + str(root / "before" / "proto"), |
| 92 | + "--config", |
| 93 | + "buf.yaml", |
| 94 | + "--error-format", |
| 95 | + error_format, |
| 96 | + ], |
| 97 | + cwd=root / "after", |
| 98 | + capture_output=True, |
| 99 | + text=True, |
| 100 | + check=False, |
| 101 | + ) |
| 102 | + diagnostics = result.stdout + result.stderr |
| 103 | + if result.returncode == 100 and allows_breaks: |
| 104 | + print(diagnostics.replace("::error ", "::warning "), end="") |
| 105 | + print( |
| 106 | + "Breaking changes allowed by the version increment; review migration guidance." |
| 107 | + ) |
| 108 | + return 0 |
| 109 | + print(diagnostics, end="") |
| 110 | + return result.returncode |
| 111 | + |
| 112 | + |
| 113 | +def main() -> int: |
| 114 | + parser = argparse.ArgumentParser(description=__doc__) |
| 115 | + parser.add_argument("ref", help="Target branch/commit, or release tag to qualify") |
| 116 | + args = parser.parse_args() |
| 117 | + ref = git( |
| 118 | + "rev-parse", "--symbolic-full-name", "--verify", "--end-of-options", args.ref |
| 119 | + ) |
| 120 | + candidate = git( |
| 121 | + "rev-parse", "--verify", "--end-of-options", f"{args.ref}^{{commit}}" |
| 122 | + ) |
| 123 | + release = ref.removeprefix("refs/tags/") if ref.startswith("refs/tags/") else None |
| 124 | + stable, train, allows_breaks = train_policy(candidate, release) |
| 125 | + baseline = f"refs/tags/{stable}" if release else candidate |
| 126 | + if not release: |
| 127 | + # merge-tree writes only Git objects, leaving HEAD and the worktree |
| 128 | + # intact. Target-only additions are therefore not mistaken for deletions. |
| 129 | + candidate = git("merge-tree", "--write-tree", baseline, "HEAD").splitlines()[0] |
| 130 | + print( |
| 131 | + f"Train: {train}; breaking changes {'allowed' if allows_breaks else 'forbidden'}" |
| 132 | + ) |
| 133 | + print(f"Comparing {candidate} against {baseline}", flush=True) |
| 134 | + return compare(candidate, baseline, allows_breaks) |
| 135 | + |
| 136 | + |
| 137 | +if __name__ == "__main__": |
| 138 | + try: |
| 139 | + sys.exit(main()) |
| 140 | + except subprocess.CalledProcessError as error: |
| 141 | + print(error.stderr or error.stdout or str(error), file=sys.stderr) |
| 142 | + sys.exit(1) |
| 143 | + except (OSError, ValueError, tarfile.TarError) as error: |
| 144 | + print(error, file=sys.stderr) |
| 145 | + sys.exit(1) |
0 commit comments