refactor: use starlette.testclient.TestClient, simplify tests via parametrize

Author: alukach

tests/api/test_links_with_root_path.py

@@ -1,14 +1,12 @@
 import importlib
 
 import pytest
-from httpx import ASGITransport, AsyncClient
+from starlette.testclient import TestClient
 
 from stac_fastapi.pgstac.db import close_db_connection, connect_to_db
 
-root_path_value = "/stac/v1"
-
-# Append the root path to the base URL, this is key to reproducing the issue where the root path appears twice in some links
-base_url = f"http://api.acme.com{root_path_value}"
+BASE_URL = "http://api.acme.com"
+ROOT_PATH = "/stac/v1"
 
 
 @pytest.fixture(scope="function")
@@ -18,7 +16,7 @@ async def app_with_root_path(database, monkeypatch):
     specific ROOT_PATH environment variable and connected to the test database.
     """
 
-    monkeypatch.setenv("ROOT_PATH", root_path_value)
+    monkeypatch.setenv("ROOT_PATH", ROOT_PATH)
     monkeypatch.setenv("PGUSER", database.user)
     monkeypatch.setenv("PGPASSWORD", database.password)
     monkeypatch.setenv("PGHOST", database.host)
@@ -35,108 +33,90 @@ async def app_with_root_path(database, monkeypatch):
 
     # Ensure the app's root_path is configured as expected
     assert (
-        app.root_path == root_path_value
-    ), f"app_with_root_path fixture: app.root_path is '{app.root_path}', expected '{root_path_value}'"
+        app.root_path == ROOT_PATH
+    ), f"app_with_root_path fixture: app.root_path is '{app.root_path}', expected '{ROOT_PATH}'"
 
     await connect_to_db(app, add_write_connection_pool=with_transactions)
     yield app
     await close_db_connection(app)
 
 
 @pytest.fixture(scope="function")
-async def client_with_root_path(app_with_root_path):
-    async with AsyncClient(
-        transport=ASGITransport(app=app_with_root_path),
-        base_url=base_url,
+def client_with_root_path(app_with_root_path):
+    with TestClient(
+        app_with_root_path,
+        base_url=BASE_URL,
+        root_path=ROOT_PATH,
     ) as c:
         yield c
 
 
 @pytest.fixture(scope="function")
-async def loaded_client(client_with_root_path, load_test_data):
+def loaded_client(client_with_root_path, load_test_data):
     col = load_test_data("test_collection.json")
-    resp = await client_with_root_path.post(
+    resp = client_with_root_path.post(
         "/collections",
         json=col,
     )
     assert resp.status_code == 201
     item = load_test_data("test_item.json")
-    resp = await client_with_root_path.post(
+    resp = client_with_root_path.post(
         f"/collections/{col['id']}/items",
         json=item,
     )
     assert resp.status_code == 201
     item = load_test_data("test_item2.json")
-    resp = await client_with_root_path.post(
+    resp = client_with_root_path.post(
         f"/collections/{col['id']}/items",
         json=item,
     )
     assert resp.status_code == 201
     yield client_with_root_path
 
 
-async def test_search_links_are_valid(loaded_client):
-    resp = await loaded_client.get("/search?limit=1")
-    assert resp.status_code == 200
-    response_json = resp.json()
-    assert_links_href(response_json.get("links", []), base_url)
-
-
-async def test_collection_links_are_valid(loaded_client):
-    resp = await loaded_client.get("/collections?limit=1")
+@pytest.mark.parametrize(
+    "path",
+    [
+        "/search?limit=1",
+        "/collections?limit=1",
+        "/collections/test-collection/items?limit=1",
+    ],
+)
+def test_search_links_are_valid(loaded_client, path):
+    resp = loaded_client.get(path)
     assert resp.status_code == 200
     response_json = resp.json()
-    assert_links_href(response_json.get("links", []), base_url)
-
-
-async def test_items_collection_links_are_valid(loaded_client):
-    resp = await loaded_client.get("/collections/test-collection/items?limit=1")
-    assert resp.status_code == 200
-    response_json = resp.json()
-    assert_links_href(response_json.get("links", []), base_url)
-
-
-def assert_links_href(links, url_prefix):
-    """
-    Ensure all links start with the expected URL prefix and check that
-    there is no root_path duplicated in the URL.
-
-    Args:
-        links: List of link dictionaries with 'href' keys
-        url_prefix: Expected URL prefix (e.g., 'http://test/stac/v1')
-    """
-    from urllib.parse import urlparse
 
+    # Ensure all links start with the expected URL prefix and check that
+    # there is no root_path duplicated in the URL.
     failed_links = []
-    parsed_prefix = urlparse(url_prefix)
-    root_path = parsed_prefix.path  # e.g., '/stac/v1'
+    expected_prefix = f"{BASE_URL}{ROOT_PATH}"
 
-    for link in links:
+    for link in response_json.get("links", []):
         href = link["href"]
         rel = link.get("rel", "unknown")
 
         # Check if link starts with the expected prefix
-        if not href.startswith(url_prefix):
+        if not href.startswith(expected_prefix):
             failed_links.append(
                 {
                     "rel": rel,
                     "href": href,
-                    "error": f"does not start with expected prefix '{url_prefix}'",
+                    "error": f"does not start with expected prefix '{expected_prefix}'",
                 }
             )
             continue
 
         # Check for duplicated root path
-        if root_path and root_path != "/":
-            remainder = href[len(url_prefix) :]
-            if remainder.startswith(root_path):
-                failed_links.append(
-                    {
-                        "rel": rel,
-                        "href": href,
-                        "error": f"contains duplicated root path '{root_path}'",
-                    }
-                )
+        remainder = href[len(expected_prefix) :]
+        if remainder.startswith(ROOT_PATH):
+            failed_links.append(
+                {
+                    "rel": rel,
+                    "href": href,
+                    "error": f"contains duplicated root path '{ROOT_PATH}'",
+                }
+            )
 
     # If there are failed links, create a detailed error report
     if failed_links: