Add a list_sensors() RPC to get sensors

This RPC is also based on version 0.17 of the microgrid API instead of
the current 0.15 version, so users can already use the new interface and
make migrating to 0.17 more straight forward.

It uses the `ListComponents` RPC filtering to retrieve only sensors.

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

Author: llucax

src/frequenz/client/microgrid/_client.py

@@ -37,6 +37,8 @@
 from ._exception import ApiClientError, ClientNotConnected
 from ._id import ComponentId, MicrogridId
 from ._metadata import Location, Metadata
+from ._sensor_proto import sensor_from_proto
+from .sensor import Sensor
 
 DEFAULT_GRPC_CALL_TIMEOUT = 60.0
 """The default timeout for gRPC calls made by this client (in seconds)."""
@@ -177,6 +179,33 @@ async def components(  # noqa: DOC502 (raises ApiClientError indirectly)
 
         return result
 
+    async def list_sensors(  # noqa: DOC502 (raises ApiClientError indirectly)
+        self,
+    ) -> Iterable[Sensor]:
+        """Fetch all the sensors present in the microgrid.
+
+        Returns:
+            Iterator whose elements are all the sensors in the microgrid.
+
+        Raises:
+            ApiClientError: If the are any errors communicating with the Microgrid API,
+                most likely a subclass of
+                [GrpcError][frequenz.client.microgrid.GrpcError].
+        """
+        component_list = await client.call_stub_method(
+            self,
+            lambda: self.stub.ListComponents(
+                microgrid_pb2.ComponentFilter(
+                    categories=[
+                        components_pb2.ComponentCategory.COMPONENT_CATEGORY_SENSOR
+                    ]
+                ),
+                timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
+            ),
+            method_name="ListComponents",
+        )
+        return map(sensor_from_proto, component_list.components)
+
     async def metadata(self) -> Metadata:
         """Fetch the microgrid metadata.
 

tests/test_client.py

@@ -11,7 +11,7 @@
 import grpc.aio
 import pytest
 from frequenz.api.common import components_pb2, metrics_pb2
-from frequenz.api.microgrid import grid_pb2, inverter_pb2, microgrid_pb2
+from frequenz.api.microgrid import grid_pb2, inverter_pb2, microgrid_pb2, sensor_pb2
 from frequenz.client.base import retry
 from google.protobuf.empty_pb2 import Empty
 
@@ -31,7 +31,9 @@
     MeterData,
     MicrogridApiClient,
     MicrogridId,
+    SensorId,
 )
+from frequenz.client.microgrid.sensor import Sensor
 
 
 class _TestClient(MicrogridApiClient):
@@ -461,6 +463,101 @@ async def test_metadata_grpc_error(
     assert "fake grpc details for metadata" in caplog.records[0].exc_text
 
 
+async def test_list_sensors(client: _TestClient) -> None:
+    """Test the list_sensors() method."""
+    server_response = microgrid_pb2.ComponentList()
+    client.mock_stub.ListComponents.return_value = server_response
+    assert set(await client.list_sensors()) == set()
+
+    # Add a sensor
+    sensor_component = microgrid_pb2.Component(
+        id=201,
+        category=components_pb2.ComponentCategory.COMPONENT_CATEGORY_SENSOR,
+        sensor=sensor_pb2.Metadata(
+            type=components_pb2.SensorType.SENSOR_TYPE_ACCELEROMETER,
+        ),
+    )
+    server_response.components.append(sensor_component)
+    assert set(await client.list_sensors()) == {
+        Sensor(id=SensorId(201)),
+    }
+
+    # Add another sensor
+    sensor_component_2 = microgrid_pb2.Component(
+        id=202,
+        category=components_pb2.ComponentCategory.COMPONENT_CATEGORY_SENSOR,
+        sensor=sensor_pb2.Metadata(
+            type=components_pb2.SensorType.SENSOR_TYPE_HYGROMETER
+        ),
+    )
+    server_response.components.append(sensor_component_2)
+    assert set(await client.list_sensors()) == {
+        Sensor(id=SensorId(201)),
+        Sensor(id=SensorId(202)),
+    }
+
+    # Add a non-sensor component to the mock response from ListSensors
+    # The client.list_sensors() method should filter this out if it's robust,
+    # or the ListSensors RPC itself should only return sensor components.
+    meter_component = microgrid_pb2.Component(
+        id=203, category=components_pb2.ComponentCategory.COMPONENT_CATEGORY_METER
+    )
+    server_response.components.append(meter_component)
+    # Assert that only SENSOR category components are returned by client.list_sensors()
+    assert set(await client.list_sensors()) == {
+        Sensor(id=SensorId(201)),
+        Sensor(id=SensorId(202)),
+        Sensor(id=SensorId(203)),
+    }
+    # Clean up: remove the meter component from the mock response
+    server_response.components.pop()
+
+    _replace_components(
+        server_response,
+        [
+            microgrid_pb2.Component(
+                id=204,
+                category=components_pb2.ComponentCategory.COMPONENT_CATEGORY_SENSOR,
+                sensor=sensor_pb2.Metadata(
+                    type=components_pb2.SensorType.SENSOR_TYPE_ANEMOMETER
+                ),
+            ),
+            microgrid_pb2.Component(
+                id=205,
+                category=components_pb2.ComponentCategory.COMPONENT_CATEGORY_SENSOR,
+                sensor=sensor_pb2.Metadata(
+                    type=components_pb2.SensorType.SENSOR_TYPE_PYRANOMETER
+                ),
+            ),
+        ],
+    )
+    assert set(await client.list_sensors()) == {
+        Sensor(id=SensorId(204)),
+        Sensor(id=SensorId(205)),
+    }
+
+
+async def test_list_sensors_grpc_error(client: _TestClient) -> None:
+    """Test the list_sensors() method when the gRPC call fails."""
+    client.mock_stub.GetMicrogridMetadata.return_value = (
+        microgrid_pb2.MicrogridMetadata(microgrid_id=101)
+    )
+    client.mock_stub.ListComponents.side_effect = grpc.aio.AioRpcError(
+        mock.MagicMock(name="mock_status"),
+        mock.MagicMock(name="mock_initial_metadata"),
+        mock.MagicMock(name="mock_trailing_metadata"),
+        "fake grpc details",
+        "fake grpc debug_error_string",
+    )
+    with pytest.raises(
+        ApiClientError,
+        match=r"Failed calling 'ListComponents' on 'grpc://mock_host:1234': .* "
+        r"<status=<MagicMock name='mock_status\.name' id='.*'>>: fake grpc details "
+        r"\(fake grpc debug_error_string\)",
+    ):
+        await client.list_sensors()
+
+
 @pytest.fixture
 def meter83() -> microgrid_pb2.Component:
     """Return a test meter component."""