Fix CheckWronglyVersionedBaseUrls middleware (for landing pages) (#752)

Ensure the version part is properly checked. Don't use for-else for middleware. Add test for bare versioned base URLs. Ensure `version` is correctly set for test client. Co-authored-by: Matthew Evans <[email protected]>
Materials-Consortia · Mar 25, 2021 · 9079ec1 · 9079ec1
1 parent 0675ebb
commit 9079ec1
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 9 deletions.
diff --git a/optimade/server/middleware.py b/optimade/server/middleware.py
@@ -92,15 +92,12 @@ def check_url(url: StarletteURL):
         """
         base_url = get_base_url(url)
         optimade_path = f"{url.scheme}://{url.netloc}{url.path}"[len(base_url) :]
-        if re.match(r"^/v[0-9]+", optimade_path):
-            for version_prefix in BASE_URL_PREFIXES.values():
-                if optimade_path.startswith(f"{version_prefix}/"):
-                    break
-            else:
-                version_prefix = re.findall(r"(/v[0-9]+(\.[0-9]+){0,2})", optimade_path)
+        match = re.match(r"^(?P<version>/v[0-9]+(\.[0-9]+){0,2}).*", optimade_path)
+        if match is not None:
+            if match.group("version") not in BASE_URL_PREFIXES.values():
                 raise VersionNotSupported(
                     detail=(
-                        f"The parsed versioned base URL {version_prefix[0][0]!r} from "
+                        f"The parsed versioned base URL {match.group('version')!r} from "
                         f"{url} is not supported by this implementation. "
                         f"Supported versioned base URLs are: {', '.join(BASE_URL_PREFIXES.values())}"
                     )

diff --git a/tests/server/middleware/test_versioned_url.py b/tests/server/middleware/test_versioned_url.py
@@ -1,5 +1,5 @@
 """Test CheckWronglyVersionedBaseUrls middleware"""
-import urllib
+import urllib.parse
 
 import pytest
 
@@ -63,7 +63,7 @@ def test_multiple_versions_in_path(both_clients):
                 urllib.parse.urlparse(url)
             )
 
-        # Test also that the a non-valid OPTIMADE version raises
+        # Test also that a non-valid OPTIMADE version raises
         url = f"{CONFIG.base_url}/v0/info"
         with pytest.raises(VersionNotSupported):
             CheckWronglyVersionedBaseUrls(both_clients.app).check_url(
@@ -74,3 +74,14 @@ def test_multiple_versions_in_path(both_clients):
             CONFIG.base_url = org_base_url
         else:
             CONFIG.base_url = None
+
+
+def test_versioned_base_urls(both_clients):
+    """Test the middleware does not wrongly catch requests to versioned base URLs"""
+    from optimade.server.config import CONFIG
+    from optimade.server.routers.utils import BASE_URL_PREFIXES
+
+    for request in BASE_URL_PREFIXES.values():
+        CheckWronglyVersionedBaseUrls(both_clients.app).check_url(
+            urllib.parse.urlparse(f"{CONFIG.base_url}{request}")
+        )
diff --git a/tests/server/utils.py b/tests/server/utils.py
@@ -44,6 +44,8 @@ def __init__(
         if version:
             if not version.startswith("v") and not version.startswith("/v"):
                 version = f"/v{version}"
+            if version.startswith("v"):
+                version = f"/{version}"
             if re.match(r"/v[0-9](.[0-9]){0,2}", version) is None:
                 warnings.warn(
                     f"Invalid version passed to client: {version!r}. "