system/TestMain.py

   1 #!/usr/bin/python3 -u
   2
   3 # Thierry Parmentelat <thierry.parmentelat@inria.fr>
   4 # Copyright (C) 2010 INRIA
   5 #
   6 import sys, os, os.path
   7 from argparse import ArgumentParser
   8 import traceback
   9 import readline
  10 import glob
  11 from datetime import datetime
  12
  13 import utils
  14 from TestPlc import TestPlc, Ignored
  15 from TestBonding import TestBonding, onelab_bonding_spec
  16 from TestSite import TestSite
  17 from TestNode import TestNode
  18 from macros import sequences
  19
  20 # add $HOME in PYTHONPATH so we can import LocalSubstrate.py
  21 sys.path.append(os.environ['HOME'])
  22 import LocalSubstrate
  23
  24 class Step:
  25
  26     natives = TestPlc.__dict__
  27
  28     def display (self):
  29         return self.name.replace('_', '-')
  30     def internal (self):
  31         return self.name.replace('-', '_')
  32
  33     def __init__ (self, name):
  34         self.name = name
  35         # a native step is implemented as a method on TestPlc
  36         self.native = self.internal() in Step.natives
  37         if self.native:
  38             self.method = Step.natives[self.internal()]
  39         else:
  40             try:
  41                 self.substeps = sequences[self.internal()]
  42             except Exception as e:
  43                 print("macro step {} not found in macros.py ({}) - exiting".format(self.display(),e))
  44                 raise
  45
  46     def print_doc (self, level=0):
  47         tab = 32
  48         trail = 8
  49         if self.native:
  50             start = level*' ' + '* '
  51             # 2 is the len of '* '
  52             width = tab - level - 2
  53             format = "%%-%ds" % width
  54             line = start + format % self.display()
  55             print(line, end=' ')
  56             try:
  57                 print(self.method.__doc__)
  58             except:
  59                 print("*** no doc found")
  60         else:
  61             beg_start = level*' ' + '>>> '
  62             end_start = level*' ' + '<<< '
  63             trailer = trail * '-'
  64             # 4 is the len of '>>> '
  65             width = tab - level - 4 - trail
  66             format = "%%-%ds" % width
  67             beg_line = beg_start + format % self.display() + trail*'>'
  68             end_line = end_start + format % self.display() + trail*'<'
  69             print(beg_line)
  70             for step in self.substeps:
  71                 Step(step).print_doc(level+1)
  72             print(end_line)
  73
  74     # return a list of (name, method) for all native steps involved
  75     def tuples (self):
  76         if self.native:
  77             return [ (self.internal(), self.method,) ]
  78         else:
  79             result = []
  80             for substep in [ Step(name) for name in self.substeps ] :
  81                 result += substep.tuples()
  82             return result
  83
  84     # convenience for listing macros
  85     # just do a listdir, hoping we're in the right directory...
  86     @staticmethod
  87     def list_macros ():
  88         names= list(sequences.keys())
  89         names.sort()
  90         return names
  91
  92 class TestMain:
  93
  94     default_config = [ 'default' ]
  95 #    default_rspec_styles = [ 'pl', 'pg' ]
  96     default_rspec_styles = [ 'pg' ]
  97
  98     default_build_url = "git://git.onelab.eu/tests"
  99
 100     def __init__(self):
 101         self.path = os.path.dirname(sys.argv[0]) or "."
 102         os.chdir(self.path)
 103
 104     def show_env(self, options, message):
 105         if self.options.verbose:
 106             utils.header(message)
 107             utils.show_options("main options", options)
 108
 109     def init_steps(self):
 110         self.steps_message  = ""
 111         if not self.options.bonding:
 112             self.steps_message += 20*'x' + " Defaut steps are\n" + \
 113                                   TestPlc.printable_steps(TestPlc.default_steps)
 114             self.steps_message += 20*'x' + " Other useful steps are\n" + \
 115                                   TestPlc.printable_steps(TestPlc.other_steps)
 116             self.steps_message += 20*'x' + " Macro steps are\n" + \
 117                                   " ".join(Step.list_macros())
 118         else:
 119             self.steps_message += 20*'x' + " Default steps with bonding are\n" + \
 120                                   TestPlc.printable_steps(TestPlc.bonding_steps)
 121
 122     def list_steps(self):
 123         if not self.options.verbose:
 124             print(self.steps_message)
 125         else:
 126             # steps mentioned on the command line
 127             if self.options.steps:
 128                 scopes = [("Argument steps",self.options.steps)]
 129             else:
 130                 scopes = [("Default steps", TestPlc.default_steps)]
 131                 if self.options.all_steps:
 132                     scopes.append ( ("Other steps", TestPlc.other_steps) )
 133                     # try to list macro steps as well
 134                     scopes.append ( ("Macro steps", Step.list_macros()) )
 135             for (scope, steps) in scopes:
 136                 print('--------------------', scope)
 137                 for step in [step for step in steps if TestPlc.valid_step(step)]:
 138                     try:
 139                         (step, qualifier) = step.split('@')
 140                     except:
 141                         pass
 142                     stepname = step
 143                     for special in ['force', 'ignore']:
 144                         stepname = stepname.replace('_'+special, "")
 145                     Step(stepname).print_doc()
 146
 147     def run (self):
 148         usage = """usage: %%prog [options] steps
 149 arch-rpms-url defaults to the last value used, as stored in arg-arch-rpms-url,
 150    no default
 151 config defaults to the last value used, as stored in arg-config,
 152    or {}
 153 ips_vnode, ips_vplc and ips_qemu defaults to the last value used,
 154    as stored in arg-ips-{{bplc,vplc,bnode,vnode}},
 155    default is to use IP scanning
 156 steps refer to a method in TestPlc or to a step_* module
 157
 158 run with -l to see a list of available steps
 159 ===
 160 """.format(TestMain.default_config)
 161
 162         parser = ArgumentParser(usage = usage)
 163         parser.add_argument("-u", "--url", action="store",  dest="arch_rpms_url",
 164                             help="URL of the arch-dependent RPMS area - for locating what to test")
 165         parser.add_argument("-b", "--build", action="store", dest="build_url",
 166                             help="ignored, for legacy only")
 167         parser.add_argument("-c", "--config", action="append", dest="config", default=[],
 168                             help="Config module - can be set multiple times, or use quotes")
 169         parser.add_argument("-p", "--personality", action="store", dest="personality",
 170                             help="personality - as in vbuild-nightly")
 171         parser.add_argument("-d", "--pldistro", action="store", dest="pldistro",
 172                             help="pldistro - as in vbuild-nightly")
 173         parser.add_argument("-f", "--fcdistro", action="store", dest="fcdistro",
 174                             help="fcdistro - as in vbuild-nightly")
 175         parser.add_argument("-e", "--exclude", action="append", dest="exclude", default=[],
 176                             help="steps to exclude - can be set multiple times, or use quotes")
 177         parser.add_argument("-i", "--ignore", action="append", dest="ignore", default=[],
 178                             help="steps to run but ignore - can be set multiple times, or use quotes")
 179         parser.add_argument("-a", "--all", action="store_true", dest="all_steps", default=False,
 180                             help="Run all default steps")
 181         parser.add_argument("-l", "--list", action="store_true", dest="list_steps", default=False,
 182                             help="List known steps")
 183         parser.add_argument("-V", "--vserver", action="append", dest="ips_bplc", default=[],
 184                             help="Specify the set of hostnames for the boxes that host the plcs")
 185         parser.add_argument("-P", "--plcs", action="append", dest="ips_vplc", default=[],
 186                             help="Specify the set of hostname/IP's to use for vplcs")
 187         parser.add_argument("-Q", "--qemus", action="append", dest="ips_bnode", default=[],
 188                             help="Specify the set of hostnames for the boxes that host the nodes")
 189         parser.add_argument("-N", "--nodes", action="append", dest="ips_vnode", default=[],
 190                             help="Specify the set of hostname/IP's to use for vnodes")
 191         parser.add_argument("-s", "--size", action="store", dest="size", default=1,
 192                             type=int,
 193                             help="set test size in # of plcs - default is 1")
 194         parser.add_argument("-q", "--qualifier", action="store", dest="qualifier", default=None,
 195                             type=int,
 196                             help="run steps only on plc numbered <qualifier>, starting at 1")
 197         parser.add_argument("-y", "--rspec-style", action="append", dest="rspec_styles", default=[],
 198                             help="pl is for planetlab rspecs, pg is for protogeni")
 199         parser.add_argument("-k", "--keep-going", action="store", dest="keep_going", default=False,
 200                             help="proceeds even if some steps are failing")
 201         parser.add_argument("-D", "--dbname", action="store", dest="dbname", default=None,
 202                             help="Used by plc_db_dump and plc_db_restore")
 203         parser.add_argument("-v", "--verbose", action="store_true", dest="verbose", default=False,
 204                             help="Run in verbose mode")
 205         parser.add_argument("-I", "--interactive", action="store_true", dest="interactive", default=False,
 206                             help="prompts before each step")
 207         parser.add_argument("-n", "--dry-run", action="store_true", dest="dry_run", default=False,
 208                             help="Show environment and exits")
 209         parser.add_argument("-t", "--trace", action="store", dest="trace_file", default=None,
 210                             help="Trace file location")
 211         parser.add_argument("-g", "--bonding", action='store', dest='bonding', default=None,
 212                             help="specify build to bond with")
 213         parser.add_argument("steps", nargs='*')
 214         self.options = parser.parse_args()
 215
 216         # allow things like "run -c 'c1 c2' -c c3"
 217         def flatten (x):
 218             result = []
 219             for el in x:
 220                 if hasattr(el, "__iter__") and not isinstance(el, str):
 221                     result.extend(flatten(el))
 222                 else:
 223                     result.append(el)
 224             return result
 225         # flatten relevant options
 226         for optname in ['config', 'exclude', 'ignore', 'ips_bplc', 'ips_vplc', 'ips_bnode', 'ips_vnode']:
 227             setattr(self.options, optname,
 228                     flatten([arg.split() for arg in getattr(self.options, optname)]))
 229
 230         if not self.options.rspec_styles:
 231             self.options.rspec_styles = TestMain.default_rspec_styles
 232
 233         # handle defaults and option persistence
 234         for recname, filename, default, need_reverse in (
 235             ('build_url', 'arg-build-url', TestMain.default_build_url, None),
 236             ('ips_bplc', 'arg-ips-bplc', [], True),
 237             ('ips_vplc', 'arg-ips-vplc', [], True),
 238             ('ips_bnode', 'arg-ips-bnode', [], True),
 239             ('ips_vnode', 'arg-ips-vnode', [], True),
 240             ('config', 'arg-config', TestMain.default_config, False),
 241             ('arch_rpms_url', 'arg-arch-rpms-url', "", None),
 242             ('personality', 'arg-personality', "linux64", None),
 243             ('pldistro', 'arg-pldistro', "onelab", None),
 244             ('fcdistro', 'arg-fcdistro', 'f14', None),
 245             ):
 246 #            print('handling', recname)
 247             path = filename
 248             is_list = isinstance(default, list)
 249             is_bool = isinstance(default, bool)
 250             if not getattr(self.options, recname):
 251                 try:
 252                     with open(path) as file:
 253                         parsed = file.readlines()
 254                     if is_list:         # lists
 255                         parsed = [x.strip() for x in parsed]
 256                     else:               # strings and booleans
 257                         if len(parsed) != 1:
 258                             print("{} - error when parsing {}".format(sys.argv[1], path))
 259                             sys.exit(1)
 260                         parsed = parsed[0].strip()
 261                         if is_bool:
 262                             parsed = parsed.lower() == 'true'
 263                     setattr(self.options, recname, parsed)
 264                 except  Exception as e:
 265                     if default != "":
 266                         setattr(self.options, recname, default)
 267                     else:
 268                         print("Cannot determine", recname, e)
 269                         print("Run {} --help for help".format(sys.argv[0]))
 270                         sys.exit(1)
 271
 272             # save for next run
 273             fsave = open(path, "w")
 274             if is_list:                 # lists
 275                 for value in getattr(self.options, recname):
 276                     fsave.write(value + "\n")
 277             else:                       # strings and booleans - just call str()
 278                 fsave.write(str(getattr(self.options, recname)) + "\n")
 279             fsave.close()
 280 #            utils.header('Saved {} into {}'.format(recname, filename))
 281
 282             # lists need be reversed
 283             # I suspect this is useful for the various pools but for config, it's painful
 284             if isinstance(getattr(self.options, recname), list) and need_reverse:
 285                 getattr(self.options, recname).reverse()
 286
 287             if self.options.verbose:
 288                 utils.header('* Using {} = {}'.format(recname, getattr(self.options, recname)))
 289
 290         # hack : if sfa is not among the published rpms, skip these tests
 291         TestPlc.check_whether_build_has_sfa(self.options.arch_rpms_url)
 292
 293         # initialize steps
 294         if not self.options.steps:
 295             # defaults, depends on using bonding or not
 296             if self.options.bonding:
 297                 self.options.steps = TestPlc.bonding_steps
 298             else:
 299                 self.options.steps = TestPlc.default_steps
 300
 301         if self.options.list_steps:
 302             self.init_steps()
 303             self.list_steps()
 304             return 'SUCCESS'
 305
 306         # rewrite '-' into '_' in step names
 307         self.options.steps   = [ step.replace('-', '_') for step in self.options.steps ]
 308         self.options.exclude = [ step.replace('-', '_') for step in self.options.exclude ]
 309         self.options.ignore  = [ step.replace('-', '_') for step in self.options.ignore ]
 310
 311         # technicality, decorate known steps to produce the '_ignore' version
 312         TestPlc.create_ignore_steps()
 313
 314         # exclude
 315         selected = []
 316         for step in self.options.steps:
 317             keep = True
 318             for exclude in self.options.exclude:
 319                 if utils.match(step, exclude):
 320                     keep = False
 321                     break
 322             if keep:
 323                 selected.append(step)
 324
 325         # ignore
 326         selected = [ step if step not in self.options.ignore else step + "_ignore"
 327                      for step in selected ]
 328
 329         self.options.steps = selected
 330
 331         # this is useful when propagating on host boxes, to avoid conflicts
 332         self.options.buildname = os.path.basename(os.path.abspath(self.path))
 333
 334         if self.options.verbose:
 335             self.show_env(self.options, "Verbose")
 336
 337         # load configs
 338         all_plc_specs = []
 339         for config in self.options.config:
 340             modulename = 'config_' + config
 341             try:
 342                 m = __import__(modulename)
 343                 all_plc_specs = m.config(all_plc_specs, self.options)
 344             except :
 345                 traceback.print_exc()
 346                 print('Cannot load config {} -- ignored'.format(modulename))
 347                 raise
 348
 349         # provision on local substrate
 350         all_plc_specs = LocalSubstrate.local_substrate.provision(all_plc_specs, self.options)
 351
 352         # remember substrate IP address(es) for next run
 353         with open('arg-ips-bplc', 'w') as ips_bplc_file:
 354             for plc_spec in all_plc_specs:
 355                 ips_bplc_file.write("{}\n".format(plc_spec['host_box']))
 356         with open('arg-ips-vplc', 'w') as ips_vplc_file:
 357             for plc_spec in all_plc_specs:
 358                 ips_vplc_file.write("{}\n".format(plc_spec['settings']['PLC_API_HOST']))
 359         # ditto for nodes
 360         with open('arg-ips-bnode', 'w') as ips_bnode_file:
 361             for plc_spec in all_plc_specs:
 362                 for site_spec in plc_spec['sites']:
 363                     for node_spec in site_spec['nodes']:
 364                         ips_bnode_file.write("{}\n".format(node_spec['host_box']))
 365         with open('arg-ips-vnode','w') as ips_vnode_file:
 366             for plc_spec in all_plc_specs:
 367                 for site_spec in plc_spec['sites']:
 368                     for node_spec in site_spec['nodes']:
 369                         # back to normal (unqualified) form
 370                         stripped = node_spec['node_fields']['hostname'].split('.')[0]
 371                         ips_vnode_file.write("{}\n".format(stripped))
 372
 373         # build a TestPlc object from the result, passing options
 374         for spec in all_plc_specs:
 375             spec['failed_step'] = False
 376         all_plcs = [ (x, TestPlc(x,self.options)) for x in all_plc_specs]
 377
 378         # pass options to utils as well
 379         utils.init_options(self.options)
 380
 381         # populate TestBonding objects
 382         # need to wait until here as we need all_plcs
 383         if self.options.bonding:
 384             ## allow to pass -g ../2015.03.15--f18 so we can use bash completion
 385             self.options.bonding = os.path.basename(self.options.bonding)
 386             # this will fail if ../{bonding} has not the right arg- files
 387             for spec, test_plc in all_plcs:
 388                 test_plc.test_bonding = TestBonding (test_plc,
 389                                                      onelab_bonding_spec(self.options.bonding),
 390                                                      self.options)
 391
 392         overall_result = 'SUCCESS'
 393         all_step_infos = []
 394         for step in self.options.steps:
 395             if not TestPlc.valid_step(step):
 396                 continue
 397             # some steps need to be done regardless of the previous ones: we force them
 398             force = False
 399             if step.endswith("_force"):
 400                 step = step.replace("_force", "")
 401                 force = True
 402             # allow for steps to specify an index like in
 403             # run checkslice@2
 404             try:
 405                 step, qualifier = step.split('@')
 406             except:
 407                 qualifier = self.options.qualifier
 408
 409             try:
 410                 stepobj = Step (step)
 411                 for substep, method in stepobj.tuples():
 412                     # a cross step will run a method on TestPlc that has a signature like
 413                     # def cross_foo (self, all_test_plcs)
 414                     cross = False
 415                     if substep.find("cross_") == 0:
 416                         cross = True
 417                     all_step_infos.append ( (substep, method, force, cross, qualifier, ) )
 418             except :
 419                 utils.header("********** FAILED step {} (NOT FOUND) -- won't be run".format(step))
 420                 traceback.print_exc()
 421                 overall_result = 'FAILURE'
 422
 423         if self.options.dry_run:
 424             self.show_env(self.options, "Dry run")
 425
 426         # init & open trace file if provided
 427         if self.options.trace_file and not self.options.dry_run:
 428             # create dir if needed
 429             trace_dir = os.path.dirname(self.options.trace_file)
 430             if trace_dir and not os.path.isdir(trace_dir):
 431                 os.makedirs(trace_dir)
 432             trace = open(self.options.trace_file,"w")
 433
 434         # do all steps on all plcs
 435         TIME_FORMAT = "%H-%M-%S"
 436         TRACE_FORMAT = "TRACE: {plc_counter:d} {begin}->{seconds}s={duration}s " + \
 437                        "status={status} step={stepname} plc={plcname} force={force}\n"
 438         for stepname, method, force, cross, qualifier in all_step_infos:
 439             plc_counter = 0
 440             for spec, plc_obj in all_plcs:
 441                 plc_counter += 1
 442                 # skip this step if we have specified a plc_explicit
 443                 if qualifier and plc_counter != int(qualifier):
 444                     continue
 445
 446                 plcname = spec['name']
 447                 across_plcs = [ o for (s,o) in all_plcs if o!=plc_obj ]
 448
 449                 # run the step
 450                 beg_time = datetime.now()
 451                 begin = beg_time.strftime(TIME_FORMAT)
 452                 if not spec['failed_step'] or force or self.options.interactive or self.options.keep_going:
 453                     skip_step = False
 454                     if self.options.interactive:
 455                         prompting = True
 456                         while prompting:
 457                             msg="{:d} Run step {} on {} [r](un)/d(ry_run)/p(roceed)/s(kip)/q(uit) ? "\
 458                                 .format(plc_counter, stepname, plcname)
 459                             answer = input(msg).strip().lower() or "r"
 460                             answer = answer[0]
 461                             if answer in ['s','n']:     # skip/no/next
 462                                 print('{} on {} skipped'.format(stepname, plcname))
 463                                 prompting = False
 464                                 skip_step = True
 465                             elif answer in ['q','b']:   # quit/bye
 466                                 print('Exiting')
 467                                 return 'FAILURE'
 468                             elif answer in ['d']:       # dry_run
 469                                 dry_run = self.options.dry_run
 470                                 self.options.dry_run = True
 471                                 plc_obj.options.dry_run = True
 472                                 plc_obj.apiserver.set_dry_run(True)
 473                                 if not cross:
 474                                     step_result=method(plc_obj)
 475                                 else:
 476                                     step_result=method(plc_obj, across_plcs)
 477                                 print('dry_run step ->', step_result)
 478                                 self.options.dry_run = dry_run
 479                                 plc_obj.options.dry_run = dry_run
 480                                 plc_obj.apiserver.set_dry_run(dry_run)
 481                             elif answer in ['p']:
 482                                 # take it as a yes and leave interactive mode
 483                                 prompting = False
 484                                 self.options.interactive = False
 485                             elif answer in ['r','y']:   # run/yes
 486                                 prompting = False
 487                     if skip_step:
 488                         continue
 489                     try:
 490                         force_msg = ""
 491                         if force and spec['failed_step']:
 492                             force_msg=" (forced after {} has failed)".format(spec['failed_step'])
 493                         utils.header("********** {:d} RUNNING step {}{} on plc {}"\
 494                                      .format(plc_counter, stepname, force_msg, plcname))
 495                         if not cross:
 496                             step_result = method(plc_obj)
 497                         else:
 498                             step_result = method(plc_obj, across_plcs)
 499                         if isinstance (step_result, Ignored):
 500                             step_result = step_result.result
 501                             if step_result:
 502                                 msg = "OK"
 503                             else:
 504                                 msg = "KO"
 505                                 # do not overwrite if FAILURE
 506                                 if overall_result == 'SUCCESS':
 507                                     overall_result = 'IGNORED'
 508                             utils.header('********** {} IGNORED ({}) step {} on {}'\
 509                                          .format(plc_counter, msg, stepname, plcname))
 510                             status="{}[I]".format(msg)
 511                         elif step_result:
 512                             utils.header('********** {:d} SUCCESSFUL step {} on {}'\
 513                                          .format(plc_counter, stepname, plcname))
 514                             status = "OK"
 515                         else:
 516                             overall_result = 'FAILURE'
 517                             spec['failed_step'] = stepname
 518                             utils.header('********** {:d} FAILED step {} on {} (discarded from further steps)'\
 519                                          .format(plc_counter, stepname, plcname))
 520                             status = "KO"
 521                     except:
 522                         overall_result = 'FAILURE'
 523                         spec['failed_step'] = stepname
 524                         traceback.print_exc()
 525                         utils.header ('********** {} FAILED (exception) step {} on {} (discarded from further steps)'\
 526                                       .format(plc_counter, stepname, plcname))
 527                         status = "KO"
 528
 529                 # do not run, just display it's skipped
 530                 else:
 531                     why = "has failed {}".format(spec['failed_step'])
 532                     utils.header("********** {} SKIPPED Step {} on {} ({})"\
 533                                  .format(plc_counter, stepname, plcname, why))
 534                     status = "UNDEF"
 535                 if not self.options.dry_run:
 536                     delay = datetime.now()-beg_time
 537                     seconds = int(delay.total_seconds())
 538                     duration = str(delay)
 539                     # always do this on stdout
 540                     print(TRACE_FORMAT.format(**locals()))
 541                     # duplicate on trace_file if provided
 542                     if self.options.trace_file:
 543                         trace.write(TRACE_FORMAT.format(**locals()))
 544                         trace.flush()
 545
 546         if self.options.trace_file and not self.options.dry_run:
 547             trace.close()
 548
 549         # free local substrate
 550         LocalSubstrate.local_substrate.release(self.options)
 551
 552         return overall_result
 553
 554     # wrapper to run, returns a shell-compatible result
 555     # retcod:
 556     # 0: SUCCESS
 557     # 1: FAILURE
 558     # 2: SUCCESS but some ignored steps failed
 559     # 3: OTHER ERROR
 560     def main(self):
 561         try:
 562             success = self.run()
 563             if success == 'SUCCESS':
 564                 return 0
 565             elif success == 'IGNORED':
 566                 return 2
 567             else:
 568                 return 1
 569         except SystemExit:
 570             print('Caught SystemExit')
 571             return 3
 572         except:
 573             traceback.print_exc()
 574             return 3
 575
 576 if __name__ == "__main__":
 577     exit_code = TestMain().main()
 578     print("TestMain exit code", exit_code)
 579     sys.exit(exit_code)