github: Add workflow to test with the oldest compatible dependency versions (#45)

* Add a script to pin the oldest versions of dependencies

* github: Add another workflow to run tests with the oldest compatible dependency versions

* github: Fix duplicated job name

* Update poetry.lock

* tests: Fix repr tests on Linux

Co-authored by: mshafer-NI <[email protected]>

Author: bkeryan

.github/workflows/CI.yml

@@ -19,8 +19,12 @@ jobs:
     name: Run unit tests
     uses: ./.github/workflows/run_unit_tests.yml
     needs: [check_nitypes]
+  run_unit_tests_oldest_deps:
+    name: Run unit tests (oldest deps)
+    uses: ./.github/workflows/run_unit_tests_oldest_deps.yml
+    needs: [check_nitypes]
   report_test_results:
     name: Report test results
     uses: ./.github/workflows/report_test_results.yml
-    needs: [run_unit_tests]
+    needs: [run_unit_tests, run_unit_tests_oldest_deps]
     if: always()

.github/workflows/run_unit_tests.yml

@@ -32,6 +32,8 @@ jobs:
           key: nitypes-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
       - name: Install nitypes
         run: poetry install -v
+      - name: Display installed dependency versions
+        run: poetry run pip list
       - name: Run unit tests and code coverage
         run: poetry run pytest ./tests/unit -v --cov=nitypes --junitxml=test_results/nitypes-${{ matrix.os }}-py${{ matrix.python-version }}.xml
       - name: Upload test results

.github/workflows/run_unit_tests_oldest_deps.yml

@@ -0,0 +1,54 @@
+name: Run unit tests (oldest deps)
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  run_unit_tests_oldest_deps:
+    name: Run unit tests (oldest deps)
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+        python-version: [3.9]
+      # Fail-fast skews the pass/fail ratio and seems to make pytest produce
+      # incomplete JUnit XML results.
+      fail-fast: false
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Set up Python
+        uses: ni/python-actions/setup-python@e8f25e9a64426bd431ac124b83df11b76cdf60d5 # v0.1.0
+        id: setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up Poetry
+        uses: ni/python-actions/setup-poetry@e8f25e9a64426bd431ac124b83df11b76cdf60d5 # v0.1.0
+      - name: Cache virtualenv
+        id: cache-virtualenv
+        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        with:
+          path: .venv
+          key: nitypes-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
+      - name: Install nitypes (latest deps)
+        if: steps.cache-virtualenv.outputs.cache-hit != 'true'
+        run: poetry install -v
+      - name: Pin oldest compatible dependencies
+        if: steps.cache-virtualenv.outputs.cache-hit != 'true'
+        run: |
+          poetry run python scripts/pin_oldest_deps.py pyproject.toml
+          poetry lock --no-update
+      - name: Install nitypes (oldest deps)
+        if: steps.cache-virtualenv.outputs.cache-hit != 'true'
+        run: poetry install -v
+      - name: Display installed dependency versions
+        run: poetry run pip list
+      - name: Run unit tests and code coverage
+        run: poetry run pytest ./tests/unit -v --cov=nitypes --junitxml=test_results/nitypes-oldest-deps-${{ matrix.os }}-py${{ matrix.python-version }}.xml
+      - name: Upload test results
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: test_results_unit_oldest_deps_${{ matrix.os }}_py${{ matrix.python-version }}
+          path: ./test_results/*.xml
+        if: always()

poetry.lock

@@ -30,6 +30,7 @@ pytest-doctestplus = ">=1.4"
 pytest-mock = ">=3.0"
 # Use an unreleased version of hightime for testing.
 hightime = { git = "https://github.com/ni/hightime.git" }
+tomlkit = ">=0.11.0"
 
 [tool.poetry.group.docs]
 optional = true
@@ -55,7 +56,7 @@ requires = ["poetry>=1.2"]
 build-backend = "poetry.masonry.api"
 
 [tool.mypy]
-files = "examples/,src/,tests/"
+files = "examples/,scripts/,src/,tests/"
 plugins = "numpy.typing.mypy_plugin"
 namespace_packages = true
 strict = true
@@ -66,4 +67,4 @@ skips = [
 ]
 
 [tool.pyright]
-include = ["src/", "tests/"]
+include = ["examples/", "scripts/", "src/", "tests/"]

poetry.lock.orig

@@ -0,0 +1,43 @@
+"""Pin dependencies to the oldest compatible version for testing."""
+
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+import tomlkit
+from tomlkit.items import AbstractTable, Array
+
+
+def main(args: list[str]) -> int | str | None:
+    """Pin dependencies to the oldest compatible version for testing."""
+    pyproject_path = Path(args.pop())
+    if args:
+        return f"Unsupported arguments: {args!r}"
+    pyproject = tomlkit.loads(pyproject_path.read_text())
+    poetry_deps = pyproject["tool"]["poetry"]["dependencies"]  # type: ignore[index]
+    assert isinstance(poetry_deps, AbstractTable)
+
+    for dep, value in poetry_deps.items():
+        if dep == "python":
+            continue
+        if isinstance(value, str) and (
+            value.startswith("^") or value.startswith("~") or value.startswith(">=")
+        ):
+            poetry_deps[dep] = "==" + value.lstrip("^~>=")
+        elif isinstance(value, Array):
+            for constraint in value:
+                if "version" in constraint and (
+                    constraint["version"].startswith("^")
+                    or constraint["version"].startswith("~")
+                    or constraint["version"].startswith(">=")
+                ):
+                    constraint["version"] = "==" + constraint["version"].lstrip("^~>=")
+
+    pyproject_path.write_text(tomlkit.dumps(pyproject))
+    print("Updated pyproject.toml with pinned dependencies.")
+    return None
+
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv[1:]))

pyproject.toml

@@ -5,6 +5,7 @@
 import datetime as dt
 import itertools
 import pickle
+import sys
 import weakref
 from typing import Any, SupportsIndex
 
@@ -1751,7 +1752,7 @@ def test___different_value___equality___not_equal(
     assert left != right
 
 
-if Version(np.__version__) >= Version("2.0.0"):
+if Version(np.__version__) >= Version("2.0.0") or sys.platform != "win32":
     _NDARRAY_DTYPE_INT32 = ", dtype=int32"
 else:
     _NDARRAY_DTYPE_INT32 = ""

scripts/pin_oldest_deps.py

@@ -4,6 +4,7 @@
 import copy
 import itertools
 import pickle
+import sys
 import weakref
 from typing import Any, SupportsIndex
 
@@ -1172,7 +1173,7 @@ def test___different_value___equality___not_equal(
     assert left != right
 
 
-if Version(np.__version__) >= Version("2.0.0"):
+if Version(np.__version__) >= Version("2.0.0") or sys.platform != "win32":
     _NDARRAY_DTYPE_INT32 = ", dtype=int32"
 else:
     _NDARRAY_DTYPE_INT32 = ""