3 # Thierry Parmentelat <thierry.parmentelat@inria.fr>
4 # Copyright (C) 2010 INRIA
6 import sys, os, os.path
7 from optparse import OptionParser
9 from time import strftime
13 from TestPlc import TestPlc
14 from TestSite import TestSite
15 from TestNode import TestNode
17 # add $HOME in PYTHONPATH so we can import LocalTestResources.py
18 sys.path.append(os.environ['HOME'])
19 import LocalTestResources
23 subversion_id = "Now using git -- version tracker broken"
25 default_config = [ 'default' ]
27 default_build_url = "git://git.onelab.eu/tests"
30 self.path=os.path.dirname(sys.argv[0]) or "."
33 def show_env (self,options, message):
34 if self.options.verbose:
35 utils.header (message)
36 utils.show_options("main options",options)
39 self.steps_message = 20*'x'+" Defaut steps are\n"+TestPlc.printable_steps(TestPlc.default_steps)
40 self.steps_message += 20*'x'+" Other useful steps are\n"+TestPlc.printable_steps(TestPlc.other_steps)
43 if not self.options.verbose:
44 print self.steps_message,
46 testplc_method_dict = __import__("TestPlc").__dict__['TestPlc'].__dict__
47 scopes = [("Default steps",TestPlc.default_steps)]
48 if self.options.all_steps:
49 scopes.append ( ("Other steps",TestPlc.other_steps) )
50 for (scope,steps) in scopes:
51 print '--------------------',scope
52 for step in [step for step in steps if TestPlc.valid_step(step)]:
54 if step.find("force_") == 0:
55 stepname=step.replace("force_","")
57 print '*',step,"\r",4*"\t",
59 print testplc_method_dict[stepname].__doc__
61 print "*** no doc found"
65 usage = """usage: %%prog [options] steps
66 arch-rpms-url defaults to the last value used, as stored in arg-arch-rpms-url,
68 config defaults to the last value used, as stored in arg-config,
70 ips_node, ips_plc and ips_qemu defaults to the last value used, as stored in arg-ips-{node,plc,qemu},
71 default is to use IP scanning
72 steps refer to a method in TestPlc or to a step_* module
74 """%(TestMain.default_config)
75 usage += self.steps_message
76 parser=OptionParser(usage=usage,version=self.subversion_id)
77 parser.add_option("-u","--url",action="store", dest="arch_rpms_url",
78 help="URL of the arch-dependent RPMS area - for locating what to test")
79 parser.add_option("-b","--build",action="store", dest="build_url",
80 help="ignored, for legacy only")
81 parser.add_option("-c","--config",action="append", dest="config", default=[],
82 help="Config module - can be set multiple times, or use quotes")
83 parser.add_option("-p","--personality",action="store", dest="personality",
84 help="personality - as in vbuild-nightly")
85 parser.add_option("-d","--pldistro",action="store", dest="pldistro",
86 help="pldistro - as in vbuild-nightly")
87 parser.add_option("-f","--fcdistro",action="store", dest="fcdistro",
88 help="fcdistro - as in vbuild-nightly")
89 parser.add_option("-x","--exclude",action="append", dest="exclude", default=[],
90 help="steps to exclude - can be set multiple times, or use quotes")
91 parser.add_option("-a","--all",action="store_true",dest="all_steps", default=False,
92 help="Run all default steps")
93 parser.add_option("-l","--list",action="store_true",dest="list_steps", default=False,
94 help="List known steps")
95 parser.add_option("-N","--nodes",action="append", dest="ips_node", default=[],
96 help="Specify the set of hostname/IP's to use for nodes")
97 parser.add_option("-P","--plcs",action="append", dest="ips_plc", default=[],
98 help="Specify the set of hostname/IP's to use for plcs")
99 parser.add_option("-Q","--qemus",action="append", dest="ips_qemu", default=[],
100 help="Specify the set of hostname/IP's to use for qemu boxes")
101 parser.add_option("-s","--size",action="store",type="int",dest="size",default=1,
102 help="sets test size in # of plcs - default is 1")
103 parser.add_option("-D","--dbname",action="store",dest="dbname",default=None,
104 help="Used by db_dump and db_restore")
105 parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
106 help="Run in verbose mode")
107 parser.add_option("-i","--interactive",action="store_true",dest="interactive",default=False,
108 help="prompts before each step")
109 parser.add_option("-n","--dry-run", action="store_true", dest="dry_run", default=False,
110 help="Show environment and exits")
111 parser.add_option("-r","--restart-nm", action="store_true", dest="forcenm", default=False,
112 help="Force the NM to restart in check_slices step")
113 parser.add_option("-t","--trace", action="store", dest="trace_file", default=None,
114 #default="logs/trace-@TIME@.txt",
115 help="Trace file location")
116 (self.options, self.args) = parser.parse_args()
118 # allow things like "run -c 'c1 c2' -c c3"
122 if hasattr(el, "__iter__") and not isinstance(el, basestring):
123 result.extend(flatten(el))
127 # flatten relevant options
128 for optname in ['config','exclude','ips_node','ips_plc','ips_qemu']:
129 setattr(self.options,optname, flatten ( [ arg.split() for arg in getattr(self.options,optname) ] ))
131 # handle defaults and option persistence
132 for (recname,filename,default) in (
133 ('build_url','arg-build-url',TestMain.default_build_url) ,
134 ('ips_node','arg-ips-node',[]) ,
135 ('ips_plc','arg-ips-plc',[]) ,
136 ('ips_qemu','arg-ips-qemu',[]) ,
137 ('config','arg-config',TestMain.default_config) ,
138 ('arch_rpms_url','arg-arch-rpms-url',"") ,
139 ('personality','arg-personality',"linux32"),
140 ('pldistro','arg-pldistro',"planetlab"),
141 ('fcdistro','arg-fcdistro','centos5'),
143 # print 'handling',recname
145 is_list = isinstance(default,list)
146 if not getattr(self.options,recname):
148 parsed=file(path).readlines()
149 if not is_list: # strings
151 print "%s - error when parsing %s"%(sys.argv[1],path)
153 parsed=parsed[0].strip()
155 parsed=[x.strip() for x in parsed]
156 setattr(self.options,recname,parsed)
159 setattr(self.options,recname,default)
161 print "Cannot determine",recname
162 print "Run %s --help for help"%sys.argv[0]
168 fsave.write(getattr(self.options,recname) + "\n")
170 for value in getattr(self.options,recname):
171 fsave.write(value + "\n")
173 # utils.header('Saved %s into %s'%(recname,filename))
175 # lists need be reversed
176 if isinstance(getattr(self.options,recname),list):
177 getattr(self.options,recname).reverse()
179 if self.options.verbose:
180 utils.header('* Using %s = %s'%(recname,getattr(self.options,recname)))
182 # hack : if sfa is not among the published rpms, skip these tests
183 TestPlc.check_whether_build_has_sfa(self.options.arch_rpms_url)
186 if len(self.args) == 0:
187 self.options.steps=TestPlc.default_steps
189 self.options.steps = self.args
191 if self.options.list_steps:
197 if not self.options.steps:
199 #self.options.steps=['dump','clean','install','populate']
200 self.options.steps=TestPlc.default_steps
202 # rewrite '-' into '_' in step names
203 self.options.steps = [ step.replace('-','_') for step in self.options.steps ]
207 for step in self.options.steps:
209 for exclude in self.options.exclude:
210 if utils.match(step,exclude):
213 if keep: selected.append(step)
214 self.options.steps=selected
216 # this is useful when propagating on host boxes, to avoid conflicts
217 self.options.buildname = os.path.basename (os.path.abspath (self.path))
219 if self.options.verbose:
220 self.show_env(self.options,"Verbose")
224 for config in self.options.config:
225 modulename='config_'+config
227 m = __import__(modulename)
228 all_plc_specs = m.config(all_plc_specs,self.options)
230 traceback.print_exc()
231 print 'Cannot load config %s -- ignored'%modulename
234 # run localize as defined by local_resources
235 all_plc_specs = LocalTestResources.local_resources.localize(all_plc_specs,self.options)
237 # remember plc IP address(es) if not specified
238 ips_plc_file=open('arg-ips-plc','w')
239 for plc_spec in all_plc_specs:
240 ips_plc_file.write("%s\n"%plc_spec['PLC_API_HOST'])
243 ips_node_file=open('arg-ips-node','w')
244 for plc_spec in all_plc_specs:
245 for site_spec in plc_spec['sites']:
246 for node_spec in site_spec['nodes']:
247 ips_node_file.write("%s\n"%node_spec['node_fields']['hostname'])
248 ips_node_file.close()
249 # ditto for qemu boxes
250 ips_qemu_file=open('arg-ips-qemu','w')
251 for plc_spec in all_plc_specs:
252 for site_spec in plc_spec['sites']:
253 for node_spec in site_spec['nodes']:
254 ips_qemu_file.write("%s\n"%node_spec['host_box'])
255 ips_qemu_file.close()
256 # build a TestPlc object from the result, passing options
257 for spec in all_plc_specs:
258 spec['disabled'] = False
259 all_plcs = [ (x, TestPlc(x,self.options)) for x in all_plc_specs]
261 # pass options to utils as well
262 utils.init_options(self.options)
264 overall_result = True
265 testplc_method_dict = __import__("TestPlc").__dict__['TestPlc'].__dict__
267 for step in self.options.steps:
268 if not TestPlc.valid_step(step):
270 # some steps need to be done regardless of the previous ones: we force them
272 if step.find("force_") == 0:
273 step=step.replace("force_","")
275 # a cross step will run a method on TestPlc that has a signature like
276 # def cross_foo (self, all_test_plcs)
278 if step.find("cross_") == 0:
280 # allow for steps to specify an index like in
282 try: (step,qualifier)=step.split('@')
283 except: qualifier=None
285 # try and locate a method in TestPlc
286 if testplc_method_dict.has_key(step):
287 all_step_infos += [ (step, testplc_method_dict[step] , force, cross, qualifier)]
288 # otherwise search for the 'run' method in the step_<x> module
290 modulename='step_'+step
292 # locate all methods named run* in the module
293 module_dict = __import__(modulename).__dict__
294 names = [ key for key in module_dict.keys() if key.find("run")==0 ]
296 raise Exception,"No run* method in module %s"%modulename
298 all_step_infos += [ ("%s.%s"%(step,name),module_dict[name],force,cross,qualifier) for name in names ]
300 print '********** step %s NOT FOUND -- ignored'%(step)
301 traceback.print_exc()
302 overall_result = False
304 if self.options.dry_run:
305 self.show_env(self.options,"Dry run")
307 # init & open trace file if provided
308 if self.options.trace_file and not self.options.dry_run:
309 time=strftime("%H-%M")
310 date=strftime("%Y-%m-%d")
311 trace_file=self.options.trace_file
312 trace_file=trace_file.replace("@TIME@",time)
313 trace_file=trace_file.replace("@DATE@",date)
314 self.options.trace_file=trace_file
315 # create dir if needed
316 trace_dir=os.path.dirname(trace_file)
317 if trace_dir and not os.path.isdir(trace_dir):
318 os.makedirs(trace_dir)
319 trace=open(trace_file,"w")
321 # do all steps on all plcs
322 TIME_FORMAT="%H-%M-%S"
323 TRACE_FORMAT="TRACE: beg=%(beg)s end=%(end)s status=%(status)s step=%(stepname)s plc=%(plcname)s force=%(force)s\n"
324 for (stepname,method,force,cross,qualifier) in all_step_infos:
326 for (spec,plc_obj) in all_plcs:
328 # skip this step if we have specified a plc_explicit
329 if qualifier and plc_counter!=int(qualifier): continue
332 across_plcs = [ o for (s,o) in all_plcs if o!=plc_obj ]
335 beg=strftime(TIME_FORMAT)
336 if not spec['disabled'] or force or self.options.interactive:
338 if self.options.interactive:
341 msg="Run step %s on %s [r](un)/d(ry_run)/s(kip)/q(uit) ? "%(stepname,plcname)
342 answer=raw_input(msg).strip().lower() or "r"
344 if answer in ['s','n']: # skip/no/next
345 print '%s on %s skipped'%(stepname,plcname)
348 elif answer in ['q','b']: # quit/bye
351 elif answer in ['d']: # dry_run
352 dry_run=self.options.dry_run
353 self.options.dry_run=True
354 plc_obj.options.dry_run=True
355 plc_obj.apiserver.set_dry_run(True)
356 if not cross: step_result=method(plc_obj)
357 else: step_result=method(plc_obj,across_plcs)
358 print 'dry_run step ->',step_result
359 self.options.dry_run=dry_run
360 plc_obj.options.dry_run=dry_run
361 plc_obj.apiserver.set_dry_run(dry_run)
362 elif answer in ['r','y']: # run/yes
368 if force: force_msg=" (forced)"
369 utils.header("********** %d RUNNING step %s%s on plc %s"%(plc_counter,stepname,force_msg,plcname))
370 if not cross: step_result = method(plc_obj)
371 else: step_result = method(plc_obj,across_plcs)
373 utils.header('********** %d SUCCESSFUL step %s on %s'%(plc_counter,stepname,plcname))
376 overall_result = False
377 spec['disabled'] = True
378 utils.header('********** %d FAILED Step %s on %s (discarded from further steps)'\
379 %(plc_counter,stepname,plcname))
383 spec['disabled'] = True
384 traceback.print_exc()
385 utils.header ('********** %d FAILED (exception) Step %s on %s (discarded from further steps)'\
386 %(plc_counter,stepname,plcname))
389 # do not run, just display it's skipped
391 utils.header("********** %d IGNORED Plc %s is disabled - skipping step %s"%(plc_counter,plcname,stepname))
393 if not self.options.dry_run:
394 end=strftime(TIME_FORMAT)
395 # always do this on stdout
396 print TRACE_FORMAT%locals()
397 # duplicate on trace_file if provided
398 if self.options.trace_file:
399 trace.write(TRACE_FORMAT%locals())
402 if self.options.trace_file and not self.options.dry_run:
405 return overall_result
407 # wrapper to run, returns a shell-compatible result
416 print 'Caught SystemExit'
419 traceback.print_exc()
422 if __name__ == "__main__":
423 sys.exit(TestMain().main())