Update testing (#686)

* Update to UV for a bit faster setup
  * TODO: Tox or something for env management
* Drop 3.8 from testing

Signed-off-by: Aidan Jensen <aidan.jensen@robust.ai>
Co-authored-by: Aidan Jensen <aidan.jensen@robust.ai>

Author: aidandj

.github/package.json

@@ -2,6 +2,6 @@
   "name": "fake_package_json_for_github_action_to_read_version",
   "private": true,
   "devDependencies": {
-    "pyright": "1.1.385"
+    "pyright": "1.1.407"
   }
 }

.github/workflows/main.yml

@@ -9,17 +9,29 @@ on:
 
 jobs:
   run_test:
-    name: mypy - ${{ matrix.py-ver-mypy-protobuf }} - unittest - ${{ matrix.py-ver-unit-tests }}
+    name: mypy-protobuf - ${{ matrix.py-ver-mypy-protobuf }} - unittest - ${{ matrix.py-ver-unit-tests }} - protobuf ${{ matrix.protobuf-version }}
     runs-on: ubuntu-24.04
-    # Some CI issues regarding ubuntu-latest
-    # runs-on: ubuntu-latest
-    env:
-      PY_VER_MYPY: 3.8.17
     strategy:
       matrix:
         # Running mypy-protobuf itself
-        py-ver-mypy-protobuf: [3.8.17, 3.9.17, 3.10.12, 3.11.4, 3.12.12, 3.13.9, 3.14.0]
-        py-ver-unit-tests: [3.8.17, 3.13.9, 3.14.0]
+        py-ver-mypy-protobuf:
+          - 3.9.17
+          - 3.10.12
+          - 3.11.4
+          - 3.12.12
+          - 3.13.9
+          - 3.14.0
+        # Running unit tests
+        py-ver-unit-tests:
+          - 3.9.17
+          - 3.10.12
+          - 3.11.4
+          - 3.12.12
+          - 3.13.9
+          - 3.14.0
+        protobuf-version:
+          - 5.28.3
+          - 6.33.1
 
     steps:
       - uses: actions/checkout@v4
@@ -28,63 +40,54 @@ jobs:
           echo ::set-output name=PROTOBUF_VERSION::$(grep "^protobuf>=" test_requirements.txt | cut -f2 -d=)
           echo ::set-output name=PYRIGHT_VERSION::$(grep '"pyright"' .github/package.json | cut -d\" -f4)
         id: read_versions
-      - name: Cache pyenv
-        uses: actions/cache@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
-          path: |
-            ~/.pyenv
-            !~/.pyenv/versions
-          key: pyenv-installation-2
-      - name: Cache pyenv mypy-protobuf ver
-        uses: actions/cache@v4
-        with:
-          path: ~/.pyenv/versions/${{matrix.py-ver-mypy-protobuf}}
-          key: pyenv-${{matrix.py-ver-mypy-protobuf}}-${{hashFiles('setup.py')}}
-      - name: Cache pyenv unit tests 3 ver
-        uses: actions/cache@v4
-        with:
-          path: ~/.pyenv/versions/${{matrix.py-ver-unit-tests}}
-          key: pyenv-${{matrix.py-ver-unit-tests}}-${{hashFiles('setup.py')}}
-      - name: Cache pyenv mypy ver
-        uses: actions/cache@v4
-        with:
-          path: ~/.pyenv/versions/${{env.PY_VER_MYPY}}
-          key: pyenv-${{env.PY_VER_MYPY}}-${{hashFiles('setup.py')}}
-      - name: Install pyenv
-        run: |
-          if [ ! -e ~/.pyenv/bin/pyenv ]; then
-            rm -rf ~/.pyenv
-            curl https://pyenv.run | bash
-          fi
-
-          export PATH="$HOME/.pyenv/bin:$PATH"
-          eval "$(pyenv init -)"
-          eval "$(pyenv init --path)"
-          eval "$(pyenv virtualenv-init -)"
-
-          for PY in ${{matrix.py-ver-mypy-protobuf}} ${{env.PY_VER_MYPY}} ${{matrix.py-ver-unit-tests}}; do
-            if [ ! -e ~/.pyenv/versions/$PY ]; then
-              pyenv install --skip-existing $PY
-              pyenv shell $PY
-              python -m pip install virtualenv
-            fi
-          done
+          enable-cache: true # Optional: Enable caching for uv's package cache
+          cache-dependency-glob: '**/*requirements.txt' # Optional: Specify a glob pattern to determine cache keys
       - name: Run Tests (./run_test.sh)
         env:
           PY_VER_MYPY_PROTOBUF: ${{matrix.py-ver-mypy-protobuf}}
           PY_VER_UNIT_TESTS: ${{matrix.py-ver-unit-tests}}
+          PY_VER_MYPY: ${{matrix.py-ver-mypy-protobuf}}
+          PYTHON_PROTOBUF_VERSION: ${{matrix.protobuf-version}}
           VALIDATE: 1
         run: |
-          export PATH="$HOME/.pyenv/bin:$PATH"
-          eval "$(pyenv init -)"
-          eval "$(pyenv init --path)"
-          eval "$(pyenv virtualenv-init -)"
           ./run_test.sh
 
+
+
+  pyright:
+    name: Pyright - ${{ matrix.python-version }}
+    strategy:
+      matrix:
+        python-version:
+          - 3.9.17
+          - 3.10.12
+          - 3.11.4
+          - 3.12.12
+          - 3.13.9
+          - 3.14.0
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Read version numbers
+        run: |
+          echo ::set-output name=PYRIGHT_VERSION::$(grep '"pyright"' .github/package.json | cut -d\" -f4)
+        id: read_versions
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true # Optional: Enable caching for uv's package cache
+          cache-dependency-glob: '**/*requirements.txt' # Optional: Specify a glob pattern to determine cache keys
+      - run: |
+          uv venv -p ${{ matrix.python-version }}
+          uv pip install -r test_requirements.txt
       - name: Run Pyright
         uses: jakebailey/pyright-action@v2
         with:
           version: "${{ steps.read_versions.outputs.PYRIGHT_VERSION }}"
+          python-path: .venv/bin/python3
 
   linting:
     name: Linting

CHANGELOG.md

@@ -11,6 +11,7 @@
     - Not for async stubs
   - Enum message deprecation is supported
     - Enum field deprecation is not
+- Drop Python 3.8 testing. Newer protobuf versions are incompatible. Generated code may still work
 
 ## 3.6.0
 

pyproject.toml

@@ -23,7 +23,6 @@ report_deprecated_as_note = true
 
 [tool.pyright]
 venvPath = "."
-venv = "venv_3.8.17"
 # verboseOutput = true
 extraPaths = ["test/generated"]
 include = [

run_test.sh

@@ -3,11 +3,17 @@
 RED="\033[0;31m"
 NC='\033[0m'
 
-PY_VER_MYPY_PROTOBUF=${PY_VER_MYPY_PROTOBUF:=3.11.4}
+PY_VER_MYPY_PROTOBUF=${PY_VER_MYPY_PROTOBUF:=3.14.0}
 PY_VER_MYPY_PROTOBUF_SHORT=$(echo "$PY_VER_MYPY_PROTOBUF" | cut -d. -f1-2)
-PY_VER_MYPY=${PY_VER_MYPY:=3.8.17}
-PY_VER_UNIT_TESTS="${PY_VER_UNIT_TESTS:=3.8.17 3.13.9 3.14.0}"
+PY_VER_MYPY=${PY_VER_MYPY:=3.14.0}
+PY_VER_UNIT_TESTS="${PY_VER_UNIT_TESTS:=3.9.17 3.10.12 3.11.4 3.12.12 3.13.9 3.14.0}"
+PYTHON_PROTOBUF_VERSION=${PYTHON_PROTOBUF_VERSION:=5.28.3}
 
+# Confirm UV installed
+if ! command -v uv &> /dev/null; then
+    echo -e "${RED}uv could not be found, please install uv (https://docs.astral.sh/uv/getting-started/installation/)${NC}"
+    exit 1
+fi
 
 
 if [ -e "$CUSTOM_TYPESHED_DIR" ]; then
@@ -19,7 +25,6 @@ else
 fi
 
 # Install protoc
-PYTHON_PROTOBUF_VERSION=$(grep "^protobuf==" test_requirements.txt | cut -f3 -d=)
 PROTOBUF_VERSION=$(echo "$PYTHON_PROTOBUF_VERSION" | cut -f2-3 -d.)
 PROTOC_DIR="protoc_$PROTOBUF_VERSION"
 if [[ -z $SKIP_CLEAN ]] || [[ ! -e $PROTOC_DIR ]]; then
@@ -49,32 +54,25 @@ PROTOC_ARGS=( --proto_path=proto/ --proto_path="$PROTOC_DIR/protoc_install/inclu
 # Create mypy venv
 MYPY_VENV=venv_$PY_VER_MYPY
 (
-    eval "$(pyenv init --path)"
-    eval "$(pyenv init -)"
-    pyenv shell "$PY_VER_MYPY"
-
     if [[ -z $SKIP_CLEAN ]] || [[ ! -e $MYPY_VENV ]]; then
-        python3 --version
-        python3 -m pip --version
-        python -m pip install virtualenv
-        python3 -m virtualenv "$MYPY_VENV"
-        "$MYPY_VENV"/bin/python3 -m pip install -r mypy_requirements.txt
+        echo "Creating mypy venv for Python $PY_VER_MYPY"
+        uv venv -p "$PY_VER_MYPY" "$MYPY_VENV" --allow-existing
+        uv pip install -p "$MYPY_VENV"  -r mypy_requirements.txt
     fi
+    echo "Running mypy version:"
     "$MYPY_VENV"/bin/mypy --version
 )
 
 # Create unit tests venvs
 for PY_VER in $PY_VER_UNIT_TESTS; do
     (
         UNIT_TESTS_VENV=venv_$PY_VER
-        eval "$(pyenv init --path)"
-        eval "$(pyenv init -)"
-        pyenv shell "$PY_VER"
 
         if [[ -z $SKIP_CLEAN ]] || [[ ! -e $UNIT_TESTS_VENV ]]; then
-            python -m pip install virtualenv
-            python -m virtualenv "$UNIT_TESTS_VENV"
-            "$UNIT_TESTS_VENV"/bin/python -m pip install -r test_requirements.txt
+            uv venv -p "$PY_VER" "$UNIT_TESTS_VENV" --allow-existing
+            uv pip install -p "$UNIT_TESTS_VENV"  -r test_requirements.txt
+            # Install protobuf version override
+            uv pip install -p "$UNIT_TESTS_VENV" "protobuf==$PYTHON_PROTOBUF_VERSION"
         fi
         "$UNIT_TESTS_VENV"/bin/py.test --version
     )
@@ -83,15 +81,10 @@ done
 # Create mypy-protobuf venv
 MYPY_PROTOBUF_VENV=venv_$PY_VER_MYPY_PROTOBUF
 (
-    eval "$(pyenv init --path)"
-    eval "$(pyenv init -)"
-    pyenv shell "$PY_VER_MYPY_PROTOBUF"
-
     # Create virtualenv + Install requirements for mypy-protobuf
     if [[ -z $SKIP_CLEAN ]] || [[ ! -e $MYPY_PROTOBUF_VENV ]]; then
-        python -m pip install virtualenv
-        python -m virtualenv "$MYPY_PROTOBUF_VENV"
-        "$MYPY_PROTOBUF_VENV"/bin/python -m pip install -e .
+        uv venv -p "$PY_VER_MYPY_PROTOBUF" "$MYPY_PROTOBUF_VENV" --allow-existing
+        uv pip install -p "$MYPY_PROTOBUF_VENV" -e .
     fi
 )
 
@@ -163,10 +156,17 @@ for PY_VER in $PY_VER_UNIT_TESTS; do
         mypy ${CUSTOM_TYPESHED_DIR_ARG:+"$CUSTOM_TYPESHED_DIR_ARG"} --python-executable="$UNIT_TESTS_VENV"/bin/python --python-version="$PY_VER_MYPY_TARGET" "${MODULES[@]}"
 
         # Run stubtest. Stubtest does not work with python impl - only cpp impl
-        pip install -r test_requirements.txt
+        uv pip install -p "$MYPY_VENV" -r test_requirements.txt
+        # Override python protobuf version
+        uv pip install -p "$MYPY_VENV" "protobuf==$PYTHON_PROTOBUF_VERSION"
         API_IMPL="$(python3 -c "import google.protobuf.internal.api_implementation as a ; print(a.Type())")"
         if [[ $API_IMPL != "python" ]]; then
-            PYTHONPATH=test/generated python3 -m mypy.stubtest ${CUSTOM_TYPESHED_DIR_ARG:+"$CUSTOM_TYPESHED_DIR_ARG"} --allowlist stubtest_allowlist.txt testproto
+            # Skip stubtest for python version 3.13+ until positional argument decision is made
+            if [[ "$PY_VER_MYPY" == "3.13.9" ]] || [[ "$PY_VER_MYPY" == "3.14.0" ]]; then
+                echo "Skipping stubtest for Python $PY_VER_MYPY until positional argument decision is made"
+            else
+                PYTHONPATH=test/generated python3 -m mypy.stubtest ${CUSTOM_TYPESHED_DIR_ARG:+"$CUSTOM_TYPESHED_DIR_ARG"} --allowlist stubtest_allowlist.txt testproto
+            fi
         fi
 
         # run mypy on negative-tests (expected mypy failures)

test/test_generated_mypy.py

@@ -109,14 +109,14 @@ def grab_expectations(filename: str, marker: str) -> Generator[Tuple[str, int],
             if "#" in line and marker in line:
                 yield filename, idx + 1
 
-    errors_38 = set(grab_errors("test_negative/output.expected.3.8"))
+    errors_39 = set(grab_errors("test_negative/output.expected.3.9"))
 
-    expected_errors_38 = set(grab_expectations("test_negative/negative.py", "E:3.8"))
+    expected_errors_39 = set(grab_expectations("test_negative/negative.py", "E:3.8"))
 
-    assert errors_38 == expected_errors_38
+    assert errors_39 == expected_errors_39
 
     # Some sanity checks to make sure we don't mess this up. Please update as necessary.
-    assert len(errors_38) == 81
+    assert len(errors_39) == 81
 
 
 def test_func() -> None: