Command (non running) exception should not stop agent

Etienne Pallier
1 parent 9b04b9bd
Showing 5 changed files with 99 additions and 18 deletions Show diff stats
CHANGELOG
VERSION
src/core/pyros_django/agent/Agent.py
src/core/pyros_django/agent/AgentBasic.py
src/core/pyros_django/common/models.py
+07-10-2022 (EP): v0.6.0.1
+	- Command (non running) exception should not stop agent
+
 06-10-2022 (AKo): v0.6.0.0
 	- Change typo in agent_detail, add agent state & mode, disabling button if agent not reachable
 	- Adding titles, changes on css of agent detail, fix agentsst sender name
-0.6.0.0
 \ No newline at end of file
+0.6.0.1
 \ No newline at end of file
@@ -397,7 +397,6 @@ class Agent:
         #("self do_stop now", 200, '15.5', None),
         ("self do_specific1 1 2 3.5 titi (3,'titi',5) [1,3,5,7,9]", 200, '15.5', None),
  
-
         # 1) First, 3 EXCEPTION CASES (uncomment to activate exception)
         # Each of these lines will stop execution with an exception
         # ------------------------------------------------------------
@@ -1081,17 +1080,19 @@ class Agent:
         log.info("*"*10 + " NEXT COMMAND PROCESSING (START) " + "*"*10 + '\n')
         try :
             cmd = self._process_next_command_if_exists()
-            print(cmd)
+            #print(cmd)
         except (AgentCmdUnimplementedException, AgentCmdBadArgsException, UnknownCmdException) as e :
             print(e)
             log.error(f"EXCEPTION on Agent command '{e.cmd_name}'")
             if isinstance(e.cmd, AgentCmd) :
+                cmd = e.cmd
                 if type(e) is AgentCmdUnimplementedException:
-                    e.cmd.set_as_unimplemented("EXCEPTION: command known but unimplemented")
+                    cmd.set_as_unimplemented("EXCEPTION: command known but unimplemented")
                 else:
-                    e.cmd.set_as_invalid("EXCEPTION: command unknown or bad args")
-            self._cleanup_before_exit()
-            raise
+                    cmd.set_as_invalid("EXCEPTION: command unknown or bad args")
+            # Ne pas stopper !!
+            ##self._cleanup_before_exit()
+            ##raise
         log.info("*"*10 + " NEXT COMMAND PROCESSING (END) " + "*"*10 + "\n")
  
         # only if in TEST mode
@@ -1828,6 +1829,7 @@ class Agent:
         if not commands.exists():
             log.info("<None>")
             return None
+        
         "Current pending (or running) commands (time ordered):"
         AgentCmd.show_commands(commands)
  
@@ -2096,7 +2098,7 @@ class Agent:
  
         # Update read time to say that the command has been READ
         #cmd.set_read_time(False)
-        cmd.set_as_running()
+        ##cmd.set_as_running()
  
         log.info("(Agent SPECIFIC cmd)")
         # Execute method self."cmd.name"()
@@ -2104,6 +2106,7 @@ class Agent:
         try:
             res = self._exec_cmd_from_its_name(cmd)
         except (AgentCmdUnimplementedException, AgentCmdBadArgsException) as e:
+            ##cmd.set_as_pending()
             # These exceptions are managed at higher level :
             raise
         '''
@@ -2149,7 +2152,7 @@ class Agent:
         #print(methodsList)
         func = cmd.name
         if func not in methods_list: raise AgentCmdUnimplementedException(cmd)
-        f = getattr(self, func)
+        ##f = getattr(self, func)
         ###print(func, ' => ', signature(f))
  
         #for arg in cmd.args: print(arg)
@@ -2193,10 +2196,14 @@ class Agent:
                 #print("evaluated to", type(arg), arg)
             #except ValueError as e: newarg = arg
             args.append(arg)
+        
+        cmd.set_as_running()
         try:
             # equivalent to calling self.func(*cmd.args)
             return getattr(self, func)(*args)
         except (TypeError, AttributeError, ValueError) as e:
+            # set back to PENDING because this command should never has been RUNNING
+            cmd.set_as_pending()
             #raise e
             # "from None" pour ne pas afficher l'exception AttributeError (car interne)
             raise AgentCmdBadArgsException(cmd) from None
@@ -2319,7 +2326,7 @@ class Agent:
  
     ###
     # ================================================================================================
-    #   AGENT SPECIFIC FUNCTIONS
+    #   AGENT SPECIFIC COMMANDS (functions)
     #   (here just to serve as examples)
     # ================================================================================================
     ###
@@ -2447,7 +2454,8 @@ class Agent:
  
         log.debug(cmd.result)
         log.debug(self._cmdts.expected_res)
-        if cmd.is_executed() and self._cmdts.expected_res: 
+        ##if cmd.is_executed() and self._cmdts.expected_res: 
+        if cmd.is_finished() and self._cmdts.expected_res: 
             actual=str(cmd.result)
             expected=self._cmdts.expected_res
             assert actual==expected, f"Cmd result (='{actual}') is not as expected (='{expected}')"
@@ -2505,7 +2513,8 @@ class Agent:
  
                 # Execution was not completed
                 #if self._cmdts.is_expired() or self._cmdts.is_skipped() or self._cmdts.is_killed():
-                if self._cmdts.is_skipped() or self._cmdts.is_killed():
+                ##if self._cmdts.is_skipped() or self._cmdts.is_killed():
+                if self._cmdts.is_finished_with_error():
                     log.info("Command was not completed")
                     # 2 possible scenarios:
                     # - (1) Send the SAME command again
@@ -2521,7 +2530,7 @@ class Agent:
                     # - (2) Send next command
                     #self._cmdts = None
  
-                # Execution was completeted => get result
+                # Execution was completeted OK => get result
                 elif self._cmdts.is_executed():
                     cmdts_res = self._cmdts.get_result()
                     log.info(f"Cmd executed. Result is '{cmdts_res}'")
@@ -2576,14 +2585,15 @@ class Agent:
         assert last_cmd.name == self.TEST_COMMANDS_LIST[-1].split()[1]
         assert last_cmd.name == "do_exit"
         assert last_cmd.is_executed()
-        assert last_cmd.get_result() == "SHOULD BE DONE NOW"
+        ##assert last_cmd.get_result() == "SHOULD BE DONE NOW"
  
         nb_asserted = 0
         nb_agent_general = 0
         nb_unknown = 0
         nb_unimplemented = 0
         for cmd in commands:
-            assert cmd.is_executed() or cmd.is_killed() or cmd.is_skipped()
+            ##assert cmd.is_executed() or cmd.is_killed() or cmd.is_skipped()
+            assert cmd.is_finished()
             nb_asserted += 1
             if cmd.is_agent_general_cmd():
                 nb_agent_general += 1
@@ -10,6 +10,8 @@ import sys
 sys.path.append("../../../..")
 from src.core.pyros_django.agent.Agent import Agent, build_agent
  
+from typing import List, Tuple, Union, Any
+
 ##log = L.setupLogger("AgentXTaskLogger", "AgentX")
  
  
@@ -28,14 +30,32 @@ class AgentBasic(Agent):
     #TEST_COMMANDS_DEST = "AgentB"
     # Scenario to be executed
  
+    # @override
+    AGENT_SPECIFIC_COMMANDS = [
+        # Format : (“cmd_name”, timeout, exec_mode)
+        ("do_specific10", 10, 0),
+        #("set_specific2", 5, 0),
+        ("do_specific30", 3, 0),
+        ("existing_but_unimplemented_cmd", 3, 0),
+    ]
  
+    # @override
     TEST_COMMANDS_LIST = [
  
         # Format : ("self cmd_name cmd_args", timeout, "expected_result", expected_status),
         #("self do_stop now", 200, '', Agent.CMD_STATUS.CMD_EXECUTED),
-        ("self do_specific1 2 2 3.5 titi (3,'titi',5) [1,3,5,7,9]", 200, '16.5', None),
-
-
+        ("self do_specific10 2 2 3.5 titi (3,'titi',5) [1,3,5,7,9]", 200, '16.5', None),
+        
+        # bad parameters (missing or too many, or bad type)=> CMD_INVALID
+        ("self do_specific10", 200, '', Agent.CMD_STATUS.CMD_INVALID),
+        
+        # bad command => CMD_INVALID
+        ##FIXME: ("self unexisting_cmd", 200, '', Agent.CMD_STATUS.CMD_UNKNOWN),
+        ("self unexisting_cmd", 200, '', Agent.CMD_STATUS.CMD_INVALID),
+        
+        # Existing but unimplemented cmd => CMD_UNIMPLEMENTED
+        ("self existing_but_unimplemented_cmd", 200, '', Agent.CMD_STATUS.CMD_UNIMPLEMENTED),
+        
         # 1) First, 3 EXCEPTION CASES (uncomment to activate exception)
         # Each of these lines will stop execution with an exception
         # ------------------------------------------------------------
@@ -225,6 +245,45 @@ class AgentBasic(Agent):
         return nb_asserted
  
  
+    ###
+    # ================================================================================================
+    #   AGENT SPECIFIC COMMANDS (functions)
+    #   (here just to serve as examples)
+    # ================================================================================================
+    ###
+
+    #def do_specific1(self, arg1:int, arg2:int=2, arg3:int=3) -> int:
+    #def do_specific1(self, arg1:int, arg2:int=2, arg3:float=3.1, arg4:list=[1,2,3]) -> float:
+
+    def do_specific10(self, 
+            arg1:int, 
+            arg2:int, 
+            arg3:float=3.1, 
+            arg4:str='toto', 
+            arg5:Tuple[int,str,int]=(1,'toto',3),
+            #arg5:Tuple[int,int,int]=(1,2,3),
+            arg6:List[int]=[]
+        ) -> float:
+        '''
+        arg1 = int(arg1)
+        arg2 = int(arg2)
+        arg3 = float(arg3)
+        arg5 = ast.literal_eval(arg5)
+        print(arg5[1])
+        arg6 = ast.literal_eval(arg6)
+        '''
+        #print(arg4)
+        res = arg1 + arg2 + arg3 + arg5[0] + arg5[2]
+        if arg6: res += arg6[0]
+        return res
+
+    # Undefined specific cmd
+    #def set_specific2(self, arg1:str, arg2:int): pass
+
+    def do_specific30(self):
+        pass
+
+
 """
 =================================================================
     MAIN FUNCTION
@@ -968,9 +968,18 @@ class AgentCmd(models.Model):
     def is_running(self):
         return self.state == self.CMD_STATUS_CODES.CMD_RUNNING
  
+    # execution finished without error
     def is_executed(self):
         return self.state == self.CMD_STATUS_CODES.CMD_EXECUTED
  
+    # Cmd is finished if not pending or running
+    def is_finished(self):
+        return not (self.is_pending() or self.is_running())
+    
+    # Cmd is finished with error : finished but NOT executed
+    def is_finished_with_error(self):
+        return self.is_finished() and not self.is_executed()
+
     def is_skipped(self):
         return self.state == self.CMD_STATUS_CODES.CMD_SKIPPED