Add wrappers for the component data in unit tests (#231)

In the unit tests we have to mock component data with only few
parameters.
Current ComponentData definition doesn't allow for it because
we have to give all class parameters.
We used to avoid that by creating protobuf message with only
necessary data and use it to create ComponentData.
But this approach is complex and not resilient for the changes in the
protobuf api.
This commit wraps ComponentData. Each parameter has default protobuf
value that will be used if no argument was given.

Author: ela-kotulska-frequenz

tests/actor/test_battery_status.py

@@ -7,24 +7,17 @@
 from datetime import datetime, timedelta, timezone
 from typing import Generic, Iterable, List, Optional, Set, Tuple, TypeVar
 
-import frequenz.api.microgrid.microgrid_pb2 as microgrid_pb
 import pytest
-import pytz
 import time_machine
-from frequenz.api.microgrid.battery_pb2 import Battery as PbBattery
 from frequenz.api.microgrid.battery_pb2 import ComponentState as BatteryState
 from frequenz.api.microgrid.battery_pb2 import Error as BatteryError
 from frequenz.api.microgrid.battery_pb2 import ErrorCode as BatteryErrorCode
 from frequenz.api.microgrid.battery_pb2 import RelayState as BatteryRelayState
-from frequenz.api.microgrid.battery_pb2 import State as PbBatteryState
 from frequenz.api.microgrid.common_pb2 import ErrorLevel
 from frequenz.api.microgrid.inverter_pb2 import ComponentState as InverterState
 from frequenz.api.microgrid.inverter_pb2 import Error as InverterError
 from frequenz.api.microgrid.inverter_pb2 import ErrorCode as InverterErrorCode
-from frequenz.api.microgrid.inverter_pb2 import Inverter as PbInverter
-from frequenz.api.microgrid.inverter_pb2 import State as PbInverterState
 from frequenz.channels import Broadcast
-from google.protobuf.timestamp_pb2 import Timestamp  # pylint: disable=no-name-in-module
 from pytest_mock import MockerFixture
 
 from frequenz.sdk.actor.power_distributing._battery_status import (
@@ -40,6 +33,7 @@
     InverterData,
 )
 
+from ..utils.component_data_wrapper import BatteryDataWrapper, InverterDataWrapper
 from ..utils.mock_microgrid import MockMicrogridClient
 
 
@@ -69,29 +63,14 @@ def battery_data(
     Returns:
         BatteryData with given arguments.
     """
-    if timestamp is None:
-        timestamp = datetime.now(tz=pytz.utc)
-
-    # Create protobuf message first. Thanks to that I don't have to specify
-    # all class variables.
-    pb_timestamp = Timestamp()
-    pb_timestamp.FromDatetime(timestamp)
-
-    pb_data = microgrid_pb.ComponentData(
-        id=component_id,
-        ts=pb_timestamp,
-        battery=PbBattery(
-            state=PbBatteryState(
-                component_state=component_state,
-                relay_state=relay_state,
-            ),
-            # We don't need this method in public api. But we need it in unit tests.
-            # pylint: disable=protected-access
-            errors=[] if errors is None else errors,
-        ),
-    )
 
-    return BatteryData.from_proto(pb_data)
+    return BatteryDataWrapper(
+        component_id=component_id,
+        timestamp=datetime.now(tz=timezone.utc) if timestamp is None else timestamp,
+        _relay_state=relay_state,
+        _component_state=component_state,
+        _errors=list(errors) if errors is not None else [],
+    )
 
 
 def inverter_data(
@@ -117,26 +96,13 @@ def inverter_data(
     Returns:
         InverterData with given arguments.
     """
-    if timestamp is None:
-        timestamp = datetime.now(tz=pytz.utc)
-
-    # Create protobuf message first. Thanks to that I don't have to specify
-    # all InverterData class variable.
-    pb_timestamp = Timestamp()
-    pb_timestamp.FromDatetime(timestamp)
-
-    pb_data = microgrid_pb.ComponentData(
-        id=component_id,
-        ts=pb_timestamp,
-        inverter=PbInverter(
-            state=PbInverterState(
-                component_state=component_state,
-            ),
-            errors=[] if errors is None else errors,
-        ),
-    )
 
-    return InverterData.from_proto(pb_data)
+    return InverterDataWrapper(
+        component_id=component_id,
+        timestamp=datetime.now(tz=timezone.utc) if timestamp is None else timestamp,
+        _component_state=component_state,
+        _errors=list(errors) if errors is not None else [],
+    )
 
 
 def component_graph() -> Tuple[Set[Component], Set[Connection]]:

tests/power/test_distribution_algorithm.py

@@ -7,21 +7,14 @@
 from datetime import datetime, timezone
 from typing import Dict, List, Optional
 
-import frequenz.api.microgrid.microgrid_pb2 as microgrid_pb
 import pytest
-from frequenz.api.microgrid.battery_pb2 import Battery
-from frequenz.api.microgrid.battery_pb2 import Data as PbBatteryData
-from frequenz.api.microgrid.battery_pb2 import Properties as BatteryProperties
-from frequenz.api.microgrid.common_pb2 import AC, DC, Bounds
-from frequenz.api.microgrid.common_pb2 import Metric as PbMetric
-from frequenz.api.microgrid.common_pb2 import MetricAggregation
-from frequenz.api.microgrid.inverter_pb2 import Data as PbInverterData
-from frequenz.api.microgrid.inverter_pb2 import Inverter
-from google.protobuf.timestamp_pb2 import Timestamp  # pylint: disable=no-name-in-module
+from frequenz.api.microgrid.common_pb2 import Bounds
 
 from frequenz.sdk.microgrid.component import BatteryData, InverterData
 from frequenz.sdk.power import DistributionAlgorithm, InvBatPair
 
+from ..utils.component_data_wrapper import BatteryDataWrapper, InverterDataWrapper
+
 
 @dataclass
 class Bound:
@@ -46,21 +39,6 @@ class Metric:
     now: Optional[float]
     bound: Optional[Bound] = None
 
-    def to_protobuf(self) -> PbMetric:
-        """Create protobuf Metric message from that instance.
-
-        Returns:
-           Protobuf Metric
-        """
-        if self.now is None:
-            if self.bound is None:
-                return PbMetric()
-            return PbMetric(system_bounds=self.bound.to_protobuf())
-        if self.bound is None:
-            return PbMetric(value=self.now)
-
-        return PbMetric(value=self.now, system_bounds=self.bound.to_protobuf())
-
 
 def battery_msg(  # pylint: disable=too-many-arguments
     component_id: int,
@@ -82,26 +60,16 @@ def battery_msg(  # pylint: disable=too-many-arguments
     Returns:
         Protobuf battery component with data above
     """
-    pb_timestamp = Timestamp()
-    pb_timestamp.FromDatetime(timestamp)
-    capacitypb = capacity.to_protobuf()
-    socpb = soc.to_protobuf()
-    pb_data = microgrid_pb.ComponentData(
-        id=component_id,
-        ts=pb_timestamp,
-        battery=Battery(
-            properties=BatteryProperties(capacity=capacitypb.value),
-            data=PbBatteryData(
-                soc=MetricAggregation(
-                    avg=socpb.value, system_bounds=socpb.system_bounds
-                ),
-                dc=DC(
-                    power=PbMetric(system_bounds=power.to_protobuf()),
-                ),
-            ),
-        ),
+    return BatteryDataWrapper(
+        component_id=component_id,
+        capacity=capacity.now if capacity.now is not None else float("NaN"),
+        soc=soc.now if soc.now is not None else float("NaN"),
+        soc_lower_bound=soc.bound.lower if soc.bound is not None else float("NaN"),
+        soc_upper_bound=soc.bound.upper if soc.bound is not None else float("NaN"),
+        power_lower_bound=power.lower,
+        power_upper_bound=power.upper,
+        timestamp=timestamp,
     )
-    return BatteryData.from_proto(pb_data)
 
 
 def inverter_msg(
@@ -120,20 +88,13 @@ def inverter_msg(
     Returns:
         Protobuf inverter component with data above.
     """
-    pb_timestamp = Timestamp()
-    pb_timestamp.FromDatetime(timestamp)
-    pb_data = microgrid_pb.ComponentData(
-        id=component_id,
-        ts=pb_timestamp,
-        inverter=Inverter(
-            data=PbInverterData(
-                ac=AC(power_active=PbMetric(system_bounds=power.to_protobuf())),
-            )
-        ),
+    return InverterDataWrapper(
+        component_id=component_id,
+        timestamp=timestamp,
+        active_power_lower_bound=power.lower,
+        active_power_upper_bound=power.upper,
     )
 
-    return InverterData.from_proto(pb_data)
-
 
 class TestDistributionAlgorithm:  # pylint: disable=too-many-public-methods
     """Test whether the algorithm works as expected."""
@@ -147,16 +108,16 @@ def create_components_with_capacity(
 
         components: List[InvBatPair] = []
         for i in range(0, num):
-            bat_msg = microgrid_pb.ComponentData(
-                id=2 * i,
-                battery=Battery(properties=BatteryProperties(capacity=capacity[i])),
+            battery_data = BatteryDataWrapper(
+                component_id=2 * i,
+                timestamp=datetime.now(tz=timezone.utc),
+                capacity=capacity[i],
+            )
+            inverter_data = InverterDataWrapper(
+                component_id=2 * i + 1, timestamp=datetime.now(tz=timezone.utc)
             )
-            battery = BatteryData.from_proto(bat_msg)
-
-            inv_msg = microgrid_pb.ComponentData(id=2 * i + 1, inverter=Inverter())
-            inverter = InverterData.from_proto(inv_msg)
 
-            components.append(InvBatPair(battery, inverter))
+            components.append(InvBatPair(battery_data, inverter_data))
         return components
 
     def test_total_capacity_all_0(self) -> None: