ad more steps to go back and forth in the sfa scenario
[tests.git] / system / TestMain.py
index 501126e..8854624 100755 (executable)
@@ -1,6 +1,8 @@
-#!/usr/bin/env python
-# $Id$
+#!/usr/bin/python -u
 
+# Thierry Parmentelat <thierry.parmentelat@inria.fr>
+# Copyright (C) 2010 INRIA 
+#
 import sys, os, os.path
 from optparse import OptionParser
 import traceback
@@ -12,53 +14,71 @@ from TestPlc import TestPlc
 from TestSite import TestSite
 from TestNode import TestNode
 
+# add $HOME in PYTHONPATH so we can import LocalTestResources.py
+sys.path.append(os.environ['HOME'])
+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 "."
         os.chdir(self.path)
 
-    @staticmethod
-    def show_env (options, message):
-        utils.header (message)
-        utils.show_options("main options",options)
+    def show_env (self,options, message):
+        if self.options.verbose:
+            utils.header (message)
+            utils.show_options("main options",options)
 
-    @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())
+    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)
+
+    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) )
+            for (scope,steps) in scopes:
+                print '--------------------',scope
+                for step in [step for step in steps if TestPlc.valid_step(step)]:
+                    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"
 
     def run (self):
-        steps_message=20*'x'+" Defaut steps are\n"+TestPlc.printable_steps(TestPlc.default_steps)
-        steps_message += "\n"+20*'x'+" Other useful steps are\n"+TestPlc.printable_steps(TestPlc.other_steps)
+        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
-node-ips and plc-ips defaults to the last value used, as stored in arg-ips-node and arg-ips-plc,
+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)
-        usage += steps_message
+"""%(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")
@@ -66,29 +86,24 @@ 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",
-                          help="Specify the set of IP addresses to use for nodes (scanning disabled)")
-        parser.add_option("-P","--plcs",action="callback", callback=TestMain.optparse_list, dest="ips_plc",
-                          nargs=1,type="string",
-                          help="Specify the set of IP addresses to use for plcs (scanning disabled)")
-        parser.add_option("-1","--small",action="store_true",dest="small_test",
-                          help="run a small test (default) -- typically only one plc and one node")
-        parser.add_option("-2","--large",action="store_false",dest="small_test",default=True,
-                          help="runs full-size test")
+        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("-s","--size",action="store",type="int",dest="size",default=1,
+                          help="sets test size in # of plcs - default is 1")
         parser.add_option("-D","--dbname",action="store",dest="dbname",default=None,
                            help="Used by db_dump and 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,
@@ -100,31 +115,30 @@ steps refer to a method in TestPlc or to a step_* module
                           help="Trace file location")
         (self.options, self.args) = parser.parse_args()
 
-        if len(self.args) == 0:
-            if self.options.all_steps:
-                self.options.steps=TestPlc.default_steps
-            elif self.options.dry_run:
-                self.options.steps=TestPlc.default_steps
-            elif self.options.list_steps:
-                print steps_message
-                sys.exit(1)
-            else:
-                print 'No step found (do you mean -a ? )'
-                print "Run %s --help for help"%sys.argv[0]                        
-                sys.exit(1)
-        else:
-            self.options.steps = self.args
+        # 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 (
             ('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','f8'),
+            ('fcdistro','arg-fcdistro','centos5'),
             ) :
 #            print 'handling',recname
             path=filename
@@ -147,8 +161,6 @@ steps refer to a method in TestPlc or to a step_* module
                         print "Cannot determine",recname
                         print "Run %s --help for help"%sys.argv[0]                        
                         sys.exit(1)
-            if not self.options.quiet:
-                utils.header('* Using %s = %s'%(recname,getattr(self.options,recname)))
 
             # save for next run
             fsave=open(path,"w")
@@ -160,18 +172,36 @@ steps refer to a method in TestPlc or to a step_* module
             fsave.close()
 #            utils.header('Saved %s into %s'%(recname,filename))
 
-        if self.options.personality == "linux32":
-            self.options.arch = "i386"
-        elif self.options.personality == "linux64":
-            self.options.arch = "x86_64"
+            # lists need be reversed
+            if isinstance(getattr(self.options,recname),list):
+                getattr(self.options,recname).reverse()
+
+            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:
-            raise Exception, "Unsupported personality %r"%self.options.personality
+            self.options.steps = self.args
+
+        if self.options.list_steps:
+            self.init_steps()
+            self.list_steps()
+            return True
+
         # steps
         if not self.options.steps:
             #default (all) steps
             #self.options.steps=['dump','clean','install','populate']
             self.options.steps=TestPlc.default_steps
 
+        # rewrite '-' into '_' in step names
+        self.options.steps = [ step.replace('-','_') for step in self.options.steps ]
+
         # exclude
         selected=[]
         for step in self.options.steps:
@@ -200,22 +230,29 @@ steps refer to a method in TestPlc or to a step_* module
                 traceback.print_exc()
                 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)
+
         # remember plc IP address(es) if not specified
-        current=file('arg-ips-plc').read()
-        if not current:
-            ips_plc_file=open('arg-ips-plc','w')
-            for plc_spec in all_plc_specs:
-                ips_plc_file.write("%s\n"%plc_spec['PLC_API_HOST'])
-            ips_plc_file.close()
+        ips_plc_file=open('arg-ips-plc','w')
+        for plc_spec in all_plc_specs:
+            ips_plc_file.write("%s\n"%plc_spec['PLC_API_HOST'])
+        ips_plc_file.close()
         # ditto for nodes
-        current=file('arg-ips-node').read()
-        if not current:
-            ips_node_file=open('arg-ips-node','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()
+        ips_node_file=open('arg-ips-node','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')
+        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()
         # build a TestPlc object from the result, passing options
         for spec in all_plc_specs:
             spec['disabled'] = False
@@ -230,14 +267,19 @@ 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 no 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
             # 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)]
             # otherwise search for the 'run' method in the step_<x> module
             else:
                 modulename='step_'+step
@@ -248,7 +290,7 @@ 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) for name in names ]
                 except :
                     print '********** step %s NOT FOUND -- ignored'%(step)
                     traceback.print_exc()
@@ -272,13 +314,15 @@ 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 plc=%(plcname)s step=%(stepname)s status=%(status)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: beg=%(beg)s end=%(end)s status=%(status)s step=%(stepname)s plc=%(plcname)s force=%(force)s\n"
+        for (stepname,method,force,cross) in all_step_infos:
+            for (spec,plc_obj) in all_plcs:
                 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")
+                beg=strftime(TIME_FORMAT)
                 if not spec['disabled'] or force or self.options.interactive:
                     skip_step=False
                     if self.options.interactive:
@@ -297,13 +341,14 @@ 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:
@@ -312,7 +357,8 @@ steps refer to a method in TestPlc or to a step_* module
                         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 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))
                             status="OK"
@@ -333,11 +379,13 @@ steps refer to a method in TestPlc or to a step_* module
                     utils.header("********** IGNORED Plc %s is disabled - skipping step %s"%(plcname,stepname))
                     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()
@@ -353,6 +401,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()