Stop PowerDistributingActor at the end of each test

This removes some warnings about tasks that is pending when
loop was closed.

Signed-off-by: ela-kotulska-frequenz <[email protected]>

Author: ela-kotulska-frequenz

src/frequenz/sdk/actor/power_distributing/power_distributing.py

@@ -33,6 +33,7 @@
 from google.protobuf.empty_pb2 import Empty  # pylint: disable=no-name-in-module
 
 from ... import microgrid
+from ..._internal.asyncio import cancel_and_await
 from ...actor._decorator import actor
 from ...microgrid import ComponentGraph
 from ...microgrid.client import MicrogridApiClient
@@ -186,13 +187,21 @@ def __init__(
         self._users_channels: Dict[
             str, Bidirectional.Handle[Result, Request]
         ] = users_channels
-        self._create_users_tasks()
+        self._users_tasks = self._create_users_tasks()
         self._started = asyncio.Event()
 
-    def _create_users_tasks(self) -> None:
-        """For each user create a task to wait for request."""
+    def _create_users_tasks(self) -> List[asyncio.Task[Empty]]:
+        """For each user create a task to wait for request.
+
+        Returns:
+            List with users tasks.
+        """
+        tasks = []
         for user, handler in self._users_channels.items():
-            asyncio.create_task(self._wait_for_request(_User(user, handler)))
+            tasks.append(
+                asyncio.create_task(self._wait_for_request(_User(user, handler)))
+            )
+        return tasks
 
     def _get_upper_bound(self, batteries: Set[int]) -> int:
         """Get total upper bound of power to be set for given batteries.
@@ -634,3 +643,8 @@ async def _cancel_tasks(self, tasks: Iterable[asyncio.Task[Any]]) -> None:
             aws.cancel()
 
         await asyncio.gather(*tasks, return_exceptions=True)
+
+    async def _stop_actor(self) -> None:
+        """Stop all running async tasks."""
+        await asyncio.gather(*[cancel_and_await(t) for t in self._users_tasks])
+        await self._stop()  # type: ignore # pylint: disable=no-member

tests/actor/test_power_distributing.py

@@ -94,7 +94,7 @@ async def test_constructor(self) -> None:
 
             assert distributor._bat_inv_map == {106: 105, 206: 205, 306: 305}
             assert distributor._inv_bat_map == {105: 106, 205: 206, 305: 306}
-            await distributor._stop()  # type: ignore # pylint: disable=no-member
+            await distributor._stop_actor()
 
     async def init_mock_microgrid(self) -> MockMicrogridClient:
         """Create mock microgrid and send initial data from the components.
@@ -158,7 +158,7 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
             [asyncio.create_task(client_handle.receive())],
             timeout=SAFETY_TIMEOUT,
         )
-        await distributor._stop()  # type: ignore # pylint: disable=no-member
+        await distributor._stop_actor()
 
         assert len(pending) == 0
         assert len(done) == 1
@@ -215,7 +215,7 @@ async def test_power_distributor_two_users(self, mocker: MockerFixture) -> None:
             ],
             timeout=SAFETY_TIMEOUT,
         )
-        await distributor._stop()  # type: ignore # pylint: disable=no-member
+        await distributor._stop_actor()
 
         assert len(pending) == 0
         assert len(done) == 2
@@ -257,7 +257,7 @@ async def test_power_distributor_invalid_battery_id(
             [asyncio.create_task(user1_handle.receive())],
             timeout=SAFETY_TIMEOUT,
         )
-        await distributor._stop()  # type: ignore # pylint: disable=no-member
+        await distributor._stop_actor()
 
         assert len(done) == 1
         result: Result = done.pop().result()
@@ -328,7 +328,7 @@ async def test_power_distributor_overlapping_batteries(
             ],
             timeout=SAFETY_TIMEOUT,
         )
-        await distributor._stop()  # type: ignore # pylint: disable=no-member
+        await distributor._stop_actor()
 
         assert len(done) == 3
         success, ignored = 0, 0
@@ -382,7 +382,7 @@ async def test_power_distributor_one_user_adjust_power_consume(
             [asyncio.create_task(user1_handle.receive())],
             timeout=SAFETY_TIMEOUT,
         )
-        await distributor._stop()  # type: ignore # pylint: disable=no-member
+        await distributor._stop_actor()
 
         assert len(pending) == 0
         assert len(done) == 1
@@ -430,7 +430,7 @@ async def test_power_distributor_one_user_adjust_power_supply(
             [asyncio.create_task(user1_handle.receive())],
             timeout=SAFETY_TIMEOUT,
         )
-        await distributor._stop()  # type: ignore # pylint: disable=no-member
+        await distributor._stop_actor()
 
         assert len(pending) == 0
         assert len(done) == 1
@@ -478,7 +478,7 @@ async def test_power_distributor_one_user_adjust_power_success(
             [asyncio.create_task(user1_handle.receive())],
             timeout=SAFETY_TIMEOUT,
         )
-        await distributor._stop()  # type: ignore # pylint: disable=no-member
+        await distributor._stop_actor()
 
         assert len(pending) == 0
         assert len(done) == 1
@@ -520,7 +520,7 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
             [asyncio.create_task(client_handle.receive())],
             timeout=SAFETY_TIMEOUT,
         )
-        await distributor._stop()  # type: ignore # pylint: disable=no-member
+        await distributor._stop_actor()
 
         assert len(pending) == 0
         assert len(done) == 1