cosmetic
[tests.git] / system / TestMain.py
index 3161ea7..4dff120 100755 (executable)
@@ -1,6 +1,8 @@
 #!/usr/bin/python -u
-# $Id$
 
+# Thierry Parmentelat <thierry.parmentelat@inria.fr>
+# Copyright (C) 2010 INRIA 
+#
 import sys, os, os.path
 from optparse import OptionParser
 import traceback
@@ -18,11 +20,11 @@ import LocalTestResources
 
 class TestMain:
 
-    subversion_id = "$Id$"
+    subversion_id = "Now using git -- version tracker broken"
 
     default_config = [ 'default' ] 
 
-    default_build_url = "http://svn.planet-lab.org/svn/build/trunk"
+    default_build_url = "git://git.onelab.eu/tests"
 
     def __init__ (self):
        self.path=os.path.dirname(sys.argv[0]) or "."
@@ -34,12 +36,12 @@ class TestMain:
             utils.show_options("main options",options)
 
     def init_steps(self):
-        self.steps_message=20*'x'+" Defaut steps are\n"+TestPlc.printable_steps(TestPlc.default_steps)
-        self.steps_message += "\n"+20*'x'+" Other useful steps are\n"+TestPlc.printable_steps(TestPlc.other_steps)
+        self.steps_message  = 20*'x'+" Defaut steps are\n"+TestPlc.printable_steps(TestPlc.default_steps)
+        self.steps_message += 20*'x'+" Other useful steps are\n"+TestPlc.printable_steps(TestPlc.other_steps)
 
     def list_steps(self):
         if not self.options.verbose:
-            print self.steps_message
+            print self.steps_message,
         else:
             testplc_method_dict = __import__("TestPlc").__dict__['TestPlc'].__dict__
             scopes = [("Default steps",TestPlc.default_steps)]
@@ -48,45 +50,43 @@ class TestMain:
             for (scope,steps) in scopes:
                 print '--------------------',scope
                 for step in [step for step in steps if TestPlc.valid_step(step)]:
+                    try:        (step,qualifier)=step.split('@')
+                    except:     pass
                     stepname=step
-                    if step.find("force_") == 0:
-                        stepname=step.replace("force_","")
-                        force=True
+                    for special in ['force']:
+                        stepname = stepname.replace(special+'_',"")
                     print '*',step,"\r",4*"\t",
                     try:
-                        print testplc_method_dict[stepname].__doc__
+                        doc=testplc_method_dict[stepname].__doc__
                     except:
-                        print "*** no doc found"
-
-    @staticmethod
-    def optparse_list (option, opt, value, parser):
-        try:
-            setattr(parser.values,option.dest,getattr(parser.values,option.dest)+value.split())
-        except:
-            setattr(parser.values,option.dest,value.split())
+                        try:
+                            # locate the step_<name> module
+                            modulename='step_'+stepname
+                            doc = __import__(modulename).__doc__
+                        except:
+                            doc=None
+                    if doc: print doc
+                    else:   print "*** no doc found"
 
     def run (self):
         self.init_steps()
         usage = """usage: %%prog [options] steps
 arch-rpms-url defaults to the last value used, as stored in arg-arch-rpms-url,
    no default
-build-url defaults to the last value used, as stored in arg-build-url, 
-   or %s
 config defaults to the last value used, as stored in arg-config,
    or %r
 ips_node, ips_plc and ips_qemu defaults to the last value used, as stored in arg-ips-{node,plc,qemu},
    default is to use IP scanning
 steps refer to a method in TestPlc or to a step_* module
 ===
-"""%(TestMain.default_build_url,TestMain.default_config)
+"""%(TestMain.default_config)
         usage += self.steps_message
         parser=OptionParser(usage=usage,version=self.subversion_id)
         parser.add_option("-u","--url",action="store", dest="arch_rpms_url", 
                           help="URL of the arch-dependent RPMS area - for locating what to test")
         parser.add_option("-b","--build",action="store", dest="build_url", 
-                          help="Build URL - for locating vtest-init-vserver.sh")
-        parser.add_option("-c","--config",action="callback", callback=TestMain.optparse_list, dest="config",
-                          nargs=1,type="string",
+                          help="ignored, for legacy only")
+        parser.add_option("-c","--config",action="append", dest="config", default=[],
                           help="Config module - can be set multiple times, or use quotes")
         parser.add_option("-p","--personality",action="store", dest="personality", 
                           help="personality - as in vbuild-nightly")
@@ -94,52 +94,51 @@ steps refer to a method in TestPlc or to a step_* module
                           help="pldistro - as in vbuild-nightly")
         parser.add_option("-f","--fcdistro",action="store", dest="fcdistro", 
                           help="fcdistro - as in vbuild-nightly")
-        parser.add_option("-x","--exclude",action="callback", callback=TestMain.optparse_list, dest="exclude",
-                          nargs=1,type="string",default=[],
+        parser.add_option("-x","--exclude",action="append", dest="exclude", default=[],
                           help="steps to exclude - can be set multiple times, or use quotes")
         parser.add_option("-a","--all",action="store_true",dest="all_steps", default=False,
                           help="Run all default steps")
         parser.add_option("-l","--list",action="store_true",dest="list_steps", default=False,
                           help="List known steps")
-        parser.add_option("-N","--nodes",action="callback", callback=TestMain.optparse_list, dest="ips_node",
-                          nargs=1,type="string",
+        parser.add_option("-N","--nodes",action="append", dest="ips_node", default=[],
                           help="Specify the set of hostname/IP's to use for nodes")
-        parser.add_option("-P","--plcs",action="callback", callback=TestMain.optparse_list, dest="ips_plc",
-                          nargs=1,type="string",
+        parser.add_option("-P","--plcs",action="append", dest="ips_plc", default=[],
                           help="Specify the set of hostname/IP's to use for plcs")
-        parser.add_option("-Q","--qemus",action="callback", callback=TestMain.optparse_list, dest="ips_qemu",
-                          nargs=1,type="string",
+        parser.add_option("-Q","--qemus",action="append", dest="ips_qemu", default=[],
                           help="Specify the set of hostname/IP's to use for qemu boxes")
         parser.add_option("-s","--size",action="store",type="int",dest="size",default=1,
                           help="sets test size in # of plcs - default is 1")
+        parser.add_option("-q","--qualifier",action="store",type="int",dest="qualifier",default=None,
+                          help="run steps only on plc numbered <qualifier>, starting at 1")
+        parser.add_option("-k","--keep-going",action="store",dest="keep_going",default=False,
+                          help="proceeds even if some steps are failing")
         parser.add_option("-D","--dbname",action="store",dest="dbname",default=None,
-                           help="Used by db_dump and db_restore")
+                           help="Used by plc_db_dump and plc_db_restore")
         parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False, 
                           help="Run in verbose mode")
-        parser.add_option("-q","--quiet", action="store_true", dest="quiet", default=False, 
-                          help="Run in quiet mode")
         parser.add_option("-i","--interactive",action="store_true",dest="interactive",default=False,
                           help="prompts before each step")
         parser.add_option("-n","--dry-run", action="store_true", dest="dry_run", default=False,
                           help="Show environment and exits")
         parser.add_option("-r","--restart-nm", action="store_true", dest="forcenm", default=False, 
-                          help="Force the NM to restart in check_slices step")
+                          help="Force the NM to restart in ssh_slices step")
         parser.add_option("-t","--trace", action="store", dest="trace_file", default=None,
                           #default="logs/trace-@TIME@.txt",
                           help="Trace file location")
         (self.options, self.args) = parser.parse_args()
-        if self.options.quiet:
-            self.options.verbose=False
-
-        # no step specified
-        if len(self.args) == 0:
-            self.options.steps=TestPlc.default_steps
-        else:
-            self.options.steps = self.args
 
-        if self.options.list_steps:
-            self.list_steps()
-            sys.exit(1)
+        # allow things like "run -c 'c1 c2' -c c3"
+        def flatten (x):
+            result = []
+            for el in x:
+                if hasattr(el, "__iter__") and not isinstance(el, basestring):
+                    result.extend(flatten(el))
+                else:
+                    result.append(el)
+            return result
+        # flatten relevant options
+        for optname in ['config','exclude','ips_node','ips_plc','ips_qemu']:
+            setattr(self.options,optname, flatten ( [ arg.split() for arg in getattr(self.options,optname) ] ))
 
         # handle defaults and option persistence
         for (recname,filename,default) in (
@@ -192,6 +191,19 @@ steps refer to a method in TestPlc or to a step_* module
             if self.options.verbose:
                 utils.header('* Using %s = %s'%(recname,getattr(self.options,recname)))
 
+        # hack : if sfa is not among the published rpms, skip these tests
+        TestPlc.check_whether_build_has_sfa(self.options.arch_rpms_url)
+
+        # no step specified
+        if len(self.args) == 0:
+            self.options.steps=TestPlc.default_steps
+        else:
+            self.options.steps = self.args
+
+        if self.options.list_steps:
+            self.init_steps()
+            self.list_steps()
+            return True
 
         # steps
         if not self.options.steps:
@@ -255,7 +267,7 @@ steps refer to a method in TestPlc or to a step_* module
         ips_qemu_file.close()
         # build a TestPlc object from the result, passing options
         for spec in all_plc_specs:
-            spec['disabled'] = False
+            spec['failed_step'] = False
         all_plcs = [ (x, TestPlc(x,self.options)) for x in all_plc_specs]
 
         # pass options to utils as well
@@ -267,14 +279,24 @@ steps refer to a method in TestPlc or to a step_* module
         for step in self.options.steps:
             if not TestPlc.valid_step(step):
                 continue
+            # some steps need to be done regardless of the previous ones: we force them
             force=False
-            # is it a forced step
             if step.find("force_") == 0:
                 step=step.replace("force_","")
                 force=True
+            # a cross step will run a method on TestPlc that has a signature like
+            # def cross_foo (self, all_test_plcs)
+            cross=False
+            if step.find("cross_") == 0:
+                cross=True
+            # allow for steps to specify an index like in 
+            # run checkslice@2
+            try:        (step,qualifier)=step.split('@')
+            except:     qualifier=self.options.qualifier
+
             # try and locate a method in TestPlc
             if testplc_method_dict.has_key(step):
-                all_step_infos += [ (step, testplc_method_dict[step] , force)]
+                all_step_infos += [ (step, testplc_method_dict[step] , force, cross, qualifier)]
             # otherwise search for the 'run' method in the step_<x> module
             else:
                 modulename='step_'+step
@@ -285,9 +307,9 @@ steps refer to a method in TestPlc or to a step_* module
                     if not names:
                         raise Exception,"No run* method in module %s"%modulename
                     names.sort()
-                    all_step_infos += [ ("%s.%s"%(step,name),module_dict[name],force) for name in names ]
+                    all_step_infos += [ ("%s.%s"%(step,name),module_dict[name],force,cross,qualifier) for name in names ]
                 except :
-                    print '********** step %s NOT FOUND -- ignored'%(step)
+                    utils.header("********** FAILED step %s (NOT FOUND) -- won't be run"%step)
                     traceback.print_exc()
                     overall_result = False
             
@@ -309,19 +331,26 @@ steps refer to a method in TestPlc or to a step_* module
             trace=open(trace_file,"w")
 
         # do all steps on all plcs
-        TRACE_FORMAT="TRACE: time=%(time)s status=%(status)s step=%(stepname)s plc=%(plcname)s force=%(force)s\n"
-        for (stepname,method,force) in all_step_infos:
-            for (spec,obj) in all_plcs:
+        TIME_FORMAT="%H-%M-%S"
+        TRACE_FORMAT="TRACE: %(plc_counter)d %(beg)s->%(end)s status=%(status)s step=%(stepname)s plc=%(plcname)s force=%(force)s\n"
+        for (stepname,method,force,cross,qualifier) in all_step_infos:
+            plc_counter=0
+            for (spec,plc_obj) in all_plcs:
+                plc_counter+=1
+                # skip this step if we have specified a plc_explicit
+                if qualifier and plc_counter!=int(qualifier): continue
+
                 plcname=spec['name']
+                across_plcs = [ o for (s,o) in all_plcs if o!=plc_obj ]
 
                 # run the step
-                time=strftime("%Y-%m-%d-%H-%M")
-                if not spec['disabled'] or force or self.options.interactive:
+                beg=strftime(TIME_FORMAT)
+                if not spec['failed_step'] or force or self.options.interactive or self.options.keep_going:
                     skip_step=False
                     if self.options.interactive:
                         prompting=True
                         while prompting:
-                            msg="Run step %s on %s [r](un)/d(ry_run)/s(kip)/q(uit) ? "%(stepname,plcname)
+                            msg="%d Run step %s on %s [r](un)/d(ry_run)/s(kip)/q(uit) ? "%(plc_counter,stepname,plcname)
                             answer=raw_input(msg).strip().lower() or "r"
                             answer=answer[0]
                             if answer in ['s','n']:     # skip/no/next
@@ -334,47 +363,54 @@ steps refer to a method in TestPlc or to a step_* module
                             elif answer in ['d']:       # dry_run
                                 dry_run=self.options.dry_run
                                 self.options.dry_run=True
-                                obj.options.dry_run=True
-                                obj.apiserver.set_dry_run(True)
-                                step_result=method(obj)
+                                plc_obj.options.dry_run=True
+                                plc_obj.apiserver.set_dry_run(True)
+                                if not cross:   step_result=method(plc_obj)
+                                else:           step_result=method(plc_obj,across_plcs)
                                 print 'dry_run step ->',step_result
                                 self.options.dry_run=dry_run
-                                obj.options.dry_run=dry_run
-                                obj.apiserver.set_dry_run(dry_run)
+                                plc_obj.options.dry_run=dry_run
+                                plc_obj.apiserver.set_dry_run(dry_run)
                             elif answer in ['r','y']:   # run/yes
                                 prompting=False
                     if skip_step:
                         continue
                     try:
                         force_msg=""
-                        if force: force_msg=" (forced)"
-                        utils.header("********** RUNNING step %s%s on plc %s"%(stepname,force_msg,plcname))
-                        step_result = method(obj)
+                        if force and spec['failed_step']: force_msg=" (forced after %s has failed)"%spec['failed_step']
+                        utils.header("********** %d RUNNING step %s%s on plc %s"%(plc_counter,stepname,force_msg,plcname))
+                        if not cross:   step_result = method(plc_obj)
+                        else:           step_result = method(plc_obj,across_plcs)
                         if step_result:
-                            utils.header('********** SUCCESSFUL step %s on %s'%(stepname,plcname))
+                            utils.header('********** %d SUCCESSFUL step %s on %s'%(plc_counter,stepname,plcname))
                             status="OK"
                         else:
                             overall_result = False
-                            spec['disabled'] = True
-                            utils.header('********** FAILED Step %s on %s - discarding that plc from further steps'%(stepname,plcname))
+                            spec['failed_step'] = stepname
+                            utils.header('********** %d FAILED Step %s on %s (discarded from further steps)'\
+                                             %(plc_counter,stepname,plcname))
                             status="KO"
                     except:
                         overall_result=False
-                        spec['disabled'] = True
+                        spec['failed_step'] = stepname
                         traceback.print_exc()
-                        utils.header ('********** FAILED (exception) Step %s on plc %s - discarding this plc from further steps'%(stepname,plcname))
+                        utils.header ('********** %d FAILED (exception) Step %s on %s (discarded from further steps)'\
+                                          %(plc_counter,stepname,plcname))
                         status="KO"
 
                 # do not run, just display it's skipped
                 else:
-                    utils.header("********** IGNORED Plc %s is disabled - skipping step %s"%(plcname,stepname))
+                    why="has failed %s"%spec['failed_step']
+                    utils.header("********** %d SKIPPED Step %s on %s (%s)"%(plc_counter,stepname,plcname,why))
                     status="UNDEF"
                 if not self.options.dry_run:
-                    # alwas do this on stdout
+                    end=strftime(TIME_FORMAT)
+                    # always do this on stdout
                     print TRACE_FORMAT%locals()
                     # duplicate on trace_file if provided
                     if self.options.trace_file:
                         trace.write(TRACE_FORMAT%locals())
+                        trace.flush()
 
         if self.options.trace_file and not self.options.dry_run:
             trace.close()
@@ -390,6 +426,7 @@ steps refer to a method in TestPlc or to a step_* module
             else:
                 return 1 
         except SystemExit:
+            print 'Caught SystemExit'
             raise
         except:
             traceback.print_exc()