system/TestMain.py

   1 #!/usr/bin/python -u
   2 # $Id$
   3
   4 import sys, os, os.path
   5 from optparse import OptionParser
   6 import traceback
   7 from time import strftime
   8 import readline
   9
  10 import utils
  11 from TestPlc import TestPlc
  12 from TestSite import TestSite
  13 from TestNode import TestNode
  14
  15 class TestMain:
  16
  17     subversion_id = "$Id$"
  18
  19     default_config = [ 'default' ]
  20
  21     default_build_url = "http://svn.planet-lab.org/svn/build/trunk"
  22
  23     def __init__ (self):
  24         self.path=os.path.dirname(sys.argv[0]) or "."
  25         os.chdir(self.path)
  26
  27     @staticmethod
  28     def show_env (options, message):
  29         utils.header (message)
  30         utils.show_options("main options",options)
  31
  32     @staticmethod
  33     def optparse_list (option, opt, value, parser):
  34         try:
  35             setattr(parser.values,option.dest,getattr(parser.values,option.dest)+value.split())
  36         except:
  37             setattr(parser.values,option.dest,value.split())
  38
  39     def run (self):
  40         steps_message=20*'x'+" Defaut steps are\n"+TestPlc.printable_steps(TestPlc.default_steps)
  41         steps_message += "\n"+20*'x'+" Other useful steps are\n"+TestPlc.printable_steps(TestPlc.other_steps)
  42         usage = """usage: %%prog [options] steps
  43 arch-rpms-url defaults to the last value used, as stored in arg-arch-rpms-url,
  44    no default
  45 build-url defaults to the last value used, as stored in arg-build-url,
  46    or %s
  47 config defaults to the last value used, as stored in arg-config,
  48    or %r
  49 node-ips and plc-ips defaults to the last value used, as stored in arg-ips-node and arg-ips-plc,
  50    default is to use IP scanning
  51 steps refer to a method in TestPlc or to a step_* module
  52 ===
  53 """%(TestMain.default_build_url,TestMain.default_config)
  54         usage += steps_message
  55         parser=OptionParser(usage=usage,version=self.subversion_id)
  56         parser.add_option("-u","--url",action="store", dest="arch_rpms_url",
  57                           help="URL of the arch-dependent RPMS area - for locating what to test")
  58         parser.add_option("-b","--build",action="store", dest="build_url",
  59                           help="Build URL - for locating vtest-init-vserver.sh")
  60         parser.add_option("-c","--config",action="callback", callback=TestMain.optparse_list, dest="config",
  61                           nargs=1,type="string",
  62                           help="Config module - can be set multiple times, or use quotes")
  63         parser.add_option("-p","--personality",action="store", dest="personality",
  64                           help="personality - as in vbuild-nightly")
  65         parser.add_option("-d","--pldistro",action="store", dest="pldistro",
  66                           help="pldistro - as in vbuild-nightly")
  67         parser.add_option("-f","--fcdistro",action="store", dest="fcdistro",
  68                           help="fcdistro - as in vbuild-nightly")
  69         parser.add_option("-x","--exclude",action="callback", callback=TestMain.optparse_list, dest="exclude",
  70                           nargs=1,type="string",default=[],
  71                           help="steps to exclude - can be set multiple times, or use quotes")
  72         parser.add_option("-a","--all",action="store_true",dest="all_steps", default=False,
  73                           help="Run all default steps")
  74         parser.add_option("-l","--list",action="store_true",dest="list_steps", default=False,
  75                           help="List known steps")
  76         parser.add_option("-N","--nodes",action="callback", callback=TestMain.optparse_list, dest="ips_node",
  77                           nargs=1,type="string",
  78                           help="Specify the set of IP addresses to use for nodes (scanning disabled)")
  79         parser.add_option("-P","--plcs",action="callback", callback=TestMain.optparse_list, dest="ips_plc",
  80                           nargs=1,type="string",
  81                           help="Specify the set of IP addresses to use for plcs (scanning disabled)")
  82         parser.add_option("-s","--size",action="store",type="int",dest="size",default=1,
  83                           help="sets test size in # of plcs - default is 1")
  84         parser.add_option("-D","--dbname",action="store",dest="dbname",default=None,
  85                            help="Used by db_dump and db_restore")
  86         parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
  87                           help="Run in verbose mode")
  88         parser.add_option("-q","--quiet", action="store_true", dest="quiet", default=False,
  89                           help="Run in quiet mode")
  90         parser.add_option("-i","--interactive",action="store_true",dest="interactive",default=False,
  91                           help="prompts before each step")
  92         parser.add_option("-n","--dry-run", action="store_true", dest="dry_run", default=False,
  93                           help="Show environment and exits")
  94         parser.add_option("-r","--restart-nm", action="store_true", dest="forcenm", default=False,
  95                           help="Force the NM to restart in check_slices step")
  96         parser.add_option("-t","--trace", action="store", dest="trace_file", default=None,
  97                           #default="logs/trace-@TIME@.txt",
  98                           help="Trace file location")
  99         (self.options, self.args) = parser.parse_args()
 100         if self.options.quiet:
 101             self.options.verbose=False
 102
 103         if len(self.args) == 0:
 104             if self.options.all_steps:
 105                 self.options.steps=TestPlc.default_steps
 106             elif self.options.dry_run:
 107                 self.options.steps=TestPlc.default_steps
 108             elif self.options.list_steps:
 109                 print steps_message
 110                 sys.exit(1)
 111             else:
 112                 print 'No step found (do you mean -a ? )'
 113                 print "Run %s --help for help"%sys.argv[0]
 114                 sys.exit(1)
 115         else:
 116             self.options.steps = self.args
 117
 118         # handle defaults and option persistence
 119         for (recname,filename,default) in (
 120             ('build_url','arg-build-url',TestMain.default_build_url) ,
 121             ('ips_node','arg-ips-node',[]) ,
 122             ('ips_plc','arg-ips-plc',[]) ,
 123             ('config','arg-config',TestMain.default_config) ,
 124             ('arch_rpms_url','arg-arch-rpms-url',"") ,
 125             ('personality','arg-personality',"linux32"),
 126             ('pldistro','arg-pldistro',"planetlab"),
 127             ('fcdistro','arg-fcdistro','centos5'),
 128             ) :
 129 #            print 'handling',recname
 130             path=filename
 131             is_list = isinstance(default,list)
 132             if not getattr(self.options,recname):
 133                 try:
 134                     parsed=file(path).readlines()
 135                     if not is_list:    # strings
 136                         if len(parsed) != 1:
 137                             print "%s - error when parsing %s"%(sys.argv[1],path)
 138                             sys.exit(1)
 139                         parsed=parsed[0].strip()
 140                     else:              # lists
 141                         parsed=[x.strip() for x in parsed]
 142                     setattr(self.options,recname,parsed)
 143                 except:
 144                     if default != "":
 145                         setattr(self.options,recname,default)
 146                     else:
 147                         print "Cannot determine",recname
 148                         print "Run %s --help for help"%sys.argv[0]
 149                         sys.exit(1)
 150
 151             # save for next run
 152             fsave=open(path,"w")
 153             if not is_list:
 154                 fsave.write(getattr(self.options,recname) + "\n")
 155             else:
 156                 for value in getattr(self.options,recname):
 157                     fsave.write(value + "\n")
 158             fsave.close()
 159 #            utils.header('Saved %s into %s'%(recname,filename))
 160
 161             # lists need be reversed
 162             if isinstance(getattr(self.options,recname),list):
 163                 getattr(self.options,recname).reverse()
 164
 165             if not self.options.quiet:
 166                 utils.header('* Using %s = %s'%(recname,getattr(self.options,recname)))
 167
 168
 169         # steps
 170         if not self.options.steps:
 171             #default (all) steps
 172             #self.options.steps=['dump','clean','install','populate']
 173             self.options.steps=TestPlc.default_steps
 174
 175         # exclude
 176         selected=[]
 177         for step in self.options.steps:
 178             keep=True
 179             for exclude in self.options.exclude:
 180                 if utils.match(step,exclude):
 181                     keep=False
 182                     break
 183             if keep: selected.append(step)
 184         self.options.steps=selected
 185
 186         # this is useful when propagating on host boxes, to avoid conflicts
 187         self.options.buildname = os.path.basename (os.path.abspath (self.path))
 188
 189         if self.options.verbose:
 190             self.show_env(self.options,"Verbose")
 191
 192         # load configs
 193         all_plc_specs = []
 194         for config in self.options.config:
 195             modulename='config_'+config
 196             try:
 197                 m = __import__(modulename)
 198                 all_plc_specs = m.config(all_plc_specs,self.options)
 199             except :
 200                 traceback.print_exc()
 201                 print 'Cannot load config %s -- ignored'%modulename
 202                 raise
 203         # remember plc IP address(es) if not specified
 204         ips_plc_file=open('arg-ips-plc','w')
 205         for plc_spec in all_plc_specs:
 206             ips_plc_file.write("%s\n"%plc_spec['PLC_API_HOST'])
 207         ips_plc_file.close()
 208         # ditto for nodes
 209         ips_node_file=open('arg-ips-node','w')
 210         for plc_spec in all_plc_specs:
 211             for site_spec in plc_spec['sites']:
 212                 for node_spec in site_spec['nodes']:
 213                     ips_node_file.write("%s\n"%node_spec['node_fields']['hostname'])
 214         ips_node_file.close()
 215         # build a TestPlc object from the result, passing options
 216         for spec in all_plc_specs:
 217             spec['disabled'] = False
 218         all_plcs = [ (x, TestPlc(x,self.options)) for x in all_plc_specs]
 219
 220         # pass options to utils as well
 221         utils.init_options(self.options)
 222
 223         overall_result = True
 224         testplc_method_dict = __import__("TestPlc").__dict__['TestPlc'].__dict__
 225         all_step_infos=[]
 226         for step in self.options.steps:
 227             if not TestPlc.valid_step(step):
 228                 continue
 229             force=False
 230             # is it a forced step
 231             if step.find("force_") == 0:
 232                 step=step.replace("force_","")
 233                 force=True
 234             # try and locate a method in TestPlc
 235             if testplc_method_dict.has_key(step):
 236                 all_step_infos += [ (step, testplc_method_dict[step] , force)]
 237             # otherwise search for the 'run' method in the step_<x> module
 238             else:
 239                 modulename='step_'+step
 240                 try:
 241                     # locate all methods named run* in the module
 242                     module_dict = __import__(modulename).__dict__
 243                     names = [ key for key in module_dict.keys() if key.find("run")==0 ]
 244                     if not names:
 245                         raise Exception,"No run* method in module %s"%modulename
 246                     names.sort()
 247                     all_step_infos += [ ("%s.%s"%(step,name),module_dict[name],force) for name in names ]
 248                 except :
 249                     print '********** step %s NOT FOUND -- ignored'%(step)
 250                     traceback.print_exc()
 251                     overall_result = False
 252
 253         if self.options.dry_run:
 254             self.show_env(self.options,"Dry run")
 255
 256         # init & open trace file if provided
 257         if self.options.trace_file and not self.options.dry_run:
 258             time=strftime("%H-%M")
 259             date=strftime("%Y-%m-%d")
 260             trace_file=self.options.trace_file
 261             trace_file=trace_file.replace("@TIME@",time)
 262             trace_file=trace_file.replace("@DATE@",date)
 263             self.options.trace_file=trace_file
 264             # create dir if needed
 265             trace_dir=os.path.dirname(trace_file)
 266             if trace_dir and not os.path.isdir(trace_dir):
 267                 os.makedirs(trace_dir)
 268             trace=open(trace_file,"w")
 269
 270         # do all steps on all plcs
 271         TRACE_FORMAT="TRACE: time=%(time)s plc=%(plcname)s step=%(stepname)s status=%(status)s force=%(force)s\n"
 272         for (stepname,method,force) in all_step_infos:
 273             for (spec,obj) in all_plcs:
 274                 plcname=spec['name']
 275
 276                 # run the step
 277                 time=strftime("%Y-%m-%d-%H-%M")
 278                 if not spec['disabled'] or force or self.options.interactive:
 279                     skip_step=False
 280                     if self.options.interactive:
 281                         prompting=True
 282                         while prompting:
 283                             msg="Run step %s on %s [r](un)/d(ry_run)/s(kip)/q(uit) ? "%(stepname,plcname)
 284                             answer=raw_input(msg).strip().lower() or "r"
 285                             answer=answer[0]
 286                             if answer in ['s','n']:     # skip/no/next
 287                                 print '%s on %s skipped'%(stepname,plcname)
 288                                 prompting=False
 289                                 skip_step=True
 290                             elif answer in ['q','b']:   # quit/bye
 291                                 print 'Exiting'
 292                                 return
 293                             elif answer in ['d']:       # dry_run
 294                                 dry_run=self.options.dry_run
 295                                 self.options.dry_run=True
 296                                 obj.options.dry_run=True
 297                                 obj.apiserver.set_dry_run(True)
 298                                 step_result=method(obj)
 299                                 print 'dry_run step ->',step_result
 300                                 self.options.dry_run=dry_run
 301                                 obj.options.dry_run=dry_run
 302                                 obj.apiserver.set_dry_run(dry_run)
 303                             elif answer in ['r','y']:   # run/yes
 304                                 prompting=False
 305                     if skip_step:
 306                         continue
 307                     try:
 308                         force_msg=""
 309                         if force: force_msg=" (forced)"
 310                         utils.header("********** RUNNING step %s%s on plc %s"%(stepname,force_msg,plcname))
 311                         step_result = method(obj)
 312                         if step_result:
 313                             utils.header('********** SUCCESSFUL step %s on %s'%(stepname,plcname))
 314                             status="OK"
 315                         else:
 316                             overall_result = False
 317                             spec['disabled'] = True
 318                             utils.header('********** FAILED Step %s on %s - discarding that plc from further steps'%(stepname,plcname))
 319                             status="KO"
 320                     except:
 321                         overall_result=False
 322                         spec['disabled'] = True
 323                         traceback.print_exc()
 324                         utils.header ('********** FAILED (exception) Step %s on plc %s - discarding this plc from further steps'%(stepname,plcname))
 325                         status="KO"
 326
 327                 # do not run, just display it's skipped
 328                 else:
 329                     utils.header("********** IGNORED Plc %s is disabled - skipping step %s"%(plcname,stepname))
 330                     status="UNDEF"
 331                 if not self.options.dry_run:
 332                     # alwas do this on stdout
 333                     print TRACE_FORMAT%locals()
 334                     # duplicate on trace_file if provided
 335                     if self.options.trace_file:
 336                         trace.write(TRACE_FORMAT%locals())
 337
 338         if self.options.trace_file and not self.options.dry_run:
 339             trace.close()
 340
 341         return overall_result
 342
 343     # wrapper to run, returns a shell-compatible result
 344     def main(self):
 345         try:
 346             success=self.run()
 347             if success:
 348                 return 0
 349             else:
 350                 return 1
 351         except SystemExit:
 352             raise
 353         except:
 354             traceback.print_exc()
 355             return 2
 356
 357 if __name__ == "__main__":
 358     sys.exit(TestMain().main())