Add test_url_preflight_check

Author: simonkurtz-MSFT

samples/authX-pro/create.ipynb

@@ -231,15 +231,7 @@
     "from authfactory import AuthFactory\n",
     "\n",
     "# Preflight: Check if the infrastructure architecture deployment uses Azure Front Door. If so, assume that APIM is not directly accessible and use the Front Door URL instead.\n",
-    "endpoint_url = apim_gateway_url\n",
-    "utils.print_message('Checking if the infrastructure architecture deployment uses Azure Front Door.', blank_above = True)\n",
-    "afd_endpoint_url = utils.get_frontdoor_url(deployment, rg_name)\n",
-    "\n",
-    "if afd_endpoint_url:\n",
-    "    endpoint_url = afd_endpoint_url\n",
-    "    utils.print_message(f'Using Azure Front Door URL: {afd_endpoint_url}', blank_above = True)\n",
-    "else:\n",
-    "    utils.print_message(f'Using APIM Gateway URL: {apim_gateway_url}', blank_above = True)\n",
+    "endpoint_url = utils.test_url_preflight_check(deployment, rg_name, apim_gateway_url)\n",
     "\n",
     "# 1) HR Administrator\n",
     "# Create a JSON Web Token with a payload and sign it with the symmetric key from above.\n",

samples/authX/create.ipynb

@@ -193,15 +193,7 @@
     "from authfactory import AuthFactory\n",
     "\n",
     "# Preflight: Check if the infrastructure architecture deployment uses Azure Front Door. If so, assume that APIM is not directly accessible and use the Front Door URL instead.\n",
-    "endpoint_url = apim_gateway_url\n",
-    "utils.print_message('Checking if the infrastructure architecture deployment uses Azure Front Door.', blank_above = True)\n",
-    "afd_endpoint_url = utils.get_frontdoor_url(deployment, rg_name)\n",
-    "\n",
-    "if afd_endpoint_url:\n",
-    "    endpoint_url = afd_endpoint_url\n",
-    "    utils.print_message(f'Using Azure Front Door URL: {afd_endpoint_url}', blank_above = True)\n",
-    "else:\n",
-    "    utils.print_message(f'Using APIM Gateway URL: {apim_gateway_url}', blank_above = True)\n",
+    "endpoint_url = utils.test_url_preflight_check(deployment, rg_name, apim_gateway_url)\n",
     "\n",
     "# 1) HR Administrator\n",
     "# Create a JSON Web Token with a payload and sign it with the symmetric key from above.\n",

samples/load-balancing/create.ipynb

@@ -156,15 +156,7 @@
     "    time.sleep(sleep_in_s)  # Wait a bit before the next set of calls to allow for the backend timeouts to reset\n",
     "\n",
     "# Preflight: Check if the infrastructure architecture deployment uses Azure Front Door. If so, assume that APIM is not directly accessible and use the Front Door URL instead.\n",
-    "utils.print_message('Checking if the infrastructure architecture deployment uses Azure Front Door.', blank_above = True)\n",
-    "afd_endpoint_url = utils.get_frontdoor_url(deployment, rg_name)\n",
-    "\n",
-    "if afd_endpoint_url:\n",
-    "    reqs = ApimRequests(afd_endpoint_url)\n",
-    "    utils.print_message(f'Using Azure Front Door URL: {afd_endpoint_url}', blank_above = True)\n",
-    "else:\n",
-    "    reqs = ApimRequests(apim_gateway_url)\n",
-    "    utils.print_message(f'Using APIM Gateway URL: {apim_gateway_url}', blank_above = True)\n",
+    "endpoint_url = utils.test_url_preflight_check(deployment, rg_name, apim_gateway_url)\n",
     "\n",
     "# 1) Prioritized API calls\n",
     "utils.print_message('1/4: Starting API calls for prioritized distribution (50/50)')\n",

samples/secure-blob-access/create.ipynb

@@ -293,15 +293,7 @@
     "\n",
     "\n",
     "# Preflight: Check if the infrastructure architecture deployment uses Azure Front Door\n",
-    "endpoint_url = apim_gateway_url\n",
-    "utils.print_message('Checking if the infrastructure architecture deployment uses Azure Front Door.', blank_above = True)\n",
-    "afd_endpoint_url = utils.get_frontdoor_url(deployment, rg_name)\n",
-    "\n",
-    "if afd_endpoint_url:\n",
-    "    endpoint_url = afd_endpoint_url\n",
-    "    utils.print_message(f'Using Azure Front Door URL: {afd_endpoint_url}', blank_above = True)\n",
-    "else:\n",
-    "    utils.print_message(f'Using APIM Gateway URL: {apim_gateway_url}', blank_above = True)\n",
+    "endpoint_url = utils.test_url_preflight_check(deployment, rg_name, apim_gateway_url)\n",
     "\n",
     "# 1) Test with authorized user (has blob access role)\n",
     "utils.print_message('1) Testing with Authorized User', blank_above = True)\n",

shared/python/utils.py

@@ -829,7 +829,6 @@ def check_apim_blob_permissions(apim_name: str, storage_account_name: str, resou
 
     return False
 
-
 def wait_for_apim_blob_permissions(apim_name: str, storage_account_name: str, resource_group_name: str, max_wait_minutes: int = 15) -> bool:
     """
     Wait for APIM's managed identity to have Storage Blob Data Reader permissions on the storage account.
@@ -858,3 +857,19 @@ def wait_for_apim_blob_permissions(apim_name: str, storage_account_name: str, re
     print("")
 
     return success
+
+def test_url_preflight_check(deployment: INFRASTRUCTURE, rg_name: str, apim_gateway_url: str) -> str:
+    # Preflight: Check if the infrastructure architecture deployment uses Azure Front Door. If so, assume that APIM is not directly accessible and use the Front Door URL instead.
+
+    print_message('Checking if the infrastructure architecture deployment uses Azure Front Door.', blank_above = True)
+
+    afd_endpoint_url = get_frontdoor_url(deployment, rg_name)
+
+    if afd_endpoint_url:
+        endpoint_url = afd_endpoint_url
+        print_message(f'Using Azure Front Door URL: {afd_endpoint_url}', blank_above = True)
+    else:
+        endpoint_url = apim_gateway_url
+        print_message(f'Using APIM Gateway URL: {apim_gateway_url}', blank_above = True)
+
+    return endpoint_url