Merge pull request #3 from strawberry-graphql/agent/add-strawberry-field-coverage

Add Strawberry field coverage

Author: patrick91

.github/workflows/test.yml

@@ -53,6 +53,24 @@ jobs:
       - run: uv sync --locked
       - run: uv run --locked --with "${{ matrix.pytest-version }}" pytest -vv
 
+  compatibility:
+    name: 🧩 Strawberry compatibility
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          enable-cache: true
+          python-version: "3.14"
+
+      - run: uv sync --locked
+      - name: Run compatibility sessions
+        run: uv run nox --tags compatibility
+
   quality:
     name: ✨ Quality
     runs-on: ubuntu-latest
@@ -76,7 +94,7 @@ jobs:
   required-ci:
     name: Required CI
     if: ${{ always() }}
-    needs: [tests, quality]
+    needs: [tests, compatibility, quality]
     runs-on: ubuntu-latest
 
     steps:

CHANGELOG.md

@@ -10,4 +10,4 @@ The package registers itself with pytest through the `pytest11` entry point and
 includes the project automation needed to test and publish future plugin
 features. It does not expose fixtures, hooks, or command-line options yet.
 
-This release was contributed by [@patrick91](https://github.com/patrick91) in [#2](https://github.com/strawberry-graphql/pytest-strawberry/pull/2)
+This release was contributed by [@patrick91](https://github.com/patrick91) in [#2](https://github.com/strawberry-graphql/pytest-strawberry/pull/2)

README.md

@@ -4,9 +4,9 @@
 
 > Pytest plugin for Strawberry GraphQL
 
-This repository currently provides the package and release infrastructure for
-`pytest-strawberry`. The installed package is discovered automatically by
-pytest, but it does not expose fixtures, hooks, or command-line options yet.
+`pytest-strawberry` measures which Strawberry GraphQL schema fields are reached
+while your pytest suite runs. It reports schema field coverage independently of
+Python source coverage.
 
 ## Installation
 
@@ -16,6 +16,83 @@ pip install pytest-strawberry
 
 Pytest loads the plugin automatically through its `pytest11` entry point.
 
+## Field coverage
+
+Enable coverage on the pytest command line:
+
+```shell
+pytest --strawberry-coverage
+```
+
+By default, the report covers fields with explicit Strawberry resolvers or
+custom field resolution supplied by integrations such as Strawberry Django. It
+excludes fields handled only by Strawberry's ordinary attribute lookup:
+
+```text
+============================= Strawberry coverage =============================
+Subscriptions: excluded (requires graphql-core 3.3+); graphql-core 3.2.11
+
+Schema b6016cac
+┌───────────────────┬────────┬──────┬─────────┬───────────────────────┐
+│ Python type       │ Fields │ Miss │   Cover │ Missing fields        │
+├───────────────────┼────────┼──────┼─────────┼───────────────────────┤
+│ QueryRoot [Query] │      2 │    0 │ 100.00% │                       │
+│ UserModel [User]  │      3 │    1 │  66.67% │ email_address [email] │
+├───────────────────┼────────┼──────┼─────────┼───────────────────────┤
+│ All types         │      5 │    1 │  80.00% │                       │
+└───────────────────┴────────┴──────┴─────────┴───────────────────────┘
+
+Overall coverage: 80.00% (4/5 fields, 1 missing)
+```
+
+The table uses Python class and field names so uncovered resolvers are directly
+searchable in the codebase. When `name=` explicitly changes a GraphQL name, the
+GraphQL alias is shown in brackets. Automatic camel-casing is not repeated.
+
+Use `all` mode to include Strawberry fields that use default attribute
+resolution:
+
+```shell
+pytest --strawberry-coverage --strawberry-coverage-mode=all
+```
+
+A field counts as covered when GraphQL execution reaches its resolver or
+default lookup. A resolver that raises still counts. Fields skipped by a
+directive, omitted from the operation, or bypassed by null propagation do not.
+Aliases and fragments do not create additional field coordinates.
+
+You can enforce a minimum combined percentage:
+
+```shell
+pytest --strawberry-coverage --strawberry-coverage-fail-under=90
+```
+
+The threshold is compared with the displayed percentage rounded to two decimal
+places. Mode and threshold options require `--strawberry-coverage`.
+
+Schema executions with different eligible fields or Python mappings receive
+separate fingerprinted tables. Executions with the same field set are combined.
+The final threshold uses their combined field and hit totals. Coverage from
+pytest-xdist workers is merged automatically.
+
+A runnable [Strawberry Django example](./examples/strawberry_django) shows how
+generated model fields participate in resolver coverage without adding a
+runtime dependency on Strawberry Django.
+
+### Subscriptions
+
+Subscription resolver extensions are supported by graphql-core 3.3 and newer.
+With that capability available, subscription source and payload fields are
+included normally. graphql-core 3.2 does not run resolver extensions for
+subscriptions, so subscription-only fields are excluded and the plugin emits
+one warning if a subscription executes. Query and mutation coverage remains
+available in the same run.
+
+Only schemas used to execute an operation during the pytest session are
+reported. An observed schema with no eligible fields is 100% covered; a session
+that observes no schemas is 0% covered. Reporting and threshold enforcement are
+disabled under `--collect-only`.
+
 ## Development
 
 Install the project and its development dependencies with
@@ -35,6 +112,13 @@ uv run mypy
 uv build
 ```
 
+Run the Strawberry, graphql-core, and Strawberry Django compatibility checks
+on Python 3.14 with:
+
+```shell
+uv run nox --tags compatibility
+```
+
 ## Releases
 
 Release changes are proposed through pull requests containing a `RELEASE.md`.

RELEASE.md

@@ -0,0 +1,8 @@
+---
+release type: minor
+---
+
+Add runtime Strawberry GraphQL field coverage with resolver-only and all-field
+modes, custom field resolver support including Strawberry Django, Python-first
+terminal reporting, fail-under enforcement, subscription capability detection,
+and pytest-xdist aggregation.

examples/strawberry_django/README.md

@@ -0,0 +1,35 @@
+# Strawberry Django example
+
+This example uses an unsaved Django model instance, so it needs no database
+migrations or external services. Run its dedicated compatibility session from
+the repository root with:
+
+```shell
+uv run nox -s strawberry_django
+```
+
+The session runs the plugin's test suite with Strawberry Django installed, then
+runs this example with coverage enabled.
+
+The report includes the generated Django model fields:
+
+```text
+Schema b7dc8af0
+┌─────────────┬────────┬──────┬─────────┬────────────────┐
+│ Python type │ Fields │ Miss │   Cover │ Missing fields │
+├─────────────┼────────┼──────┼─────────┼────────────────┤
+│ FruitType   │      2 │    1 │  50.00% │ description    │
+│ Query       │      1 │    0 │ 100.00% │                │
+├─────────────┼────────┼──────┼─────────┼────────────────┤
+│ All types   │      3 │    1 │  66.67% │                │
+└─────────────┴────────┴──────┴─────────┴────────────────┘
+
+Overall coverage: 66.67% (2/3 fields, 1 missing)
+```
+
+Resolver mode includes `FruitType.name` and `FruitType.description` because
+`StrawberryDjangoField` supplies custom field resolution. The query covers
+`name`, leaving `description` visible in the missing-fields column.
+
+Add `--strawberry-coverage-mode=all` to include ordinary Strawberry attribute
+lookups too.

examples/strawberry_django/test_schema.py

@@ -0,0 +1,51 @@
+import django
+import strawberry
+import strawberry_django
+from django.conf import settings
+from django.db import models
+
+if not settings.configured:
+    settings.configure(
+        DATABASES={
+            "default": {
+                "ENGINE": "django.db.backends.sqlite3",
+                "NAME": ":memory:",
+            }
+        },
+        INSTALLED_APPS=[],
+    )
+django.setup()
+
+
+class Fruit(models.Model):
+    name = models.CharField(max_length=100)
+    description = models.TextField()
+
+    class Meta:
+        app_label = "coverage_example"
+
+    def __str__(self) -> str:
+        return self.name
+
+
+@strawberry_django.type(Fruit)
+class FruitType:
+    name: strawberry.auto
+    description: strawberry.auto
+
+
+@strawberry.type
+class Query:
+    @strawberry.field
+    def fruit(self) -> FruitType:
+        return Fruit(name="Strawberry", description="A very good berry")
+
+
+schema = strawberry.Schema(query=Query)
+
+
+def test_fruit_name() -> None:
+    result = schema.execute_sync("{ fruit { name } }")
+
+    assert result.errors is None
+    assert result.data == {"fruit": {"name": "Strawberry"}}

noxfile.py

@@ -0,0 +1,43 @@
+"""Compatibility test sessions."""
+
+from __future__ import annotations
+
+import nox
+
+nox.needs_version = ">=2026.8.10"
+nox.options.default_venv_backend = "uv"
+
+PYTHON = "3.14"
+PYTEST_XDIST = "pytest-xdist>=3.6.0,<4.0.0"
+
+
+@nox.session(python=PYTHON, tags=["compatibility"])
+def strawberry_min(session: nox.Session) -> None:
+    """Test the lowest supported Strawberry and graphql-core versions."""
+    session.install(
+        ".",
+        PYTEST_XDIST,
+        "strawberry-graphql==0.316.0",
+        "graphql-core==3.2.11",
+    )
+    session.run("pytest", "-vv")
+
+
+@nox.session(python=PYTHON, tags=["compatibility"])
+def graphql_core_33(session: nox.Session) -> None:
+    """Test subscription coverage with graphql-core 3.3."""
+    session.install(".", PYTEST_XDIST, "graphql-core>=3.3.0rc0,<3.4")
+    session.run("pytest", "-vv")
+
+
+@nox.session(python=PYTHON, tags=["compatibility"])
+def strawberry_django(session: nox.Session) -> None:
+    """Test Strawberry Django support and its runnable example."""
+    session.install(".", PYTEST_XDIST, "strawberry-graphql-django==0.87.0")
+    session.run("pytest", "-vv")
+    session.run(
+        "pytest",
+        "examples/strawberry_django",
+        "-q",
+        "--strawberry-coverage",
+    )

pyproject.toml

@@ -22,7 +22,10 @@ classifiers = [
   "Topic :: Software Development :: Testing",
 ]
 requires-python = ">=3.10,<4.0"
-dependencies = ["pytest>=8.0,<10.0"]
+dependencies = [
+  "pytest>=8.0,<10.0",
+  "strawberry-graphql>=0.316.0",
+]
 
 [project.urls]
 repository = "https://github.com/strawberry-graphql/pytest-strawberry"
@@ -34,7 +37,9 @@ pytest-strawberry = "pytest_strawberry.plugin"
 [dependency-groups]
 dev = [
   "mypy>=1.15.0,<3.0.0",
+  "nox>=2026.8.10,<2027.0.0",
   "pre-commit>=4.0.0,<5.0.0",
+  "pytest-xdist>=3.6.0,<4.0.0",
   "ruff>=0.14.1,<0.17.0",
 ]
 
@@ -78,6 +83,7 @@ ignore = [
 ]
 
 [tool.ruff.lint.per-file-ignores]
+"examples/**/*.py" = ["D", "INP001", "S101"]
 "tests/*" = ["D", "S101"]
 
 [build-system]