Remove uses of *Report.distribution_result from tests

And replace them with the separate distribution result stream from
`*Pool`s, like
`battery_pool.power_distribution_results.new_receiver()` for battery
pools.

The `distribution_result` field from the `Report` classes would be
removed in subsequent commits.

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

tests/timeseries/_battery_pool/test_battery_pool_control_methods.py

@@ -14,6 +14,7 @@
 from pytest_mock import MockerFixture
 
 from frequenz.sdk import microgrid, timeseries
+from frequenz.sdk._internal._channels import LatestValueCache
 from frequenz.sdk.actor import ResamplerConfig, power_distributing
 from frequenz.sdk.actor.power_distributing import ComponentPoolStatus
 from frequenz.sdk.actor.power_distributing._component_pool_status_tracker import (
@@ -161,6 +162,7 @@ def _assert_report(  # pylint: disable=too-many-arguments
         power: float | None,
         lower: float,
         upper: float,
+        dist_result: power_distributing.Result | None = None,
         expected_result_pred: (
             typing.Callable[[power_distributing.Result], bool] | None
         ) = None,
@@ -172,8 +174,8 @@ def _assert_report(  # pylint: disable=too-many-arguments
         assert report.bounds.lower == Power.from_watts(lower)
         assert report.bounds.upper == Power.from_watts(upper)
         if expected_result_pred is not None:
-            assert report.distribution_result is not None
-            assert expected_result_pred(report.distribution_result)
+            assert dist_result is not None
+            assert expected_result_pred(dist_result)
 
     async def test_case_1(
         self,
@@ -196,6 +198,9 @@ async def test_case_1(
         battery_pool = microgrid.new_battery_pool(priority=5)
 
         bounds_rx = battery_pool.power_status.new_receiver()
+        latest_dist_result = LatestValueCache(
+            battery_pool.power_distribution_results.new_receiver()
+        )
 
         self._assert_report(
             await bounds_rx.receive(), power=None, lower=-4000.0, upper=4000.0
@@ -217,6 +222,7 @@ async def test_case_1(
             power=1000.0,
             lower=-4000.0,
             upper=4000.0,
+            dist_result=latest_dist_result.get(),
             expected_result_pred=lambda result: isinstance(
                 result, power_distributing.Success
             ),
@@ -236,6 +242,7 @@ async def side_effect(inv_id: int, _: float) -> None:
             power=100.0,
             lower=-4000.0,
             upper=4000.0,
+            dist_result=latest_dist_result.get(),
             expected_result_pred=lambda result: isinstance(
                 result, power_distributing.Success
             ),
@@ -250,6 +257,7 @@ async def side_effect(inv_id: int, _: float) -> None:
             power=100.0,
             lower=-4000.0,
             upper=4000.0,
+            dist_result=latest_dist_result.get(),
             expected_result_pred=lambda result: isinstance(
                 result, power_distributing.PartialFailure
             )
@@ -267,6 +275,7 @@ async def side_effect(inv_id: int, _: float) -> None:
             power=100.0,
             lower=-4000.0,
             upper=4000.0,
+            dist_result=latest_dist_result.get(),
             expected_result_pred=lambda result: isinstance(
                 result, power_distributing.Success
             ),
@@ -294,6 +303,9 @@ async def test_case_2(self, mocks: Mocks, mocker: MockerFixture) -> None:
             priority=5, component_ids=set(mocks.microgrid.battery_ids[2:])
         )
         bounds_2_rx = battery_pool_2.power_status.new_receiver()
+        latest_dist_result_2 = LatestValueCache(
+            battery_pool_2.power_distribution_results.new_receiver()
+        )
 
         self._assert_report(
             await bounds_1_rx.receive(), power=None, lower=-2000.0, upper=2000.0
@@ -313,8 +325,9 @@ async def test_case_2(self, mocks: Mocks, mocker: MockerFixture) -> None:
         set_power.reset_mock()
 
         await battery_pool_2.propose_power(Power.from_watts(1000.0))
+
         bounds = await bounds_2_rx.receive()
-        if bounds.distribution_result is None:
+        if not latest_dist_result_2.has_value():
             bounds = await bounds_2_rx.receive()
         self._assert_report(bounds, power=1000.0, lower=-2000.0, upper=2000.0)
         assert set_power.call_count == 2
@@ -341,6 +354,9 @@ async def test_case_3(self, mocks: Mocks, mocker: MockerFixture) -> None:
         bounds_1_rx = battery_pool_1.power_status.new_receiver()
         battery_pool_2 = microgrid.new_battery_pool(priority=1)
         bounds_2_rx = battery_pool_2.power_status.new_receiver()
+        latest_dist_result_2 = LatestValueCache(
+            battery_pool_2.power_distribution_results.new_receiver()
+        )
 
         self._assert_report(
             await bounds_1_rx.receive(), power=None, lower=-4000.0, upper=4000.0
@@ -374,7 +390,7 @@ async def test_case_3(self, mocks: Mocks, mocker: MockerFixture) -> None:
             await bounds_1_rx.receive(), power=0.0, lower=-4000.0, upper=4000.0
         )
         bounds = await bounds_2_rx.receive()
-        if bounds.distribution_result is None:
+        if not latest_dist_result_2.has_value():
             bounds = await bounds_2_rx.receive()
         self._assert_report(bounds, power=0.0, lower=-1000.0, upper=0.0)
 
@@ -398,6 +414,9 @@ async def test_case_4(self, mocks: Mocks, mocker: MockerFixture) -> None:
 
         battery_pool = microgrid.new_battery_pool(priority=5)
         bounds_rx = battery_pool.power_status.new_receiver()
+        latest_dist_result = LatestValueCache(
+            battery_pool.power_distribution_results.new_receiver()
+        )
 
         self._assert_report(
             await bounds_rx.receive(), power=None, lower=-4000.0, upper=4000.0
@@ -418,6 +437,7 @@ async def test_case_4(self, mocks: Mocks, mocker: MockerFixture) -> None:
             power=1000.0,
             lower=-4000.0,
             upper=4000.0,
+            dist_result=latest_dist_result.get(),
             expected_result_pred=lambda result: isinstance(
                 result, power_distributing.Success
             ),
@@ -442,6 +462,7 @@ async def test_case_4(self, mocks: Mocks, mocker: MockerFixture) -> None:
             power=400.0,
             lower=-4000.0,
             upper=4000.0,
+            dist_result=latest_dist_result.get(),
             expected_result_pred=lambda result: isinstance(
                 result, power_distributing.Success
             ),
@@ -464,6 +485,7 @@ async def test_case_4(self, mocks: Mocks, mocker: MockerFixture) -> None:
             power=0.0,
             lower=-4000.0,
             upper=4000.0,
+            dist_result=latest_dist_result.get(),
             expected_result_pred=lambda result: isinstance(
                 result, power_distributing.Success
             ),
@@ -488,12 +510,13 @@ async def test_case_4(self, mocks: Mocks, mocker: MockerFixture) -> None:
             power=-400.0,
             lower=-4000.0,
             upper=4000.0,
+            dist_result=latest_dist_result.get(),
             expected_result_pred=lambda result: isinstance(
                 result, power_distributing.Success
             ),
         )
 
-    async def test_case_5(  # pylint: disable=too-many-statements
+    async def test_case_5(  # pylint: disable=too-many-statements,too-many-locals
         self,
         mocks: Mocks,
         mocker: MockerFixture,
@@ -525,6 +548,10 @@ async def test_case_5(  # pylint: disable=too-many-statements
         battery_pool_1 = microgrid.new_battery_pool(priority=1)
         bounds_1_rx = battery_pool_1.power_status.new_receiver()
 
+        latest_dist_result_4 = LatestValueCache(
+            battery_pool_4.power_distribution_results.new_receiver()
+        )
+
         self._assert_report(
             await bounds_4_rx.receive(), power=None, lower=-4000.0, upper=4000.0
         )
@@ -587,12 +614,13 @@ async def test_case_5(  # pylint: disable=too-many-statements
             await bounds_1_rx.receive()
             await bounds_2_rx.receive()
             await bounds_3_rx.receive()
-            bounds = await bounds_4_rx.receive()
-            if bounds.distribution_result is None or not isinstance(
-                bounds.distribution_result, power_distributing.Success
+            await bounds_4_rx.receive()
+            dist_result = latest_dist_result_4.get()
+            if dist_result is None or not isinstance(
+                dist_result, power_distributing.Success
             ):
                 continue
-            if bounds.distribution_result.succeeded_power == Power.from_watts(720.0):
+            if dist_result.succeeded_power == Power.from_watts(720.0):
                 break
 
         assert set_power.call_count == 4
@@ -626,12 +654,13 @@ async def test_case_5(  # pylint: disable=too-many-statements
             await bounds_1_rx.receive()
             await bounds_2_rx.receive()
             await bounds_3_rx.receive()
-            bounds = await bounds_4_rx.receive()
-            if bounds.distribution_result is None or not isinstance(
-                bounds.distribution_result, power_distributing.Success
+            await bounds_4_rx.receive()
+            dist_result = latest_dist_result_4.get()
+            if dist_result is None or not isinstance(
+                dist_result, power_distributing.Success
             ):
                 continue
-            if bounds.distribution_result.succeeded_power == Power.from_watts(-280.0):
+            if dist_result.succeeded_power == Power.from_watts(-280.0):
                 break
 
         assert set_power.call_count == 4

tests/timeseries/_ev_charger_pool/test_ev_charger_pool_control_methods.py

@@ -163,6 +163,7 @@ def _assert_report(  # pylint: disable=too-many-arguments
         power: float | None,
         lower: float,
         upper: float,
+        dist_result: power_distributing.Result | None = None,
         expected_result_pred: (
             typing.Callable[[power_distributing.Result], bool] | None
         ) = None,
@@ -174,8 +175,8 @@ def _assert_report(  # pylint: disable=too-many-arguments
         assert report.bounds.lower == Power.from_watts(lower)
         assert report.bounds.upper == Power.from_watts(upper)
         if expected_result_pred is not None:
-            assert report.distribution_result is not None
-            assert expected_result_pred(report.distribution_result)
+            assert dist_result is not None
+            assert expected_result_pred(dist_result)
 
     async def _get_bounds_receiver(
         self, ev_charger_pool: EVChargerPool

tests/timeseries/_pv_pool/test_pv_pool_control_methods.py

@@ -92,6 +92,7 @@ def _assert_report(  # pylint: disable=too-many-arguments
         power: float | None,
         lower: float,
         upper: float,
+        dist_result: power_distributing.Result | None = None,
         expected_result_pred: (
             typing.Callable[[power_distributing.Result], bool] | None
         ) = None,
@@ -103,8 +104,8 @@ def _assert_report(  # pylint: disable=too-many-arguments
         assert report.bounds.lower == Power.from_watts(lower)
         assert report.bounds.upper == Power.from_watts(upper)
         if expected_result_pred is not None:
-            assert report.distribution_result is not None
-            assert expected_result_pred(report.distribution_result)
+            assert dist_result is not None
+            assert expected_result_pred(dist_result)
 
     async def _recv_reports_until(
         self,