Added find_api_root() to standardize URL building-blocks.

(cherry picked from commit ff7a190)

Author: ggainey

CHANGES/+api_root_changes.feature

@@ -0,0 +1 @@
+Added `pulpcore.app.find_url.find_api_root()` to standardize Pulp url-creation.

pulp_file/tests/unit/test_serializers.py

@@ -2,17 +2,13 @@
 from django.core.files.uploadedfile import SimpleUploadedFile
 from django.test import TestCase
 
+from pulpcore.plugin.find_url import find_api_root
 from pulpcore.plugin.models import Artifact
 
 from pulp_file.app.models import FileContent
 from pulp_file.app.serializers import FileContentSerializer
 
-V3_API_ROOT = (
-    settings.V3_API_ROOT
-    if not settings.DOMAIN_ENABLED
-    else settings.V3_DOMAIN_API_ROOT.replace("<slug:pulp_domain>", "default")
-)
-
+_, V3_API_ROOT = find_api_root(domain="default")
 
 CHECKSUM_LEN = {
     "md5": 32,

pulpcore/app/find_url.py

@@ -0,0 +1,49 @@
+from django.conf import settings
+
+DOMAIN_SLUG = "<slug:pulp_domain>"
+REWRITE_SLUG = "/<path:api_root>/"
+
+
+# We isolate this utility-function to avoid pulling in random "Django App must be configured"
+# code segments from the rest of the .util methods/imports
+def find_api_root(version="v3", set_domain=True, domain=None, lstrip=False, rewrite_header=True):
+    """
+    Returns the tuple (api-root, <root>/api/<version>)
+
+    Args:
+        version (str): API-version desired
+        set_domain (bool): Should the domain-slug be included if DOMAIN_ENABLED?
+        domain (str): Domain-name to replace DOMAIN_SLUG
+        lstrip (bool): Should the full version have it's leading-/ stripped
+        rewrite_header (bool): Should API_ROOT_REWRITE_HEADER be honored or not
+
+    Examples:
+        find_api_root() : ("/pulp/", "/pulp/api/v3/")
+        find_api_root(), DOMAIN_ENABLED: ("/pulp/", "/pulp/<slug:pulp_domain>/api/v3/")
+        find_api_root(domain="default"), DOMAIN_ENABLED : ("/pulp/", "/pulp/default/api/v3/")
+        find_api_root(lstrip=True) : ("pulp/", "pulp/api/v3/")
+        find_api_root(), API_ROOT_REWRITE_HEADER: ("/<path:api_root>/", "/<path:api_root>/api/v3/")
+        find_api_root(version="v4", domain="foo", lstrip=True), API_ROOT_REWRITE_HEADER :
+            ("<path:api_root>/", "<path:api_root>/default/api/v4/")
+    Returns:
+        (str, str) : (API_ROOT (possibly re-written), API_ROOT/api/<version>/
+                     (with <domain> if enabled))
+    """
+    # Some current path-building wants to ignore REWRITE - make that possible
+    if rewrite_header and settings.API_ROOT_REWRITE_HEADER:
+        api_root = REWRITE_SLUG
+    else:
+        api_root = settings.API_ROOT
+
+    # Some current path-building wants to ignore DOMAIN - make that possible
+    if set_domain and settings.DOMAIN_ENABLED:
+        if domain:
+            path = f"{api_root}{domain}/api/{version}/"
+        else:
+            path = f"{api_root}{DOMAIN_SLUG}/api/{version}/"
+    else:
+        path = f"{api_root}api/{version}/"
+    if lstrip:
+        return api_root.lstrip("/"), path.lstrip("/")
+    else:
+        return api_root, path

pulpcore/app/settings.py

@@ -557,6 +557,9 @@ def otel_middleware_hook(settings):
     api_root = "/<path:api_root>/"
 else:
     api_root = settings.API_ROOT
+# protocol://host:port/{API_ROOT}{domain}/api/{version}/
+# All of the below are DEPRECATED, and should be replaced by calling
+# pulpcore.plugin.find_url.find_api_root() (q.v.)
 settings.set("V3_API_ROOT", api_root + "api/v3/")  # Not user configurable
 settings.set("V3_DOMAIN_API_ROOT", api_root + "<slug:pulp_domain>/api/v3/")
 settings.set("V3_API_ROOT_NO_FRONT_SLASH", settings.V3_API_ROOT.lstrip("/"))

pulpcore/app/templatetags/pulp_urls.py

@@ -1,8 +1,9 @@
-from django.conf import settings
 from django.template.defaultfilters import register, stringfilter
 from django.template.defaultfilters import urlize as orig_urlize
 from django.utils.safestring import SafeData, mark_safe
 
+from pulpcore.app.find_url import find_api_root
+
 
 @register.filter(needs_autoescape=True)
 @stringfilter
@@ -12,13 +13,19 @@ def urlize(text, autoescape=True):
 
     This filter overwrites the django default implementation to also handle pulp api hrefs.
     """
+    #    urlize() will turn strings into links of they're of the form protocol://site/path.
+    #    We force it to recognize Pulp-api-links by replacing strings in the incoming text of
+    #    the form "API_ROOT/api/v3/whatever", forcing them to look like
+    #    "http://SENTINEL.org/(string)", urlize()ing the result, then undoing the replace to
+    #    lose the http://SENTINEL.org's.
+    _, current_path = find_api_root(set_domain=False, rewrite_header=False)
     safe_input = isinstance(text, SafeData)
-    text = text.replace(settings.V3_API_ROOT, "http://SENTINEL.org" + settings.V3_API_ROOT)
+    text = text.replace(current_path, "http://SENTINEL.org" + current_path)
     if safe_input:
         text = mark_safe(text)
     text = orig_urlize(text, autoescape=autoescape)
     safe_input = isinstance(text, SafeData)
-    text = text.replace("http://SENTINEL.org" + settings.V3_API_ROOT, settings.V3_API_ROOT)
+    text = text.replace("http://SENTINEL.org" + current_path, current_path)
     if safe_input:
         text = mark_safe(text)
     return text

pulpcore/app/urls.py

@@ -26,15 +26,13 @@
     OrphansCleanupViewset,
     ReclaimSpaceViewSet,
 )
+from pulpcore.plugin.find_url import find_api_root
 
-if settings.DOMAIN_ENABLED:
-    API_ROOT = settings.V3_DOMAIN_API_ROOT_NO_FRONT_SLASH
-else:
-    API_ROOT = settings.V3_API_ROOT_NO_FRONT_SLASH
-if settings.API_ROOT_REWRITE_HEADER:
-    V3_API_ROOT = settings.V3_API_ROOT.replace("/<path:api_root>/", settings.API_ROOT)
-else:
-    V3_API_ROOT = settings.V3_API_ROOT
+_, PATH_DOMAIN_REWRITE_NOFRONT = find_api_root(lstrip=True, set_domain=True, rewrite_header=True)
+_, PATH_NODOMAIN_NOREWRITE_NOFRONT = find_api_root(
+    lstrip=True, set_domain=False, rewrite_header=False
+)
+_, PATH_NODOMAIN_REWRITE_NOFRONT = find_api_root(lstrip=True, set_domain=False, rewrite_header=True)
 
 
 class ViewSetNode:
@@ -191,7 +189,7 @@ class PulpDefaultRouter(routers.DefaultRouter):
         SpectacularRedocView.as_view(
             authentication_classes=[],
             permission_classes=[],
-            url=f"{V3_API_ROOT}docs/api.json?include_html=1&pk_path=1",
+            url=f"/{PATH_NODOMAIN_NOREWRITE_NOFRONT}docs/api.json?include_html=1&pk_path=1",
         ),
         name="schema-redoc",
     ),
@@ -200,16 +198,17 @@ class PulpDefaultRouter(routers.DefaultRouter):
         SpectacularSwaggerView.as_view(
             authentication_classes=[],
             permission_classes=[],
-            url=f"{V3_API_ROOT}docs/api.json?include_html=1&pk_path=1",
+            url=f"/{PATH_NODOMAIN_NOREWRITE_NOFRONT}docs/api.json?include_html=1&pk_path=1",
         ),
         name="schema-swagger",
     ),
 ]
 
 urlpatterns = [
-    path(API_ROOT, include(special_views)),
+    path(PATH_DOMAIN_REWRITE_NOFRONT, include(special_views)),
     path("auth/", include("rest_framework.urls")),
-    path(settings.V3_API_ROOT_NO_FRONT_SLASH, include(docs_and_status)),
+    # docs/status aren't "inside" a domain
+    path(PATH_NODOMAIN_REWRITE_NOFRONT, include(docs_and_status)),
 ]
 
 if settings.DOMAIN_ENABLED:
@@ -224,7 +223,7 @@ class NoSchema(p.callback.cls):
         view = NoSchema.as_view(**p.callback.initkwargs)
         name = p.name + "-domains" if p.name else None
         docs_and_status_no_schema.append(path(str(p.pattern), view, name=name))
-    urlpatterns.insert(-1, path(API_ROOT, include(docs_and_status_no_schema)))
+    urlpatterns.insert(-1, path(PATH_DOMAIN_REWRITE_NOFRONT, include(docs_and_status_no_schema)))
 
 if "social_django" in settings.INSTALLED_APPS:
     urlpatterns.append(
@@ -236,7 +235,7 @@ class NoSchema(p.callback.cls):
 
 all_routers = [root_router] + vs_tree.register_with(root_router)
 for router in all_routers:
-    urlpatterns.append(path(API_ROOT, include(router.urls)))
+    urlpatterns.append(path(PATH_DOMAIN_REWRITE_NOFRONT, include(router.urls)))
 
 # If plugins define a urls.py, include them into the root namespace.
 for plugin_pattern in plugin_patterns:

pulpcore/app/util.py

@@ -28,7 +28,6 @@
 
 # a little cache so viewset_for_model doesn't have to iterate over every app every time
 _model_viewset_cache = {}
-STRIPPED_API_ROOT = settings.API_ROOT.strip("/")
 
 
 def reverse(viewname, args=None, kwargs=None, request=None, relative_url=True, **extra):
@@ -42,7 +41,7 @@ def reverse(viewname, args=None, kwargs=None, request=None, relative_url=True, *
     if settings.DOMAIN_ENABLED:
         kwargs.setdefault("pulp_domain", get_domain().name)
     if settings.API_ROOT_REWRITE_HEADER:
-        kwargs.setdefault("api_root", getattr(request, "api_root", STRIPPED_API_ROOT))
+        kwargs.setdefault("api_root", getattr(request, "api_root", settings.API_ROOT.strip("/")))
     if relative_url:
         request = None
     return drf_reverse(viewname, args=args, kwargs=kwargs, request=request, **extra)
@@ -75,7 +74,6 @@ def get_url(model, domain=None, request=None):
     if isinstance(model, model._meta.model):
         view_action = "detail"
         kwargs["pk"] = model.pk
-
     return reverse(get_view_name_for_model(model, view_action), kwargs=kwargs, request=request)
 
 
@@ -297,7 +295,6 @@ def get_view_name_for_model(model_obj, view_action):
     if isinstance(model_obj, models.MasterModel):
         model_obj = model_obj.cast()
     viewset = get_viewset_for_model(model_obj)
-
     # return the complete view name, joining the registered viewset base name with
     # the requested view method.
     for router in all_routers:

pulpcore/openapi/__init__.py

@@ -34,16 +34,21 @@
 
 from pulpcore.app.apps import pulp_plugin_configs
 from pulpcore.app.loggers import deprecation_logger
+from pulpcore.plugin.find_url import find_api_root
 
+# Get the API-ROOT for this installation
+_unused, FULL_API_PATH_NOFRONT = find_api_root(lstrip=True)
+
+# Massage some api-affecting vars to "genericize" them for the spec
 if settings.DOMAIN_ENABLED:
-    API_ROOT_NO_FRONT_SLASH = settings.V3_DOMAIN_API_ROOT_NO_FRONT_SLASH.replace("slug:", "")
-else:
-    API_ROOT_NO_FRONT_SLASH = settings.V3_API_ROOT_NO_FRONT_SLASH
+    FULL_API_PATH_NOFRONT = FULL_API_PATH_NOFRONT.replace("slug:", "")
 if settings.API_ROOT_REWRITE_HEADER:
-    API_ROOT_NO_FRONT_SLASH = API_ROOT_NO_FRONT_SLASH.replace(
+    FULL_API_PATH_NOFRONT = FULL_API_PATH_NOFRONT.replace(
         "<path:api_root>", settings.API_ROOT.strip("/")
     )
-API_ROOT_NO_FRONT_SLASH = API_ROOT_NO_FRONT_SLASH.replace("<", "{").replace(">", "}")
+
+# Final massage to make api-root "openapi compatible"
+FULL_API_PATH_NOFRONT = FULL_API_PATH_NOFRONT.replace("<", "{").replace(">", "}")
 
 # Python does not distinguish integer sizes. The safest assumption is that they are large.
 extend_schema_field(OpenApiTypes.INT64)(serializers.IntegerField)
@@ -59,7 +64,7 @@ class PulpAutoSchema(AutoSchema):
         "patch": "partial_update",
         "delete": "delete",
     }
-    V3_API = API_ROOT_NO_FRONT_SLASH.replace("{pulp_domain}/", "")
+    V3_API = FULL_API_PATH_NOFRONT.replace("{pulp_domain}/", "")
 
     def _tokenize_path(self):
         """
@@ -116,7 +121,7 @@ class MyViewSet(ViewSet):
         tokenized_path = self._tokenize_path()
 
         subpath = "/".join(tokenized_path)
-        operation_keys = subpath.replace(settings.V3_API_ROOT_NO_FRONT_SLASH, "").split("/")
+        operation_keys = subpath.replace(self.V3_API, "").split("/")
         operation_keys = [i.title() for i in operation_keys]
         if len(operation_keys) > 2:
             del operation_keys[1]

pulpcore/plugin/find_url.py

@@ -0,0 +1,3 @@
+from pulpcore.app.find_url import find_api_root
+
+__all__ = ["find_api_root"]

pulpcore/pytest_plugin.py

@@ -20,6 +20,7 @@
 from packaging.version import parse as parse_version
 from yarl import URL
 
+from pulpcore.plugin.find_url import find_api_root
 from pulpcore.tests.functional.utils import (
     SLEEP_TIME,
     TASK_TIMEOUT,
@@ -771,18 +772,18 @@ def pulp_content_origin_with_prefix(pulp_settings):
 
 @pytest.fixture(scope="session")
 def pulp_api_v3_path(pulp_settings, pulp_domain_enabled):
+    root, path = find_api_root(set_domain=True, rewrite_header=False, domain="default")
+
+    # Check that find_api_root() is doing what the tests expect
     if pulp_domain_enabled:
-        v3_api_root = pulp_settings.V3_DOMAIN_API_ROOT
-        v3_api_root = v3_api_root.replace("<slug:pulp_domain>", "default")
+        v3_api_root = f"{pulp_settings.API_ROOT}default/api/v3/"
     else:
-        v3_api_root = pulp_settings.V3_API_ROOT
-    if v3_api_root is None:
-        raise RuntimeError(
-            "This fixture requires the server to have the `V3_API_ROOT` setting set."
-        )
-    if pulp_settings.API_ROOT_REWRITE_HEADER:
-        v3_api_root = v3_api_root.replace("<path:api_root>", pulp_settings.API_ROOT.strip("/"))
-    return v3_api_root
+        v3_api_root = f"{pulp_settings.API_ROOT}api/v3/"
+    assert path == v3_api_root
+
+    if path is None:
+        raise RuntimeError("This fixture requires the server to have the `API_ROOT` setting set.")
+    return path
 
 
 @pytest.fixture(scope="session")