cosmetic - when displaying Completer short timeouts (in the order of seconds and...
[tests.git] / system / Completer.py
1 #!/usr/bin/env python
2 import sys, time
3 from datetime import datetime, timedelta
4
5 import utils
6
7 ### more generic code for waiting for any number of things 
8 ### within a given timeframe i.e. given some timeout/silent/period
9 ### takes in argument a list of tasks that are instances 
10 ### of a CompleterTask subclass
11 class Completer:
12     def __init__ (self, tasks, verbose=True, message=None):
13         self.tasks=tasks
14         self.verbose=verbose
15         self.message="({})".format(message) if message else ""
16     def run (self, timeout_timedelta, silent_timedelta, period):
17         begin = datetime.now()
18         timeout = begin+timeout_timedelta
19         timeout_seconds = timeout_timedelta.total_seconds()
20         timeout_minutes = timeout_seconds/60
21         graceout = datetime.now()+silent_timedelta
22         silent_seconds = silent_timedelta.total_seconds()
23         silent_minutes = silent_seconds/60
24         period_seconds=int(period.total_seconds())
25         if self.verbose:
26             if timeout_seconds >= 120:
27                 utils.header("max timeout is %d minutes, silent for %d minutes (period is %s s)"%\
28                              (timeout_minutes,silent_minutes,period_seconds))
29             else:
30                 utils.header("max timeout is %d seconds, silent for %d seconds (period is %s s)"%\
31                              (timeout_seconds,silent_seconds,period_seconds))
32         tasks=self.tasks
33         while tasks:
34             fine=[]
35             for task in tasks:
36                 success=task.run (silent=datetime.now() <= graceout)
37                 if success: fine.append(task)
38             for task in fine: tasks.remove(task)
39             if not tasks:
40                 if self.verbose:
41                     duration = datetime.now()-begin
42                     print "total completer {} {}s".format(self.message,
43                                                           int(duration.total_seconds()))
44                 return True
45             if datetime.now() > timeout:
46                 for task in tasks: 
47                     task.failure_epilogue()
48                 return False
49             if self.verbose:
50                 print '%ds..'%period_seconds,
51             time.sleep(period_seconds)
52         # in case we're empty 
53         return True
54
55
56 #################### CompleterTask
57 ### . run(silent)  (return True or False)
58 ###   silent is an input boolean indicating if we're within the silent period
59 ### . failure()    (print a message)
60
61 ########## expectations (+ first arg self)
62 # failure()     (to describe which went wrong once it's over)
63 # -- and --
64 # run (silent)  
65 # -- or -- 
66 # actual_run()
67 # message()
68
69 class CompleterTask:
70     def run (self, silent):
71         result=self.actual_run()
72         if silent:
73             print '+' if result else '.',
74             sys.stdout.flush()
75         else:
76             print self.message(),"->","OK" if result else "KO"
77         return result
78     def message (self): return "you-need-to-redefine-message"
79     def failure_epilogue (self): print "you-need-to-redefine-failure_epilogue"
80
81 # random result
82 class TaskTest (CompleterTask):
83     counter=1
84     def __init__ (self,max):
85         import random
86         self.counter=TaskTest.counter
87         TaskTest.counter+=1
88         self.delay=random.random()*max
89         self.fire=datetime.now()+timedelta(seconds=self.delay)
90     def actual_run(self):
91         return datetime.now()>=self.fire
92     def message (self):
93         return "Task %d - delay was %d s"%(self.counter,self.delay)
94
95     def failure_epilogue (self): print "BOTTOM LINE: FAILURE with task (%s)"%self.counter
96
97 def main ():
98     import sys
99     if len(sys.argv)!=6:
100         print "Usage: <command> number_tasks max_random timeout_s silent_s period_s"
101         sys.exit(1)
102     [number,max,timeout,silent,period]= [ int(x) for x in sys.argv[1:]]
103     tasks = [ TaskTest(max) for i in range(number)]
104     success=Completer(tasks,verbose=True).run(timedelta(seconds=timeout),
105                                               timedelta(seconds=silent),
106                                               timedelta(seconds=period))
107     print "OVERALL",success
108
109 if __name__ == '__main__':
110     main()