refactor(actor): Cleanup actor base messages code

Author: gfieni

src/powerapi/actor/actor.py

@@ -286,13 +286,13 @@ def soft_kill(self):
         <powerapi.message.message.PoisonPillMessage>`
 
         """
-        self.send_control(PoisonPillMessage(soft=True, sender_name='system'))
+        self.send_control(PoisonPillMessage())
         self.socket_interface.close()
 
     def hard_kill(self):
         """Kill this actor by sending a hard :class:`PoisonPillMessage
         <powerapi.message.message.PoisonPillMessage>`
 
         """
-        self.send_control(PoisonPillMessage(soft=False, sender_name='system'))
+        self.send_control(PoisonPillMessage(soft=False))
         self.socket_interface.close()

src/powerapi/actor/supervisor.py

@@ -107,7 +107,7 @@ def launch_actor(self, actor, start_message=True):
         actor.connect_data()
 
         if start_message:
-            actor.send_control(StartMessage(SUPERVISOR_NAME))
+            actor.send_control(StartMessage())
             msg = actor.receive_control(2000)
             if isinstance(msg, ErrorMessage):
                 raise ActorInitError(msg.error_message)

src/powerapi/handler/start_handler.py

@@ -44,8 +44,7 @@ def handle(self, msg):
         :param powerapi.StartMessage msg: Message that initialize the actor
         """
         if self.state.initialized:
-            self.state.actor.send_control(
-                ErrorMessage(self.state.actor.name, 'Actor already initialized'))
+            self.state.actor.send_control(ErrorMessage('Actor already initialized'))
             return
 
         if not isinstance(msg, StartMessage):
@@ -55,7 +54,7 @@ def handle(self, msg):
 
         if self.state.alive:
             self.state.initialized = True
-            self.state.actor.send_control(OKMessage(self.state.actor.name))
+            self.state.actor.send_control(OKMessage())
 
     def initialization(self):
         """

src/powerapi/message.py

@@ -30,82 +30,41 @@
 
 class Message:
     """
-    Abstract Message class
+    Abstract actor Message class.
     """
 
-    def __init__(self, sender_name: str):
-        self.sender_name = sender_name
-
-    def __str__(self):
-        raise NotImplementedError()
-
 
 class OKMessage(Message):
     """
-    Message sends to acknowledge last received message
+    Message sent by an actor after a successful startup.
     """
 
-    def __init__(self, sender_name: str):
-        Message.__init__(self, sender_name)
-
-    def __str__(self):
-        return "OKMessage"
-
 
 class ErrorMessage(Message):
     """
-    Message used to indicate that an error as occuried
+    Message sent by an actor when an error occurs during startup.
     """
 
-    def __init__(self, sender_name: str, error_message: str):
+    def __init__(self, error_message: str):
         """
-        :param str error_code: message associated to the error
+        :param error_message: Message associated to the encountered error.
         """
-        Message.__init__(self, sender_name)
         self.error_message = error_message
 
-    def __str__(self):
-        return "ErrorMessage : " + self.error_message
-
 
 class StartMessage(Message):
     """
-    Message that asks the actor to launch its initialisation process
+    Message sent to an actor to initiate its startup.
     """
 
-    def __init__(self, sender_name: str):
-        Message.__init__(self, sender_name)
-
-    def __str__(self):
-        return "StartMessage"
-
-
-class EndMessage(Message):
-    """
-    Message sent by actor to its parent when it terminates itself
-    """
-
-    def __init__(self, sender_name: str):
-        Message.__init__(self, sender_name)
-
-    def __str__(self):
-        return "EndMessage"
-
 
 class PoisonPillMessage(Message):
     """
-    Message which allow to kill an actor
+    Message sent to an actor to initiate its shutdown.
     """
 
-    def __init__(self, soft: bool = True, sender_name: str = ''):
-        Message.__init__(self, sender_name=sender_name)
+    def __init__(self, soft: bool = True):
+        """
+        :param bool soft: Indicate whether the actor should process all its messages before shutting down.
+        """
         self.is_soft = soft
-        self.is_hard = not soft
-
-    def __str__(self):
-        return "PoisonPillMessage"
-
-    def __eq__(self, other):
-        if isinstance(other, PoisonPillMessage):
-            return other.is_soft == self.is_soft and other.is_hard == self.is_hard
-        return False

src/powerapi/puller/handlers.py

@@ -76,7 +76,7 @@ def run(self):
                     dispatcher.send_data(raw_report)
 
             except FilterUselessError:
-                self.handler.handle_internal_msg(PoisonPillMessage(False, self.name))
+                self.handler.handle_internal_msg(PoisonPillMessage(False))
                 return
 
             except BadInputData as exn:
@@ -86,7 +86,7 @@ def run(self):
             except StopIteration:
                 time.sleep(self.state.timeout_puller / 1000)
                 if not self.state.stream_mode:
-                    self.handler.handle_internal_msg(PoisonPillMessage(False, self.name))
+                    self.handler.handle_internal_msg(PoisonPillMessage(False))
                     return
 
 
@@ -141,11 +141,11 @@ def handle(self, msg: Message):
         try:
             StartHandler.handle(self, msg)
         except PullerInitializationException as e:
-            self.state.actor.send_control(ErrorMessage(self.state.actor.name, e.msg))
+            self.state.actor.send_control(ErrorMessage(e.msg))
 
         self.pull_db()
 
-        self.handle_internal_msg(PoisonPillMessage(False, self.state.actor.name))
+        self.handle_internal_msg(PoisonPillMessage(False))
 
     def pull_db(self):
         """
@@ -166,4 +166,4 @@ def _connect_database(self):
             self.state.database_it = self.state.database.iter(self.state.stream_mode)
         except DBError as error:
             self.state.alive = False
-            self.state.actor.send_control(ErrorMessage(self.state.actor.name, error.msg))
+            self.state.actor.send_control(ErrorMessage(error.msg))

src/powerapi/pusher/handlers.py

@@ -47,7 +47,7 @@ def initialization(self):
         try:
             self.state.database.connect()
         except DBError as error:
-            self.state.actor.send_control(ErrorMessage(self.state.actor.name, error.msg))
+            self.state.actor.send_control(ErrorMessage(error.msg))
             self.state.alive = False
 
 

tests/unit/actor/abstract_test_actor.py

@@ -152,7 +152,7 @@ def pusher(database):
     actor.connect_control()
 
     yield actor
-    actor.send_control(PoisonPillMessage(sender_name='system-test'))
+    actor.send_control(PoisonPillMessage())
     if actor.is_alive():
         actor.terminate()
     actor.socket_interface.close()
@@ -168,7 +168,7 @@ def start_actor(actor: Actor):
     actor.start()
     actor.connect_control()
     actor.connect_data()
-    actor.send_control(StartMessage('system'))
+    actor.send_control(StartMessage())
     _ = actor.receive_control(2000)
 
 
@@ -263,7 +263,7 @@ def init_actor(actor):
     @staticmethod
     @pytest.fixture
     def started_actor(init_actor):
-        init_actor.send_control(StartMessage('test_case'))
+        init_actor.send_control(StartMessage())
         _ = init_actor.receive_control(2000)
         yield init_actor
 
@@ -330,7 +330,7 @@ def actor_with_crash_handler(actor):
     @staticmethod
     @pytest.fixture
     def started_actor_with_crash_handler(actor_with_crash_handler):
-        actor_with_crash_handler.send_control(StartMessage(SENDER_NAME))
+        actor_with_crash_handler.send_control(StartMessage())
         _ = actor_with_crash_handler.receive_control(2000)
         return actor_with_crash_handler
 
@@ -342,22 +342,22 @@ def test_new_actor_is_alive(init_actor):
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_PoisonPillMessage_set_actor_alive_to_False(init_actor):
-        init_actor.send_control(PoisonPillMessage(sender_name='system-abstract-test'))
+        init_actor.send_control(PoisonPillMessage())
         time.sleep(0.1)
         assert not init_actor.is_alive()
 
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_StartMessage_answer_OkMessage(init_actor):
-        init_actor.send_control(StartMessage(SENDER_NAME))
+        init_actor.send_control(StartMessage())
         msg = init_actor.receive_control(2000)
         print('message start', str(msg))
         assert isinstance(msg, OKMessage)
 
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_StartMessage_to_already_started_actor_answer_ErrorMessage(started_actor):
-        started_actor.send_control(StartMessage(SENDER_NAME))
+        started_actor.send_control(StartMessage())
         msg = started_actor.receive_control(2000)
         assert isinstance(msg, ErrorMessage)
         assert msg.error_message == 'Actor already initialized'
@@ -366,13 +366,13 @@ def test_send_StartMessage_to_already_started_actor_answer_ErrorMessage(started_
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_message_on_data_canal_to_non_initialized_actor_raise_NotConnectedException(actor):
         with pytest.raises(NotConnectedException):
-            actor.send_data(StartMessage(SENDER_NAME))
+            actor.send_data(StartMessage())
 
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_message_on_control_canal_to_non_initialized_actor_raise_NotConnectedException(actor):
         with pytest.raises(NotConnectedException):
-            actor.send_control(StartMessage(SENDER_NAME))
+            actor.send_control(StartMessage())
 
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
@@ -401,7 +401,7 @@ def test_if_actor_behaviour_raise_fatal_exception_the_actor_must_be_killed(actor
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_starting_actor_with_a_no_StartMessage_does_no_change_initialized(init_actor):
-        init_actor.send_control(ErrorMessage('system', 'error test'))
+        init_actor.send_control(ErrorMessage('error test'))
         assert not init_actor.state.initialized
 
 
@@ -451,7 +451,7 @@ def init_actor_with_db(actor_with_db):
     @staticmethod
     @pytest.fixture
     def started_actor_with_db(init_actor_with_db, fake_db):
-        init_actor_with_db.send_control(StartMessage('test_case'))
+        init_actor_with_db.send_control(StartMessage())
         _ = init_actor_with_db.receive_control(2000)
         yield init_actor_with_db
 
@@ -460,7 +460,7 @@ def started_actor_with_db(init_actor_with_db, fake_db):
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def started_actor_with_crash_handler(actor_with_db_and_crash_handler):
-        actor_with_db_and_crash_handler.send_control(StartMessage(SENDER_NAME))
+        actor_with_db_and_crash_handler.send_control(StartMessage())
         _ = actor_with_db_and_crash_handler.receive_control(2000)
         return actor_with_db_and_crash_handler
 
@@ -472,22 +472,22 @@ def test_new_actor_is_alive(init_actor_with_db):
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_PoisonPillMessage_set_actor_alive_to_False(init_actor_with_db):
-        init_actor_with_db.send_control(PoisonPillMessage(sender_name='system-abstract-test'))
+        init_actor_with_db.send_control(PoisonPillMessage())
         time.sleep(0.1)
         assert not init_actor_with_db.is_alive()
 
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_StartMessage_answer_OkMessage(init_actor_with_db):
-        init_actor_with_db.send_control(StartMessage(SENDER_NAME))
+        init_actor_with_db.send_control(StartMessage())
         msg = init_actor_with_db.receive_control(2000)
         print('message start', str(msg))
         assert isinstance(msg, OKMessage)
 
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_StartMessage_to_already_started_actor_answer_ErrorMessage(started_actor_with_db):
-        started_actor_with_db.send_control(StartMessage(SENDER_NAME))
+        started_actor_with_db.send_control(StartMessage())
         msg = started_actor_with_db.receive_control(2000)
         assert isinstance(msg, ErrorMessage)
         assert msg.error_message == 'Actor already initialized'
@@ -496,13 +496,13 @@ def test_send_StartMessage_to_already_started_actor_answer_ErrorMessage(started_
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_message_on_data_canal_to_non_initialized_actor_raise_NotConnectedException(actor_with_db):
         with pytest.raises(NotConnectedException):
-            actor_with_db.send_data(StartMessage(SENDER_NAME))
+            actor_with_db.send_data(StartMessage())
 
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_send_message_on_control_canal_to_non_initialized_actor_raise_NotConnectedException(actor_with_db):
         with pytest.raises(NotConnectedException):
-            actor_with_db.send_control(StartMessage(SENDER_NAME))
+            actor_with_db.send_control(StartMessage())
 
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
@@ -531,5 +531,5 @@ def test_if_actor_behaviour_raise_fatal_exception_the_actor_must_be_killed(init_
     @staticmethod
     @pytest.mark.usefixtures("shutdown_system")
     def test_starting_actor_with_a_no_StartMessage_does_no_change_initialized(init_actor_with_db):
-        init_actor_with_db.send_control(ErrorMessage('system', 'error test'))
+        init_actor_with_db.send_control(ErrorMessage('error test'))
         assert not init_actor_with_db.state.initialized

tests/unit/actor/test_supervisor.py

@@ -68,7 +68,7 @@ def send_control(self, msg):
         self.send_msg.append(msg)
 
     def receive_control(self, timeout=None):
-        return OKMessage("FakeActor")
+        return OKMessage()
 
 
 class FakeActorConnectError(FakeActor):
@@ -86,7 +86,7 @@ class FakeActorInitError(FakeActor):
     """
 
     def receive_control(self, timeout=None):
-        return ErrorMessage('error', 'FakeActorConnectError')
+        return ErrorMessage('FakeActorConnectError')
 
 
 ############

tests/unit/dispatcher/test_dispatcher_actor.py

@@ -319,7 +319,7 @@ def started_actor(init_actor):
         """
         Fixture for starting a DispatcherActor.
         """
-        init_actor.send_control(StartMessage('test_case'))
+        init_actor.send_control(StartMessage())
         _ = init_actor.receive_control(2000)
         yield init_actor
 
@@ -481,7 +481,7 @@ def test_send_PoisonPillMessage_make_dispatcher_forward_it_to_formula(dispatcher
         """
         Check that a PoissonPillMessage stops the DispatcherActor as well as their formulas
         """
-        dispatcher_with_two_formula.send_control(PoisonPillMessage(True, 'system-test-dispatcher'))
+        dispatcher_with_two_formula.send_control(PoisonPillMessage())
 
         sleep(2)