Modernize testing infrastructure with matrix testing and comprehensive tooling

SmileyChris · SmileyChris · commit 814ea66ba2af · 2025-11-12T17:47:30.000+13:00
- Add test matrix supporting Python 3.9-3.13 and Django 3.2-5.1
- Configure ruff for comprehensive linting (pycodestyle, Pyflakes, isort, pyupgrade, flake8-bugbear)
- Add bandit for security scanning
- Set up coverage tracking with 90%+ threshold enforcement
- Update justfile with smart test commands (quick, legacy, previous, latest)
- Restructure GitHub workflow into 3 jobs: tests, lint-and-type-check, coverage
- Apply auto-fixes for type hints and code style (TC006, UP045, RET504, B009)
- Fix line-length violations to comply with 88-character limit

Test matrix environments:
- legacy: Python 3.9 + Django 3.2
- previous: Python 3.11 + Django 4.2
- latest: Python 3.13 + Django 5.1

All 81 tests pass with 94% source coverage across all environments.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -1,78 +1,116 @@
 name: Tests
 
 on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
+  - push
+  - pull_request
 
 jobs:
-  test:
+  tests:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
-        django-version: ['3.2', '4.0', '4.1', '4.2', '5.0']
-        exclude:
-          # Django 5.0 requires Python 3.10+
-          - python-version: '3.8'
-            django-version: '5.0'
-          - python-version: '3.9'
-            django-version: '5.0'
-          # Django 4.2 is LTS, test more thoroughly
-          - python-version: '3.8'
-            django-version: '4.0'
-          - python-version: '3.8'
-            django-version: '4.1'
+        include:
+          # Legacy: Python 3.9 + Django 3.2
+          - python-version: "3.9"
+            test-env: legacy
+          # Previous: Python 3.11 + Django 4.2
+          - python-version: "3.11"
+            test-env: previous
+          # Latest: Python 3.13 + Django 5.1
+          - python-version: "3.13"
+            test-env: latest
 
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
 
-    - name: Install uv
-      uses: astral-sh/setup-uv@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
 
-    - name: Install dependencies
-      run: |
-        uv pip install --system "django==${{ matrix.django-version }}.*"
-        uv pip install --system -e ".[dev]"
+      - name: Install just
+        uses: extractions/setup-just@v2
 
-    - name: Run tests
-      run: |
-        pytest tests/ -v --cov=graphql_sqlcommenter --cov-report=xml --cov-report=term
+      - name: Run tests for ${{ matrix.test-env }}
+        run: just test ${{ matrix.test-env }} ${{ matrix.python-version }}
 
-    - name: Upload coverage to Codecov
-      if: matrix.python-version == '3.11' && matrix.django-version == '4.2'
-      uses: codecov/codecov-action@v4
-      with:
-        file: ./coverage.xml
-        fail_ci_if_error: false
+      - name: Upload coverage data
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.python-version }}-${{ matrix.test-env }}
+          path: .coverage.*
+          include-hidden-files: true
+          if-no-files-found: error
 
-  lint:
+  lint-and-type-check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.11'
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
 
-    - name: Install uv
-      uses: astral-sh/setup-uv@v4
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
 
-    - name: Install dependencies
-      run: |
-        uv pip install --system ruff mypy
+      - name: Install dependencies
+        run: uv sync --group dev
 
-    - name: Lint with ruff
-      run: |
-        ruff check graphql_sqlcommenter/ tests/
+      - name: Check formatting
+        run: |
+          uv run ruff check --select I graphql_sqlcommenter
+          uv run ruff format --check graphql_sqlcommenter
 
-    - name: Type check with mypy
-      run: |
-        mypy graphql_sqlcommenter/ || true  # Allow to fail for now
+      - name: Run linters
+        run: uv run ruff check graphql_sqlcommenter
+
+      - name: Run type checker
+        run: uv run mypy graphql_sqlcommenter
+
+      - name: Check documentation
+        run: uv run --group docs mkdocs build --strict
+
+      - name: Run security scan
+        run: uv run bandit -r graphql_sqlcommenter -x tests
+
+  coverage:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install coverage
+        run: uv pip install --system coverage
+
+      - name: Download all coverage artifacts
+        uses: actions/download-artifact@v4
+        with:
+          pattern: coverage-*
+          merge-multiple: true
+
+      - name: Combine and check coverage
+        run: |
+          coverage combine
+          echo "Source coverage (must be 90%+):"
+          coverage report --fail-under=90 -m
+          coverage html
+
+      - name: Upload coverage HTML
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-html
+          path: htmlcov/
diff --git a/graphql_sqlcommenter/apps.py b/graphql_sqlcommenter/apps.py
@@ -1,7 +1,8 @@
 """
 Django app configuration for graphql-sqlcommenter.
 
-This provides a ready() hook to automatically patch Graphene when using the Graphene integration approach.
+This provides a ready() hook to automatically patch Graphene when using
+the Graphene integration approach.
 """
 
 from django.apps import AppConfig
diff --git a/graphql_sqlcommenter/context.py b/graphql_sqlcommenter/context.py
@@ -50,7 +50,8 @@ def get_graphql_meta() -> Optional[GraphQLMetadata]:
     Get GraphQL metadata for the current context.
 
     Returns:
-        Dictionary with keys 'op', 'type', and 'sha', or None if not in a GraphQL context.
+        Dictionary with keys 'op', 'type', and 'sha', or None if not
+        in a GraphQL context.
     """
     return graphql_meta.get()
 
diff --git a/graphql_sqlcommenter/graphene_integration.py b/graphql_sqlcommenter/graphene_integration.py
@@ -25,7 +25,6 @@
 
 import hashlib
 import logging
-from collections.abc import AsyncIterator, Awaitable, Generator, Mapping
 from contextlib import asynccontextmanager, contextmanager
 from typing import TYPE_CHECKING, Any, Callable, cast
 
@@ -36,6 +35,8 @@
 )
 
 if TYPE_CHECKING:  # pragma: no cover - import for type checking only
+    from collections.abc import AsyncIterator, Awaitable, Generator, Mapping
+
     from graphene.types.schema import Schema
 else:  # pragma: no cover - fallback when graphene is absent
     Schema = Any  # type: ignore[misc,assignment]
@@ -124,8 +125,7 @@ async def patched_graphql_async(
     ) -> Any:
         """Patched async GraphQL execution with metadata capture."""
         with _graphql_meta_context(source, kwargs):
-            result = await old_graphql_async(schema, source, *args, **kwargs)
-            return result
+            return await old_graphql_async(schema, source, *args, **kwargs)
 
     # Apply patches
     graphene_schema.graphql_sync = patched_graphql_sync
@@ -255,9 +255,9 @@ def _patch_graphql_core_execution() -> None:
     )
 
     # Store original functions
-    old_execute = cast(Callable[..., Awaitable[Any]], gql_execution.execute)
-    old_execute_sync = cast(Callable[..., Any], gql_execution.execute_sync)
-    old_subscribe = cast(Callable[..., AsyncIterator[Any]], gql_execution.subscribe)
+    old_execute = cast("Callable[..., Awaitable[Any]]", gql_execution.execute)
+    old_execute_sync = cast("Callable[..., Any]", gql_execution.execute_sync)
+    old_subscribe = cast("Callable[..., AsyncIterator[Any]]", gql_execution.subscribe)
 
     async def patched_execute(
         schema: Any, document: Any, *args: Any, **kwargs: Any
@@ -269,8 +269,7 @@ async def patched_execute(
 
             query = print_ast(document)
             async with _async_graphql_meta_context(query, kwargs):
-                result = await old_execute(schema, document, *args, **kwargs)
-                return result
+                return await old_execute(schema, document, *args, **kwargs)
         except Exception as e:
             logger.debug(f"Could not capture metadata in execute: {e}")
             return await old_execute(schema, document, *args, **kwargs)
@@ -308,7 +307,7 @@ async def patched_subscribe(
     # Apply patches
     gql_execution.execute = patched_execute
     gql_execution.execute_sync = patched_execute_sync
-    gql_execution.subscribe = cast(Any, patched_subscribe)
+    gql_execution.subscribe = cast("Any", patched_subscribe)
 
     _patched_graphql_core = True
     logger.info("graphql-core patching complete")
@@ -477,7 +476,7 @@ def _coerce_query_string(source: str | Any) -> str:
     Convert a GraphQL Source object or string into a plain string.
     """
     if hasattr(source, "body"):
-        body_value = getattr(source, "body")
+        body_value = source.body
         if callable(body_value):
             body_value = body_value()
         return str(body_value)
diff --git a/graphql_sqlcommenter/middleware.py b/graphql_sqlcommenter/middleware.py
@@ -12,13 +12,15 @@
 import json
 import logging
 from collections.abc import Mapping, Sequence
-from typing import Callable, cast
+from typing import TYPE_CHECKING, Callable, cast
 
 from django.conf import settings
-from django.http import HttpRequest, HttpResponse
 
 from .context import GraphQLOperationType, set_graphql_meta
 
+if TYPE_CHECKING:
+    from django.http import HttpRequest, HttpResponse
+
 logger = logging.getLogger(__name__)
 
 
@@ -149,4 +151,4 @@ def _parse_body(self, body: str) -> Mapping[str, object]:
         data = json.loads(body)
         if not isinstance(data, Mapping):
             raise ValueError("GraphQL request payload must be a JSON object")
-        return cast(Mapping[str, object], data)
+        return cast("Mapping[str, object]", data)
diff --git a/graphql_sqlcommenter/wrapper.py b/graphql_sqlcommenter/wrapper.py
@@ -8,18 +8,20 @@
 from __future__ import annotations
 
 import logging
-from typing import Any, Optional, Protocol
+from typing import TYPE_CHECKING, Any, Protocol
 
 import django
 from django.db.backends.utils import CursorDebugWrapper
-from django.http import HttpRequest
-from django.urls import ResolverMatch
 from google.cloud.sqlcommenter import generate_sql_comment
 from google.cloud.sqlcommenter.opencensus import get_opencensus_values
 from google.cloud.sqlcommenter.opentelemetry import get_opentelemetry_values
 
 from .context import GraphQLMetadata, get_graphql_meta
 
+if TYPE_CHECKING:
+    from django.http import HttpRequest
+    from django.urls import ResolverMatch
+
 django_version = django.get_version()
 logger = logging.getLogger(__name__)
 
@@ -30,7 +32,7 @@ class ExecuteCallable(Protocol):
     def __call__(
         self,
         sql: str,
-        params: Optional[tuple[Any, ...]],
+        params: tuple[Any, ...] | None,
         many: bool,
         context: dict[str, Any],
     ) -> Any: ...
@@ -57,7 +59,7 @@ def __call__(
         self,
         execute: ExecuteCallable,
         sql: str,
-        params: Optional[tuple[Any, ...]],
+        params: tuple[Any, ...] | None,
         many: bool,
         context: dict[str, Any],
     ) -> Any:
@@ -98,14 +100,15 @@ def __call__(
 
         if with_opencensus and with_opentelemetry:
             logger.warning(
-                "SQLCOMMENTER_WITH_OPENCENSUS and SQLCOMMENTER_WITH_OPENTELEMETRY were enabled. "
+                "SQLCOMMENTER_WITH_OPENCENSUS and "
+                "SQLCOMMENTER_WITH_OPENTELEMETRY were enabled. "
                 "Only use one to avoid unexpected behavior"
             )
 
         # Extract Django request context
         connection_settings = context["connection"].settings_dict
         db_driver = str(connection_settings.get("ENGINE", ""))
-        resolver_match: Optional[ResolverMatch] = getattr(
+        resolver_match: ResolverMatch | None = getattr(
             self.request, "resolver_match", None
         )
 
@@ -142,7 +145,7 @@ def __call__(
 
         # Add GraphQL metadata if available
         if with_graphql:
-            meta: Optional[GraphQLMetadata] = get_graphql_meta()
+            meta: GraphQLMetadata | None = get_graphql_meta()
             if meta:
                 comment_kwargs.update(
                     {
diff --git a/justfile b/justfile
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/uv.lock b/uv.lock
