Run stubtest on stubs on different platforms

python · AlexWaygood · Nov 11, 2022 · Oct 18, 2022 · Oct 18, 2022 · Oct 18, 2022
commit 61deba65bf47cb5dd7cb6939878b962036eb6cd1
diff --git a/.github/workflows/daily.yml b/.github/workflows/daily.yml
@@ -54,7 +54,7 @@ jobs:
       - name: Install apt packages
         run: |
           sudo apt update
-          sudo apt install -y $(python tests/get_apt_packages.py)
+          sudo apt install -y $(python tests/get_packages.py)
       - name: Run stubtest
         run: xvfb-run python tests/stubtest_third_party.py --num-shards 4 --shard-index ${{ matrix.shard-index }}
 

diff --git a/.github/workflows/stubtest_stubs.yml b/.github/workflows/stubtest_stubs.yml
@@ -0,0 +1,69 @@
+name: Test
+
+on:
+  pull_request:
+    paths-ignore:
+      - '**/*.md'
+      - 'scripts/**'
+
+permissions:
+  contents: read
+
+env:
+  PIP_DISABLE_PIP_VERSION_CHECK: 1
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  stubtest-third-party:
+    name: Check third party stubs with stubtest
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+      - name: Install dependencies
+        run: pip install -r requirements-tests.txt
+      - name: Run stubtest
+        run: |
+          STUBS=$(
+            git diff --name-only origin/${{ github.base_ref }} HEAD |
+            # Uncomment the following to (very slowly) run on all third party stubs:
+            # git ls-files |
+            egrep ^stubs/ | cut -d "/" -f 2 | sort -u | (while read stub; do [ -d stubs/$stub ] && echo $stub || true; done)
+          )
+          if test -n "$STUBS"; then
+            echo "Testing $STUBS..."
+            PACKAGES=$(python tests/get_packages.py $STUBS)
+
+            if [ "${{ matrix.os }}" = "ubuntu-latest" ]; then
+              if test -n "$PACKAGES"; then
+                echo "Installing apt packages: $PACKAGES"
+                sudo apt update && sudo apt install -y $PACKAGES
+              fi
+              xvfb-run python tests/stubtest_third_party.py $STUBS
+            fi
+
+            if [ "${{ matrix.os }}" = "macos-latest" ]; then
+              # TODO: install brew packages
+              python tests/stubtest_third_party.py $STUBS
+            fi
+
+            if [ "${{ matrix.os }}" = "windows-latest" ]; then
+              # TODO: support windows
+              python tests/stubtest_third_party.py $STUBS
+            fi
+          else
+            echo "Nothing to test"
+          fi
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -147,36 +147,3 @@ jobs:
           cd stub_uploader
           pip install -r requirements.txt
           python -m pytest tests
-
-  stubtest-third-party:
-    name: Check third party stubs with stubtest
-    runs-on: ubuntu-20.04
-    if: github.event_name == 'pull_request'
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-python@v4
-        with:
-          python-version: "3.9"
-      - name: Install dependencies
-        run: pip install -r requirements-tests.txt
-      - name: Run stubtest
-        run: |
-          STUBS=$(
-            git diff --name-only origin/${{ github.base_ref }} HEAD |
-            # Uncomment the following to (very slowly) run on all third party stubs:
-            # git ls-files |
-            egrep ^stubs/ | cut -d "/" -f 2 | sort -u | (while read stub; do [ -d stubs/$stub ] && echo $stub || true; done)
-          )
-          if test -n "$STUBS"; then
-            echo "Testing $STUBS..."
-            APT_PACKAGES=$(python tests/get_apt_packages.py $STUBS)
-            if test -n "$APT_PACKAGES"; then
-              echo "Installing apt packages: $APT_PACKAGES"
-              sudo apt update && sudo apt install -y $APT_PACKAGES
-            fi
-            xvfb-run python tests/stubtest_third_party.py $STUBS
-          else
-            echo "Nothing to test"
-          fi
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -192,6 +192,9 @@ This has the following keys:
 * `apt_dependencies` (default: `[]`): A list of Ubuntu APT packages
   that need to be installed for stubtest to run successfully. These are
   usually packages needed to pip install the implementation distribution.
+* `platform` (default: `None`): A list of supported OSes.
+  Can contain `win32`, `linux`, and `darwin` values.
+  If not specified, all platforms are considered supported.
 
 The format of all `METADATA.toml` files can be checked by running
 `python3 ./tests/check_consistent.py`.

diff --git a/stubs/JACK-Client/METADATA.toml b/stubs/JACK-Client/METADATA.toml
@@ -1,4 +1,5 @@
 version = "0.5.*"
 
 [tool.stubtest]
+platform = ["linux"]
 apt_dependencies = ["libjack-dev"]
diff --git a/stubs/pyaudio/METADATA.toml b/stubs/pyaudio/METADATA.toml
@@ -1,4 +1,5 @@
 version = "0.2.*"
 
 [tool.stubtest]
+platform = ["linux"]
 apt_dependencies = ["portaudio19-dev"]
diff --git a/stubs/pycurl/METADATA.toml b/stubs/pycurl/METADATA.toml
@@ -1,4 +1,5 @@
 version = "7.45.*"
 
 [tool.stubtest]
+platform = ["linux"]
 apt_dependencies = ["libcurl4-openssl-dev"]
diff --git a/tests/get_apt_packages.py b/tests/get_apt_packages.py
diff --git a/tests/get_packages.py b/tests/get_packages.py
@@ -0,0 +1,23 @@
+#!/usr/bin/env python3
+import os
+import sys
+
+import tomli
+
+platform = sys.platform
+distributions = sys.argv[1:]
+if not distributions:
+    distributions = os.listdir("stubs")
+
+metadata_mapping = {
+    "linux": "apt_dependencies",
+    # TODO: support others:
+    # "darwin": "brew_dependencies",
+    # "win32": "choco_dependencies",
+}
+
+if platform in metadata_mapping:
+    for distribution in distributions:
+        with open(f"stubs/{distribution}/METADATA.toml", "rb") as file:
+            for package in tomli.load(file).get("tool", {}).get("stubtest", {}).get(metadata_mapping[platform], []):
+                print(package)
diff --git a/tests/stubtest_third_party.py b/tests/stubtest_third_party.py
@@ -34,6 +34,11 @@ def run_stubtest(dist: Path, *, verbose: bool = False) -> bool:
         print(colored("skipping", "yellow"))
         return True
 
+    platform = metadata.get("tool", {}).get("plaform", None)
+    if platform is not None and sys.platform not in platform:
+        print(colored(f"skipping, unsupported platform: {sys.platform}, supported: {platform}", "yellow"))
+        return True
+
     with tempfile.TemporaryDirectory() as tmp:
         venv_dir = Path(tmp)
         venv.create(venv_dir, with_pip=True, clear=True)