bump to 5.2
[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):
13         self.tasks=tasks
14         self.verbose=verbose
15     def run (self, timeout_timedelta, silent_timedelta, period=None):
16         timeout = datetime.now()+timeout_timedelta
17         timeout_minutes = timeout_timedelta.total_seconds()/60
18         graceout = datetime.now()+silent_timedelta
19         silent_minutes = silent_timedelta.total_seconds()/60
20         period_seconds=int(period.total_seconds())
21         if self.verbose:
22             utils.header("max timeout is %d minutes, silent for %d minutes (period is %s s)"%\
23                              (timeout_minutes,silent_minutes,period_seconds))
24         tasks=self.tasks
25         while tasks:
26             fine=[]
27             for task in tasks:
28                 success=task.run (silent=datetime.now() <= graceout)
29                 if success: fine.append(task)
30             for task in fine: tasks.remove(task)
31             if not tasks: return True
32             if datetime.now() > timeout:
33                 for task in tasks: 
34                     print task.failure_message()
35                 return False
36             if self.verbose:
37                 print '%ds..'%period_seconds,
38             time.sleep(period_seconds)
39         # in case we're empty 
40         return True
41
42
43 #################### CompleterTask
44 ### . run(silent)  (return True or False)
45 ###   silent is an input boolean indicating if we're within the silent period
46 ### . failure()    (print a message)
47
48 ########## expectations (+ first arg self)
49 # failure()     (to describe which went wrong once it's over)
50 # -- and --
51 # run (silent)  
52 # -- or -- 
53 # actual_run()
54 # message()
55
56 class CompleterTask:
57     def run (self, silent):
58         result=self.actual_run()
59         if silent:
60             print '+' if result else '.',
61             sys.stdout.flush()
62         else:
63             print self.message(),"->","OK" if result else "KO"
64         return result
65     def message (self): return "you-need-to-redefine-message"
66     def failure_message (self): return "you-need-to-redefine-failure_message"
67
68 # random result
69 class TaskTest (CompleterTask):
70     counter=1
71     def __init__ (self,max):
72         import random
73         self.counter=TaskTest.counter
74         TaskTest.counter+=1
75         self.delay=random.random()*max
76         self.fire=datetime.now()+timedelta(seconds=self.delay)
77     def actual_run(self):
78         return datetime.now()>=self.fire
79     def message (self):
80         return "Task %d - delay was %d s"%(self.counter,self.delay)
81
82     def failure_message (self): return "BOTTOM LINE: FAILURE with task (%s)"%self.counter
83
84 def main ():
85     import sys
86     if len(sys.argv)!=6:
87         print "Usage: <command> number_tasks max_random timeout_s silent_s period_s"
88         sys.exit(1)
89     [number,max,timeout,silent,period]= [ int(x) for x in sys.argv[1:]]
90     tasks = [ TaskTest(max) for i in range(number)]
91     success=Completer(tasks,verbose=True).run(timedelta(seconds=timeout),
92                                               timedelta(seconds=silent),
93                                               timedelta(seconds=period))
94     print "OVERALL",success
95
96 if __name__ == '__main__':
97     main()