Ajout de la gestion des commandes badly named

Etienne Pallier
1 parent 8902a770
Showing 4 changed files with 54 additions and 6 deletions Show diff stats
privatedev/plugin/agent/AgentBasic.py
src/core/pyros_django/agent/Agent.py
src/core/pyros_django/agent/AgentBasic.py
src/core/pyros_django/common/models.py
@@ -37,7 +37,8 @@ class AgentBasic(Agent):
         # Format : (“cmd_name”, timeout, exec_mode)
         ("do_specific10", 10, 0),
         ("do_cmd_unimplemented", 3, 0),
-        ("cmd_unimplemented2", 3, 0),
+        ("cmd_badly_named_and_implemented", 3, 0),
+        ("cmd_badly_named_and_unimplemented", 3, 0),
         #("set_specific2", 5, 0),
         ("do_specific30", 3, 0),
         ("do_cmd_raising_error_exec", 3, 0),
@@ -47,7 +48,7 @@ class AgentBasic(Agent):
     # on DEV
     #COMMIT_ONLY = False
     # on commit only
-    COMMIT_ONLY = True
+    COMMIT_ONLY = False
  
     # @override
     _TEST_COMMANDS_LIST = [
@@ -60,7 +61,12 @@ class AgentBasic(Agent):
         #("self do_stop now", 200, 'STOPPING now', Agent.CMD_STATUS.CMD_EXECUTED),
         #("self do_stop", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
         #("self do_stop asap", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
-        
+
+
+        # Badly named command (not generic) => CMD_INVAlID
+        (True, "self cmd_badly_named_and_implemented", 200, "Command badly named, must start with do_, get_, or set_", Agent.CMD_STATUS.CMD_INVALID),
+        (True, "self cmd_badly_named_and_unimplemented", 200, None, Agent.CMD_STATUS.CMD_INVALID),
+
         # do_restart
  
         (COMMIT_ONLY, "self do_restart asap", 200, 'RESTARTING asap', Agent.CMD_STATUS.CMD_EXECUTED),
@@ -371,6 +377,8 @@ class AgentBasic(Agent):
     def do_specific30(self):
         pass
  
+    def cmd_badly_named_and_implemented(self):
+        pass
  
 """
 =================================================================
@@ -388,4 +396,9 @@ if __name__ == &quot;__main__&quot;:
     agent.setSimulatorMode(TEST_MODE)
     print(agent)
     '''
+
+    # Run only 4 iterations
+    #agent.run(nb_iter=4)
+
+    # Run indefinitely
     agent.run()
@@ -1334,6 +1334,10 @@ class Agent:
  
         cmd.set_read_time()
  
+        if not AgentCmd.is_generic(cmd.name) and not self.is_native_device_command(cmd.name):
+            cmd.set_as_invalid("Command badly named, must start with do_, get_, or set_")
+            return cmd
+        
         # CASE 1 - AGENT GENERAL command
         # (DO_RESTART, DO_EXIST, DO_ABORT, DO_ABORT_COMMAND, DO_FLUSH_COMMANDS, ...)
         # This processing can set DO_MAIN_LOOP and DO_RESTART_LOOP to False
@@ -1465,6 +1469,10 @@ class Agent:
         #if self.TEST_MODE: self._TEST_test_routine_process()
         pass
  
+    # To be overriden by AgentDevice
+    def is_native_device_command(self, cmd_name:str):
+        return False
+
     """
     def purge_commands(self):
         ###
@@ -1517,6 +1525,12 @@ class Agent:
             #print(cmd_name)
             specific_commands += cmd_name
  
+            # 1) Error case 1 - Badly named command (not get, set, do) (implemented or not)
+            if not AgentCmd.is_generic(cmd_name):
+                specific_commands += '(I);'
+                continue
+
+            # 2) Error case 2 - Well named command (get, set, do) but not yet implemented
             try:
                 f = getattr(self, cmd_name)
             # Exception if exists an unimplemented command
@@ -1527,6 +1541,7 @@ class Agent:
                 # next cmd
                 continue
  
+            # 3) Normal case : well named command and implemented
             specific_commands += "("
             args = signature(f)
             #specific_commands += str(args)
@@ -37,7 +37,8 @@ class AgentBasic(Agent):
         # Format : (“cmd_name”, timeout, exec_mode)
         ("do_specific10", 10, 0),
         ("do_cmd_unimplemented", 3, 0),
-        ("cmd_unimplemented2", 3, 0),
+        ("cmd_badly_named_and_implemented", 3, 0),
+        ("cmd_badly_named_and_unimplemented", 3, 0),
         #("set_specific2", 5, 0),
         ("do_specific30", 3, 0),
         ("do_cmd_raising_error_exec", 3, 0),
@@ -47,7 +48,7 @@ class AgentBasic(Agent):
     # on DEV
     #COMMIT_ONLY = False
     # on commit only
-    COMMIT_ONLY = True
+    COMMIT_ONLY = False
  
     # @override
     _TEST_COMMANDS_LIST = [
@@ -60,7 +61,12 @@ class AgentBasic(Agent):
         #("self do_stop now", 200, 'STOPPING now', Agent.CMD_STATUS.CMD_EXECUTED),
         #("self do_stop", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
         #("self do_stop asap", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
-        
+
+
+        # Badly named command (not generic) => CMD_INVAlID
+        (True, "self cmd_badly_named_and_implemented", 200, "Command badly named, must start with do_, get_, or set_", Agent.CMD_STATUS.CMD_INVALID),
+        (True, "self cmd_badly_named_and_unimplemented", 200, None, Agent.CMD_STATUS.CMD_INVALID),
+
         # do_restart
  
         (COMMIT_ONLY, "self do_restart asap", 200, 'RESTARTING asap', Agent.CMD_STATUS.CMD_EXECUTED),
@@ -371,6 +377,8 @@ class AgentBasic(Agent):
     def do_specific30(self):
         pass
  
+    def cmd_badly_named_and_implemented(self):
+        pass
  
 """
 =================================================================
@@ -388,4 +396,9 @@ if __name__ == &quot;__main__&quot;:
     agent.setSimulatorMode(TEST_MODE)
     print(agent)
     '''
+
+    # Run only 4 iterations
+    #agent.run(nb_iter=4)
+
+    # Run indefinitely
     agent.run()
@@ -664,6 +664,13 @@ class AgentCmd(models.Model):
  
     # -------------- Command CLASS (static) METHODS --------------
  
+    @classmethod
+    def is_generic(self, cmd_name:str) ->bool :
+        '''
+        Generic if starts with get_, set_, or do_
+        '''
+        return cmd_name.startswith( ('get_', 'set_', 'do_') )
+
     # Avoid to override the Model __init__ method
     # See https://docs.djangoproject.com/en/stable/ref/models/instances/#creating-objects
     @classmethod