Merge pull request #1229 from gooddata/snapshot-master-b7e9aebf-to-rel/dev

[bot] Merge master/b7e9aebf into rel/dev

Author: yenkins-admin

packages/gooddata-pipelines/src/gooddata_pipelines/api/gooddata_api.py

@@ -20,25 +20,11 @@ class ApiMethods:
     def _get_base_url(domain: str) -> str:
         """Returns the root endpoint for the GoodData Cloud API.
 
-        Method ensures that the URL starts with "https://" and does not
-        end with a trailing slash.
-
         Args:
             domain (str): The domain of the GoodData Cloud instance.
         Returns:
             str: The base URL for the GoodData Cloud API.
         """
-        # Remove trailing slash if present.
-        if domain[-1] == "/":
-            domain = domain[:-1]
-
-        if not domain.startswith("https://") and not domain.startswith(
-            "http://"
-        ):
-            domain = f"https://{domain}"
-
-        if domain.startswith("http://") and not domain.startswith("https://"):
-            domain = domain.replace("http://", "https://")
 
         return f"{domain}/api/{API_VERSION}"
 

packages/gooddata-pipelines/src/gooddata_pipelines/api/gooddata_api_wrapper.py

@@ -8,6 +8,7 @@
 from gooddata_pipelines.api.gooddata_sdk import SdkMethods
 
 
+# TODO: Refactor the GoodDataApi class to use composition instead of inheritance.
 class GoodDataApi(SdkMethods, ApiMethods):
     """Wrapper class for the GoodData Cloud API.
 
@@ -22,7 +23,7 @@ def __init__(self, host: str, token: str) -> None:
             host (str): The GoodData Cloud host URL.
             token (str): The authentication token for the GoodData Cloud API.
         """
-        self._domain: str = host
+        self._domain: str = self._get_clean_host(host)
         self._token: str = token
 
         # Initialize the GoodData SDK
@@ -34,3 +35,31 @@ def __init__(self, host: str, token: str) -> None:
             "Authorization": f"Bearer {self._token}",
             "Content-Type": "application/vnd.gooddata.api+json",
         }
+
+    @staticmethod
+    def _get_clean_host(host: str) -> str:
+        """Returns a clean URL of the GoodData Cloud host.
+
+        Method ensures that the URL starts with "https://" and does not
+        end with a trailing slash.
+        """
+
+        if host is None:
+            raise RuntimeError("Host is not set. Please provide a valid host.")
+
+        if host == "":
+            raise ValueError(
+                "Host is an empty string. Please provide a valid host."
+            )
+
+        # Remove trailing slash if present.
+        if host[-1] == "/":
+            host = host[:-1]
+
+        if not host.startswith("https://") and not host.startswith("http://"):
+            host = f"https://{host}"
+
+        if host.startswith("http://") and not host.startswith("https://"):
+            host = host.replace("http://", "https://")
+
+        return host

packages/gooddata-pipelines/tests/panther/test_api_wrapper.py

@@ -6,32 +6,40 @@
     API_VERSION,
     ApiMethods,
 )
+from gooddata_pipelines.api.gooddata_api_wrapper import GoodDataApi
+
+
+def test_get_base_url():
+    """Test the get_base_url method with various domain inputs."""
+    domain = "example.com"
+    expected_base_url = f"example.com/api/{API_VERSION}"
+    result = ApiMethods._get_base_url(domain)
+    assert result == expected_base_url
 
 
 @pytest.mark.parametrize(
-    "domain, expected_base_url",
+    "host, expected_clean_host",
     [
-        ("example.com", f"https://example.com/api/{API_VERSION}"),
+        ("example.com", "https://example.com"),
         (
             "https://example.com",
-            f"https://example.com/api/{API_VERSION}",
+            "https://example.com",
         ),
         (
             "http://example.com",
-            f"https://example.com/api/{API_VERSION}",
+            "https://example.com",
         ),
-        ("example.com/", f"https://example.com/api/{API_VERSION}"),
+        ("example.com/", "https://example.com"),
         (
             "https://example.com/",
-            f"https://example.com/api/{API_VERSION}",
+            "https://example.com",
         ),
         (
             "http://example.com/",
-            f"https://example.com/api/{API_VERSION}",
+            "https://example.com",
         ),
     ],
 )
-def test_get_base_url(domain, expected_base_url):
-    """Test the get_base_url method with various domain inputs."""
-    result = ApiMethods._get_base_url(domain)
-    assert result == expected_base_url
+def test_get_clean_host(host, expected_clean_host):
+    result = GoodDataApi._get_clean_host(host)
+    assert result == expected_clean_host

packages/gooddata-pipelines/tests/provisioning/test_provisioning.py

@@ -119,7 +119,7 @@ def test_create_from_profile() -> None:
         profile="mock_profile",
         profiles_path=Path(f"{TEST_DATA_DIR}/profiles.yaml"),
     )
-    assert provisioner._api._domain == "http://localhost:3000"
+    assert provisioner._api._domain == "https://localhost:3000"
     assert provisioner._api._token == os.environ.pop("MOCK_TOKEN")