feat: Updating logic to conditionally the public API url from the yaml config if no regex match

Signed-off-by: S3B4SZ17 <[email protected]>

Author: S3B4SZ17

app_config.yaml

@@ -6,6 +6,7 @@ app:
 
 sysdig:
   host: "https://us2.app.sysdig.com"
+  # public_api_url: "https://<YOUR_CUSTOM_PUBLIC_API_URL>"
 
 mcp:
   transport: stdio

tests/config_test.py

@@ -45,7 +45,5 @@ def test_api_url_format() -> None:
     assert public_api_me2 == region_urls["me2"]["public_url"], (
         f"Expected {region_urls['me2']['public_url']}, got {public_api_me2}"
     )
-    assert public_api_edge == region_urls["edge"]["public_url"], (
-        f"Expected {region_urls['edge']['public_url']}, got {public_api_edge}"
-    )
+    assert not public_api_edge, f"Expected empty string, got {public_api_edge}"
     print("All public API URLs are formatted correctly.")

tests/conftest.py

@@ -43,4 +43,4 @@ def mock_creds():
     Fixture to set up mocked credentials.
     """
     os.environ["SYSDIG_SECURE_TOKEN"] = "mocked_token"
-    os.environ["SYSDIG_HOST"] = "https://mocked.secure"
+    os.environ["SYSDIG_HOST"] = "https://us2.app.sysdig.com"

utils/sysdig/client_config.py

@@ -8,10 +8,15 @@
 import re
 from typing import Optional
 
+# Application config loader
+from utils.app_config import get_app_config
+
 # Set up logging
 logging.basicConfig(format="%(asctime)s-%(process)d-%(levelname)s- %(message)s", level=os.environ.get("LOGLEVEL", "ERROR"))
 log = logging.getLogger(__name__)
 
+app_config = get_app_config()
+
 
 # Lazy-load the Sysdig client configuration
 def get_configuration(
@@ -22,18 +27,36 @@ def get_configuration(
 
     Args:
         token (str): The Sysdig Secure token.
-        sysdig_host_url (str): The base URL of the Sysdig API.
-        old_api (bool): If True, uses the old Sysdig API URL format. Defaults to False.
+        sysdig_host_url (str): The base URL of the Sysdig API,
+            refer to the docs https://docs.sysdig.com/en/administration/saas-regions-and-ip-ranges/#sysdig-platform-regions.
+        old_api (bool): If True, uses the old Sysdig API URL format.
+            Defaults to False using the public API URL format https://api.{region}.sysdig.com.
     Returns:
         sysdig_client.Configuration: A configured Sysdig client instance.
+    Raises:
+        ValueError: If the Sysdig host URL is not provided or is invalid.
     """
     # Check if the token and sysdig_host_url are provided, otherwise fetch from environment variables
     if not token and not sysdig_host_url:
         env_vars = get_api_env_vars()
         token = env_vars["SYSDIG_SECURE_TOKEN"]
         sysdig_host_url = env_vars["SYSDIG_HOST"]
     if not old_api:
+        """
+        Client expecting the public API URL in the format https://api.{region}.sysdig.com. We will check the following:
+        - A valid Sysdig host URL is provided by matching the expected patterns with a regex.
+        - If not, we will try to fetch the public API URL from the app config yaml 'sysdig.public_api_url'.
+        - If neither is available, we will raise an error.
+        """
         sysdig_host_url = _get_public_api_url(sysdig_host_url)
+        if not sysdig_host_url:
+            sysdig_host_url = app_config.get("sysdig", {}).get("public_api_url")
+            if not sysdig_host_url:
+                raise ValueError(
+                    "No valid Sysdig public API URL found. Please check your Sysdig host URL or"
+                    "explicitly set the public API URL in the app config 'sysdig.public_api_url'."
+                    "The expected format is https://api.{region}.sysdig.com."
+                )
         log.info(f"Using public API URL: {sysdig_host_url}")
 
     configuration = sysdig_client.Configuration(
@@ -71,7 +94,7 @@ def _get_public_api_url(base_url: str) -> str:
     This function extracts the region from the base URL and constructs the public API URL in the format
     https://api.{region}.sysdig.com.
 
-    If the base URL does not match any known patterns, it returns the original base URL.
+    If the base URL does not match any known patterns, it returns an empty string.
 
     Args:
         base_url: The base URL of the Sysdig API
@@ -92,5 +115,5 @@ def _get_public_api_url(base_url: str) -> str:
             region = region_fn(match)
             return f"https://api.{region}.sysdig.com"
 
-    log.warning("A not recognized Sysdig URL was provided, returning the same URL. This may lead to unexpected behavior.")
-    return base_url
+    log.warning("A not recognized Sysdig URL was provided, returning an empty string. This may lead to unexpected behavior.")
+    return ""