- un peu de refactoring sur le Scheduler

- quelques nouveaux activity diagrams pour le Scheduler

- un peu de refactoring sur le Scheduler
- quelques nouveaux activity diagrams pour le Scheduler
Etienne Pallier
1 parent 47c4dbef
Showing 20 changed files with 192 additions and 23 deletions Show diff stats
doc/uml/activities/alert_manager/check_alert_validity_act.png
doc/uml/activities/alert_manager/retrieve_alert_act.txt
doc/uml/activities/monitoring/init_system_act.txt
doc/uml/activities/routine_manager/build_request_act.png
doc/uml/activities/routine_manager/see_sequences_result_act.txt
doc/uml/activities/scheduler/compute_schedule_act.txt
doc/uml/activities/scheduler/compute_schedule_act_.txt
doc/uml/activities/scheduler/copy_from_previous_schedule_act.txt
doc/uml/activities/scheduler/make_schedule_act.txt
doc/uml/usecases/alert_manager_usc.png
doc/uml/usecases/analyzer_usc.png
doc/uml/usecases/majordome_usc.png
doc/uml/usecases/majordome_usc.txt
doc/uml/usecases/monitoring_usc.png
doc/uml/usecases/monitoring_usc.txt
doc/uml/usecases/observation_manager_usc.png
doc/uml/usecases/routine_manager_usc.png
doc/uml/usecases/scheduler_usc.png
doc/uml/usecases/user_manager_usc.png
src/scheduler/Scheduler.py
@@ -2,7 +2,7 @@
  
 title Retrieve alerts
  
-(*) --> "Read files names in events_received directory"
+(*) --> "Read file names in events_received directory"
  
 --> if "New file detected" then
 	--> [yes] "Check alert validity"
+TODO:
+- start Monitoring 
+- start a scheduling (en faisant un "start Majordome" et non pas un "start Monitoring", car c'est le majordome qui doit lancer le premier scheduling)
+- tester si la nuit a déjà commencé !! (ça sera le cas si on redémarre le système pendant la nuit)
+
 @startuml
  
 title Initialize system
 @startuml
  
 (*) --> if "Sequence is finished"
-		--> [Yes] "Get images and analyses files names"
+		--> [Yes] "Get images [and analyses files names]"
 		if "Files exist"
-			--> [Yes] "Display images and analyses"
+			--> [Yes] "Display images [and analyses]"
 			--> (*)
 		else
 			--> [No] "Display error message"
@@ -1,8 +0,0 @@
-@startuml
-
-title Compute schedule
-
-(*) --> "See specification document 'Module PLANNING'"
-	--> (*)
-
-@enduml
 \ No newline at end of file
@@ -0,0 +1,47 @@
+@startuml
+
+legend right
+  Short
+  legend
+endlegend
+
+title **Scheduler.compute_schedule()**
+
+skinparam activity {
+  'StartColor red
+  'BarColor SaddleBrown 
+  'EndColor Silver
+  'BackgroundColor Peru
+  BackgroundColor<<MODULE>> Peru
+  'BorderColor Peru
+  'FontName Impact
+}
+
+(*)	--> "//# Order schedule sequences according to efficiency criteria (priority, set time, ...)//" <<MODULE>>
+
+	--> "//# Create a unique big empty available interval that takes all the night duration [plan_start,plan_end]// \n
+        intervals = Interval(schedule.plan_start, schedule.plan_end)"
+
+	--> "//# Remove invalid sequences from schedule, and mark them INVALID// \n
+	A sequence is invalid if:
+	 - sequence.jd1 < 0 
+	 - OR sequence.jd2 < 0 
+	 - OR sequence.duration <= 0 
+	 - OR sequence.jd2 - sequence.jd1 < sequence.duration \n\n
+	**remove_invalid_sequences()**\l" <<MODULE>>
+
+	--> "//# **TODO:** Determine priorities according to SP, user, ...// 
+	**determine_priorities()**\l" as B1 <<MODULE>>
+        
+	--> "//# Remove non eligible sequences from schedule//
+	**remove_non_eligible_sequences()**\l" <<MODULE>>
+
+	--> "//# Sort sequences according to highest priority and soonest JD2// 
+	**sort_by_jd2_and_priorities()**\l" <<MODULE>>
+ 
+	--> "//# Try to place sorted sequences in schedule one by one in available intervals (shift placed sequences if necessary)// 
+	**place_sequences()**\l" <<MODULE>>
+
+	--> (*)
+
+@enduml
 \ No newline at end of file
@@ -0,0 +1,34 @@
+@startuml
+
+legend right
+  Short
+  legend
+endlegend
+
+title **Scheduler.copy_from_previous_schedule()**
+
+skinparam activity {
+  'StartColor red
+  'BarColor SaddleBrown 
+  'EndColor Silver
+  'BackgroundColor Peru
+  BackgroundColor<<START>> Peru
+  'BorderColor Peru
+  'FontName Impact
+}
+
+(*)	--> "//Copy needed data from previous schedule : EXECUTED sequences, plan_night_start, plan_end//" <<START>>
+
+	--> previous_sched = get last schedule from DB
+	
+    --> "previous_exc_seq = get all EXECUTED sequences from previous_sched\n 
+	Associate each EXECUTED sequence to the new schedule (in DB)\l"
+	
+    --> "schedule.plan_night_start = previous_sched.plan_night_start\n
+    schedule.plan_end = previous_sched.plan_end\n
+    //Schedule must start in MAX_OVERHEAD seconds://\n
+    schedule.plan_start = now + MAX_OVERHEAD\l"
+    
+	--> (*)
+
+@enduml
 \ No newline at end of file
@@ -0,0 +1,40 @@
+@startuml
+
+'skinparam backgroundColor #AAFFFF
+
+skinparam activity {
+  'StartColor red
+  'BarColor SaddleBrown 
+  'EndColor Silver
+  'BackgroundColor Peru
+  BackgroundColor<<MODULE>> Peru
+  'BorderColor Peru
+  'FontName Impact
+}
+
+
+
+
+title **Scheduler.make_schedule()** (//Make Schedule//)
+
+(*) --> "//Schedule Creation// \n//see specification document 'Module PLANNING'//" <<MODULE>>
+
+	--> if "First Schedule" then
+		--> [True] "schedule.plan_night_start = schedule.plan_start"
+		--> "sequences = {all OBSERVABLE sequences}" as A2
+	else
+		--> [False] "//Copy needed data from previous schedule : EXECUTED sequences, plan_night_start, plan_end// 
+		copy_from_previous_schedule()\l" <<MODULE>>
+	endif
+	--> A2
+    --> "//Add to each sequence its schedule id:// 
+    sequences = [(sequence, shs) for sequence in sequences]"
+    
+	--> "//Order schedule sequences according to efficiency criteria (priority, set time, ...)// 
+	compute_schedule()\l" <<MODULE>>
+
+    --> Save schedule
+    
+	--> (*)
+
+@enduml
 \ No newline at end of file
+TODO: 
+- start AlertManager et Monitoring
+- lancer le premier Scheduling
+- ...
+Il faut récupérer ici plein de fonctions attribuées (par erreur de conception) à Monitoring
+
+
 @startuml
  
 title Majordome
+TODO: 
+Le Monitor fait bcp trop de choses qui dépassent sa responsabilité.
+Il faut passer quelques unes de ces fonctions au Majordome: 
+- démarrer le AlertManager
+- initialize instruments
+- config instruments
+- update soft versions
+- compute night start&end
+
 @startuml
  
 title Monitoring
@@ -153,16 +153,24 @@ class Scheduler():
         global SIMULATION
         SIMULATION = False
  
-        if first_schedule is False:
-            self.copy_from_previous_schedule()
-        else:
+        #if first_schedule is False:
+        if first_schedule:
             self.schedule.plan_night_start = self.schedule.plan_start
+        else:
+            self.copy_from_previous_schedule()
  
         self.sequences = list(Sequence.objects.filter(status=Sequence.OBSERVABLE))
+        # Add to each sequence its schedule id
         shs_list = []
+        
+        #EP improved:
+        '''
         for sequence in self.sequences:
             shs_list.append(ScheduleHasSequences(sequence=sequence, schedule=self.schedule))
         self.sequences = [(sequence, shs_list[index]) for index, sequence in enumerate(self.sequences)]
+        '''
+        self.sequences = [(sequence, ScheduleHasSequences(sequence=sequence, schedule=self.schedule)) for sequence in self.sequences]
+        
         self.compute_schedule()
         self.save_schedule()
         return self.schedule
@@ -171,14 +179,20 @@ class Scheduler():
         '''
             Copy needed information from the previous schedule :
                 - gets the executed sequences from the previous schedule and copy them into the new schedule
-                - gets plan_start and plan_end
-                - computes new plan_restart
+                - gets plan_night_start and plan_end
+                - computes new plan_restart (plan_start)
  
             shs means 'ScheduleHasSequences'
+            
+            Side effects:
+            - create new shs entries
         '''
  
+        # Get all EXECUTED sequences from last schedule
         previous_sched = Schedule.objects.order_by('-created')[1]
         previous_exc_seq = previous_sched.sequences.filter(status=Sequence.EXECUTED)
+
+        # Associate each EXECUTED sequence to the new schedule in DB (by creating a new shs entry for each sequence) 
         for seq in previous_exc_seq:
             shs = seq.shs
             shs.pk = None
@@ -217,19 +231,37 @@ class Scheduler():
         return (self.schedule, self.sequences)
  
     def compute_schedule(self):
+        #EP TODO: est-on sur ici que self.intervals est VIDE ???
+        # Create a unique big empty available interval that takes all the night duration [plan_start,plan_end]
         self.intervals.append(
             Interval(self.schedule.plan_start, self.schedule.plan_end))
-        self.check_sequences_validity()
+        
+        ''' 
+        EP:
+        Uniquement à cause des sequences de Alain Klotz (qui sont parfois invalides pour Pyros) ???
+        TODO: cette étape pourra être supprimée en production, car les sequences fabriquées par Pyros seront valides
+        '''
+        #EP renamed
+        #self.check_sequences_validity()
+        self.remove_invalid_sequences()
+        
         self.determine_priorities()
-        self.remove_not_eligible_sequences()
+        
+        self.remove_non_eligible_sequences()
+        
         self.sort_by_jd2_and_priorities()
-        self.organize_sequences()
+ 
+        #EP renamed:       
+        #self.organize_sequences()
+        self.place_sequences()
  
-    def check_sequences_validity(self):
+    #EP renamed:
+    #def check_sequences_validity(self):
+    def remove_invalid_sequences(self):
         '''
         Checks come sequence attributes to validate their integrity
  
-        :side-effect :
+        :side-effects :
             - remove invalid sequences from self.sequences
             - set INVALID status for invalid sequences in DB
         '''
@@ -250,7 +282,7 @@ class Scheduler():
         # TODO: définir comment on calcule la priorité
         pass
  
-    def remove_not_eligible_sequences(self):
+    def remove_non_eligible_sequences(self):
         '''
         Computes overlap between [jd1; jd2] and [plan_start; plan_end]
         Removes from self.sequences all the sequences that cannot be observed between plan_start and plan_end
@@ -258,6 +290,7 @@ class Scheduler():
  
         :side-effect :
             - remove unwanted sequences from self.sequences
+            - mark them as UNPLANNABLE (in DB)
         '''
  
         ''' Note (1) '''
@@ -280,7 +313,9 @@ class Scheduler():
         self.sequences.sort(key=lambda x: x[0].jd2)
         self.sequences.sort(key=lambda x: x[0].priority)
  
-    def organize_sequences(self):
+    #EP renamed
+    #def organize_sequences(self):
+    def place_sequences(self):
         '''
         Main function of the Scheduler
         Arrange a maximum of observable sequences in the planning