has option -X (old) and -S (new) to select between a
[tests.git] / system / TestMain.py
index 5035a2f..a325223 100755 (executable)
@@ -8,21 +8,89 @@ from optparse import OptionParser
 import traceback
 from time import strftime
 import readline
+import glob
 
 import utils
 from TestPlc import TestPlc
 from TestSite import TestSite
 from TestNode import TestNode
+from macros import sequences
 
-# add $HOME in PYTHONPATH so we can import LocalTestResources.py
+# add $HOME in PYTHONPATH so we can import LocalSubstrate.py
 sys.path.append(os.environ['HOME'])
-import LocalTestResources
+import LocalSubstrate
+
+class Step:
+
+    natives=TestPlc.__dict__
+
+    def display (self): return self.name.replace('_','-')
+    def internal (self): return self.name.replace('-','_')
+
+    def __init__ (self, name):
+        self.name=name
+        # a native step is implemented as a method on TestPlc
+        self.native = self.internal() in Step.natives
+        if self.native:
+            self.method=Step.natives[self.internal()]
+        else:
+            try:
+                self.substeps=sequences[self.internal()]
+            except Exception,e:
+                print "macro step %s not found in macros.py (%s) - exiting"%(self.display(),e)
+                raise
+
+    def print_doc (self,level=0):
+        tab=32
+        trail=8
+        if self.native:
+            start=level*' '+'* '
+            # 2 is the len of '* '
+            width=tab-level-2
+            format="%%-%ds"%width
+            line=start+format%self.display()
+            print line,
+            try:
+                print self.method.__doc__
+            except:
+                print "*** no doc found"
+        else:
+            beg_start=level*' '+'>>> '
+            end_start=level*' '+'<<< '
+            trailer=trail*'-'
+            # 4 is the len of '>>> '
+            width=tab-level-4-trail
+            format=("%%-%ds"%width)
+            beg_line=beg_start+format%self.display()+trail*'>'
+            end_line=end_start+format%self.display()+trail*'<'
+            print beg_line
+            for step in self.substeps:
+                Step(step).print_doc(level+1)
+            print end_line
+
+    # return a list of (name, method) for all native steps involved
+    def tuples (self):
+        if self.native: return [ (self.internal(), self.method,) ]
+        else:
+            result=[]
+            for substep in [ Step(name) for name in self.substeps ] : 
+                result += substep.tuples()
+            return result
+
+    # convenience for listing macros
+    # just do a listdir, hoping we're in the right directory...
+    @staticmethod
+    def list_macros ():
+        names= sequences.keys()
+        names.sort()
+        return names
 
 class TestMain:
 
     subversion_id = "Now using git -- version tracker broken"
 
     default_config = [ 'default' ] 
+    default_rspec_styles = [ 'pl', 'pg' ]
 
     default_build_url = "git://git.onelab.eu/tests"
 
@@ -38,27 +106,30 @@ class TestMain:
     def init_steps(self):
         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)
+        self.steps_message += 20*'x'+" Macro steps are\n"+" ".join(Step.list_macros())
 
     def list_steps(self):
         if not self.options.verbose:
             print self.steps_message,
         else:
-            testplc_method_dict = __import__("TestPlc").__dict__['TestPlc'].__dict__
-            scopes = [("Default steps",TestPlc.default_steps)]
-            if self.options.all_steps:
-                scopes.append ( ("Other steps",TestPlc.other_steps) )
+            # steps mentioned on the command line
+            if self.options.args:
+                scopes = [("Argument steps",self.options.args)]
+            else:
+                scopes = [("Default steps",TestPlc.default_steps)]
+                if self.options.all_steps:
+                    scopes.append ( ("Other steps",TestPlc.other_steps) )
+                    # try to list macro steps as well
+                    scopes.append ( ("Macro steps", Step.list_macros()) )
             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
-                    print '*',step,"\r",4*"\t",
-                    try:
-                        print testplc_method_dict[stepname].__doc__
-                    except:
-                        print "*** no doc found"
+                    for special in ['force']:
+                        stepname = stepname.replace(special+'_',"")
+                    Step(stepname).print_doc()
 
     def run (self):
         self.init_steps()
@@ -67,7 +138,7 @@ arch-rpms-url defaults to the last value used, as stored in arg-arch-rpms-url,
    no default
 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},
+ips_vnode, ips_vplc and ips_qemu defaults to the last value used, as stored in arg-ips-{bplc,vplc,bnode,vnode},
    default is to use IP scanning
 steps refer to a method in TestPlc or to a step_* module
 ===
@@ -86,34 +157,44 @@ 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="append", dest="exclude", default=[],
+        parser.add_option("-e","--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="append", dest="ips_node", default=[],
-                          help="Specify the set of hostname/IP's to use for nodes")
-        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="append", dest="ips_qemu", default=[],
-                          help="Specify the set of hostname/IP's to use for qemu boxes")
+        parser.add_option("-V","--vserver",action="append", dest="ips_bplc", default=[],
+                          help="Specify the set of hostnames for the boxes that host the plcs")
+        parser.add_option("-P","--plcs",action="append", dest="ips_vplc", default=[],
+                          help="Specify the set of hostname/IP's to use for vplcs")
+        parser.add_option("-Q","--qemus",action="append", dest="ips_bnode", default=[],
+                          help="Specify the set of hostnames for the boxes that host the nodes")
+        parser.add_option("-N","--nodes",action="append", dest="ips_vnode", default=[],
+                          help="Specify the set of hostname/IP's to use for vnodes")
+        parser.add_option ('-X', "--lxc",action='store_true',dest='plcs_use_lxc',default=True,
+                           help='use lxc-enabled plc boxes instead of vs-enabled ones')
+        parser.add_option ('-S', "--vs",action='store_false',dest='plcs_use_lxc',
+                           help='use lxc-enabled plc boxes instead of vs-enabled ones')
         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("-y","--rspec-style",action="append",dest="rspec_styles",default=[],
+                          help="pl is for planetlab rspecs, pg is for protogeni")
+        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("-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")
+# dropped when added Completer.py
+#        parser.add_option("-r","--restart-nm", action="store_true", dest="forcenm", default=False, 
+#                          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()
 
@@ -127,34 +208,42 @@ steps refer to a method in TestPlc or to a step_* module
                     result.append(el)
             return result
         # flatten relevant options
-        for optname in ['config','exclude','ips_node','ips_plc','ips_qemu']:
+        for optname in ['config','exclude','ips_bplc','ips_vplc','ips_bnode','ips_vnode']:
             setattr(self.options,optname, flatten ( [ arg.split() for arg in getattr(self.options,optname) ] ))
 
+        if not self.options.rspec_styles:
+            self.options.rspec_styles=TestMain.default_rspec_styles
+
         # handle defaults and option persistence
-        for (recname,filename,default) in (
-            ('build_url','arg-build-url',TestMain.default_build_url) ,
-            ('ips_node','arg-ips-node',[]) , 
-            ('ips_plc','arg-ips-plc',[]) , 
-            ('ips_qemu','arg-ips-qemu',[]) , 
-            ('config','arg-config',TestMain.default_config) , 
-            ('arch_rpms_url','arg-arch-rpms-url',"") , 
-            ('personality','arg-personality',"linux32"),
-            ('pldistro','arg-pldistro',"planetlab"),
-            ('fcdistro','arg-fcdistro','centos5'),
+        for (recname,filename,default,need_reverse) in (
+            ('build_url','arg-build-url',TestMain.default_build_url,None) ,
+            ('ips_bplc','arg-ips-bplc',[],True),
+            ('ips_vplc','arg-ips-vplc',[],True) , 
+            ('ips_bnode','arg-ips-bnode',[],True),
+            ('ips_vnode','arg-ips-vnode',[],True) , 
+            ('config','arg-config',TestMain.default_config,False) , 
+            ('arch_rpms_url','arg-arch-rpms-url',"",None) , 
+            ('personality','arg-personality',"linux64",None),
+            ('pldistro','arg-pldistro',"onelab",None),
+            ('fcdistro','arg-fcdistro','f14',None),
+            ('plcs_use_lxc','arg-plcs-use-lxc',False,None),
             ) :
 #            print 'handling',recname
             path=filename
             is_list = isinstance(default,list)
+            is_bool = isinstance(default,bool)
             if not getattr(self.options,recname):
                 try:
                     parsed=file(path).readlines()
-                    if not is_list:    # strings
+                    if is_list:         # lists
+                        parsed=[x.strip() for x in parsed]
+                    else:               # strings and booleans
                         if len(parsed) != 1:
                             print "%s - error when parsing %s"%(sys.argv[1],path)
                             sys.exit(1)
                         parsed=parsed[0].strip()
-                    else:              # lists
-                        parsed=[x.strip() for x in parsed]
+                        if is_bool:
+                            parsed = parsed.lower()=='true'
                     setattr(self.options,recname,parsed)
                 except:
                     if default != "":
@@ -166,16 +255,17 @@ steps refer to a method in TestPlc or to a step_* module
 
             # save for next run
             fsave=open(path,"w")
-            if not is_list:
-                fsave.write(getattr(self.options,recname) + "\n")
-            else:
+            if is_list:                 # lists
                 for value in getattr(self.options,recname):
                     fsave.write(value + "\n")
+            else:                       # strings and booleans - just call str()
+                fsave.write(str(getattr(self.options,recname)) + "\n")
             fsave.close()
 #            utils.header('Saved %s into %s'%(recname,filename))
 
             # lists need be reversed
-            if isinstance(getattr(self.options,recname),list):
+            # I suspect this is useful for the various pools but for config, it's painful
+            if isinstance(getattr(self.options,recname),list) and need_reverse:
                 getattr(self.options,recname).reverse()
 
             if self.options.verbose:
@@ -185,6 +275,7 @@ steps refer to a method in TestPlc or to a step_* module
         TestPlc.check_whether_build_has_sfa(self.options.arch_rpms_url)
 
         # no step specified
+        self.options.args = self.args
         if len(self.args) == 0:
             self.options.steps=TestPlc.default_steps
         else:
@@ -203,6 +294,7 @@ steps refer to a method in TestPlc or to a step_* module
 
         # rewrite '-' into '_' in step names
         self.options.steps = [ step.replace('-','_') for step in self.options.steps ]
+        self.options.exclude = [ step.replace('-','_') for step in self.options.exclude ]
 
         # exclude
         selected=[]
@@ -233,38 +325,44 @@ steps refer to a method in TestPlc or to a step_* module
                 print 'Cannot load config %s -- ignored'%modulename
                 raise
 
-        # run localize as defined by local_resources
-        all_plc_specs = LocalTestResources.local_resources.localize(all_plc_specs,self.options)
+        # provision on local substrate
+        if self.options.plcs_use_lxc: LocalSubstrate.local_substrate.rescope (plcs_on_vs=False, plcs_on_lxc=True)
+        all_plc_specs = LocalSubstrate.local_substrate.provision(all_plc_specs,self.options)
 
-        # remember plc IP address(es) if not specified
-        ips_plc_file=open('arg-ips-plc','w')
+        # remember substrate IP address(es) for next run
+        ips_bplc_file=open('arg-ips-bplc','w')
+        for plc_spec in all_plc_specs:
+            ips_bplc_file.write("%s\n"%plc_spec['host_box'])
+        ips_bplc_file.close()
+        ips_vplc_file=open('arg-ips-vplc','w')
         for plc_spec in all_plc_specs:
-            ips_plc_file.write("%s\n"%plc_spec['PLC_API_HOST'])
-        ips_plc_file.close()
+            ips_vplc_file.write("%s\n"%plc_spec['PLC_API_HOST'])
+        ips_vplc_file.close()
         # ditto for nodes
-        ips_node_file=open('arg-ips-node','w')
+        ips_bnode_file=open('arg-ips-bnode','w')
         for plc_spec in all_plc_specs:
             for site_spec in plc_spec['sites']:
                 for node_spec in site_spec['nodes']:
-                    ips_node_file.write("%s\n"%node_spec['node_fields']['hostname'])
-        ips_node_file.close()
-        # ditto for qemu boxes
-        ips_qemu_file=open('arg-ips-qemu','w')
+                    ips_bnode_file.write("%s\n"%node_spec['host_box'])
+        ips_bnode_file.close()
+        ips_vnode_file=open('arg-ips-vnode','w')
         for plc_spec in all_plc_specs:
             for site_spec in plc_spec['sites']:
                 for node_spec in site_spec['nodes']:
-                    ips_qemu_file.write("%s\n"%node_spec['host_box'])
-        ips_qemu_file.close()
+                    # back to normal (unqualified) form
+                    stripped=node_spec['node_fields']['hostname'].split('.')[0]
+                    ips_vnode_file.write("%s\n"%stripped)
+        ips_vnode_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
         utils.init_options(self.options)
 
         overall_result = True
-        testplc_method_dict = __import__("TestPlc").__dict__['TestPlc'].__dict__
         all_step_infos=[]
         for step in self.options.steps:
             if not TestPlc.valid_step(step):
@@ -274,55 +372,39 @@ steps refer to a method in TestPlc or to a step_* module
             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, cross, qualifier)]
-            # otherwise search for the 'run' method in the step_<x> module
-            else:
-                modulename='step_'+step
-                try:
-                    # locate all methods named run* in the module
-                    module_dict = __import__(modulename).__dict__
-                    names = [ key for key in module_dict.keys() if key.find("run")==0 ]
-                    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,cross,qualifier) for name in names ]
-                except :
-                    print '********** step %s NOT FOUND -- ignored'%(step)
-                    traceback.print_exc()
-                    overall_result = False
+            try:
+                stepobj = Step (step)
+                for (substep, method) in stepobj.tuples():
+                    # a cross step will run a method on TestPlc that has a signature like
+                    # def cross_foo (self, all_test_plcs)
+                    cross=False
+                    if substep.find("cross_") == 0:
+                        cross=True
+                    all_step_infos.append ( (substep, method, force, cross, qualifier, ) )
+            except :
+                utils.header("********** FAILED step %s (NOT FOUND) -- won't be run"%step)
+                traceback.print_exc()
+                overall_result = False
             
         if self.options.dry_run:
             self.show_env(self.options,"Dry run")
         
         # init & open trace file if provided
         if self.options.trace_file and not self.options.dry_run:
-            time=strftime("%H-%M")
-            date=strftime("%Y-%m-%d")
-            trace_file=self.options.trace_file
-            trace_file=trace_file.replace("@TIME@",time)
-            trace_file=trace_file.replace("@DATE@",date)
-            self.options.trace_file=trace_file
             # create dir if needed
-            trace_dir=os.path.dirname(trace_file)
+            trace_dir=os.path.dirname(self.options.trace_file)
             if trace_dir and not os.path.isdir(trace_dir):
                 os.makedirs(trace_dir)
-            trace=open(trace_file,"w")
+            trace=open(self.options.trace_file,"w")
 
         # do all steps on all plcs
         TIME_FORMAT="%H-%M-%S"
-        TRACE_FORMAT="TRACE: beg=%(beg)s end=%(end)s status=%(status)s step=%(stepname)s plc=%(plcname)s force=%(force)s\n"
+        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:
@@ -335,12 +417,12 @@ steps refer to a method in TestPlc or to a step_* module
 
                 # run the step
                 beg=strftime(TIME_FORMAT)
-                if not spec['disabled'] or force or self.options.interactive:
+                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)/p(roceed)/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
@@ -361,13 +443,17 @@ steps refer to a method in TestPlc or to a step_* module
                                 self.options.dry_run=dry_run
                                 plc_obj.options.dry_run=dry_run
                                 plc_obj.apiserver.set_dry_run(dry_run)
+                            elif answer in ['p']:
+                                # take it as a yes and leave interactive mode
+                                prompting=False
+                                self.options.interactive=False
                             elif answer in ['r','y']:   # run/yes
                                 prompting=False
                     if skip_step:
                         continue
                     try:
                         force_msg=""
-                        if force: force_msg=" (forced)"
+                        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)
@@ -376,13 +462,13 @@ steps refer to a method in TestPlc or to a step_* module
                             status="OK"
                         else:
                             overall_result = False
-                            spec['disabled'] = True
+                            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 ('********** %d FAILED (exception) Step %s on %s (discarded from further steps)'\
                                           %(plc_counter,stepname,plcname))
@@ -390,7 +476,8 @@ steps refer to a method in TestPlc or to a step_* module
 
                 # do not run, just display it's skipped
                 else:
-                    utils.header("********** %d IGNORED Plc %s is disabled - skipping step %s"%(plc_counter,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:
                     end=strftime(TIME_FORMAT)
@@ -404,6 +491,9 @@ steps refer to a method in TestPlc or to a step_* module
         if self.options.trace_file and not self.options.dry_run:
             trace.close()
 
+        # free local substrate
+        LocalSubstrate.local_substrate.release(self.options)
+        
         return overall_result
 
     # wrapper to run, returns a shell-compatible result