Ajout infos précises sur statut commande + Bugfix simulateur sur "abort"

& Nouveaux diagrammes UML pour Command (state diag) et Agent (activity diag)

Ajout infos précises sur statut commande + Bugfix simulateur sur "abort"
& Nouveaux diagrammes UML pour Command (state diag) et Agent (activity diag)
Etienne Pallier
1 parent ee5f79f8
Showing 6 changed files with 223 additions and 67 deletions Show diff stats
README.md
src/agent/Agent.py
src/agent/AgentB.py
src/agent/Agent_run_activitydiag.png
src/common/models.py
src/common/models_Command_statediag.png
@@ -67,13 +67,13 @@ This software has been tested and validated with the following configurations :
 --------------------------------------------------------------------------------------------
 ## LAST VERSION
  
-Date: 29/03/2019
+Date: 01/04/2019
  
 Author: E. Pallier
  
-VERSION: 0.20.33
+VERSION: 0.20.34
  
-Comment: Déplacé AgentM dans src/monitoring/ (pyros start agentM)
+Comment: Ajout informations plus précises sur statut commande + Bugfix simulateur sur "abort" 
  
 	- Scenario de test :
 		- lancer agents A et B en mode simu (option -t): ./pyros.py -t start agentA,agentB
@@ -88,6 +88,8 @@ Comment: Déplacé AgentM dans src/monitoring/ (pyros start agentM)
 		- pour utiliser thread ou processus : il suffit de mettre la constante RUN_IN_THREAD de AgentA (ou AgentB ou AgentX) à False ou True
  
 	- Historique des nouveautés implémentées :
+		- Nouveaux diagrammes UML pour Command (state diag) et Agent (activity diag)
+		- Déplacé AgentM dans src/monitoring/ (pyros start agentM)
 		- Implémenté la commande "restart_init" (voir doc "play with a pyros agent") et refactorisation de run()
 		- Implémenté le "abort" dans le simulateur
 		- Optimisation log_agent_status() (ex update_survey())
@@ -194,61 +194,133 @@ class Agent:
     """
  
     """
-    PLANTUML ACTIVITY DIAGRAM
-    # (http://plantuml.com/fr/activity-diagram-legacy)
-    """
+    # --- Agent ACTIVIY DIAGRAM (plantUML) ---
+    # NEW syntax => http://plantuml.com/fr/activity-diagram-beta
+    # OLD syntax => http://plantuml.com/fr/activity-diagram-legacy
  
-    """
     @startuml
     version
     @enduml
-    """
  
-    """
+    # Exemple de skin utilisable (celui de ChemCam) :
+    skinparam activity {
+        StartColor red
+        EndColor Silver
+        BackgroundColor Peru
+        BackgroundColor<< Begin >> Olive
+        BorderColor Peru
+        FontName Impact
+    }
+
+    (NEW SYNTAX)
     @startuml
  
     title
-    __** Agent.run() function activity diagram **__
+    __**Agent.run() function : Activity Diagram **__
+
     end title
  
-    skinparam activity {
-      StartColor red
-      EndColor Silver
-      BackgroundColor Peru
-      BackgroundColor<< Begin >> Olive
-      BorderColor Peru
-      FontName Impact
-    }
+    start
  
-    (*) --> load_config()
+    :DO_EXIT = False
+    DO_RESTART = True;
  
-    --> init()
+    while (DO_RESTART ?) is (yes)
+        :load_config();
+        :init();
+        :DO_MAIN_LOOP = True;
+        while (DO_MAIN_LOOP ?) is (yes)
+            partition main_loop() {
+                :reload_config();
+                note right
+                    only if changed
+                end note
  
-    partition infinite_loop {
-            ---> "reload_config()"
-            note right
-                only if changed
-            end note
+                :log_agent_status();
+                note right
+                    Log this agent status in DB
+                end note
  
-            --> log_agent_status()
-            note right
-                Log this agent status in DB
-            end note
+                :routine_process();
+
+                :cmd = get_next_valid_command();
+                partition command_process(cmd) {
+                    :cmd = self.general_process(cmd);
+                    note right
+                        only if there is a command
+                    end note
+                    :specific_process(cmd);
+                    note right
+                        only if there is a command and I am "active"
+                    end note
+                }
+                if (DO_RESTART or DO_EXIT ?) then (yes)
+                    :DO_MAIN_LOOP = False;
+                endif
  
-            --> routine_process()
  
-            --> cmd = get_next_valid_command()
-            --> cmd = command_process(cmd)
-            note right
-                only if there is a command
-            end note
-    }
  
-    If "NEW ITERATION ?" then
-        --> [Yes] "reload_config()"        
-    else
-        --> (*)
-    Endif
+
+            }
+        endwhile (no)
+    endwhile (no)
+
+    stop
+
+    @enduml
+
+
+    (OLD SYNTAX)
+    @startuml
+    title
+    __** Agent.run() function activity diagram **__
+    end title
+
+    (*) --> DO_EXIT=False & DO_RESTART=True
+
+    partition while-DO_RESTART {
+        --> load_config()
+        --> init()
+        --> DO_MAIN_LOOP = True
+        --> main_loop()
+
+        partition while-DO_MAIN_LOOP {
+            partition main_loop() {
+
+                ---> "reload_config()"
+                note right
+                    only if changed
+                end note
+
+                --> log_agent_status()
+                note right
+                    Log this agent status in DB
+                end note
+
+                --> routine_process()
+
+                --> cmd = get_next_valid_command()
+                --> cmd = command_process(cmd)
+                    note right
+                        only if there is a command
+                    end note
+                partition command_process(cmd) {
+                    --> cmd = self.general_process(cmd)
+                    --> specific_process(cmd)
+                    note right
+                        only if there is a command and I am "active"
+                    end note
+                }
+            }
+        }
+
+        If "NEW ITERATION ?" then
+            --> "reload_config()"
+        else
+            --> [No] (*)
+        Endif
+
+    }
  
     @enduml
     """
@@ -399,7 +471,7 @@ class Agent:
     _path_data = '../../config'
  
     _iter_num = None
-    
+
     # Log object
     _log = None
  
@@ -595,10 +667,10 @@ class Agent:
         cmd = self.get_next_valid_command()
         #if cmd: cmd = self.general_process(cmd)
         # Process this (next) command (if exists)
-        if cmd: cmd = self.command_process(cmd)
+        if cmd: self.command_process(cmd)
         # if restart, exit this loop to restart from beginning
         if self.DO_RESTART or self.DO_EXIT:
-            self.DO_MAIN_LOOP = False 
+            self.DO_MAIN_LOOP = False
             return
  
         self.printd("------END COMMMAND PROCESSING------")
@@ -611,7 +683,7 @@ class Agent:
         # (simulator only) Exit if max duration is reached
         if self.SIMULATOR_MAX_DURATION_SEC and (time.time()-self.start_time > self.SIMULATOR_MAX_DURATION_SEC):
             self.print("Exit because of max duration set to ", self.SIMULATOR_MAX_DURATION_SEC, "s")
-            self.kill_running_specific_cmd_if_exists()
+            self.kill_running_specific_cmd_if_exists(self.name)
             if self.SIMULATOR_MODE and self.SIMULATOR_WITH_TEST: self.simulator_test_results()
             self.DO_MAIN_LOOP = False
             return
@@ -911,9 +983,6 @@ class Agent:
         # 6) Current cmd must now be a valid (not expired) and PENDING one,
         # so pass it to general_process() for execution
         #self.printd(f"Got command {cmd.name} sent by agent {cmd.sender} at {cmd.sender_deposit_time}")
-        self.print("***")
-        self.print("*** Got", cmd)
-        self.print("***")
         return cmd
  
  
@@ -929,7 +998,10 @@ class Agent:
         assert cmd is not None
  
         self.set_status(self.STATUS_GENERAL_PROCESS)
-        self.print(f"Starting processing of {cmd}")
+        self.print("***")
+        self.print("*** RECEIVED", cmd)
+        self.print("***")
+        self.printd(f"Starting general processing of this command")
  
         # Update read time to say that the command has been READ
         cmd.set_read_time()
@@ -999,7 +1071,7 @@ class Agent:
             #self.printd("Current pending commands are:")
             #Command.show_commands(self._pending_commands)
             self.print("Aborting current executing command if exists:")
-            self.kill_running_specific_cmd_if_exists()
+            self.kill_running_specific_cmd_if_exists(cmd.sender)
             if cmd.name == "restart_init":
                 self.print("restart_init received: Restarting from init()")
                 self.DO_RESTART=True
@@ -1072,7 +1144,7 @@ class Agent:
         self.printd("Ending specific process (thread has been launched)")
  
  
-    def kill_running_specific_cmd_if_exists(self):
+    def kill_running_specific_cmd_if_exists(self, abort_sender):
         if (self._current_specific_thread is None) or not self._current_specific_thread.is_alive():
             self.printd("...No current specific command thread to abort...")
         else:
@@ -1083,7 +1155,7 @@ class Agent:
             #self._current_specific_thread.shutdown()
             #threading._shutdown()
             #self._current_specific_thread.raise_exception()
-            self._current_specific_cmd.set_as_killed()
+            self._current_specific_cmd.set_as_killed_by(abort_sender)
             self._current_specific_thread.terminate()
             # Now, wait for the end of the thread
             if self.RUN_IN_THREAD:
@@ -1129,7 +1201,9 @@ class Agent:
         SIMULATOR MODE ONLY
         """
  
-        # There is a current command being processed => check its status to see if finished
+        # There is a current command being processed 
+        # => check if next command is "abort"
+        # => if so, instantly send an "abort" to abort previous command
         if self.cmdts is not None:
             self.print(f"Waiting for end of cmd '{self.cmdts.name}' execution...")
             # Update cmdts fields from DB
@@ -1139,8 +1213,14 @@ class Agent:
                     # If next command is "abort" then abort becomes the new current command (to be sent)
                     self.next_cmdts = self.simulator_get_next_command_to_send()
                     if self.next_cmdts and self.next_cmdts.name == "abort":
+                        # Wait a little to give a chance to agentB to start execution of current command,
+                        # so that we can abort it then (otherwise it won't be aborted!!)
+                        time.sleep(2)
                         self.cmdts = self.next_cmdts
                         self.next_cmdts = None
+                        self.print("***")
+                        self.print(f"*** SEND command", self.cmdts)
+                        self.print("***")
                         self.cmdts.send()
  
             # Current cmd is no more running
@@ -1176,7 +1256,7 @@ class Agent:
                 # Set cmdts to None so that a new command will be sent at next iteration
                 self.cmdts = None
  
-        # No currently running command => get a new command to send
+        # No currently running command => get a new command and SEND it
         if self.cmdts is None:
             if self.next_cmdts is not None:
                 self.cmdts = self.next_cmdts
@@ -1186,8 +1266,11 @@ class Agent:
             # No more command to send (from simulator) => return
             if self.cmdts is None: return
             # Send cmd (= set as pending and save)
-            self.print(f"Send command", self.cmdts)
+            self.print("***")
+            self.print(f"*** SEND command", self.cmdts)
+            self.print("***")
             #self.cmdts.set_as_pending()
+            # SEND
             self.cmdts.send()
             #cmdts_is_processed = False
             #cmdts_res = None
@@ -29,8 +29,8 @@ class AgentB(Agent):
         "flush_commands",
         "go_active",
  
-        # Because of this command, the receiver agent
-        # will no more send any new command
+        # Because of this command, the recipient agent
+        # should no more send any new specific command
         "go_idle",
         "go_idle",
         "go_idle",
@@ -323,6 +323,45 @@ class Command(models.Model):
     | id | sender | recipient | name | validity_duration (default=60) | s_deposit_time | r_read_time
     """
  
+    """
+    # --- Command STATE DIAGRAM ---
+    # http://plantuml.com/fr/state-diagram
+    @startuml
+
+    title
+    __**models.Command class : State Diagram**__
+
+    end title
+
+    [*] --> PENDING : **created by sender**
+
+    ' --- (1) PENDING ---
+    PENDING: + s_deposit_time \n+ r_read_time
+    PENDING --> RUNNING : **launched**
+    PENDING --> SKIPPED: **recipient is IDLE**
+    PENDING --> EXPIRED: **command is too old**
+
+    ' --- (2) RUNNING, SKIPPED, or EXPIRED ---
+    RUNNING: + r_launched_time
+    RUNNING --> PROCESSED : **finished**
+    RUNNING --> KILLED: \l**aborted** \n(by sender or other allowed agent, \nwith command "abort" or "exit")
+
+    SKIPPED: + r_skipped_time
+    SKIPPED --> [*]
+
+    EXPIRED --> [*]
+    EXPIRED: + expired_time \n+ author_agent_name
+
+    ' --- (3) PROCESSED or KILLED ---
+    PROCESSED: + finished_time
+    PROCESSED --> [*]
+
+    KILLED --> [*]
+    KILLED: + finished_time \n+ author_agent_name
+
+    @enduml
+    """
+
     # -------------- Command CONSTANTS --------------
  
     # Receiver status codes
@@ -361,17 +400,29 @@ class Command(models.Model):
     # -------------- Command FIELDS --------------
  
     #sender = models.CharField(max_length=50, blank=True, null=True, unique=True)
-    sender = models.CharField(max_length=50, help_text='sender agent name')
-    recipient = models.CharField(max_length=50, help_text='recipient agent name')
-    name = models.CharField(max_length=400, help_text='command name')
+    # Sender and Recipient agents
+    sender = models.CharField(max_length=50, help_text='sender agent name', null=False)
+    recipient = models.CharField(max_length=50, help_text='recipient agent name', null=False)
+    # Other agent (than sender or recipient) that set this command to KILLED or EXPIRED 
+    author_agent_name = models.CharField(max_length=50, help_text='sender agent name', null=True)
+    name = models.CharField(max_length=400, help_text='command name', null=False)
     validity_duration = models.PositiveIntegerField('(in sec)', default=COMMANDS_VALIDITY_DURATION_SEC_DEFAULT)
-    # Automatically set at table line creation (line created by the sender)
+
+    # (AUTO on create) Automatically set at table line creation (line created by the sender)
     s_deposit_time = models.DateTimeField(blank=True, null=True, auto_now_add=True)
     # Set by the recipient :
-    # - at reading time
+    # - on reading:
     r_read_time = models.DateTimeField(null=True)
-    # - after execution
-    r_processed_time = models.DateTimeField(null=True)
+    # - on skipping (because idle):
+    r_skipped_time = models.DateTimeField(null=True)
+    # - on expiration (because too old):
+    r_skipped_time = models.DateTimeField(null=True)
+    # - on launching:
+    r_launched_time = models.DateTimeField(null=True)
+    # - after kill or execution:
+    #r_processed_time = models.DateTimeField(null=True)
+    finished_time = models.DateTimeField(null=True)
+
     r_status_code = models.CharField(choices = CMD_STATUS_CODES, default=CMD_STATUS_CODES.CMD_PENDING, max_length=20)
     #r_status_code = models.IntegerField(choices=CMD_STATUS_CODES, default=RSCODE_PENDING)
     # TODO: maybe à mettre au format json (key:value)
@@ -595,10 +646,13 @@ class Command(models.Model):
  
     def set_as_processed(self):
         print(f"- Set command {self.name} as processed")
+        self.set_status_to(self.CMD_STATUS_CODES.CMD_EXECUTED)
         #print(self)
+        """
         self.r_status_code = self.CMD_STATUS_CODES.CMD_EXECUTED
         self.r_processed_time = datetime.utcnow().astimezone()
         self.save()
+        """
         # Optimization: update the related fields, but does not work, why ?
         ##self.save(update_fields=["r_status_code", "r_processed_time"])
  
@@ -612,10 +666,10 @@ class Command(models.Model):
     def set_as_skipped(self):
         self.set_status_to(self.CMD_STATUS_CODES.CMD_SKIPPED)
  
-    def set_as_killed(self):
+    def set_as_killed_by(self, author_agent:str):
         print(f"- Set command {self.name} as killed")
         #print(f"- Set this command as killed: {self}")
-        self.set_status_to(self.CMD_STATUS_CODES.CMD_KILLED)
+        self.set_status_to(self.CMD_STATUS_CODES.CMD_KILLED, author_agent)
  
     def set_as_running(self):
         print(f"- Set command {self.name} as running")
@@ -625,7 +679,24 @@ class Command(models.Model):
         self.set_status_to(self.CMD_STATUS_CODES.CMD_EXECUTED)
     '''
  
-    def set_status_to(self, status:str):
+    def set_status_to(self, status:str, author_agent_name:str=None):
+        now_time = datetime.utcnow().astimezone()
+        if status in (self.CMD_STATUS_CODES.CMD_RUNNING, self.CMD_STATUS_CODES.CMD_SKIPPED, self.CMD_STATUS_CODES.CMD_OUTOFDATE):
+            assert self.is_pending()
+            if status == self.CMD_STATUS_CODES.CMD_RUNNING:
+                self.r_launched_time = now_time
+            elif status == self.CMD_STATUS_CODES.CMD_SKIPPED:
+                self.r_skipped_time = now_time
+            # EXPIRED
+            elif status == self.CMD_STATUS_CODES.CMD_OUTOFDATE:
+                self.expired_time = now_time
+                self.author_agent_name = author_agent_name
+        elif status in (self.CMD_STATUS_CODES.CMD_EXECUTED, self.CMD_STATUS_CODES.CMD_KILLED):
+            assert self.is_running()
+            self.finished_time = now_time
+            if status == self.CMD_STATUS_CODES.CMD_KILLED:
+                self.author_agent_name = author_agent_name
+        # Update command status
         self.r_status_code = status
         self.save()
         # Optimization, but does not work, why ?...