refactor errors

Author: NicoleMGomes

src/sap_cloud_sdk/agentgateway/_lob.py

@@ -122,11 +122,11 @@ def get_ias_client_id_lob() -> str:
     destination properties are returned — no auth token exchange is performed.
 
     Returns:
-        The IAS client ID string, or ``""`` if the destination is not found
-        or the property is absent.
+        The IAS client ID string, or ``""`` if the ``clientId`` property is absent.
 
     Raises:
         EnvironmentError: If ``APPFND_CONHOS_LANDSCAPE`` is not set.
+        AgentGatewaySDKError: If the IAS destination is not found.
         Any exception raised by the destination client.
     """
     dest_name = _ias_dest_name()
@@ -137,10 +137,7 @@ def get_ias_client_id_lob() -> str:
         options=ConsumptionOptions(skip_token_retrieval=True),
     )
     if not dest:
-        logger.warning(
-            "IAS destination '%s' not found — clientId will be empty", dest_name
-        )
-        return ""
+        raise AgentGatewaySDKError(f"IAS destination '{dest_name}' not found")
     return dest.properties.get("clientId", "")
 
 

src/sap_cloud_sdk/agentgateway/agw_client.py

@@ -309,11 +309,10 @@ def get_ias_client_id(self) -> str:
           and returns the ``clientId`` destination property.
 
         Returns:
-            The IAS client ID string, or ``""`` if it cannot be resolved.
+            The IAS client ID string.
 
         Raises:
-            Nothing — failures are caught, logged at WARNING level,
-            and an empty string is returned instead.
+            AgentGatewaySDKError: If the IAS client ID cannot be resolved.
         """
         try:
             credentials_path = detect_customer_agent_credentials()
@@ -326,11 +325,10 @@ def get_ias_client_id(self) -> str:
 
             # LoB flow — read clientId from the IAS destination properties
             return get_ias_client_id_lob()
-        except Exception:
-            logger.warning(
-                "Could not resolve IAS client ID from destination — clientId will be empty"
-            )
-            return ""
+        except AgentGatewaySDKError:
+            raise
+        except Exception as e:
+            raise AgentGatewaySDKError(f"Could not resolve IAS client ID: {e}") from e
 
     @record_metrics(Module.AGENTGATEWAY, Operation.AGENTGATEWAY_LIST_MCP_TOOLS)
     async def list_mcp_tools(

src/sap_cloud_sdk/agentgateway/user-guide.md

@@ -229,7 +229,7 @@ Returns the IAS client ID. Automatically detects agent type:
 - **Customer agents**: reads `client_id` directly from the mounted credentials file.
 - **LoB agents**: fetches the IAS destination (`sap-managed-runtime-ias-{landscape}`) at provider subaccount level and returns the `clientId` destination property.
 
-Returns `""` and logs a `WARNING` if the value cannot be resolved.
+Raises `AgentGatewaySDKError` if the value cannot be resolved.
 
 ```python
 agw_client = create_client(tenant_subdomain="my-tenant")

src/sap_cloud_sdk/destination/client.py

@@ -7,6 +7,7 @@
 from typing import Any, Dict, List, Optional, Callable, TypeVar
 
 from sap_cloud_sdk.core.telemetry import Module, Operation, record_metrics
+from sap_cloud_sdk.core.secret_resolver import read_from_mount_and_fallback_to_env_var
 from sap_cloud_sdk.destination._http import DestinationHttp, API_V1, API_V2
 from sap_cloud_sdk.destination._models import (
     AccessStrategy,
@@ -684,17 +685,12 @@ def get_service_instance_id(self) -> str:
         module ``destination``, instance ``default``).
 
         Returns:
-            The instance ID string, or ``""`` if the secret cannot be resolved.
+            The instance ID string.
 
         Raises:
-            Nothing — resolution failures are caught, logged at WARNING level,
-            and an empty string is returned instead.
+            DestinationOperationError: If the instance ID cannot be resolved from secrets.
         """
         try:
-            from sap_cloud_sdk.core.secret_resolver import (
-                read_from_mount_and_fallback_to_env_var,
-            )
-
             config = _DestinationInstanceConfig()
             read_from_mount_and_fallback_to_env_var(
                 base_volume_mount="/etc/secrets/appfnd",
@@ -704,11 +700,10 @@ def get_service_instance_id(self) -> str:
                 target=config,
             )
             return config.instanceid
-        except Exception:
-            logger.warning(
-                "Could not resolve destination instance ID from secrets — instanceId will be empty"
-            )
-            return ""
+        except Exception as e:
+            raise DestinationOperationError(
+                "Could not resolve destination instance ID from secrets"
+            ) from e
 
     # ---------- Internal helpers ----------
 

src/sap_cloud_sdk/destination/user-guide.md

@@ -755,4 +755,4 @@ The function reads the `instanceid` field from the secret resolved via the stand
 - **Mount path**: `/etc/secrets/appfnd/destination/default/instanceid`
 - **Env var fallback**: `CLOUD_SDK_CFG_DESTINATION_DEFAULT_INSTANCEID`
 
-Returns `""` and logs a `WARNING` if the secret cannot be resolved (e.g., running locally without a binding).
+Raises `DestinationOperationError` if the secret cannot be resolved (e.g., running locally without a binding).

tests/agentgateway/unit/test_agw_client.py

@@ -1012,14 +1012,13 @@ def test_customer_returns_client_id_from_credentials(self):
 
         assert result == "customer-client-id"
 
-    def test_customer_returns_empty_string_on_load_failure(self):
+    def test_customer_raises_on_load_failure(self):
         with (
             patch(_DETECT_CREDS_PATCH, return_value="/etc/ums/credentials/credentials"),
             patch(_LOAD_CREDS_PATCH, side_effect=Exception("parse error")),
         ):
-            result = create_client().get_ias_client_id()
-
-        assert result == ""
+            with pytest.raises(AgentGatewaySDKError, match="Could not resolve IAS client ID"):
+                create_client().get_ias_client_id()
 
     # --- LoB flow ---
 
@@ -1031,11 +1030,10 @@ def test_lob_returns_client_id_from_destination_properties(self, _mock_detect):
         assert result == "lob-client-id"
 
     @_NO_CUSTOMER_CREDS
-    def test_lob_returns_empty_string_when_destination_not_found(self, _mock_detect):
-        with patch(_GET_IAS_CLIENT_ID_LOB_PATCH, return_value=""):
-            result = create_client(tenant_subdomain="my-tenant").get_ias_client_id()
-
-        assert result == ""
+    def test_lob_raises_when_destination_not_found(self, _mock_detect):
+        with patch(_GET_IAS_CLIENT_ID_LOB_PATCH, side_effect=AgentGatewaySDKError("IAS destination 'sap-managed-runtime-ias-eu10' not found")):
+            with pytest.raises(AgentGatewaySDKError, match="IAS destination"):
+                create_client(tenant_subdomain="my-tenant").get_ias_client_id()
 
     @_NO_CUSTOMER_CREDS
     def test_lob_returns_empty_string_when_property_absent(self, _mock_detect):
@@ -1045,13 +1043,7 @@ def test_lob_returns_empty_string_when_property_absent(self, _mock_detect):
         assert result == ""
 
     @_NO_CUSTOMER_CREDS
-    def test_lob_returns_empty_string_and_logs_warning_on_exception(self, _mock_detect):
-        with (
-            patch(_GET_IAS_CLIENT_ID_LOB_PATCH, side_effect=EnvironmentError("APPFND_CONHOS_LANDSCAPE not set")),
-            patch("sap_cloud_sdk.agentgateway.agw_client.logger") as mock_logger,
-        ):
-            result = create_client(tenant_subdomain="my-tenant").get_ias_client_id()
-
-        assert result == ""
-        mock_logger.warning.assert_called_once()
-        assert "clientId" in mock_logger.warning.call_args[0][0]
+    def test_lob_raises_on_exception(self, _mock_detect):
+        with patch(_GET_IAS_CLIENT_ID_LOB_PATCH, side_effect=EnvironmentError("APPFND_CONHOS_LANDSCAPE not set")):
+            with pytest.raises(AgentGatewaySDKError, match="Could not resolve IAS client ID"):
+                create_client(tenant_subdomain="my-tenant").get_ias_client_id()

tests/agentgateway/unit/test_lob.py

@@ -1037,17 +1037,16 @@ def test_returns_client_id_from_destination_properties(self):
             options=ConsumptionOptions(skip_token_retrieval=True),
         )
 
-    def test_returns_empty_string_when_destination_not_found(self):
+    def test_raises_when_destination_not_found(self):
         mock_dest_client = MagicMock()
         mock_dest_client.get_destination.return_value = None
 
         with (
             patch("sap_cloud_sdk.agentgateway._lob._ias_dest_name", return_value="sap-managed-runtime-ias-eu10"),
             patch("sap_cloud_sdk.agentgateway._lob.create_destination_client", return_value=mock_dest_client),
         ):
-            result = get_ias_client_id_lob()
-
-        assert result == ""
+            with pytest.raises(AgentGatewaySDKError, match="sap-managed-runtime-ias-eu10"):
+                get_ias_client_id_lob()
 
     def test_returns_empty_string_when_property_absent(self):
         mock_dest = MagicMock()

tests/destination/unit/test_client.py

@@ -2222,7 +2222,7 @@ def test_patch_destination_labels_without_tenant_uses_provider_context(self):
         assert kwargs["tenant_subdomain"] is None
 
 
-_RESOLVER_PATCH = "sap_cloud_sdk.core.secret_resolver.read_from_mount_and_fallback_to_env_var"
+_RESOLVER_PATCH = "sap_cloud_sdk.destination.client.read_from_mount_and_fallback_to_env_var"
 
 
 class TestGetServiceInstanceId:
@@ -2248,19 +2248,8 @@ def fill_instanceid(*args, **kwargs):
         )
 
     @patch(_RESOLVER_PATCH, side_effect=RuntimeError("mount failed"))
-    def test_returns_empty_string_on_exception(self, _mock_read):
+    def test_raises_on_exception(self, _mock_read):
         client = DestinationClient(MagicMock())
 
-        result = client.get_service_instance_id()
-
-        assert result == ""
-
-    @patch(_RESOLVER_PATCH, side_effect=RuntimeError("mount failed"))
-    def test_logs_warning_on_exception(self, _mock_read):
-        client = DestinationClient(MagicMock())
-
-        with patch("sap_cloud_sdk.destination.client.logger") as mock_logger:
+        with pytest.raises(DestinationOperationError, match="Could not resolve destination instance ID from secrets"):
             client.get_service_instance_id()
-
-        mock_logger.warning.assert_called_once()
-        assert "instanceId" in mock_logger.warning.call_args[0][0]