Update PolicyEngine bundle to 4.18.5

Author: anth-volk

.github/check-policyengine-bundle-supported.sh

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+CHECK_ONLY_IF_CHANGED=0
+BASE_REF=""
+VERSION_GUARD_SCRIPT="${SIMULATION_VERSION_GUARD_SCRIPT:-.github/request-simulation-model-versions.sh}"
+
+usage() {
+    echo "Usage: $0 [--if-changed-from-base <base_ref>]"
+    exit 1
+}
+
+while [ $# -gt 0 ]; do
+    case "$1" in
+        --if-changed-from-base)
+            CHECK_ONLY_IF_CHANGED=1
+            BASE_REF="$2"
+            shift 2
+            ;;
+        -h|--help)
+            usage
+            ;;
+        *)
+            echo "Error: Unknown option $1"
+            usage
+            ;;
+    esac
+done
+
+extract_policyengine_version() {
+    sed -n 's/.*policyengine\[models\]==\([0-9.][0-9.]*\).*/\1/p' | head -n 1
+}
+
+current_version="$(extract_policyengine_version < pyproject.toml)"
+if [ -z "$current_version" ]; then
+    echo "ERROR: policyengine[models] pin not found in pyproject.toml"
+    exit 1
+fi
+
+if [ "$CHECK_ONLY_IF_CHANGED" = "1" ]; then
+    if [ -z "$BASE_REF" ]; then
+        echo "ERROR: --if-changed-from-base requires a base ref"
+        exit 1
+    fi
+
+    git fetch --no-tags --depth=1 origin "$BASE_REF"
+    base_version="$(
+        git show "origin/${BASE_REF}:pyproject.toml" \
+            | extract_policyengine_version \
+            || true
+    )"
+
+    if [ "$current_version" = "$base_version" ]; then
+        echo "PolicyEngine .py bundle pin is unchanged; skipping simulation API support check."
+        exit 0
+    fi
+fi
+
+bash "$VERSION_GUARD_SCRIPT" -py "$current_version"

.github/workflows/pr.yml

@@ -6,9 +6,27 @@ env:
   ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
 
 jobs:
+  ensure-policyengine-bundle-supported-by-simulation-api:
+    name: Ensure PolicyEngine bundle is supported by simulation API
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install jq
+        run: sudo apt-get install -y jq
+      - name: Check simulation API supports updated PolicyEngine bundle
+        env:
+          SIMULATION_API_URL: ${{ secrets.SIMULATION_API_URL }}
+        run: bash .github/check-policyengine-bundle-supported.sh --if-changed-from-base "${{ github.base_ref }}"
+
   lint:
     name: Lint
     runs-on: ubuntu-latest
+    needs: ensure-policyengine-bundle-supported-by-simulation-api
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
@@ -21,6 +39,7 @@ jobs:
   quality-guards:
     name: Quality guards
     runs-on: ubuntu-latest
+    needs: ensure-policyengine-bundle-supported-by-simulation-api
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
@@ -33,13 +52,15 @@ jobs:
   check-changelog:
     name: Check changelog fragment
     runs-on: ubuntu-latest
+    needs: ensure-policyengine-bundle-supported-by-simulation-api
     steps:
       - uses: actions/checkout@v4
       - name: Check for changelog fragment
         run: bash .github/scripts/check_changelog_fragment.sh
   test_container_builds:
     name: Docker
     runs-on: ubuntu-latest
+    needs: ensure-policyengine-bundle-supported-by-simulation-api
     permissions:
       contents: read
       packages: write
@@ -57,6 +78,7 @@ jobs:
   test_cloud_run_container_builds:
     name: Cloud Run container
     runs-on: ubuntu-latest
+    needs: ensure-policyengine-bundle-supported-by-simulation-api
     permissions:
       contents: read
     steps:
@@ -67,6 +89,7 @@ jobs:
   test_env_vars:
     name: Test environment variables
     runs-on: ubuntu-latest
+    needs: ensure-policyengine-bundle-supported-by-simulation-api
     permissions:
       contents: read
       id-token: write
@@ -95,7 +118,9 @@ jobs:
   test:
     name: Test
     runs-on: ubuntu-latest
-    needs: test_env_vars
+    needs:
+      - ensure-policyengine-bundle-supported-by-simulation-api
+      - test_env_vars
     permissions:
       contents: read
       id-token: write

.github/workflows/push.yml

@@ -37,20 +37,12 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-      - name: Install dependencies (required for finding API model versions)
-        run: make install
-      - name: Install jq (required only for GitHub Actions)
+      - name: Install jq
         run: sudo apt-get install -y jq
-      - name: Find API model versions and write to environment variable
-        run: python3 .github/find-api-model-versions.py
-      - name: Ensure full API and simulation API model versions are in sync
-        run: ".github/request-simulation-model-versions.sh -py ${{ env.POLICYENGINE_VERSION }} -us ${{ env.US_VERSION }} -uk ${{ env.UK_VERSION }}"
+      - name: Check simulation API supports PolicyEngine bundle
         env:
           SIMULATION_API_URL: ${{ secrets.SIMULATION_API_URL }}
+        run: bash .github/check-policyengine-bundle-supported.sh
 
   versioning:
     name: Update versioning
@@ -365,20 +357,12 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-      - name: Install dependencies (required for finding API model versions)
-        run: make install
-      - name: Install jq (required only for GitHub Actions)
+      - name: Install jq
         run: sudo apt-get install -y jq
-      - name: Find API model versions and write to environment variable
-        run: python3 .github/find-api-model-versions.py
-      - name: Ensure full API and simulation API model versions are in sync
-        run: ".github/request-simulation-model-versions.sh -py ${{ env.POLICYENGINE_VERSION }} -us ${{ env.US_VERSION }} -uk ${{ env.UK_VERSION }}"
+      - name: Check simulation API supports PolicyEngine bundle
         env:
           SIMULATION_API_URL: ${{ secrets.SIMULATION_API_URL }}
+        run: bash .github/check-policyengine-bundle-supported.sh
 
   deploy-production-candidate:
     name: Deploy production App Engine candidate

changelog.d/update-policyengine-bundle-4.18.5.changed.md

@@ -0,0 +1 @@
+Update the PolicyEngine bundle to 4.18.5.

pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "policyengine_canada==0.96.3",
     "policyengine-ng==0.5.1",
     "policyengine-il==0.1.0",
-    "policyengine[models]==4.18.3",
+    "policyengine[models]==4.18.5",
     "pydantic",
     "pymysql",
     "python-dotenv",

tests/unit/test_cloud_run_deploy_scripts.py

@@ -7,7 +7,6 @@
 import subprocess
 from pathlib import Path
 
-
 REPO = Path(__file__).resolve().parents[2]
 PRODUCTION_CLOUD_SQL_INSTANCE = "policyengine-api:us-central1:policyengine-api-data"
 DEDICATED_CLOUD_RUN_RUNTIME_SERVICE_ACCOUNT = (
@@ -182,6 +181,57 @@ def test_simulation_version_guard_accepts_bundle_and_compatible_country_routes()
     assert "SUCCESS: PolicyEngine bundle route is deployed and ready" in result.stdout
 
 
+def test_simulation_version_guard_accepts_policyengine_bundle_route_only():
+    result = _run_simulation_version_guard(
+        {
+            "policyengine": {
+                "latest": "4.18.5",
+                "4.18.5": "policyengine-simulation-py4-18-5",
+            },
+            "us": {},
+            "uk": {},
+        },
+        "-py",
+        "4.18.5",
+    )
+
+    assert result.returncode == 0, result.stderr
+    assert "PolicyEngine .py bundle 4.18.5 is deployed" in result.stdout
+    assert "SUCCESS: PolicyEngine bundle route is deployed and ready" in result.stdout
+
+
+def test_policyengine_bundle_support_check_passes_pyproject_pin_to_guard(tmp_path):
+    capture_path = tmp_path / "guard-args.txt"
+    guard_script = tmp_path / "request-simulation-model-versions.sh"
+    guard_script.write_text(
+        'printf "%s\\n" "$@" > "$CAPTURE_PATH"\n',
+        encoding="utf-8",
+    )
+
+    result = subprocess.run(
+        ["bash", ".github/check-policyengine-bundle-supported.sh"],
+        cwd=REPO,
+        env=_script_env(
+            SIMULATION_VERSION_GUARD_SCRIPT=str(guard_script),
+            CAPTURE_PATH=str(capture_path),
+        ),
+        text=True,
+        capture_output=True,
+        check=False,
+    )
+
+    pyproject = (REPO / "pyproject.toml").read_text(encoding="utf-8")
+    current_version = re.search(r"policyengine\[models\]==([0-9.]+)", pyproject).group(
+        1
+    )
+
+    assert result.returncode == 0, result.stderr
+    assert capture_path.read_text(encoding="utf-8").splitlines() == [
+        "-py",
+        current_version,
+    ]
+
+
 def test_simulation_version_guard_rejects_country_route_to_different_app():
     result = _run_simulation_version_guard(
         {

tests/unit/test_constants.py

@@ -3,18 +3,17 @@
 import sys
 
 import pytest
-
 from policyengine_api.constants import (
     COUNTRY_PACKAGE_VERSIONS,
     POLICYENGINE_CORE_VERSION,
     POLICYENGINE_VERSION,
     REGION_PREFIXES,
     UK_REGION_TYPES,
     US_REGION_TYPES,
-    get_py_manifest,
     _load_policyengine_bundle,
     _normalize_distribution_name,
     _resolve_distribution_version,
+    get_py_manifest,
 )
 
 
@@ -126,6 +125,23 @@ def test__resolve_distribution_version_falls_back_to_default(self):
 
 
 class TestPolicyEngineBundleVersions:
+    @staticmethod
+    def _expected_bundle_versions() -> dict[str, str]:
+        manifest = json.loads(get_py_manifest().read_text(encoding="utf-8"))
+        packages = manifest["packages"]
+        normalized_packages = {
+            _normalize_distribution_name(package.get("name") or package_key): package
+            for package_key, package in packages.items()
+        }
+        return {
+            "policyengine": str(
+                manifest.get("policyengine_version") or manifest.get("bundle_version")
+            ),
+            "core": str(normalized_packages["policyengine-core"]["version"]),
+            "us": str(normalized_packages["policyengine-us"]["version"]),
+            "uk": str(normalized_packages["policyengine-uk"]["version"]),
+        }
+
     def test__get_py_manifest_returns_packaged_manifest_path(self):
         manifest_path = get_py_manifest()
 
@@ -173,12 +189,7 @@ def find_spec(self, fullname, path=None, target=None):
         )
 
         assert result.returncode == 0, result.stderr
-        assert json.loads(result.stdout) == {
-            "policyengine": "4.18.3",
-            "core": "3.27.1",
-            "us": "1.729.0",
-            "uk": "2.89.2",
-        }
+        assert json.loads(result.stdout) == self._expected_bundle_versions()
 
     def test__load_policyengine_bundle_rejects_missing_manifest(
         self, monkeypatch, tmp_path
@@ -205,7 +216,8 @@ def test__load_policyengine_bundle_rejects_non_object_manifest(
             _load_policyengine_bundle()
 
     def test__uses_policyengine_bundle_versions_for_us_uk_and_core(self):
-        assert POLICYENGINE_VERSION == "4.18.3"
-        assert POLICYENGINE_CORE_VERSION == "3.27.1"
-        assert COUNTRY_PACKAGE_VERSIONS["us"] == "1.729.0"
-        assert COUNTRY_PACKAGE_VERSIONS["uk"] == "2.89.2"
+        expected_versions = self._expected_bundle_versions()
+        assert POLICYENGINE_VERSION == expected_versions["policyengine"]
+        assert POLICYENGINE_CORE_VERSION == expected_versions["core"]
+        assert COUNTRY_PACKAGE_VERSIONS["us"] == expected_versions["us"]
+        assert COUNTRY_PACKAGE_VERSIONS["uk"] == expected_versions["uk"]