import glob
import utils
-from TestPlc import TestPlc
+from TestPlc import TestPlc, Ignored
from TestSite import TestSite
from TestNode import TestNode
+from macros import sequences
# add $HOME in PYTHONPATH so we can import LocalSubstrate.py
sys.path.append(os.environ['HOME'])
natives=TestPlc.__dict__
+ def display (self): return self.name.replace('_','-')
+ def internal (self): return self.name.replace('-','_')
+
def __init__ (self, name):
- self.name=name.replace('-','_')
+ self.name=name
# a native step is implemented as a method on TestPlc
- self.native = name in Step.natives
+ self.native = self.internal() in Step.natives
if self.native:
- self.method=Step.natives[self.name]
+ self.method=Step.natives[self.internal()]
else:
- # non-native steps (macros) are implemented as a 'Step'
try:
- modulename = 'macro_' + self.name
- module = __import__ (modulename)
- self.substeps = module.sequence
+ self.substeps=sequences[self.internal()]
except Exception,e:
- print "Cannot load macro step %s (%s) - exiting"%(self.name,e)
+ print "macro step %s not found in macros.py (%s) - exiting"%(self.display(),e)
raise
- def norm_name (self): return self.name.replace('_','-')
-
- def print_doc (self):
+ def print_doc (self,level=0):
+ tab=32
+ trail=8
if self.native:
- print '*',self.norm_name(),"\r",4*"\t",
+ 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:
- print '*',self.norm_name(),"\r",3*"\t","========== BEG MACRO step"
+ 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()
- print '*',self.norm_name(),"\r",3*"\t","========== END MACRO step"
+ 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.name, self.method,) ]
+ if self.native: return [ (self.internal(), self.method,) ]
else:
result=[]
for substep in [ Step(name) for name in self.substeps ] :
# just do a listdir, hoping we're in the right directory...
@staticmethod
def list_macros ():
- names= [ filename.replace('macro_','').replace('.py','') for filename in glob.glob ('macro_*.py')]
+ names= sequences.keys()
names.sort()
return names
try: (step,qualifier)=step.split('@')
except: pass
stepname=step
- for special in ['force']:
- stepname = stepname.replace(special+'_',"")
+ for special in ['force','ignore']:
+ stepname = stepname.replace('_'+special,"")
Step(stepname).print_doc()
def run (self):
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("-i","--ignore",action="append", dest="ignore", default=[],
+ help="steps to run but ignore - 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="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,
+ 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 ssh_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,
help="Trace file location")
(self.options, self.args) = parser.parse_args()
result.append(el)
return result
# flatten relevant options
- for optname in ['config','exclude','ips_bplc','ips_vplc','ips_bnode','ips_vnode']:
+ for optname in ['config','exclude','ignore','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:
# 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 != "":
# 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))
if self.options.list_steps:
self.init_steps()
self.list_steps()
- return True
+ return 'SUCCESS'
# steps
if not self.options.steps:
# 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 ]
+ self.options.ignore = [ step.replace('-','_') for step in self.options.ignore ]
+
+ # technicality, decorate known steps to produce the '_ignore' version
+ TestPlc.create_ignore_steps()
# exclude
selected=[]
keep=False
break
if keep: selected.append(step)
+
+ # ignore
+ selected = [ step if step not in self.options.ignore else step+"_ignore"
+ for step in selected ]
+
self.options.steps=selected
# this is useful when propagating on host boxes, to avoid conflicts
# pass options to utils as well
utils.init_options(self.options)
- overall_result = True
+ overall_result = 'SUCCESS'
all_step_infos=[]
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
- if step.find("force_") == 0:
- step=step.replace("force_","")
+ if step.endswith("_force"):
+ step=step.replace("_force","")
force=True
# allow for steps to specify an index like in
# run checkslice@2
except :
utils.header("********** FAILED step %s (NOT FOUND) -- won't be run"%step)
traceback.print_exc()
- overall_result = False
+ overall_result = 'FAILURE'
if self.options.dry_run:
self.show_env(self.options,"Dry run")
skip_step=True
elif answer in ['q','b']: # quit/bye
print 'Exiting'
- return
+ return 'FAILURE'
elif answer in ['d']: # dry_run
dry_run=self.options.dry_run
self.options.dry_run=True
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:
+ if isinstance (step_result,Ignored):
+ step_result=step_result.result
+ if step_result:
+ msg="OK"
+ else:
+ msg="KO"
+ # do not overwrite if FAILURE
+ if overall_result=='SUCCESS':
+ overall_result='IGNORED'
+ utils.header('********** %d IGNORED (%s) step %s on %s'%(plc_counter,msg,stepname,plcname))
+ status="%s[I]"%msg
+ elif step_result:
utils.header('********** %d SUCCESSFUL step %s on %s'%(plc_counter,stepname,plcname))
status="OK"
else:
- overall_result = False
+ overall_result = 'FAILURE'
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
+ overall_result='FAILURE'
spec['failed_step'] = stepname
traceback.print_exc()
utils.header ('********** %d FAILED (exception) Step %s on %s (discarded from further steps)'\
return overall_result
# wrapper to run, returns a shell-compatible result
+ # retcod:
+ # 0: SUCCESS
+ # 1: FAILURE
+ # 2: SUCCESS but some ignored steps failed
+ # 3: OTHER ERROR
def main(self):
try:
success=self.run()
- if success:
- return 0
- else:
- return 1
+ if success == 'SUCCESS': return 0
+ elif success == 'IGNORED': return 2
+ else: return 1
except SystemExit:
print 'Caught SystemExit'
- raise
+ return 3
except:
traceback.print_exc()
- return 2
+ return 3
if __name__ == "__main__":
- sys.exit(TestMain().main())
+ exit_code = TestMain().main()
+ print "TestMain exit code",exit_code
+ sys.exit(exit_code)