Raise the new exceptions in the client

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

src/frequenz/client/microgrid/_client.py

@@ -90,19 +90,21 @@ async def components(self) -> Iterable[Component]:
             Iterator whose elements are all the components in the microgrid.
 
         Raises:
-            ClientError: If the connection to the Microgrid API cannot be established or
-                when the api call exceeded the timeout.
+            ClientError: If the are any errors communicating with the Microgrid API,
+                most likely a subclass of
+                [GrpcStatusError][frequenz.client.microgrid.GrpcStatusError].
         """
         try:
             component_list = await self.api.list_components(
                 pb_microgrid.ComponentFilter(),
                 timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
             )
-
-        except grpclib.GRPCError as err:
-            raise ClientError(
-                f"Failed to list components. Microgrid API: {self._server_url}. Err: {err}"
-            ) from err
+        except grpclib.GRPCError as grpc_error:
+            raise ClientError.from_grpc_error(
+                server_url=self._server_url,
+                operation="list_components",
+                grpc_error=grpc_error,
+            ) from grpc_error
 
         components_only = filter(
             lambda c: c.category
@@ -168,8 +170,9 @@ async def connections(
             Microgrid connections matching the provided start and end filters.
 
         Raises:
-            ClientError: If the connection to the Microgrid API cannot be established or
-                when the api call exceeded the timeout.
+            ClientError: If the are any errors communicating with the Microgrid API,
+                most likely a subclass of
+                [GrpcStatusError][frequenz.client.microgrid.GrpcStatusError].
         """
         connection_filter = pb_microgrid.ConnectionFilter(
             starts=list(starts), ends=list(ends)
@@ -182,10 +185,12 @@ async def connections(
                     timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
                 ),
             )
-        except grpclib.GRPCError as err:
-            raise ClientError(
-                f"Failed to list connections. Microgrid API: {self._server_url}. Err: {err}"
-            ) from err
+        except grpclib.GRPCError as grpc_error:
+            raise ClientError.from_grpc_error(
+                server_url=self._server_url,
+                operation="list_connections",
+                grpc_error=grpc_error,
+            ) from grpc_error
         # Filter out the components filtered in `components` method.
         # id=0 is an exception indicating grid component.
         valid_ids = {c.component_id for c in valid_components}
@@ -384,8 +389,9 @@ async def set_power(self, component_id: int, power_w: float) -> None:
             power_w: power to set for the component.
 
         Raises:
-            ClientError: If the connection to the Microgrid API cannot be established or
-                when the api call exceeded the timeout.
+            ClientError: If the are any errors communicating with the Microgrid API,
+                most likely a subclass of
+                [GrpcStatusError][frequenz.client.microgrid.GrpcStatusError].
         """
         try:
             await self.api.set_power_active(
@@ -394,10 +400,12 @@ async def set_power(self, component_id: int, power_w: float) -> None:
                 ),
                 timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
             )
-        except grpclib.GRPCError as err:
-            raise ClientError(
-                f"Failed to set power. Microgrid API: {self._server_url}. Err: {err}"
-            ) from err
+        except grpclib.GRPCError as grpc_error:
+            raise ClientError.from_grpc_error(
+                server_url=self._server_url,
+                operation="set_power_active",
+                grpc_error=grpc_error,
+            ) from grpc_error
 
     async def set_bounds(
         self,
@@ -415,10 +423,10 @@ async def set_bounds(
         Raises:
             ValueError: when upper bound is less than 0, or when lower bound is
                 greater than 0.
-            ClientError: If the connection to the Microgrid API cannot be established or
-                when the api call exceeded the timeout.
+            ClientError: If the are any errors communicating with the Microgrid API,
+                most likely a subclass of
+                [GrpcStatusError][frequenz.client.microgrid.GrpcStatusError].
         """
-        api_details = f"Microgrid API: {self._server_url}."
         if upper < 0:
             raise ValueError(f"Upper bound {upper} must be greater than or equal to 0.")
         if lower > 0:
@@ -436,15 +444,9 @@ async def set_bounds(
                 ),
                 timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
             )
-        except grpclib.GRPCError as err:
-            _logger.error(
-                "set_bounds write failed: %s, for message: %s, api: %s. Err: %s",
-                err,
-                next,
-                api_details,
-                err,
-            )
-            raise ClientError(
-                f"Failed to set inclusion bounds. Microgrid API: {self._server_url}. "
-                f"Err: {err}"
-            ) from err
+        except grpclib.GRPCError as grpc_error:
+            raise ClientError.from_grpc_error(
+                server_url=self._server_url,
+                operation="add_inclusion_bounds",
+                grpc_error=grpc_error,
+            ) from grpc_error

tests/test_client.py

@@ -187,12 +187,13 @@ async def test_components_grpc_error() -> None:
     """Test the components() method when the gRPC call fails."""
     client = _TestClient()
     client.mock_stub.list_components.side_effect = grpclib.GRPCError(
-        mock.MagicMock(name="mock status"), "fake grpc error"
+        mock.MagicMock(name="mock_status"), "fake grpc error", "fake details"
     )
     with pytest.raises(
         ClientError,
-        match="Failed to list components. Microgrid API: grpc://mock_host:1234. "
-        "Err: .*fake grpc error",
+        match=r"Failed calling 'list_components' on 'grpc://mock_host:1234': .* "
+        r"<status=<MagicMock name='mock_status\.name' id='.*'>>: fake grpc error "
+        r"\(fake details\)",
     ):
         await client.components()
 
@@ -327,12 +328,13 @@ async def test_connections_grpc_error() -> None:
     """Test the components() method when the gRPC call fails."""
     client = _TestClient()
     client.mock_stub.list_connections.side_effect = grpclib.GRPCError(
-        mock.MagicMock(name="mock status"), "fake grpc error"
+        mock.MagicMock(name="mock_status"), "fake grpc error", "fake details"
     )
     with pytest.raises(
         ClientError,
-        match="Failed to list connections. Microgrid API: grpc://mock_host:1234. "
-        "Err: .*fake grpc error",
+        match=r"Failed calling 'list_connections' on 'grpc://mock_host:1234': .* "
+        r"<status=<MagicMock name='mock_status\.name' id='.*'>>: fake grpc error "
+        r"\(fake details\)",
     ):
         await client.connections()
 
@@ -543,12 +545,13 @@ async def test_set_power_grpc_error() -> None:
     """Test set_power() raises ClientError when the gRPC call fails."""
     client = _TestClient()
     client.mock_stub.set_power_active.side_effect = grpclib.GRPCError(
-        mock.MagicMock(name="mock status"), "fake grpc error"
+        mock.MagicMock(name="mock_status"), "fake grpc error", "fake details"
     )
     with pytest.raises(
         ClientError,
-        match="Failed to set power. Microgrid API: grpc://mock_host:1234. "
-        "Err: .*fake grpc error",
+        match=r"Failed calling 'set_power_active' on 'grpc://mock_host:1234': .* "
+        r"<status=<MagicMock name='mock_status\.name' id='.*'>>: fake grpc error "
+        r"\(fake details\)",
     ):
         await client.set_power(component_id=83, power_w=100.0)
 
@@ -609,11 +612,12 @@ async def test_set_bounds_grpc_error() -> None:
     """Test the components() method when the gRPC call fails."""
     client = _TestClient()
     client.mock_stub.add_inclusion_bounds.side_effect = grpclib.GRPCError(
-        mock.MagicMock(name="mock status"), "fake grpc error"
+        mock.MagicMock(name="mock_status"), "fake grpc error", "fake details"
     )
     with pytest.raises(
         ClientError,
-        match="Failed to set inclusion bounds. Microgrid API: grpc://mock_host:1234. "
-        "Err: .*fake grpc error",
+        match=r"Failed calling 'add_inclusion_bounds' on 'grpc://mock_host:1234': .* "
+        r"<status=<MagicMock name='mock_status\.name' id='.*'>>: fake grpc error "
+        r"\(fake details\)",
     ):
         await client.set_bounds(99, 0.0, 100.0)