👷 [#538] Add performance test for objects API list

Author: stevenbal

.github/workflows/ci.yml

@@ -49,6 +49,35 @@ jobs:
       - name: Publish coverage report
         uses: codecov/codecov-action@v4
 
+  performance-tests:
+    name: Run the performance test suite
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Bring up docker compose and load data
+        run: |
+          docker compose up -d --build || ( docker compose logs >&2 && exit 1; )
+          until docker compose logs web | grep -q "spawned uWSGI worker"; do
+            echo "uWSGI not running yet, waiting..."
+            sleep 3
+          done
+          docker compose exec --user root web pip install factory-boy
+          cat performance-test/create_data.py | docker compose exec -T web src/manage.py shell
+
+      - name: Run tests
+        run: |
+          pip install -r requirements/ci.txt
+          pytest performance-test/ --benchmark-json output.json
+
+      - name: Store benchmark result
+        uses: benchmark-action/github-action-benchmark@v1.20.4
+        with:
+          tool: 'pytest'
+          output-file-path: output.json
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
   docs:
     runs-on: ubuntu-latest
     name: Documentation build

performance_test/conftest.py

@@ -0,0 +1,13 @@
+import pytest
+
+
+@pytest.fixture
+def benchmark_assertions(benchmark):
+    def wrapper(**kwargs):
+        stats = benchmark.stats["stats"]
+        for name, value in kwargs.items():
+            assert (
+                getattr(stats, name) < value
+            ), f"{name} {getattr(stats, name)} exceeded {value} s"
+
+    return wrapper

performance_test/create_data.py

@@ -0,0 +1,17 @@
+from objects.core.tests.factories import ObjectRecordFactory, ObjectTypeFactory
+from objects.token.tests.factories import TokenAuthFactory
+
+object_type = ObjectTypeFactory.create(
+    service__api_root="http://localhost:8001/api/v2/",
+    uuid="f1220670-8ab7-44f1-a318-bd0782e97662",
+)
+
+token = TokenAuthFactory(token="secret", is_superuser=True)
+
+ObjectRecordFactory.create_batch(
+    5000,
+    object__object_type=object_type,
+    start_at="2020-01-01",
+    version=1,
+    data={"kiemjaar": "1234"},
+)

performance_test/test_objects_list.py

@@ -0,0 +1,29 @@
+import pytest
+import requests
+from furl import furl
+
+BASE_URL = furl("http://localhost:8000/api/v2/")
+AUTH_HEADERS = {"Authorization": "Token secret"}
+
+
+@pytest.mark.benchmark(max_time=60, min_rounds=5)
+def test_objects_api_list(benchmark, benchmark_assertions):
+    """
+    Regression test for maykinmedia/objects-api#538
+    """
+    params = {
+        "pageSize": 1000,
+        "type": "http://localhost:8001/api/v2/objecttypes/f1220670-8ab7-44f1-a318-bd0782e97662",
+        "data_attrs": "kiemjaar__exact__1234",
+        "ordering": "-record__data__contactmoment__datumContact",
+    }
+
+    def make_request():
+        return requests.get((BASE_URL / "objects").set(params), headers=AUTH_HEADERS)
+
+    result = benchmark(make_request)
+
+    assert result.status_code == 200
+    assert result.json()["count"] == 5000
+
+    benchmark_assertions(mean=1, max=1)

requirements/ci.txt

@@ -534,6 +534,8 @@ psycopg2==2.9.9
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   open-api-framework
+py-cpuinfo==9.0.0
+    # via pytest-benchmark
 pycodestyle==2.12.1
     # via flake8
 pycparser==2.20
@@ -584,6 +586,10 @@ pyrsistent==0.17.3
     #   -r requirements/base.txt
     #   jsonschema
 pytest==8.3.3
+    # via
+    #   -r requirements/test-tools.in
+    #   pytest-benchmark
+pytest-benchmark==5.1.0
     # via -r requirements/test-tools.in
 python-dateutil==2.9.0.post0
     # via

requirements/dev.txt

@@ -640,6 +640,11 @@ psycopg2==2.9.9
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   open-api-framework
+py-cpuinfo==9.0.0
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   pytest-benchmark
 pycodestyle==2.12.1
     # via
     #   -c requirements/ci.txt
@@ -711,6 +716,11 @@ pytest==8.3.3
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+    #   pytest-benchmark
+pytest-benchmark==5.1.0
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
 python-dateutil==2.9.0.post0
     # via
     #   -c requirements/ci.txt

requirements/test-tools.in

@@ -4,6 +4,7 @@
 # Dependencies only relevant for (unit) testing
 codecov
 pytest
+pytest-benchmark
 coverage < 5.0
 django-webtest
 factory-boy