tests: updating pagination tests and pagination_tester to check exact results to make sure we get back the expected results from pagination, not just checking the number of results

Author: theodorehreuter

tests/conftest.py

@@ -73,7 +73,7 @@ def mock_product_test_wolf_cola(
     return Product(
         id="test-wolf-cola",
         title="Test Wolf Cola Product",
-        description="Test product for Wolf Cola for testing GET /product pagination",
+        description="The right cola for closure",
         license="CC-BY-4.0",
         keywords=["test", "satellite", "wolf-cola"],
         providers=[mock_provider],
@@ -161,7 +161,7 @@ def pagination_tester(
     method: str,
     limit: int,
     target: str,
-    expected_total_returns: int,
+    expected_returns: list,
     body: dict | None = None,
 ) -> None:
     retrieved = []
@@ -181,6 +181,7 @@ def pagination_tester(
         resp_body = res.json()
         retrieved.extend(resp_body[target])
 
+        # get url w/ query params for next call if exists, and POST body if necessary
         if resp_body["links"]:
             next_url = next(
                 (d["href"] for d in resp_body["links"] if d["rel"] == "next"), None
@@ -191,7 +192,8 @@ def pagination_tester(
         else:
             next_url = None
 
-    assert len(retrieved) == expected_total_returns
+    assert len(retrieved) == len(expected_returns)
+    assert retrieved == expected_returns
 
 
 def make_request(
@@ -203,6 +205,8 @@ def make_request(
     limit: int,
 ) -> Response:
     """request wrapper for pagination tests"""
+
+    # extract pagination token
     if next_token and "next=" in next_token:
         next_token = next_token.split("next=")[1]
     params = {"next": next_token, "limit": limit}

tests/test_opportunity.py

@@ -104,6 +104,9 @@ def test_search_opportunities_pagination(
     mock_test_pagination_opportunities: List[Opportunity],
 ) -> None:
     product_backend._opportunities = mock_test_pagination_opportunities
+    expected_returns = [
+        x.model_dump(mode="json") for x in mock_test_pagination_opportunities
+    ]
 
     now = datetime.now(UTC)
     start = now
@@ -133,6 +136,6 @@ def test_search_opportunities_pagination(
         method="POST",
         limit=2,
         target="features",
-        expected_total_returns=3,
+        expected_returns=expected_returns,
         body=request_payload,
     )

tests/test_order.py

@@ -1,3 +1,4 @@
+import copy
 from datetime import UTC, datetime, timedelta, timezone
 
 import pytest
@@ -7,7 +8,7 @@
 from geojson_pydantic.types import Position2D
 from httpx import Response
 
-from stapi_fastapi.models.order import OrderPayload, OrderStatus, OrderStatusCode
+from stapi_fastapi.models.order import Order, OrderPayload, OrderStatus, OrderStatusCode
 from tests.conftest import pagination_tester
 
 from .application import InMemoryOrderDB, MyOrderParameters
@@ -149,27 +150,43 @@ def test_order_status_after_create(
 
 
 @pytest.fixture
-def setup_orders_pagination(stapi_client: TestClient, create_order_payloads) -> None:
+def setup_orders_pagination(
+    stapi_client: TestClient, create_order_payloads
+) -> list[Order]:
     product_id = "test-spotlight"
-
+    orders = []
+    # t = {'id': 'dc2d9027-a670-475b-878c-a5a6e8ab022b', 'type': 'Feature', 'geometry': {'type': 'Point', 'coordinates': [14.4, 56.5]}, 'properties': {'product_id': 'test-spotlight', 'created': '2025-01-16T19:09:45.448059Z', 'status': {'timestamp': '2025-01-16T19:09:45.447952Z', 'status_code': 'received', 'reason_code': None, 'reason_text': None, 'links': []}, 'search_parameters': {'datetime': '2024-10-09T18:55:33+00:00/2024-10-12T18:55:33+00:00', 'geometry': {'type': 'Point', 'coordinates': [14.4, 56.5]}, 'filter': None}, 'opportunity_properties': {'datetime': '2024-01-29T12:00:00Z/2024-01-30T12:00:00Z', 'off_nadir': 10}, 'order_parameters': {'s3_path': 's3://my-bucket'}}, 'links': [{'href': 'http://stapiserver/orders/dc2d9027-a670-475b-878c-a5a6e8ab022b', 'rel': 'self', 'type': 'application/geo+json'}, {'href': 'http://stapiserver/orders/dc2d9027-a670-475b-878c-a5a6e8ab022b/statuses', 'rel': 'monitor', 'type': 'application/json'}, {'href': 'http://stapiserver/orders/dc2d9027-a670-475b-878c-a5a6e8ab022b', 'rel': 'self', 'type': 'application/json'}]}
     for order in create_order_payloads:
         res = stapi_client.post(
             f"products/{product_id}/orders",
             json=order.model_dump(),
         )
+        body = res.json()
+        orders.append(body)
 
         assert res.status_code == status.HTTP_201_CREATED, res.text
         assert res.headers["Content-Type"] == "application/geo+json"
 
+    return orders
+
+
+def test_order_pagination(
+    setup_orders_pagination, create_order_payloads, stapi_client: TestClient
+) -> None:
+    expected_returns = []
+    for order in setup_orders_pagination:
+        json_link = copy.deepcopy(order["links"][0])
+        json_link["type"] = "application/json"
+        order["links"].append(json_link)
+        expected_returns.append(order)
 
-def test_order_pagination(setup_orders_pagination, stapi_client: TestClient) -> None:
     pagination_tester(
         stapi_client=stapi_client,
         endpoint="/orders",
         method="GET",
         limit=2,
         target="features",
-        expected_total_returns=3,
+        expected_returns=expected_returns,
     )
 
 
@@ -213,14 +230,15 @@ def test_order_status_pagination(
     order_db._statuses = order_statuses
 
     order_id = "test_order_id"
+    expected_returns = [x.model_dump(mode="json") for x in order_statuses[order_id]]
 
     pagination_tester(
         stapi_client=stapi_client,
         endpoint=f"/orders/{order_id}/statuses",
         method="GET",
         limit=2,
         target="statuses",
-        expected_total_returns=3,
+        expected_returns=expected_returns,
     )
 
 

tests/test_product.py

@@ -67,14 +67,49 @@ def test_product_order_parameters_response(
     assert "s3_path" in json_schema["properties"]
 
 
-def test_product_pagination(stapi_client: TestClient):
+def test_product_pagination(
+    stapi_client: TestClient, mock_product_test_spotlight, mock_product_test_wolf_cola
+):
+    expected_returns = []
+    for product in [mock_product_test_spotlight, mock_product_test_wolf_cola]:
+        prod = product.model_dump(mode="json", by_alias=True)
+        product_id = prod["id"]
+        prod["links"] = [
+            {
+                "href": f"http://stapiserver/products/{product_id}",
+                "rel": "self",
+                "type": "application/json",
+            },
+            {
+                "href": f"http://stapiserver/products/{product_id}/constraints",
+                "rel": "constraints",
+                "type": "application/json",
+            },
+            {
+                "href": f"http://stapiserver/products/{product_id}/order-parameters",
+                "rel": "order-parameters",
+                "type": "application/json",
+            },
+            {
+                "href": f"http://stapiserver/products/{product_id}/opportunities",
+                "rel": "opportunities",
+                "type": "application/json",
+            },
+            {
+                "href": f"http://stapiserver/products/{product_id}/orders",
+                "rel": "create-order",
+                "type": "application/json",
+            },
+        ]
+        expected_returns.append(prod)
+
     pagination_tester(
         stapi_client=stapi_client,
         endpoint="/products",
         method="GET",
         limit=1,
         target="products",
-        expected_total_returns=2,
+        expected_returns=expected_returns,
     )