Add test information

Author: simonkurtz-MSFT

infrastructure/afd-apim-pe/create.ipynb

@@ -187,7 +187,7 @@
     "from apimtesting import ApimTesting\n",
     "\n",
     "reqs = ApimRequests(apim_gateway_url)\n",
-    "tests = ApimTesting(\"AFD-APIM-PE Tests (Pre-Lockdown)\")\n",
+    "tests = ApimTesting(\"AFD-APIM-PE Tests (Pre-Lockdown)\", deployment, deployment)\n",
     "\n",
     "utils.print_message('Calling Hello World (Root) API via API Management Gateway URL. Expect 200 (if run before disabling API Management public network access).')\n",
     "output = reqs.singleGet('/')\n",
@@ -255,7 +255,7 @@
     "\n",
     "reqsApim = ApimRequests(apim_gateway_url)\n",
     "reqsAfd  = ApimRequests(afd_endpoint_url)\n",
-    "tests = ApimTesting(\"AFD-APIM-PE Tests (Post-Lockdown)\")\n",
+    "tests = ApimTesting(\"AFD-APIM-PE Tests (Post-Lockdown)\", deployment, deployment)\n",
     "\n",
     "# 1) Unsuccessful call to APIM Gateway URL (should fail with 403 Forbidden)\n",
     "output = reqsApim.singleGet('/', msg = '1) Calling Hello World (Root) API via API Management Gateway URL. Expect 403 as APIM public access is disabled now.')\n",

infrastructure/apim-aca/create.ipynb

@@ -130,7 +130,7 @@
     "from apimtesting import ApimTesting\n",
     "\n",
     "reqs = ApimRequests(apim_gateway_url)\n",
-    "tests = ApimTesting(\"APIM-ACA Tests\")\n",
+    "tests = ApimTesting(\"APIM-ACA Tests\", deployment, deployment)\n",
     "\n",
     "output = reqs.singleGet('/', msg = 'Calling Hello World (Root) API')\n",
     "tests.verify(output, 'Hello World from API Management!')\n",

infrastructure/simple-apim/create.ipynb

@@ -112,7 +112,7 @@
     "from apimtesting import ApimTesting\n",
     "\n",
     "reqs = ApimRequests(apim_gateway_url)\n",
-    "tests = ApimTesting(\"Simple APIM Tests\")\n",
+    "tests = ApimTesting(\"Simple APIM Tests\", deployment, deployment)\n",
     "\n",
     "output = reqs.singleGet('/', msg = 'Calling Hello World (Root) API')\n",
     "tests.verify(output, 'Hello World from API Management!')\n",

samples/authX-pro/create.ipynb

@@ -18,7 +18,6 @@
    "outputs": [],
    "source": [
     "import utils\n",
-    "import time\n",
     "from apimtypes import *\n",
     "\n",
     "# 1) User-defined parameters (change these as needed)\n",
@@ -152,7 +151,7 @@
     "from users import UserHelper\n",
     "from authfactory import AuthFactory\n",
     "\n",
-    "tests = ApimTesting(\"AuthX-Pro Sample Tests\")\n",
+    "tests = ApimTesting(\"AuthX-Pro Sample Tests\", sample_folder, deployment)\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 = utils.test_url_preflight_check(deployment, rg_name, apim_gateway_url)\n",

samples/authX/create.ipynb

@@ -126,7 +126,7 @@
     "from users import UserHelper\n",
     "from authfactory import AuthFactory\n",
     "\n",
-    "tests = ApimTesting(\"AuthX Sample Tests\")\n",
+    "tests = ApimTesting(\"AuthX Sample Tests\", sample_folder, deployment)\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 = utils.test_url_preflight_check(deployment, rg_name, apim_gateway_url)\n",

samples/general/create.ipynb

@@ -100,14 +100,8 @@
     "from apimrequests import ApimRequests\n",
     "from apimtesting import ApimTesting\n",
     "\n",
-    "tests = ApimTesting(\"General Sample Tests\")\n",
+    "tests = ApimTesting(\"General Sample Tests\", sample_folder, deployment)\n",
     "\n",
-    "# 1) Issue a direct request to API Management\n",
-    "reqsApim = ApimRequests(apim_gateway_url)\n",
-    "output = reqsApim.singleGet('/request-headers', msg = 'Calling Request Headers API via API Management Gateway URL. Response codes 200 and 403 are both valid depending on the infrastructure used.')\n",
-    "tests.verify('Host:' in output, True)\n",
-    "\n",
-    "# 2) Issue requests against Front Door.\n",
     "# Check if the infrastructure architecture deployment uses Azure Front Door.\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",
@@ -116,6 +110,10 @@
     "    reqsAfd = ApimRequests(afd_endpoint_url)\n",
     "    output = reqsAfd.singleGet('/request-headers', msg = 'Calling Request Headers API via via Azure Front Door. Expect 200.')\n",
     "    tests.verify('Host:' in output, True)\n",
+    "else:\n",
+    "    # Issue a direct request to API Management\n",
+    "    reqsApim = ApimRequests(apim_gateway_url)\n",
+    "    output = reqsApim.singleGet('/request-headers', msg = 'Calling Request Headers API via API Management Gateway URL. Response codes 200 and 403 are both valid depending on the infrastructure used.')\n",
     "\n",
     "tests.print_summary()\n",
     "\n",

samples/load-balancing/create.ipynb

@@ -116,7 +116,7 @@
     "    utils.print_message(f'Waiting for {sleep_in_s} seconds for the backend timeouts to reset before starting the next set of calls', blank_above = True)\n",
     "    time.sleep(sleep_in_s)  # Wait a bit before the next set of calls to allow for the backend timeouts to reset\n",
     "\n",
-    "tests = ApimTesting(\"Load Balancing Sample Tests\")\n",
+    "tests = ApimTesting(\"Load Balancing Sample Tests\", sample_folder, deployment)\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 = utils.test_url_preflight_check(deployment, rg_name, apim_gateway_url)\n",

samples/secure-blob-access/create.ipynb

@@ -20,7 +20,6 @@
    "outputs": [],
    "source": [
     "import utils\n",
-    "import time\n",
     "from apimtypes import *\n",
     "\n",
     "# 1) User-defined parameters (change these as needed)\n",
@@ -235,7 +234,7 @@
     "            utils.print_error(\"Failed to parse JSON response or response is not in expected format.\")\n",
     "    return response\n",
     "\n",
-    "tests = ApimTesting(\"Secure Blob Access Sample Tests\")\n",
+    "tests = ApimTesting(\"Secure Blob Access Sample Tests\", sample_folder, deployment)\n",
     "\n",
     "# Preflight: Check if the infrastructure architecture deployment uses Azure Front Door\n",
     "endpoint_url = utils.test_url_preflight_check(deployment, rg_name, apim_gateway_url)\n",
@@ -244,7 +243,7 @@
     "utils.print_message('1) Testing with Authorized User', blank_above = True)\n",
     "\n",
     "# Create a JWT with the HR Member role (blob access)\n",
-    "encoded_jwt_token_hr_member = AuthFactory.create_symmetric_jwt_token_for_user(UserHelper.get_user_by_role(Role.HR_MEMBER), jwt_key_value)\n",
+    "encoded_jwt_token_hr_member = AuthFactory.create_symmetric_jwt_token_for_user(UserHelper.get_user_by_role(Role.HR_MEMBER), nb_helper.jwt_key_value)\n",
     "print(f'\\nJWT token for HR Member:\\n{encoded_jwt_token_hr_member}')  # this value is used to call the APIs via APIM\n",
     "\n",
     "# Set up APIM requests with authorized JWT\n",
@@ -260,7 +259,7 @@
     "# 2) Test with unauthorized user (has blob access role)\n",
     "utils.print_message('2) Testing with Unauthorized User', blank_above = True)\n",
     "\n",
-    "encoded_jwt_token_no_role = AuthFactory.create_symmetric_jwt_token_for_user(UserHelper.get_user_by_role(Role.NONE), jwt_key_value)\n",
+    "encoded_jwt_token_no_role = AuthFactory.create_symmetric_jwt_token_for_user(UserHelper.get_user_by_role(Role.NONE), nb_helper.jwt_key_value)\n",
     "print(f'\\nJWT token for user with no role:\\n{encoded_jwt_token_no_role}')  # this value is used to call the APIs via APIM\n",
     "\n",
     "# Set up APIM requests with unauthorized JWT\n",

shared/python/apimtesting.py

@@ -2,6 +2,7 @@
 Rudimentary test framework to offload validations from the Jupyter notebooks. 
 """
 
+from apimtypes import INFRASTRUCTURE
 
 # ------------------------------
 #    CLASSES
@@ -16,14 +17,18 @@ class ApimTesting:
     #    CONSTRUCTOR
     # ------------------------------
 
-    def __init__(self, test_suite_name: str = 'APIM Tests') -> None:
+    def __init__(self, test_suite_name: str = 'APIM Tests', sample_name: str = None, deployment: INFRASTRUCTURE = None) -> None:
         """
         Initialize the ApimTesting instance.
 
         Args:
             test_suite_name (str, optional): The name of the test suite. Defaults to 'APIM Tests'.
+            sample_name (str, optional): The name of the sample being tested. Defaults to None.
+            deployment (str, optional): The deployment name (INFRASTRUCTURE)
         """
         self.test_suite_name = test_suite_name
+        self.sample_name = sample_name
+        self.deployment = deployment
         self.tests_passed = 0
         self.tests_failed = 0
         self.total_tests = 0
@@ -75,14 +80,17 @@ def print_summary(self) -> None:
         # Create padded title
         title = f"🧪 {self.test_suite_name} - Test Results Summary 🧪"
         title_padding = max(0, (border_width - len(title)) // 2)
-        
+
         # Start the fancy display
         print('\n')  # Blank lines for spacing
         print(border_line)
         print(f'{' ' * title_padding}{title}')
         print(border_line)
         print()
 
+        print(f' Sample Name : {self.sample_name if self.sample_name else "N/A"}')
+        print(f' Deployment  : {self.deployment.name if self.deployment else "N/A"}\n')
+
         # Test statistics with visual indicators
         print(f'📊 Test Execution Statistics:')
         print(f'    • Total Tests  : {self.total_tests:>5}')
@@ -109,9 +117,7 @@ def print_summary(self) -> None:
             print('🔍 Detailed Error Analysis:')
             print('─' * 50)
             for i, error in enumerate(self.errors, 1):
-                print(f'{i:>2}.\n{error}')
-        else:
-            print('✅ No errors encountered - Everything looks great!')
+                print(f'{i:>2}. {error}\n')
 
         print()
         print(border_line)

shared/python/utils.py

@@ -921,7 +921,7 @@ def get_frontdoor_url(deployment_name: INFRASTRUCTURE, rg_name: str) -> str | No
     if afd_endpoint_url:
         print_ok(f"Front Door Endpoint URL: {afd_endpoint_url}", blank_above = False)
     else:
-        print_error("No Front Door endpoint URL found. Please check the deployment and ensure that Azure Front Door is configured correctly.")
+        print_warning("No Front Door endpoint URL found.")
 
     return afd_endpoint_url
 
@@ -1288,7 +1288,7 @@ def cleanup_old_jwt_signing_keys(apim_name: str, resource_group_name: str, curre
                     deleted_count += 1
 
         # Summary
-        print_success(f"JWT signing key cleanup completed. Deleted {deleted_count} old keys, kept {kept_count}'.", blank_above = True)
+        print_success(f"JWT signing key cleanup completed. Deleted {deleted_count} old key(s), kept {kept_count}'.", blank_above = True)
         return True
 
     except Exception as e: