Improve update-versions.py

update-versions.py

@@ -1,50 +1,90 @@
 import argparse
 import collections
 import functools
-import github
 import json
 import os
 import pathlib
-import semver
 import subprocess
+from dataclasses import dataclass
+from pathlib import Path
+from typing import (
+    Callable,
+    Iterable,
+    List,
+    Optional,
+    OrderedDict,
+)
 
+import github
+from github.GitRelease import GitRelease
+from semver import Version as SemVer
 
-def read_versions():
-    with open("versions.json", "r") as f:
-        return json.load(f)
 
+@dataclass
+class NixHashes:
+    hash: str
+    vendorHash: str
+
+
+Versions = OrderedDict[SemVer, NixHashes]
+
+
+def parse_semver(input: str) -> SemVer:
+    return SemVer.parse(input.removeprefix("v"))
+
+
+def read_current_versions(file: Path) -> Versions:
+    with open(file, "r") as f:
+        versions = json.load(f)
+
+    result: OrderedDict[SemVer, NixHashes] = OrderedDict()
+    for key_raw, value_raw in versions.items():
+        key = parse_semver(key_raw)
+        result[key] = NixHashes(
+            hash=value_raw["hash"], vendorHash=value_raw["vendorHash"]
+        )
+
+    return result
 
-def is_stable(release):
-    version = release.tag_name.removeprefix("v")
-    return semver.compare(version, "1.0.0") >= 0 and not (
-        release.draft or release.prerelease
-    )
 
+def get_stable_github_versions(releases: Iterable[GitRelease]) -> List[SemVer]:
+    stable_version = SemVer(1, 0, 0)
 
-def by_version(release):
-    return release.tag_name.removeprefix("v").split(".")
+    def to_semver(release: GitRelease) -> SemVer:
+        return parse_semver(release.tag_name)
 
+    def is_stable(release: GitRelease) -> bool:
+        return to_semver(release) >= stable_version and not (
+            release.draft or release.prerelease
+        )
+
+    return list(map(to_semver, filter(is_stable, releases)))
 
-def to_version(vendor_hash):
-    def add_version(versions, release):
-        version = release.tag_name.removeprefix("v")
-        calculated_hash = calculate_hash(versions, version)
-        versions[version] = {
-            "hash": calculated_hash,
-            "vendorHash": calculate_vendor_hash(
-                versions, version, calculated_hash, vendor_hash
-            ),
-        }
-        return versions
+
+def get_or_calculate_hashes(
+    vendor_hash_nix: Path,
+) -> Callable[[Versions, SemVer], Versions]:
+    def add_version(
+        current_versions: Versions,
+        new_version: SemVer,
+    ) -> Versions:
+        maybe_current_hashes = current_versions.get(new_version)
+        calculated_hash = calculate_hash(new_version, maybe_current_hashes)
+        calculated_vendor_hash = calculate_vendor_hash(
+            new_version, maybe_current_hashes, calculated_hash, vendor_hash_nix
+        )
+
+        to_upsert = NixHashes(hash=calculated_hash, vendorHash=calculated_vendor_hash)
+        current_versions[new_version] = to_upsert
+        return current_versions
 
     return add_version
 
 
-def calculate_hash(versions, version):
-    current_hash = versions.get(version, {}).get("hash")
-    if current_hash:
+def calculate_hash(version: SemVer, maybe_current_hashes: Optional[NixHashes]) -> str:
+    if maybe_current_hashes:
         print(f"Using existing hash for {version}")
-        return current_hash
+        return maybe_current_hashes.hash
     else:
         print(f"Calculating hash for {version}")
         return nix_prefetch(
@@ -60,58 +100,83 @@ def calculate_hash(versions, version):
         )
 
 
-def calculate_vendor_hash(versions, version, calculated_hash, vendor_hash):
-    current_vendor_hash = versions.get(version, {}).get("vendorHash")
-    if current_vendor_hash:
+def calculate_vendor_hash(
+    version: SemVer,
+    maybe_current_hashes: Optional[NixHashes],
+    calculated_hash: str,
+    vendor_hash_nix: Path,
+) -> str:
+    if maybe_current_hashes:
         print(f"Using existing vendorHash for {version}")
-        return current_vendor_hash
+        return maybe_current_hashes.vendorHash
     else:
         print(f"Calculating vendorHash for {version}")
         return nix_prefetch(
             [
                 "--file",
-                str(vendor_hash.resolve()),
+                str(vendor_hash_nix.resolve()),
                 "--argstr",
                 "version",
-                version,
+                str(version),
                 "--argstr",
                 "hash",
                 calculated_hash,
             ]
         )
 
 
-def nix_prefetch(args):
+def nix_prefetch(args: Iterable[str]) -> str:
     return subprocess.check_output(
         [
             "nix-prefetch",
             "--silent",
             "--option",
             "extra-experimental-features",
             "flakes",
-        ]
-        + args,
+            *args,
+        ],
         text=True,
     ).strip()
 
 
-parser = argparse.ArgumentParser(description="Update versions.json file")
-parser.add_argument("--vendor_hash", type=pathlib.Path, default="vendor-hash.nix")
-args = parser.parse_args()
-
-auth = github.Auth.Token(os.environ["GITHUB_TOKEN"])
-g = github.Github(auth=auth)
-repo = g.get_repo("hashicorp/terraform")
-# TODO: Drop "v" prefix first
-releases = list(filter(is_stable, repo.get_releases()))
-current_versions = read_versions()
-versions = collections.OrderedDict(
-    sorted(
-        functools.reduce(
-            to_version(args.vendor_hash), releases, current_versions
-        ).items(),
-        reverse=True,
+def main():
+    parser = argparse.ArgumentParser(description="Update versions.json file")
+    parser.add_argument(
+        "--vendor_hash",
+        type=pathlib.Path,
+        default="vendor-hash.nix",
+        help="Path to vendor-hash.nix file",
     )
-)
-with open("versions.json", "w") as f:
-    json.dump(versions, f, indent=2)
+    args = parser.parse_args()
+
+    gh_token = github.Auth.Token(os.environ["GITHUB_TOKEN"])
+    gh = github.Github(auth=gh_token)
+    repo = gh.get_repo("hashicorp/terraform")
+
+    versions_file = Path("versions.json")
+
+    gh_releases = repo.get_releases()
+    stable_gh_versions = get_stable_github_versions(gh_releases)
+    current_versions = read_current_versions(versions_file)
+
+    versions = collections.OrderedDict(
+        sorted(
+            functools.reduce(
+                get_or_calculate_hashes(args.vendor_hash),
+                stable_gh_versions,
+                current_versions,
+            ).items(),
+            reverse=True,
+        )
+    )
+
+    versions_jsonified = OrderedDict(
+        (str(version), hashes.__dict__) for version, hashes in versions.items()
+    )
+
+    with open(versions_file, "w") as f:
+        json.dump(versions_jsonified, f, indent=2)
+
+
+if __name__ == "__main__":
+    main()

versions.json

@@ -111,6 +111,10 @@
     "hash": "sha256-jt+axusOYbJmGJpim8i76Yfb/QgWduUmZMIiIs0CJoA=",
     "vendorHash": "sha256-M22VONnPs0vv2L3q/2RjE0+Jna/Kv95xubVNthp5bMc="
   },
+  "1.3.10": {
+    "hash": "sha256-XOuhPZEb4CkynIRYIpg4zdlngym+1urndVYkoZGbeQ8=",
+    "vendorHash": "sha256-CE6jNBvM0980+R0e5brK5lMrkad+91qTt9mp2h3NZyY="
+  },
   "1.3.9": {
     "hash": "sha256-gwuUdO9m4Q2tFRLSVTbcsclOq9jcbQU4JV9nIElTkQ4=",
     "vendorHash": "sha256-CE6jNBvM0980+R0e5brK5lMrkad+91qTt9mp2h3NZyY="
@@ -143,10 +147,6 @@
     "hash": "sha256-Xr6ZmKE7BoMh2gZcvcZgWwb8WuAb3Xb8vV9gZVjDZFE=",
     "vendorHash": "sha256-+m7e49yN7OkiQQVvqimF0Tvz5wUr2M5bxs3yBU2lt7Y="
   },
-  "1.3.10": {
-    "hash": "sha256-XOuhPZEb4CkynIRYIpg4zdlngym+1urndVYkoZGbeQ8=",
-    "vendorHash": "sha256-CE6jNBvM0980+R0e5brK5lMrkad+91qTt9mp2h3NZyY="
-  },
   "1.3.1": {
     "hash": "sha256-ugdMpp/YTCyXaUY6NTrIa9r/+C4bYLYqQEic4cvgoVo=",
     "vendorHash": "sha256-+m7e49yN7OkiQQVvqimF0Tvz5wUr2M5bxs3yBU2lt7Y="
@@ -235,6 +235,14 @@
     "hash": "sha256-nnYMoQitqFbOjI8twDh9hWDb1qxMNNVy6wldxkyDKY0=",
     "vendorHash": "sha256-Rk2hHtJfaS553MJIea6n51irMas3qcBrWAD+adzTi1Y="
   },
+  "1.0.11": {
+    "hash": "sha256-Z2qFetJZgylRbf75oKEr8blPhQcABxcE1nObUD/RBUw=",
+    "vendorHash": "sha256-4oSL7QT6KjZlt3NKkjNWcrZA8yCkx6aI2kYsdyh8L68="
+  },
+  "1.0.10": {
+    "hash": "sha256-qxqtWAAS1yh4gd7eplB5o7Wxjvo3knIKqgWdlHC6j8k=",
+    "vendorHash": "sha256-grh8DzTzEFfBbkIbr1SnBwpX7nbN8wQaTlH/GrgglAE="
+  },
   "1.0.9": {
     "hash": "sha256-A+rN9rzJFKPSkCXTWOyKTSlFMJHRxvJ/lk6x3EehJz0=",
     "vendorHash": "sha256-grh8DzTzEFfBbkIbr1SnBwpX7nbN8wQaTlH/GrgglAE="
@@ -267,14 +275,6 @@
     "hash": "sha256-KmSkHJ5RB2cP4z/IT/p+LHm658soM0IS0TPYKxU02z4=",
     "vendorHash": "sha256-s5HFBPWv7OEvgMBkAVZNivk6tD1T3QjUDqsIU9TPLmA="
   },
-  "1.0.11": {
-    "hash": "sha256-Z2qFetJZgylRbf75oKEr8blPhQcABxcE1nObUD/RBUw=",
-    "vendorHash": "sha256-4oSL7QT6KjZlt3NKkjNWcrZA8yCkx6aI2kYsdyh8L68="
-  },
-  "1.0.10": {
-    "hash": "sha256-qxqtWAAS1yh4gd7eplB5o7Wxjvo3knIKqgWdlHC6j8k=",
-    "vendorHash": "sha256-grh8DzTzEFfBbkIbr1SnBwpX7nbN8wQaTlH/GrgglAE="
-  },
   "1.0.1": {
     "hash": "sha256-QPrUWojUHwTP3mNnC2aOiAcT2VHU16pLXh5KLhwfw2s=",
     "vendorHash": "sha256-vUIaNTBs/wmpVfJuSP3CXipealqQUALwgbR14AqCJyo="