Check in CI that HyperQueue and its Python binding have the same version

Kobzol · Kobzol · commit dd7dc4f57bbe · 2022-01-13T11:26:30.000+01:00
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -110,12 +110,12 @@ jobs:
           maturin-version: latest
           manylinux: 2014
           command: build
-          args: --manifest-path crates/pyhq/Cargo.toml --release
+          args: --manifest-path crates/pyhq/Cargo.toml --release --out wheels
       - name: Upload test artifacts
         uses: actions/upload-artifact@v2
         with:
           name: archive-pyhq
-          path: target/wheels/hyperqueue-*.whl
+          path: wheels/hyperqueue-*.whl
   create-tag:
     runs-on: ubuntu-latest
     needs: [ set-env, build-binaries-x64, build-binaries-powerpc, build-python-binding ]
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -13,7 +13,13 @@ on:
     tags:
       - 'v*'
 jobs:
+  version-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check package versions
+        run: python scripts/check_package_versions.py
   set-env:
+    needs: [version-check]
     runs-on: ubuntu-latest
     outputs:
       sha: ${{ env.SHA }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -49,8 +49,8 @@ jobs:
 
       - name: Build Python binding
         run: |
-          maturin build --manifest-path crates/pyhq/Cargo.toml
-          python -m pip install target/wheels/hyperqueue-*.whl
+          maturin build --manifest-path crates/pyhq/Cargo.toml --out wheels
+          python -m pip install wheels/hyperqueue-*.whl
 
       - name: Test Python
         id: python_test
@@ -88,3 +88,6 @@ jobs:
         run: |
           python -m pip install -r docs/requirements.txt
           mkdocs build --strict
+
+      - name: Check package versions
+        run: python scripts/check_package_versions.py
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/pyhq/Cargo.toml b/crates/pyhq/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "pyhq"
-version = "0.1.0"
+version = "0.7.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
diff --git a/scripts/check.sh b/scripts/check.sh
@@ -8,11 +8,11 @@ cd `dirname $0`/..
 cargo fmt --all
 
 # Format Python code
-isort --profile black tests benchmarks crates/pyhq/python
-black tests benchmarks crates/pyhq/python
+isort --profile black scripts tests benchmarks crates/pyhq/python
+black scripts tests benchmarks crates/pyhq/python
 
 # Lint Python code
-flake8 tests benchmarks crates/pyhq/python
+flake8 scripts tests benchmarks crates/pyhq/python
 
 # Test Rust code
 cargo test
diff --git a/scripts/check_package_versions.py b/scripts/check_package_versions.py
@@ -0,0 +1,22 @@
+import json
+import subprocess
+
+if __name__ == "__main__":
+    """
+    Checks that HyperQueue and its binding have the same version.
+    """
+    output = (
+        subprocess.check_output(["cargo", "metadata", "--no-deps", "-q"])
+        .decode()
+        .strip()
+    )
+    metadata = json.loads(output)
+    packages = metadata["packages"]
+    hq_version = [p["version"] for p in packages if p["name"] == "hyperqueue"][0]
+    pyhq_version = [p["version"] for p in packages if p["name"] == "pyhq"][0]
+
+    if hq_version != pyhq_version:
+        raise Exception(
+            f"Hyperqueue has a different version ({hq_version}) "
+            f"than its Python binding ({pyhq_version})"
+        )
diff --git a/scripts/extract_changelog.py b/scripts/extract_changelog.py
@@ -1,6 +1,5 @@
 import sys
-from os.path import dirname, abspath, join
-
+from os.path import abspath, dirname, join
 
 CURRENT_DIR = dirname(abspath(__file__))
 CHANGELOG_PATH = join(dirname(CURRENT_DIR), "CHANGELOG.md")
@@ -16,7 +15,7 @@ def get_matching_lines(text: str, tag: str):
         if line.startswith("# "):
             version = normalize(line.lstrip("# "))
             if version == tag:
-                for matching_line in lines[index + 1:]:
+                for matching_line in lines[index + 1 :]:
                     if matching_line.startswith("# "):
                         return
                     yield matching_line
diff --git a/scripts/get_docs_version.py b/scripts/get_docs_version.py
@@ -3,28 +3,28 @@
 
 
 def latest_version():
-    return {
-        "type": "latest"
-    }
+    return {"type": "latest"}
 
 
 def get_version(output: str):
     if not output:
         return latest_version()
     else:
-        tags = [t.strip() for t in output.splitlines(keepends=False) if t.startswith("v")]
+        tags = [
+            t.strip() for t in output.splitlines(keepends=False) if t.startswith("v")
+        ]
         if not tags:
             return latest_version()
-        return {
-            "type": "stable",
-            "version": sorted(tags, reverse=True)[0]
-        }
+        return {"type": "stable", "version": sorted(tags, reverse=True)[0]}
 
 
 if __name__ == "__main__":
     """
-    Calculates whether the current commit is a stable version (=there is some tag pointing to it) or an unstable one.
+    Calculates whether the current commit is a stable version (=there is some tag pointing to it) or
+    an unstable one.
     """
-    output = subprocess.check_output(["git", "tag", "--points-at", "HEAD"]).decode().strip()
+    output = (
+        subprocess.check_output(["git", "tag", "--points-at", "HEAD"]).decode().strip()
+    )
     version = get_version(output)
     print(json.dumps(version))
