Migrate ConfigManagingActor to the Actor class

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

Author: llucax

src/frequenz/sdk/actor/_config_managing.py

@@ -12,14 +12,13 @@
 from frequenz.channels import Sender
 from frequenz.channels.util import FileWatcher
 
-from ..actor._decorator import actor
+from ..actor._actor import Actor
 from ..config import Config
 
 _logger = logging.getLogger(__name__)
 
 
-@actor
-class ConfigManagingActor:
+class ConfigManagingActor(Actor):
     """An actor that monitors a TOML configuration file for updates.
 
     When the file is updated, the new configuration is sent, as a [`dict`][], to the
@@ -44,6 +43,7 @@ def __init__(
             output: The sender to send the config to.
             event_types: The set of event types to monitor.
         """
+        super().__init__()
         self._config_path: pathlib.Path = (
             config_path
             if isinstance(config_path, pathlib.Path)
@@ -79,8 +79,13 @@ async def send_config(self) -> None:
         config = Config(conf_vars)
         await self._output.send(config)
 
-    async def run(self) -> None:
-        """Monitor for and send configuration file updates."""
+    async def _run(self) -> None:
+        """Monitor for and send configuration file updates.
+
+        At startup, the Config Manager sends the current config so that it
+        can be cache in the Broadcast channel and served to receivers even if
+        there hasn't been any change to the config file itself.
+        """
         await self.send_config()
 
         async for event in self._file_watcher:

tests/actor/test_config_manager.py

@@ -80,27 +80,23 @@ async def test_update(self, config_file: pathlib.Path) -> None:
         config_channel: Broadcast[Config] = Broadcast(
             "Config Channel", resend_latest=True
         )
-        _config_manager = ConfigManagingActor(config_file, config_channel.new_sender())
-
         config_receiver = config_channel.new_receiver()
 
-        config = await config_receiver.receive()
-        assert config is not None
-        assert config.get("logging_lvl") == "DEBUG"
-        assert config.get("var1") == "1"
-        assert config.get("var2") is None
-        assert config.get("var3") is None
-
-        number = 5
-        config_file.write_text(create_content(number=number))
-
-        config = await config_receiver.receive()
-        assert config is not None
-        assert config.get("logging_lvl") == "ERROR"
-        assert config.get("var1") == "0"
-        assert config.get("var2") == str(number)
-        assert config.get("var3") is None
-        assert config_file.read_text() == create_content(number=number)
-
-        # pylint: disable=protected-access,no-member
-        await _config_manager._stop()  # type: ignore
+        async with ConfigManagingActor(config_file, config_channel.new_sender()):
+            config = await config_receiver.receive()
+            assert config is not None
+            assert config.get("logging_lvl") == "DEBUG"
+            assert config.get("var1") == "1"
+            assert config.get("var2") is None
+            assert config.get("var3") is None
+
+            number = 5
+            config_file.write_text(create_content(number=number))
+
+            config = await config_receiver.receive()
+            assert config is not None
+            assert config.get("logging_lvl") == "ERROR"
+            assert config.get("var1") == "0"
+            assert config.get("var2") == str(number)
+            assert config.get("var3") is None
+            assert config_file.read_text() == create_content(number=number)