Implémentation complète du "Command state diag"

Etienne Pallier
1 parent 36b5f53e
Showing 3 changed files with 46 additions and 43 deletions Show diff stats
README.md
src/agent/Agent.py
src/common/models.py
@@ -67,13 +67,13 @@ This software has been tested and validated with the following configurations :
 --------------------------------------------------------------------------------------------
 ## LAST VERSION
  
-Date: 01/04/2019
+Date: 02/04/2019
  
 Author: E. Pallier
  
-VERSION: 0.20.35
+VERSION: 0.20.36
  
-Comment: TODO ??? Agent sender peut marquer "expired" une commande qu'il a envoyée
+Comment: Implémentation complète du "Command state diag"
  
 	- Scenario de test :
 		- lancer agents A et B en mode simu (option -t): ./pyros.py -t start agentA,agentB
@@ -273,7 +273,7 @@ class Agent:
     (OLD SYNTAX)
     @startuml
     title
-    __** Agent.run() function activity diagram **__
+    __** (OLD) Agent.run() function activity diagram **__
     end title
  
     (*) --> DO_EXIT=False & DO_RESTART=True
@@ -342,7 +342,7 @@ class Command(models.Model):
     PENDING --> EXPIRED: **command is too old**
  
     ' --- (2) RUNNING, SKIPPED, or EXPIRED ---
-    RUNNING: + r_launched_time
+    RUNNING: + r_start_time
     RUNNING --> PROCESSED : **finished**
     RUNNING --> KILLED: \l**aborted** \n(by sender or other allowed agent, \nwith command "abort" or "exit")
  
@@ -350,14 +350,14 @@ class Command(models.Model):
     SKIPPED --> [*]
  
     EXPIRED --> [*]
-    EXPIRED: + expired_time \n+ author_agent_name
+    EXPIRED: + expired_time \n+ killer_agent_name
  
     ' --- (3) PROCESSED or KILLED ---
-    PROCESSED: + finished_time
+    PROCESSED: + end_time
     PROCESSED --> [*]
  
     KILLED --> [*]
-    KILLED: + finished_time \n+ author_agent_name
+    KILLED: + end_time \n+ killer_agent_name
  
     @enduml
     """
@@ -404,27 +404,30 @@ class Command(models.Model):
     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)
+    killer_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)
+    #state = models.CharField(choices = CMD_STATUS_CODES, default=CMD_STATUS_CODES.CMD_PENDING, max_length=20)
+    state = models.CharField(choices = CMD_STATUS_CODES, default=CMD_STATUS_CODES.CMD_PENDING, max_length=20)
+    #state = models.IntegerField(choices=CMD_STATUS_CODES, default=RSCODE_PENDING)
  
     # (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 :
     # - on reading:
     r_read_time = models.DateTimeField(null=True)
+    # - on launching:
+    #r_start_time = models.DateTimeField(null=True)
+    r_start_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:
+    #expired_time = models.DateTimeField(null=True)
+    # - after kill or execution or expiration:
     #r_processed_time = models.DateTimeField(null=True)
-    finished_time = models.DateTimeField(null=True)
+    #end_time = models.DateTimeField(null=True)
+    end_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)
     result = models.CharField(max_length=400, blank=True)
  
@@ -466,7 +469,7 @@ class Command(models.Model):
             # only commands for agent agent_name
             recipient = agent_name,
             # only running commands
-            r_status_code = cls.CMD_STATUS_CODES.CMD_RUNNING,
+            state = cls.CMD_STATUS_CODES.CMD_RUNNING,
             # only not expired commands
             #s_deposit_time__gte = cls.get_peremption_date_from_now(),
         )
@@ -492,7 +495,7 @@ class Command(models.Model):
             # only commands for agent agent_name
             recipient = agent_name,
             # only running commands
-            r_status_code = cls.CMD_STATUS_CODES.CMD_PENDING,
+            state = cls.CMD_STATUS_CODES.CMD_PENDING,
             # except very recent commands : take only commands that are more than 2 sec old
             s_deposit_time__lt = now_minus_2sec
         )
@@ -507,7 +510,7 @@ class Command(models.Model):
         return cls.objects.filter(
             # only pending commands
             # but also including the currently running command
-            Q(r_status_code = cls.CMD_STATUS_CODES.CMD_PENDING) | Q(r_status_code = cls.CMD_STATUS_CODES.CMD_RUNNING),
+            Q(state = cls.CMD_STATUS_CODES.CMD_PENDING) | Q(state = cls.CMD_STATUS_CODES.CMD_RUNNING),
             # only commands for agent agent_name
             recipient = agent_name,
             # only not expired commands
@@ -555,7 +558,7 @@ class Command(models.Model):
             # only expired commands
             s_deposit_time__lt = cls.get_peremption_date_from_now(),
         ).exclude(
-            r_status_code = cls.CMD_STATUS_CODES.CMD_RUNNING
+            state = cls.CMD_STATUS_CODES.CMD_RUNNING
         )
         if old_commands.exists():
             print("Found old commands to delete:")
@@ -578,7 +581,7 @@ class Command(models.Model):
     # -------------- Command INSTANCE METHODS --------------
  
     def __str__(self):
-        return (f"Commmand '{self.name}' ({self.r_status_code}) sent by agent {self.sender} to agent {self.recipient} at {self.s_deposit_time}")
+        return (f"Commmand '{self.name}' ({self.state}) sent by agent {self.sender} to agent {self.recipient} at {self.s_deposit_time}")
  
     # --- BOOLEAN (test) functions ---
  
@@ -601,20 +604,20 @@ class Command(models.Model):
         return self.r_read_time is not None
  
     def is_pending(self):
-        return self.r_status_code == self.CMD_STATUS_CODES.CMD_PENDING
+        return self.state == self.CMD_STATUS_CODES.CMD_PENDING
  
     def is_running(self):
         #return (datetime.utcnow() - self.s_deposit_time) > timedelta(seconds = self.validity_duration)
-        return self.r_status_code == self.CMD_STATUS_CODES.CMD_RUNNING
+        return self.state == self.CMD_STATUS_CODES.CMD_RUNNING
  
     def is_executed(self):
-        return self.r_status_code == self.CMD_STATUS_CODES.CMD_EXECUTED
+        return self.state == self.CMD_STATUS_CODES.CMD_EXECUTED
  
     def is_skipped(self):
-        return self.r_status_code == self.CMD_STATUS_CODES.CMD_SKIPPED
+        return self.state == self.CMD_STATUS_CODES.CMD_SKIPPED
  
     def is_killed(self):
-        return self.r_status_code == self.CMD_STATUS_CODES.CMD_KILLED
+        return self.state == self.CMD_STATUS_CODES.CMD_KILLED
  
     def is_expired(self):
         #return (datetime.utcnow() - self.s_deposit_time) > timedelta(seconds = self.validity_duration)
@@ -646,61 +649,61 @@ 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)
+        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXECUTED)
         #print(self)
         """
-        self.r_status_code = self.CMD_STATUS_CODES.CMD_EXECUTED
+        self.state = 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"])
+        ##self.save(update_fields=["state", "r_processed_time"])
  
     def set_as_outofdate(self):
         print(f"- Set this command as expired (older than its validity duration of {self.validity_duration}s): {self}")
-        self.set_status_to(self.CMD_STATUS_CODES.CMD_OUTOFDATE)
+        self.set_state_to(self.CMD_STATUS_CODES.CMD_OUTOFDATE)
  
     def set_as_pending(self):
-        self.set_status_to(self.CMD_STATUS_CODES.CMD_PENDING)
+        self.set_state_to(self.CMD_STATUS_CODES.CMD_PENDING)
  
     def set_as_skipped(self):
-        self.set_status_to(self.CMD_STATUS_CODES.CMD_SKIPPED)
+        self.set_state_to(self.CMD_STATUS_CODES.CMD_SKIPPED)
  
     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, author_agent)
+        self.set_state_to(self.CMD_STATUS_CODES.CMD_KILLED, author_agent)
  
     def set_as_running(self):
         print(f"- Set command {self.name} as running")
-        self.set_status_to(self.CMD_STATUS_CODES.CMD_RUNNING)
+        self.set_state_to(self.CMD_STATUS_CODES.CMD_RUNNING)
     '''
     def set_as_executed(self):
-        self.set_status_to(self.CMD_STATUS_CODES.CMD_EXECUTED)
+        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXECUTED)
     '''
  
-    def set_status_to(self, status:str, author_agent_name:str=None):
+    def set_state_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
+                self.r_start_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
+                self.end_time = now_time
+                self.killer_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
+            self.end_time = now_time
             if status == self.CMD_STATUS_CODES.CMD_KILLED:
-                self.author_agent_name = author_agent_name
+                self.killer_agent_name = author_agent_name
         # Update command status
-        self.r_status_code = status
+        self.state = status
         self.save()
         # Optimization, but does not work, why ?...
-        ##self.save(update_fields=["r_status_code"])
+        ##self.save(update_fields=["state"])