system/TestPlc.py

   1 # Thierry Parmentelat <thierry.parmentelat@inria.fr>
   2 # Copyright (C) 2010 INRIA
   3 #
   4 import sys
   5 import time
   6 import os, os.path
   7 import traceback
   8 import socket
   9 from datetime import datetime, timedelta
  10 from types import StringTypes
  11
  12 import utils
  13 from Completer import Completer, CompleterTask
  14 from TestSite import TestSite
  15 from TestNode import TestNode, CompleterTaskNodeSsh
  16 from TestUser import TestUser
  17 from TestKey import TestKey
  18 from TestSlice import TestSlice
  19 from TestSliver import TestSliver
  20 from TestBoxQemu import TestBoxQemu
  21 from TestSsh import TestSsh
  22 from TestApiserver import TestApiserver
  23 from TestAuthSfa import TestAuthSfa
  24 from PlcapiUrlScanner import PlcapiUrlScanner
  25
  26 has_sfa_cache_filename="sfa-cache"
  27
  28 # step methods must take (self) and return a boolean (options is a member of the class)
  29
  30 def standby(minutes,dry_run):
  31     utils.header('Entering StandBy for %d mn'%minutes)
  32     if dry_run:
  33         print 'dry_run'
  34     else:
  35         time.sleep(60*minutes)
  36     return True
  37
  38 def standby_generic (func):
  39     def actual(self):
  40         minutes=int(func.__name__.split("_")[1])
  41         return standby(minutes,self.options.dry_run)
  42     return actual
  43
  44 def node_mapper (method):
  45     def map_on_nodes(self,*args, **kwds):
  46         overall=True
  47         node_method = TestNode.__dict__[method.__name__]
  48         for test_node in self.all_nodes():
  49             if not node_method(test_node, *args, **kwds): overall=False
  50         return overall
  51     # maintain __name__ for ignore_result
  52     map_on_nodes.__name__=method.__name__
  53     # restore the doc text
  54     map_on_nodes.__doc__=TestNode.__dict__[method.__name__].__doc__
  55     return map_on_nodes
  56
  57 def slice_mapper (method):
  58     def map_on_slices(self):
  59         overall=True
  60         slice_method = TestSlice.__dict__[method.__name__]
  61         for slice_spec in self.plc_spec['slices']:
  62             site_spec = self.locate_site (slice_spec['sitename'])
  63             test_site = TestSite(self,site_spec)
  64             test_slice=TestSlice(self,test_site,slice_spec)
  65             if not slice_method(test_slice,self.options): overall=False
  66         return overall
  67     # maintain __name__ for ignore_result
  68     map_on_slices.__name__=method.__name__
  69     # restore the doc text
  70     map_on_slices.__doc__=TestSlice.__dict__[method.__name__].__doc__
  71     return map_on_slices
  72
  73 # run a step but return True so that we can go on
  74 def ignore_result (method):
  75     def ignoring (self):
  76         # ssh_slice_ignore->ssh_slice
  77         ref_name=method.__name__.replace('_ignore','').replace('force_','')
  78         ref_method=TestPlc.__dict__[ref_name]
  79         result=ref_method(self)
  80         print "Actual (but ignored) result for %(ref_name)s is %(result)s"%locals()
  81         return Ignored (result)
  82     name=method.__name__.replace('_ignore','').replace('force_','')
  83     ignoring.__name__=name
  84     ignoring.__doc__="ignored version of " + name
  85     return ignoring
  86
  87 # a variant that expects the TestSlice method to return a list of CompleterTasks that
  88 # are then merged into a single Completer run to avoid wating for all the slices
  89 # esp. useful when a test fails of course
  90 # because we need to pass arguments we use a class instead..
  91 class slice_mapper__tasks (object):
  92     # could not get this to work with named arguments
  93     def __init__ (self,timeout_minutes,silent_minutes,period_seconds):
  94         self.timeout=timedelta(minutes=timeout_minutes)
  95         self.silent=timedelta(minutes=silent_minutes)
  96         self.period=timedelta(seconds=period_seconds)
  97     def __call__ (self, method):
  98         decorator_self=self
  99         # compute augmented method name
 100         method_name = method.__name__ + "__tasks"
 101         # locate in TestSlice
 102         slice_method = TestSlice.__dict__[ method_name ]
 103         def wrappee(self):
 104             tasks=[]
 105             for slice_spec in self.plc_spec['slices']:
 106                 site_spec = self.locate_site (slice_spec['sitename'])
 107                 test_site = TestSite(self,site_spec)
 108                 test_slice=TestSlice(self,test_site,slice_spec)
 109                 tasks += slice_method (test_slice, self.options)
 110             return Completer (tasks).run (decorator_self.timeout, decorator_self.silent, decorator_self.period)
 111         # restore the doc text from the TestSlice method even if a bit odd
 112         wrappee.__doc__ = slice_method.__doc__
 113         return wrappee
 114
 115 def auth_sfa_mapper (method):
 116     def actual(self):
 117         overall=True
 118         auth_method = TestAuthSfa.__dict__[method.__name__]
 119         for auth_spec in self.plc_spec['sfa']['auth_sfa_specs']:
 120             test_auth=TestAuthSfa(self,auth_spec)
 121             if not auth_method(test_auth,self.options): overall=False
 122         return overall
 123     # restore the doc text
 124     actual.__doc__=TestAuthSfa.__dict__[method.__name__].__doc__
 125     return actual
 126
 127 class Ignored:
 128     def __init__ (self,result):
 129         self.result=result
 130
 131 SEP='<sep>'
 132 SEPSFA='<sep_sfa>'
 133
 134 class TestPlc:
 135
 136     default_steps = [
 137         'show', SEP,
 138         'plcvm_delete','plcvm_timestamp','plcvm_create', SEP,
 139         'plc_install', 'plc_configure', 'plc_start', SEP,
 140         'keys_fetch', 'keys_store', 'keys_clear_known_hosts', SEP,
 141         'plcapi_urls','speed_up_slices', SEP,
 142         'initscripts', 'sites', 'nodes', 'slices', 'nodegroups', 'leases', SEP,
 143 # slices created under plcsh interactively seem to be fine but these ones don't have the tags
 144 # keep this our of the way for now
 145         'check_vsys_defaults_ignore', SEP,
 146 # run this first off so it's easier to re-run on another qemu box
 147         'qemu_kill_mine', SEP,
 148         'nodestate_reinstall', 'qemu_local_init','bootcd', 'qemu_local_config', SEP,
 149         'qemu_clean_mine', 'qemu_export', 'qemu_start', 'qemu_timestamp', SEP,
 150         'sfa_install_all', 'sfa_configure', 'cross_sfa_configure', 'sfa_start', 'sfa_import', SEPSFA,
 151         'sfi_configure@1', 'sfa_register_site@1','sfa_register_pi@1', SEPSFA,
 152         'sfa_register_user@1', 'sfa_update_user@1', 'sfa_register_slice@1', 'sfa_renew_slice@1', SEPSFA,
 153         'sfa_remove_user_from_slice@1','sfi_show_slice_researchers@1',
 154         'sfa_insert_user_in_slice@1','sfi_show_slice_researchers@1', SEPSFA,
 155         'sfa_discover@1', 'sfa_create_slice@1', 'sfa_check_slice_plc@1', 'sfa_update_slice@1', SEPSFA,
 156         'sfi_list@1', 'sfi_show_site@1', 'sfa_utest@1', SEPSFA,
 157         # we used to run plcsh_stress_test, and then ssh_node_debug and ssh_node_boot
 158         # but as the stress test might take a while, we sometimes missed the debug mode..
 159         'probe_kvm_iptables',
 160         'ping_node', 'ssh_node_debug', 'plcsh_stress_test@1', SEP,
 161         'ssh_node_boot', 'node_bmlogs', 'ssh_slice', 'ssh_slice_basics', 'check_initscripts_ignore', SEP,
 162         'ssh_slice_sfa@1', 'sfa_delete_slice@1', 'sfa_delete_user@1', SEPSFA,
 163         'cross_check_tcp@1', 'check_system_slice', SEP,
 164         # check slices are turned off properly
 165         'empty_slices', 'ssh_slice_off', 'slice_fs_deleted_ignore', SEP,
 166         # check they are properly re-created with the same name
 167         'fill_slices', 'ssh_slice_again_ignore', SEP,
 168         'gather_logs_force', SEP,
 169         ]
 170     other_steps = [
 171         'export', 'show_boxes', SEP,
 172         'check_hooks', 'plc_stop', 'plcvm_start', 'plcvm_stop', SEP,
 173         'delete_initscripts', 'delete_nodegroups','delete_all_sites', SEP,
 174         'delete_sites', 'delete_nodes', 'delete_slices', 'keys_clean', SEP,
 175         'delete_leases', 'list_leases', SEP,
 176         'populate', SEP,
 177         'nodestate_show','nodestate_safeboot','nodestate_boot', SEP,
 178         'qemu_list_all', 'qemu_list_mine', 'qemu_kill_all', SEP,
 179         'sfa_install_core', 'sfa_install_sfatables', 'sfa_install_plc', 'sfa_install_client', SEPSFA,
 180         'sfa_plcclean', 'sfa_dbclean', 'sfa_stop','sfa_uninstall', 'sfi_clean', SEPSFA,
 181         'plc_db_dump' , 'plc_db_restore', SEP,
 182         'check_netflow','check_drl', SEP,
 183         'debug_nodemanager', 'slice_fs_present', SEP,
 184         'standby_1_through_20','yes','no',SEP,
 185         ]
 186
 187     @staticmethod
 188     def printable_steps (list):
 189         single_line=" ".join(list)+" "
 190         return single_line.replace(" "+SEP+" "," \\\n").replace(" "+SEPSFA+" "," \\\n")
 191     @staticmethod
 192     def valid_step (step):
 193         return step != SEP and step != SEPSFA
 194
 195     # turn off the sfa-related steps when build has skipped SFA
 196     # this was originally for centos5 but is still valid
 197     # for up to f12 as recent SFAs with sqlalchemy won't build before f14
 198     @staticmethod
 199     def _has_sfa_cached (rpms_url):
 200         if os.path.isfile(has_sfa_cache_filename):
 201             cached=file(has_sfa_cache_filename).read()=="yes"
 202             utils.header("build provides SFA (cached):%s"%cached)
 203             return cached
 204         # warning, we're now building 'sface' so let's be a bit more picky
 205         # full builds are expected to return with 0 here
 206         utils.header ("Checking if build provides SFA package...")
 207         retcod=os.system ("curl --silent %s/ | grep -q sfa-"%rpms_url)==0
 208         encoded='yes' if retcod else 'no'
 209         file(has_sfa_cache_filename,'w').write(encoded)
 210         return retcod
 211
 212     @staticmethod
 213     def check_whether_build_has_sfa (rpms_url):
 214         has_sfa=TestPlc._has_sfa_cached(rpms_url)
 215         if has_sfa:
 216             utils.header("build does provide SFA")
 217         else:
 218             # move all steps containing 'sfa' from default_steps to other_steps
 219             utils.header("SFA package not found - removing steps with sfa or sfi")
 220             sfa_steps= [ step for step in TestPlc.default_steps if step.find('sfa')>=0 or step.find("sfi")>=0 ]
 221             TestPlc.other_steps += sfa_steps
 222             for step in sfa_steps: TestPlc.default_steps.remove(step)
 223
 224     def __init__ (self,plc_spec,options):
 225         self.plc_spec=plc_spec
 226         self.options=options
 227         self.test_ssh=TestSsh(self.plc_spec['host_box'],self.options.buildname)
 228         self.vserverip=plc_spec['vserverip']
 229         self.vservername=plc_spec['vservername']
 230         self.url="https://%s:443/PLCAPI/"%plc_spec['vserverip']
 231         self.apiserver=TestApiserver(self.url,options.dry_run)
 232         (self.ssh_node_boot_timeout,self.ssh_node_boot_silent)=plc_spec['ssh_node_boot_timers']
 233         (self.ssh_node_debug_timeout,self.ssh_node_debug_silent)=plc_spec['ssh_node_debug_timers']
 234
 235     def has_addresses_api (self):
 236         return self.apiserver.has_method('AddIpAddress')
 237
 238     def name(self):
 239         name=self.plc_spec['name']
 240         return "%s.%s"%(name,self.vservername)
 241
 242     def hostname(self):
 243         return self.plc_spec['host_box']
 244
 245     def is_local (self):
 246         return self.test_ssh.is_local()
 247
 248     # define the API methods on this object through xmlrpc
 249     # would help, but not strictly necessary
 250     def connect (self):
 251         pass
 252
 253     def actual_command_in_guest (self,command, backslash=False):
 254         raw1=self.host_to_guest(command)
 255         raw2=self.test_ssh.actual_command(raw1,dry_run=self.options.dry_run, backslash=backslash)
 256         return raw2
 257
 258     def start_guest (self):
 259       return utils.system(self.test_ssh.actual_command(self.start_guest_in_host(),dry_run=self.options.dry_run))
 260
 261     def stop_guest (self):
 262       return utils.system(self.test_ssh.actual_command(self.stop_guest_in_host(),dry_run=self.options.dry_run))
 263
 264     def run_in_guest (self,command,backslash=False):
 265         raw=self.actual_command_in_guest(command,backslash)
 266         return utils.system(raw)
 267
 268     def run_in_host (self,command):
 269         return self.test_ssh.run_in_buildname(command, dry_run=self.options.dry_run)
 270
 271     # backslashing turned out so awful at some point that I've turned off auto-backslashing
 272     # see e.g. plc_start esp. the version for f14
 273     #command gets run in the plc's vm
 274     def host_to_guest(self,command):
 275         # f14 still needs some extra help
 276         if self.options.fcdistro == 'f14':
 277             raw="virsh -c lxc:/// lxc-enter-namespace %s -- /usr/bin/env PATH=/bin:/sbin:/usr/bin:/usr/sbin %s" %(self.vservername,command)
 278         else:
 279             raw="virsh -c lxc:/// lxc-enter-namespace %s -- /usr/bin/env %s" %(self.vservername,command)
 280         return raw
 281
 282     # this /vservers thing is legacy...
 283     def vm_root_in_host(self):
 284         return "/vservers/%s/"%(self.vservername)
 285
 286     def vm_timestamp_path (self):
 287         return "/vservers/%s/%s.timestamp"%(self.vservername,self.vservername)
 288
 289     #start/stop the vserver
 290     def start_guest_in_host(self):
 291         return "virsh -c lxc:/// start %s"%(self.vservername)
 292
 293     def stop_guest_in_host(self):
 294         return "virsh -c lxc:/// destroy %s"%(self.vservername)
 295
 296     # xxx quick n dirty
 297     def run_in_guest_piped (self,local,remote):
 298         return utils.system(local+" | "+self.test_ssh.actual_command(self.host_to_guest(remote),keep_stdin=True))
 299
 300     def yum_check_installed (self, rpms):
 301         if isinstance (rpms, list):
 302             rpms=" ".join(rpms)
 303         return self.run_in_guest("rpm -q %s"%rpms)==0
 304
 305     # does a yum install in the vs, ignore yum retcod, check with rpm
 306     def yum_install (self, rpms):
 307         if isinstance (rpms, list):
 308             rpms=" ".join(rpms)
 309         self.run_in_guest("yum -y install %s"%rpms)
 310         # yum-complete-transaction comes with yum-utils, that is in vtest.pkgs
 311         self.run_in_guest("yum-complete-transaction -y")
 312         return self.yum_check_installed (rpms)
 313
 314     def auth_root (self):
 315         return {'Username':self.plc_spec['PLC_ROOT_USER'],
 316                 'AuthMethod':'password',
 317                 'AuthString':self.plc_spec['PLC_ROOT_PASSWORD'],
 318                 'Role' : self.plc_spec['role']
 319                 }
 320     def locate_site (self,sitename):
 321         for site in self.plc_spec['sites']:
 322             if site['site_fields']['name'] == sitename:
 323                 return site
 324             if site['site_fields']['login_base'] == sitename:
 325                 return site
 326         raise Exception,"Cannot locate site %s"%sitename
 327
 328     def locate_node (self,nodename):
 329         for site in self.plc_spec['sites']:
 330             for node in site['nodes']:
 331                 if node['name'] == nodename:
 332                     return (site,node)
 333         raise Exception,"Cannot locate node %s"%nodename
 334
 335     def locate_hostname (self,hostname):
 336         for site in self.plc_spec['sites']:
 337             for node in site['nodes']:
 338                 if node['node_fields']['hostname'] == hostname:
 339                     return (site,node)
 340         raise Exception,"Cannot locate hostname %s"%hostname
 341
 342     def locate_key (self,key_name):
 343         for key in self.plc_spec['keys']:
 344             if key['key_name'] == key_name:
 345                 return key
 346         raise Exception,"Cannot locate key %s"%key_name
 347
 348     def locate_private_key_from_key_names (self, key_names):
 349         # locate the first avail. key
 350         found=False
 351         for key_name in key_names:
 352             key_spec=self.locate_key(key_name)
 353             test_key=TestKey(self,key_spec)
 354             publickey=test_key.publicpath()
 355             privatekey=test_key.privatepath()
 356             if os.path.isfile(publickey) and os.path.isfile(privatekey):
 357                 found=True
 358         if found: return privatekey
 359         else:     return None
 360
 361     def locate_slice (self, slicename):
 362         for slice in self.plc_spec['slices']:
 363             if slice['slice_fields']['name'] == slicename:
 364                 return slice
 365         raise Exception,"Cannot locate slice %s"%slicename
 366
 367     def all_sliver_objs (self):
 368         result=[]
 369         for slice_spec in self.plc_spec['slices']:
 370             slicename = slice_spec['slice_fields']['name']
 371             for nodename in slice_spec['nodenames']:
 372                 result.append(self.locate_sliver_obj (nodename,slicename))
 373         return result
 374
 375     def locate_sliver_obj (self,nodename,slicename):
 376         (site,node) = self.locate_node(nodename)
 377         slice = self.locate_slice (slicename)
 378         # build objects
 379         test_site = TestSite (self, site)
 380         test_node = TestNode (self, test_site,node)
 381         # xxx the slice site is assumed to be the node site - mhh - probably harmless
 382         test_slice = TestSlice (self, test_site, slice)
 383         return TestSliver (self, test_node, test_slice)
 384
 385     def locate_first_node(self):
 386         nodename=self.plc_spec['slices'][0]['nodenames'][0]
 387         (site,node) = self.locate_node(nodename)
 388         test_site = TestSite (self, site)
 389         test_node = TestNode (self, test_site,node)
 390         return test_node
 391
 392     def locate_first_sliver (self):
 393         slice_spec=self.plc_spec['slices'][0]
 394         slicename=slice_spec['slice_fields']['name']
 395         nodename=slice_spec['nodenames'][0]
 396         return self.locate_sliver_obj(nodename,slicename)
 397
 398     # all different hostboxes used in this plc
 399     def get_BoxNodes(self):
 400         # maps on sites and nodes, return [ (host_box,test_node) ]
 401         tuples=[]
 402         for site_spec in self.plc_spec['sites']:
 403             test_site = TestSite (self,site_spec)
 404             for node_spec in site_spec['nodes']:
 405                 test_node = TestNode (self, test_site, node_spec)
 406                 if not test_node.is_real():
 407                     tuples.append( (test_node.host_box(),test_node) )
 408         # transform into a dict { 'host_box' -> [ test_node .. ] }
 409         result = {}
 410         for (box,node) in tuples:
 411             if not result.has_key(box):
 412                 result[box]=[node]
 413             else:
 414                 result[box].append(node)
 415         return result
 416
 417     # a step for checking this stuff
 418     def show_boxes (self):
 419         'print summary of nodes location'
 420         for (box,nodes) in self.get_BoxNodes().iteritems():
 421             print box,":"," + ".join( [ node.name() for node in nodes ] )
 422         return True
 423
 424     # make this a valid step
 425     def qemu_kill_all(self):
 426         'kill all qemu instances on the qemu boxes involved by this setup'
 427         # this is the brute force version, kill all qemus on that host box
 428         for (box,nodes) in self.get_BoxNodes().iteritems():
 429             # pass the first nodename, as we don't push template-qemu on testboxes
 430             nodedir=nodes[0].nodedir()
 431             TestBoxQemu(box,self.options.buildname).qemu_kill_all(nodedir)
 432         return True
 433
 434     # make this a valid step
 435     def qemu_list_all(self):
 436         'list all qemu instances on the qemu boxes involved by this setup'
 437         for (box,nodes) in self.get_BoxNodes().iteritems():
 438             # this is the brute force version, kill all qemus on that host box
 439             TestBoxQemu(box,self.options.buildname).qemu_list_all()
 440         return True
 441
 442     # kill only the qemus related to this test
 443     def qemu_list_mine(self):
 444         'list qemu instances for our nodes'
 445         for (box,nodes) in self.get_BoxNodes().iteritems():
 446             # the fine-grain version
 447             for node in nodes:
 448                 node.list_qemu()
 449         return True
 450
 451     # kill only the qemus related to this test
 452     def qemu_clean_mine(self):
 453         'cleanup (rm -rf) qemu instances for our nodes'
 454         for (box,nodes) in self.get_BoxNodes().iteritems():
 455             # the fine-grain version
 456             for node in nodes:
 457                 node.qemu_clean()
 458         return True
 459
 460     # kill only the right qemus
 461     def qemu_kill_mine(self):
 462         'kill the qemu instances for our nodes'
 463         for (box,nodes) in self.get_BoxNodes().iteritems():
 464             # the fine-grain version
 465             for node in nodes:
 466                 node.kill_qemu()
 467         return True
 468
 469     #################### display config
 470     def show (self):
 471         "show test configuration after localization"
 472         self.show_pass (1)
 473         self.show_pass (2)
 474         return True
 475
 476     # uggly hack to make sure 'run export' only reports about the 1st plc
 477     # to avoid confusion - also we use 'inri_slice1' in various aliases..
 478     exported_id=1
 479     def export (self):
 480         "print cut'n paste-able stuff to export env variables to your shell"
 481         # guess local domain from hostname
 482         if TestPlc.exported_id>1:
 483             print "export GUESTHOSTNAME%d=%s"%(TestPlc.exported_id,self.plc_spec['vservername'])
 484             return True
 485         TestPlc.exported_id+=1
 486         domain=socket.gethostname().split('.',1)[1]
 487         fqdn="%s.%s"%(self.plc_spec['host_box'],domain)
 488         print "export BUILD=%s"%self.options.buildname
 489         print "export PLCHOSTLXC=%s"%fqdn
 490         print "export GUESTNAME=%s"%self.plc_spec['vservername']
 491         vplcname=self.plc_spec['vservername'].split('-')[-1]
 492         print "export GUESTHOSTNAME=%s.%s"%(vplcname,domain)
 493         # find hostname of first node
 494         (hostname,qemubox) = self.all_node_infos()[0]
 495         print "export KVMHOST=%s.%s"%(qemubox,domain)
 496         print "export NODE=%s"%(hostname)
 497         return True
 498
 499     # entry point
 500     always_display_keys=['PLC_WWW_HOST','nodes','sites',]
 501     def show_pass (self,passno):
 502         for (key,val) in self.plc_spec.iteritems():
 503             if not self.options.verbose and key not in TestPlc.always_display_keys: continue
 504             if passno == 2:
 505                 if key == 'sites':
 506                     for site in val:
 507                         self.display_site_spec(site)
 508                         for node in site['nodes']:
 509                             self.display_node_spec(node)
 510                 elif key=='initscripts':
 511                     for initscript in val:
 512                         self.display_initscript_spec (initscript)
 513                 elif key=='slices':
 514                     for slice in val:
 515                         self.display_slice_spec (slice)
 516                 elif key=='keys':
 517                     for key in val:
 518                         self.display_key_spec (key)
 519             elif passno == 1:
 520                 if key not in ['sites','initscripts','slices','keys']:
 521                     print '+   ',key,':',val
 522
 523     def display_site_spec (self,site):
 524         print '+ ======== site',site['site_fields']['name']
 525         for (k,v) in site.iteritems():
 526             if not self.options.verbose and k not in TestPlc.always_display_keys: continue
 527             if k=='nodes':
 528                 if v:
 529                     print '+       ','nodes : ',
 530                     for node in v:
 531                         print node['node_fields']['hostname'],'',
 532                     print ''
 533             elif k=='users':
 534                 if v:
 535                     print '+       users : ',
 536                     for user in v:
 537                         print user['name'],'',
 538                     print ''
 539             elif k == 'site_fields':
 540                 print '+       login_base',':',v['login_base']
 541             elif k == 'address_fields':
 542                 pass
 543             else:
 544                 print '+       ',
 545                 utils.pprint(k,v)
 546
 547     def display_initscript_spec (self,initscript):
 548         print '+ ======== initscript',initscript['initscript_fields']['name']
 549
 550     def display_key_spec (self,key):
 551         print '+ ======== key',key['key_name']
 552
 553     def display_slice_spec (self,slice):
 554         print '+ ======== slice',slice['slice_fields']['name']
 555         for (k,v) in slice.iteritems():
 556             if k=='nodenames':
 557                 if v:
 558                     print '+       nodes : ',
 559                     for nodename in v:
 560                         print nodename,'',
 561                     print ''
 562             elif k=='usernames':
 563                 if v:
 564                     print '+       users : ',
 565                     for username in v:
 566                         print username,'',
 567                     print ''
 568             elif k=='slice_fields':
 569                 print '+       fields',':',
 570                 print 'max_nodes=',v['max_nodes'],
 571                 print ''
 572             else:
 573                 print '+       ',k,v
 574
 575     def display_node_spec (self,node):
 576         print "+           node=%s host_box=%s"%(node['name'],node['host_box']),
 577         print "hostname=",node['node_fields']['hostname'],
 578         print "ip=",node['interface_fields']['ip']
 579         if self.options.verbose:
 580             utils.pprint("node details",node,depth=3)
 581
 582     # another entry point for just showing the boxes involved
 583     def display_mapping (self):
 584         TestPlc.display_mapping_plc(self.plc_spec)
 585         return True
 586
 587     @staticmethod
 588     def display_mapping_plc (plc_spec):
 589         print '+ MyPLC',plc_spec['name']
 590         # WARNING this would not be right for lxc-based PLC's - should be harmless though
 591         print '+\tvserver address = root@%s:/vservers/%s'%(plc_spec['host_box'],plc_spec['vservername'])
 592         print '+\tIP = %s/%s'%(plc_spec['PLC_API_HOST'],plc_spec['vserverip'])
 593         for site_spec in plc_spec['sites']:
 594             for node_spec in site_spec['nodes']:
 595                 TestPlc.display_mapping_node(node_spec)
 596
 597     @staticmethod
 598     def display_mapping_node (node_spec):
 599         print '+   NODE %s'%(node_spec['name'])
 600         print '+\tqemu box %s'%node_spec['host_box']
 601         print '+\thostname=%s'%node_spec['node_fields']['hostname']
 602
 603     # write a timestamp in /vservers/<>.timestamp
 604     # cannot be inside the vserver, that causes vserver .. build to cough
 605     def plcvm_timestamp (self):
 606         "Create a timestamp to remember creation date for this plc"
 607         now=int(time.time())
 608         # TODO-lxc check this one
 609         # a first approx. is to store the timestamp close to the VM root like vs does
 610         stamp_path=self.vm_timestamp_path ()
 611         stamp_dir = os.path.dirname (stamp_path)
 612         utils.system(self.test_ssh.actual_command("mkdir -p %s"%stamp_dir))
 613         return utils.system(self.test_ssh.actual_command("echo %d > %s"%(now,stamp_path)))==0
 614
 615     # this is called inconditionnally at the beginning of the test sequence
 616     # just in case this is a rerun, so if the vm is not running it's fine
 617     def plcvm_delete(self):
 618         "vserver delete the test myplc"
 619         stamp_path=self.vm_timestamp_path()
 620         self.run_in_host("rm -f %s"%stamp_path)
 621         self.run_in_host("virsh -c lxc:// destroy %s"%self.vservername)
 622         self.run_in_host("virsh -c lxc:// undefine %s"%self.vservername)
 623         self.run_in_host("rm -fr /vservers/%s"%self.vservername)
 624         return True
 625
 626     ### install
 627     # historically the build was being fetched by the tests
 628     # now the build pushes itself as a subdir of the tests workdir
 629     # so that the tests do not have to worry about extracting the build (svn, git, or whatever)
 630     def plcvm_create (self):
 631         "vserver creation (no install done)"
 632         # push the local build/ dir to the testplc box
 633         if self.is_local():
 634             # a full path for the local calls
 635             build_dir=os.path.dirname(sys.argv[0])
 636             # sometimes this is empty - set to "." in such a case
 637             if not build_dir: build_dir="."
 638             build_dir += "/build"
 639         else:
 640             # use a standard name - will be relative to remote buildname
 641             build_dir="build"
 642             # remove for safety; do *not* mkdir first, otherwise we end up with build/build/
 643             self.test_ssh.rmdir(build_dir)
 644             self.test_ssh.copy(build_dir,recursive=True)
 645         # the repo url is taken from arch-rpms-url
 646         # with the last step (i386) removed
 647         repo_url = self.options.arch_rpms_url
 648         for level in [ 'arch' ]:
 649             repo_url = os.path.dirname(repo_url)
 650
 651         # invoke initvm (drop support for vs)
 652         script="lbuild-initvm.sh"
 653         script_options=""
 654         # pass the vbuild-nightly options to [lv]test-initvm
 655         script_options += " -p %s"%self.options.personality
 656         script_options += " -d %s"%self.options.pldistro
 657         script_options += " -f %s"%self.options.fcdistro
 658         script_options += " -r %s"%repo_url
 659         vserver_name = self.vservername
 660         try:
 661             vserver_hostname=socket.gethostbyaddr(self.vserverip)[0]
 662             script_options += " -n %s"%vserver_hostname
 663         except:
 664             print "Cannot reverse lookup %s"%self.vserverip
 665             print "This is considered fatal, as this might pollute the test results"
 666             return False
 667         create_vserver="%(build_dir)s/%(script)s %(script_options)s %(vserver_name)s"%locals()
 668         return self.run_in_host(create_vserver) == 0
 669
 670     ### install_rpm
 671     def plc_install(self):
 672         "yum install myplc, noderepo, and the plain bootstrapfs"
 673
 674         # workaround for getting pgsql8.2 on centos5
 675         if self.options.fcdistro == "centos5":
 676             self.run_in_guest("rpm -Uvh http://download.fedora.redhat.com/pub/epel/5/i386/epel-release-5-3.noarch.rpm")
 677
 678         # compute nodefamily
 679         if self.options.personality == "linux32":
 680             arch = "i386"
 681         elif self.options.personality == "linux64":
 682             arch = "x86_64"
 683         else:
 684             raise Exception, "Unsupported personality %r"%self.options.personality
 685         nodefamily="%s-%s-%s"%(self.options.pldistro,self.options.fcdistro,arch)
 686
 687         pkgs_list=[]
 688         pkgs_list.append ("slicerepo-%s"%nodefamily)
 689         pkgs_list.append ("myplc")
 690         pkgs_list.append ("noderepo-%s"%nodefamily)
 691         pkgs_list.append ("nodeimage-%s-plain"%nodefamily)
 692         pkgs_string=" ".join(pkgs_list)
 693         return self.yum_install (pkgs_list)
 694
 695     ###
 696     def mod_python(self):
 697         """yum install mod_python, useful on f18 and above so as to avoid broken wsgi"""
 698         return self.yum_install ( [ 'mod_python' ] )
 699
 700     ###
 701     def plc_configure(self):
 702         "run plc-config-tty"
 703         tmpname='%s.plc-config-tty'%(self.name())
 704         fileconf=open(tmpname,'w')
 705         for var in [ 'PLC_NAME',
 706                      'PLC_ROOT_USER',
 707                      'PLC_ROOT_PASSWORD',
 708                      'PLC_SLICE_PREFIX',
 709                      'PLC_MAIL_ENABLED',
 710                      'PLC_MAIL_SUPPORT_ADDRESS',
 711                      'PLC_DB_HOST',
 712 #                     'PLC_DB_PASSWORD',
 713                      # Above line was added for integrating SFA Testing
 714                      'PLC_API_HOST',
 715                      'PLC_WWW_HOST',
 716                      'PLC_BOOT_HOST',
 717                      'PLC_NET_DNS1',
 718                      'PLC_NET_DNS2',
 719                      'PLC_RESERVATION_GRANULARITY',
 720                      'PLC_OMF_ENABLED',
 721                      'PLC_OMF_XMPP_SERVER',
 722                      'PLC_VSYS_DEFAULTS',
 723                      ]:
 724             fileconf.write ('e %s\n%s\n'%(var,self.plc_spec[var]))
 725         fileconf.write('w\n')
 726         fileconf.write('q\n')
 727         fileconf.close()
 728         utils.system('cat %s'%tmpname)
 729         self.run_in_guest_piped('cat %s'%tmpname,'plc-config-tty')
 730         utils.system('rm %s'%tmpname)
 731         return True
 732
 733 # f14 is a bit odd in this respect, although this worked fine in guests up to f18
 734 # however using a vplc guest under f20 requires this trick
 735 # the symptom is this: service plc start
 736 # Starting plc (via systemctl):  Failed to get D-Bus connection: \
 737 #    Failed to connect to socket /org/freedesktop/systemd1/private: Connection refused
 738 # weird thing is the doc says f14 uses upstart by default and not systemd
 739 # so this sounds kind of harmless
 740     def start_service (self,service): return self.start_stop_service (service,'start')
 741     def stop_service  (self,service): return self.start_stop_service (service,'stop')
 742
 743     def start_stop_service (self, service,start_or_stop):
 744         "utility to start/stop a service with the special trick for f14"
 745         if self.options.fcdistro != 'f14':
 746             return self.run_in_guest ("service %s %s"%(service,start_or_stop))==0
 747         else:
 748             # patch /sbin/service so it does not reset environment
 749             self.run_in_guest ('sed -i -e \\"s,env -i,env,\\" /sbin/service')
 750             # this is because our own scripts in turn call service
 751             return self.run_in_guest("SYSTEMCTL_SKIP_REDIRECT=true service %s %s"%(service,start_or_stop))==0
 752
 753     def plc_start(self):
 754         "service plc start"
 755         return self.start_service ('plc')
 756
 757     def plc_stop(self):
 758         "service plc stop"
 759         return self.stop_service ('plc')
 760
 761     def plcvm_start (self):
 762         "start the PLC vserver"
 763         self.start_guest()
 764         return True
 765
 766     def plcvm_stop (self):
 767         "stop the PLC vserver"
 768         self.stop_guest()
 769         return True
 770
 771     # stores the keys from the config for further use
 772     def keys_store(self):
 773         "stores test users ssh keys in keys/"
 774         for key_spec in self.plc_spec['keys']:
 775                 TestKey(self,key_spec).store_key()
 776         return True
 777
 778     def keys_clean(self):
 779         "removes keys cached in keys/"
 780         utils.system("rm -rf ./keys")
 781         return True
 782
 783     # fetches the ssh keys in the plc's /etc/planetlab and stores them in keys/
 784     # for later direct access to the nodes
 785     def keys_fetch(self):
 786         "gets ssh keys in /etc/planetlab/ and stores them locally in keys/"
 787         dir="./keys"
 788         if not os.path.isdir(dir):
 789             os.mkdir(dir)
 790         vservername=self.vservername
 791         vm_root=self.vm_root_in_host()
 792         overall=True
 793         prefix = 'debug_ssh_key'
 794         for ext in [ 'pub', 'rsa' ] :
 795             src="%(vm_root)s/etc/planetlab/%(prefix)s.%(ext)s"%locals()
 796             dst="keys/%(vservername)s-debug.%(ext)s"%locals()
 797             if self.test_ssh.fetch(src,dst) != 0: overall=False
 798         return overall
 799
 800     def sites (self):
 801         "create sites with PLCAPI"
 802         return self.do_sites()
 803
 804     def delete_sites (self):
 805         "delete sites with PLCAPI"
 806         return self.do_sites(action="delete")
 807
 808     def do_sites (self,action="add"):
 809         for site_spec in self.plc_spec['sites']:
 810             test_site = TestSite (self,site_spec)
 811             if (action != "add"):
 812                 utils.header("Deleting site %s in %s"%(test_site.name(),self.name()))
 813                 test_site.delete_site()
 814                 # deleted with the site
 815                 #test_site.delete_users()
 816                 continue
 817             else:
 818                 utils.header("Creating site %s & users in %s"%(test_site.name(),self.name()))
 819                 test_site.create_site()
 820                 test_site.create_users()
 821         return True
 822
 823     def delete_all_sites (self):
 824         "Delete all sites in PLC, and related objects"
 825         print 'auth_root',self.auth_root()
 826         sites = self.apiserver.GetSites(self.auth_root(), {}, ['site_id','login_base'])
 827         for site in sites:
 828             # keep automatic site - otherwise we shoot in our own foot, root_auth is not valid anymore
 829             if site['login_base']==self.plc_spec['PLC_SLICE_PREFIX']: continue
 830             site_id=site['site_id']
 831             print 'Deleting site_id',site_id
 832             self.apiserver.DeleteSite(self.auth_root(),site_id)
 833         return True
 834
 835     def nodes (self):
 836         "create nodes with PLCAPI"
 837         return self.do_nodes()
 838     def delete_nodes (self):
 839         "delete nodes with PLCAPI"
 840         return self.do_nodes(action="delete")
 841
 842     def do_nodes (self,action="add"):
 843         for site_spec in self.plc_spec['sites']:
 844             test_site = TestSite (self,site_spec)
 845             if action != "add":
 846                 utils.header("Deleting nodes in site %s"%test_site.name())
 847                 for node_spec in site_spec['nodes']:
 848                     test_node=TestNode(self,test_site,node_spec)
 849                     utils.header("Deleting %s"%test_node.name())
 850                     test_node.delete_node()
 851             else:
 852                 utils.header("Creating nodes for site %s in %s"%(test_site.name(),self.name()))
 853                 for node_spec in site_spec['nodes']:
 854                     utils.pprint('Creating node %s'%node_spec,node_spec)
 855                     test_node = TestNode (self,test_site,node_spec)
 856                     test_node.create_node ()
 857         return True
 858
 859     def nodegroups (self):
 860         "create nodegroups with PLCAPI"
 861         return self.do_nodegroups("add")
 862     def delete_nodegroups (self):
 863         "delete nodegroups with PLCAPI"
 864         return self.do_nodegroups("delete")
 865
 866     YEAR = 365*24*3600
 867     @staticmethod
 868     def translate_timestamp (start,grain,timestamp):
 869         if timestamp < TestPlc.YEAR:    return start+timestamp*grain
 870         else:                           return timestamp
 871
 872     @staticmethod
 873     def timestamp_printable (timestamp):
 874         return time.strftime('%m-%d %H:%M:%S UTC',time.gmtime(timestamp))
 875
 876     def leases(self):
 877         "create leases (on reservable nodes only, use e.g. run -c default -c resa)"
 878         now=int(time.time())
 879         grain=self.apiserver.GetLeaseGranularity(self.auth_root())
 880         print 'API answered grain=',grain
 881         start=(now/grain)*grain
 882         start += grain
 883         # find out all nodes that are reservable
 884         nodes=self.all_reservable_nodenames()
 885         if not nodes:
 886             utils.header ("No reservable node found - proceeding without leases")
 887             return True
 888         ok=True
 889         # attach them to the leases as specified in plc_specs
 890         # this is where the 'leases' field gets interpreted as relative of absolute
 891         for lease_spec in self.plc_spec['leases']:
 892             # skip the ones that come with a null slice id
 893             if not lease_spec['slice']: continue
 894             lease_spec['t_from']=TestPlc.translate_timestamp(start,grain,lease_spec['t_from'])
 895             lease_spec['t_until']=TestPlc.translate_timestamp(start,grain,lease_spec['t_until'])
 896             lease_addition=self.apiserver.AddLeases(self.auth_root(),nodes,
 897                                                     lease_spec['slice'],lease_spec['t_from'],lease_spec['t_until'])
 898             if lease_addition['errors']:
 899                 utils.header("Cannot create leases, %s"%lease_addition['errors'])
 900                 ok=False
 901             else:
 902                 utils.header('Leases on nodes %r for %s from %d (%s) until %d (%s)'%\
 903                               (nodes,lease_spec['slice'],
 904                                lease_spec['t_from'],TestPlc.timestamp_printable(lease_spec['t_from']),
 905                                lease_spec['t_until'],TestPlc.timestamp_printable(lease_spec['t_until'])))
 906
 907         return ok
 908
 909     def delete_leases (self):
 910         "remove all leases in the myplc side"
 911         lease_ids= [ l['lease_id'] for l in self.apiserver.GetLeases(self.auth_root())]
 912         utils.header("Cleaning leases %r"%lease_ids)
 913         self.apiserver.DeleteLeases(self.auth_root(),lease_ids)
 914         return True
 915
 916     def list_leases (self):
 917         "list all leases known to the myplc"
 918         leases = self.apiserver.GetLeases(self.auth_root())
 919         now=int(time.time())
 920         for l in leases:
 921             current=l['t_until']>=now
 922             if self.options.verbose or current:
 923                 utils.header("%s %s from %s until %s"%(l['hostname'],l['name'],
 924                                                        TestPlc.timestamp_printable(l['t_from']),
 925                                                        TestPlc.timestamp_printable(l['t_until'])))
 926         return True
 927
 928     # create nodegroups if needed, and populate
 929     def do_nodegroups (self, action="add"):
 930         # 1st pass to scan contents
 931         groups_dict = {}
 932         for site_spec in self.plc_spec['sites']:
 933             test_site = TestSite (self,site_spec)
 934             for node_spec in site_spec['nodes']:
 935                 test_node=TestNode (self,test_site,node_spec)
 936                 if node_spec.has_key('nodegroups'):
 937                     nodegroupnames=node_spec['nodegroups']
 938                     if isinstance(nodegroupnames,StringTypes):
 939                         nodegroupnames = [ nodegroupnames ]
 940                     for nodegroupname in nodegroupnames:
 941                         if not groups_dict.has_key(nodegroupname):
 942                             groups_dict[nodegroupname]=[]
 943                         groups_dict[nodegroupname].append(test_node.name())
 944         auth=self.auth_root()
 945         overall = True
 946         for (nodegroupname,group_nodes) in groups_dict.iteritems():
 947             if action == "add":
 948                 print 'nodegroups:','dealing with nodegroup',nodegroupname,'on nodes',group_nodes
 949                 # first, check if the nodetagtype is here
 950                 tag_types = self.apiserver.GetTagTypes(auth,{'tagname':nodegroupname})
 951                 if tag_types:
 952                     tag_type_id = tag_types[0]['tag_type_id']
 953                 else:
 954                     tag_type_id = self.apiserver.AddTagType(auth,
 955                                                             {'tagname':nodegroupname,
 956                                                              'description': 'for nodegroup %s'%nodegroupname,
 957                                                              'category':'test'})
 958                 print 'located tag (type)',nodegroupname,'as',tag_type_id
 959                 # create nodegroup
 960                 nodegroups = self.apiserver.GetNodeGroups (auth, {'groupname':nodegroupname})
 961                 if not nodegroups:
 962                     self.apiserver.AddNodeGroup(auth, nodegroupname, tag_type_id, 'yes')
 963                     print 'created nodegroup',nodegroupname,'from tagname',nodegroupname,'and value','yes'
 964                 # set node tag on all nodes, value='yes'
 965                 for nodename in group_nodes:
 966                     try:
 967                         self.apiserver.AddNodeTag(auth, nodename, nodegroupname, "yes")
 968                     except:
 969                         traceback.print_exc()
 970                         print 'node',nodename,'seems to already have tag',nodegroupname
 971                     # check anyway
 972                     try:
 973                         expect_yes = self.apiserver.GetNodeTags(auth,
 974                                                                 {'hostname':nodename,
 975                                                                  'tagname':nodegroupname},
 976                                                                 ['value'])[0]['value']
 977                         if expect_yes != "yes":
 978                             print 'Mismatch node tag on node',nodename,'got',expect_yes
 979                             overall=False
 980                     except:
 981                         if not self.options.dry_run:
 982                             print 'Cannot find tag',nodegroupname,'on node',nodename
 983                             overall = False
 984             else:
 985                 try:
 986                     print 'cleaning nodegroup',nodegroupname
 987                     self.apiserver.DeleteNodeGroup(auth,nodegroupname)
 988                 except:
 989                     traceback.print_exc()
 990                     overall=False
 991         return overall
 992
 993     # a list of TestNode objs
 994     def all_nodes (self):
 995         nodes=[]
 996         for site_spec in self.plc_spec['sites']:
 997             test_site = TestSite (self,site_spec)
 998             for node_spec in site_spec['nodes']:
 999                 nodes.append(TestNode (self,test_site,node_spec))
1000         return nodes
1001
1002     # return a list of tuples (nodename,qemuname)
1003     def all_node_infos (self) :
1004         node_infos = []
1005         for site_spec in self.plc_spec['sites']:
1006             node_infos += [ (node_spec['node_fields']['hostname'],node_spec['host_box']) \
1007                                 for node_spec in site_spec['nodes'] ]
1008         return node_infos
1009
1010     def all_nodenames (self): return [ x[0] for x in self.all_node_infos() ]
1011     def all_reservable_nodenames (self):
1012         res=[]
1013         for site_spec in self.plc_spec['sites']:
1014             for node_spec in site_spec['nodes']:
1015                 node_fields=node_spec['node_fields']
1016                 if 'node_type' in node_fields and node_fields['node_type']=='reservable':
1017                     res.append(node_fields['hostname'])
1018         return res
1019
1020     # silent_minutes : during the first <silent_minutes> minutes nothing gets printed
1021     def nodes_check_boot_state (self, target_boot_state, timeout_minutes, silent_minutes,period_seconds=15):
1022         if self.options.dry_run:
1023             print 'dry_run'
1024             return True
1025
1026         class CompleterTaskBootState (CompleterTask):
1027             def __init__ (self, test_plc,hostname):
1028                 self.test_plc=test_plc
1029                 self.hostname=hostname
1030                 self.last_boot_state='undef'
1031             def actual_run (self):
1032                 try:
1033                     node = self.test_plc.apiserver.GetNodes(self.test_plc.auth_root(), [ self.hostname ],
1034                                                                ['boot_state'])[0]
1035                     self.last_boot_state = node['boot_state']
1036                     return self.last_boot_state == target_boot_state
1037                 except:
1038                     return False
1039             def message (self):
1040                 return "CompleterTaskBootState with node %s"%self.hostname
1041             def failure_message (self):
1042                 return "node %s in state %s - expected %s"%(self.hostname,self.last_boot_state,target_boot_state)
1043
1044         timeout = timedelta(minutes=timeout_minutes)
1045         graceout = timedelta(minutes=silent_minutes)
1046         period   = timedelta(seconds=period_seconds)
1047         # the nodes that haven't checked yet - start with a full list and shrink over time
1048         utils.header("checking nodes boot state (expected %s)"%target_boot_state)
1049         tasks = [ CompleterTaskBootState (self,hostname) \
1050                       for (hostname,_) in self.all_node_infos() ]
1051         return Completer (tasks).run (timeout, graceout, period)
1052
1053     def nodes_booted(self):
1054         return self.nodes_check_boot_state('boot',timeout_minutes=30,silent_minutes=28)
1055
1056     def probe_kvm_iptables (self):
1057         (_,kvmbox) = self.all_node_infos()[0]
1058         TestSsh(kvmbox).run("iptables-save")
1059         return True
1060
1061     # probing nodes
1062     def check_nodes_ping(self,timeout_seconds=120,period_seconds=10):
1063         class CompleterTaskPingNode (CompleterTask):
1064             def __init__ (self, hostname):
1065                 self.hostname=hostname
1066             def run(self,silent):
1067                 command="ping -c 1 -w 1 %s >& /dev/null"%self.hostname
1068                 return utils.system (command, silent=silent)==0
1069             def failure_message (self):
1070                 return "Cannot ping node with name %s"%self.hostname
1071         timeout=timedelta (seconds=timeout_seconds)
1072         graceout=timeout
1073         period=timedelta (seconds=period_seconds)
1074         node_infos = self.all_node_infos()
1075         tasks = [ CompleterTaskPingNode (h) for (h,_) in node_infos ]
1076         return Completer (tasks).run (timeout, graceout, period)
1077
1078     # ping node before we try to reach ssh, helpful for troubleshooting failing bootCDs
1079     def ping_node (self):
1080         "Ping nodes"
1081         return self.check_nodes_ping ()
1082
1083     def check_nodes_ssh(self,debug,timeout_minutes,silent_minutes,period_seconds=15):
1084         # various delays
1085         timeout  = timedelta(minutes=timeout_minutes)
1086         graceout = timedelta(minutes=silent_minutes)
1087         period   = timedelta(seconds=period_seconds)
1088         vservername=self.vservername
1089         if debug:
1090             message="debug"
1091             local_key = "keys/%(vservername)s-debug.rsa"%locals()
1092         else:
1093             message="boot"
1094             local_key = "keys/key_admin.rsa"
1095         utils.header("checking ssh access to nodes (expected in %s mode)"%message)
1096         node_infos = self.all_node_infos()
1097         tasks = [ CompleterTaskNodeSsh (nodename, qemuname, local_key, boot_state=message) \
1098                       for (nodename,qemuname) in node_infos ]
1099         return Completer (tasks).run (timeout, graceout, period)
1100
1101     def ssh_node_debug(self):
1102         "Tries to ssh into nodes in debug mode with the debug ssh key"
1103         return self.check_nodes_ssh(debug=True,
1104                                     timeout_minutes=self.ssh_node_debug_timeout,
1105                                     silent_minutes=self.ssh_node_debug_silent)
1106
1107     def ssh_node_boot(self):
1108         "Tries to ssh into nodes in production mode with the root ssh key"
1109         return self.check_nodes_ssh(debug=False,
1110                                     timeout_minutes=self.ssh_node_boot_timeout,
1111                                     silent_minutes=self.ssh_node_boot_silent)
1112
1113     def node_bmlogs(self):
1114         "Checks that there's a non-empty dir. /var/log/bm/raw"
1115         return utils.system(self.actual_command_in_guest("ls /var/log/bm/raw"))==0
1116
1117     @node_mapper
1118     def qemu_local_init (self): pass
1119     @node_mapper
1120     def bootcd (self): pass
1121     @node_mapper
1122     def qemu_local_config (self): pass
1123     @node_mapper
1124     def nodestate_reinstall (self): pass
1125     @node_mapper
1126     def nodestate_safeboot (self): pass
1127     @node_mapper
1128     def nodestate_boot (self): pass
1129     @node_mapper
1130     def nodestate_show (self): pass
1131     @node_mapper
1132     def qemu_export (self): pass
1133
1134     ### check hooks : invoke scripts from hooks/{node,slice}
1135     def check_hooks_node (self):
1136         return self.locate_first_node().check_hooks()
1137     def check_hooks_sliver (self) :
1138         return self.locate_first_sliver().check_hooks()
1139
1140     def check_hooks (self):
1141         "runs unit tests in the node and slice contexts - see hooks/{node,slice}"
1142         return self.check_hooks_node() and self.check_hooks_sliver()
1143
1144     ### initscripts
1145     def do_check_initscripts(self):
1146         class CompleterTaskInitscript (CompleterTask):
1147             def __init__ (self, test_sliver, stamp):
1148                 self.test_sliver=test_sliver
1149                 self.stamp=stamp
1150             def actual_run (self):
1151                 return self.test_sliver.check_initscript_stamp (self.stamp)
1152             def message (self):
1153                 return "initscript checker for %s"%self.test_sliver.name()
1154             def failure_message (self):
1155                 return "initscript stamp %s not found in sliver %s"%(self.stamp,self.test_sliver.name())
1156
1157         tasks=[]
1158         for slice_spec in self.plc_spec['slices']:
1159             if not slice_spec.has_key('initscriptstamp'):
1160                 continue
1161             stamp=slice_spec['initscriptstamp']
1162             slicename=slice_spec['slice_fields']['name']
1163             for nodename in slice_spec['nodenames']:
1164                 print 'nodename',nodename,'slicename',slicename,'stamp',stamp
1165                 (site,node) = self.locate_node (nodename)
1166                 # xxx - passing the wrong site - probably harmless
1167                 test_site = TestSite (self,site)
1168                 test_slice = TestSlice (self,test_site,slice_spec)
1169                 test_node = TestNode (self,test_site,node)
1170                 test_sliver = TestSliver (self, test_node, test_slice)
1171                 tasks.append ( CompleterTaskInitscript (test_sliver, stamp))
1172         return Completer (tasks).run (timedelta(minutes=5), timedelta(minutes=4), timedelta(seconds=10))
1173
1174     def check_initscripts(self):
1175         "check that the initscripts have triggered"
1176         return self.do_check_initscripts()
1177
1178     def initscripts (self):
1179         "create initscripts with PLCAPI"
1180         for initscript in self.plc_spec['initscripts']:
1181             utils.pprint('Adding Initscript in plc %s'%self.plc_spec['name'],initscript)
1182             self.apiserver.AddInitScript(self.auth_root(),initscript['initscript_fields'])
1183         return True
1184
1185     def delete_initscripts (self):
1186         "delete initscripts with PLCAPI"
1187         for initscript in self.plc_spec['initscripts']:
1188             initscript_name = initscript['initscript_fields']['name']
1189             print('Attempting to delete %s in plc %s'%(initscript_name,self.plc_spec['name']))
1190             try:
1191                 self.apiserver.DeleteInitScript(self.auth_root(),initscript_name)
1192                 print initscript_name,'deleted'
1193             except:
1194                 print 'deletion went wrong - probably did not exist'
1195         return True
1196
1197     ### manage slices
1198     def slices (self):
1199         "create slices with PLCAPI"
1200         return self.do_slices(action="add")
1201
1202     def delete_slices (self):
1203         "delete slices with PLCAPI"
1204         return self.do_slices(action="delete")
1205
1206     def fill_slices (self):
1207         "add nodes in slices with PLCAPI"
1208         return self.do_slices(action="fill")
1209
1210     def empty_slices (self):
1211         "remove nodes from slices with PLCAPI"
1212         return self.do_slices(action="empty")
1213
1214     def do_slices (self,  action="add"):
1215         for slice in self.plc_spec['slices']:
1216             site_spec = self.locate_site (slice['sitename'])
1217             test_site = TestSite(self,site_spec)
1218             test_slice=TestSlice(self,test_site,slice)
1219             if action == "delete":
1220                 test_slice.delete_slice()
1221             elif action=="fill":
1222                 test_slice.add_nodes()
1223             elif action=="empty":
1224                 test_slice.delete_nodes()
1225             else:
1226                 test_slice.create_slice()
1227         return True
1228
1229     @slice_mapper__tasks(20,10,15)
1230     def ssh_slice(self): pass
1231     @slice_mapper__tasks(20,19,15)
1232     def ssh_slice_off (self): pass
1233     @slice_mapper__tasks(2,1,15)
1234     def slice_fs_present(self): pass
1235     @slice_mapper__tasks(2,1,15)
1236     def slice_fs_deleted(self): pass
1237
1238     # use another name so we can exclude/ignore it from the tests on the nightly command line
1239     def ssh_slice_again(self): return self.ssh_slice()
1240     # note that simply doing ssh_slice_again=ssh_slice would kind od work too
1241     # but for some reason the ignore-wrapping thing would not
1242
1243     @slice_mapper
1244     def ssh_slice_basics(self): pass
1245     @slice_mapper
1246     def check_vsys_defaults(self): pass
1247
1248     @node_mapper
1249     def keys_clear_known_hosts (self): pass
1250
1251     def plcapi_urls (self):
1252         return PlcapiUrlScanner (self.auth_root(),ip=self.vserverip).scan()
1253
1254     def speed_up_slices (self):
1255         "tweak nodemanager settings on all nodes using a conf file"
1256         # create the template on the server-side
1257         template="%s.nodemanager"%self.name()
1258         template_file = open (template,"w")
1259         template_file.write('OPTIONS="-p 30 -r 11 -d"\n')
1260         template_file.close()
1261         in_vm="/var/www/html/PlanetLabConf/nodemanager"
1262         remote="%s/%s"%(self.vm_root_in_host(),in_vm)
1263         self.test_ssh.copy_abs(template,remote)
1264         # Add a conf file
1265         self.apiserver.AddConfFile (self.auth_root(),
1266                                     {'dest':'/etc/sysconfig/nodemanager',
1267                                      'source':'PlanetLabConf/nodemanager',
1268                                      'postinstall_cmd':'service nm restart',})
1269         return True
1270
1271     def debug_nodemanager (self):
1272         "sets verbose mode for nodemanager, and speeds up cycle even more (needs speed_up_slices first)"
1273         template="%s.nodemanager"%self.name()
1274         template_file = open (template,"w")
1275         template_file.write('OPTIONS="-p 10 -r 6 -v -d"\n')
1276         template_file.close()
1277         in_vm="/var/www/html/PlanetLabConf/nodemanager"
1278         remote="%s/%s"%(self.vm_root_in_host(),in_vm)
1279         self.test_ssh.copy_abs(template,remote)
1280         return True
1281
1282     @node_mapper
1283     def qemu_start (self) : pass
1284
1285     @node_mapper
1286     def qemu_timestamp (self) : pass
1287
1288     # when a spec refers to a node possibly on another plc
1289     def locate_sliver_obj_cross (self, nodename, slicename, other_plcs):
1290         for plc in [ self ] + other_plcs:
1291             try:
1292                 return plc.locate_sliver_obj (nodename, slicename)
1293             except:
1294                 pass
1295         raise Exception, "Cannot locate sliver %s@%s among all PLCs"%(nodename,slicename)
1296
1297     # implement this one as a cross step so that we can take advantage of different nodes
1298     # in multi-plcs mode
1299     def cross_check_tcp (self, other_plcs):
1300         "check TCP connectivity between 2 slices (or in loopback if only one is defined)"
1301         if 'tcp_specs' not in self.plc_spec or not self.plc_spec['tcp_specs']:
1302             utils.header ("check_tcp: no/empty config found")
1303             return True
1304         specs = self.plc_spec['tcp_specs']
1305         overall=True
1306         for spec in specs:
1307             port = spec['port']
1308             # server side
1309             s_test_sliver = self.locate_sliver_obj_cross (spec['server_node'],spec['server_slice'],other_plcs)
1310             if not s_test_sliver.run_tcp_server(port,timeout=20):
1311                 overall=False
1312                 break
1313
1314             # idem for the client side
1315             c_test_sliver = self.locate_sliver_obj_cross (spec['client_node'],spec['client_slice'],other_plcs)
1316             # use nodename from locatesd sliver, unless 'client_connect' is set
1317             if 'client_connect' in spec:
1318                 destination = spec['client_connect']
1319             else:
1320                 destination=s_test_sliver.test_node.name()
1321             if not c_test_sliver.run_tcp_client(destination,port):
1322                 overall=False
1323         return overall
1324
1325     # painfully enough, we need to allow for some time as netflow might show up last
1326     def check_system_slice (self):
1327         "all nodes: check that a system slice is alive"
1328         # netflow currently not working in the lxc distro
1329         # drl not built at all in the wtx distro
1330         # if we find either of them we're happy
1331         return self.check_netflow() or self.check_drl()
1332
1333     # expose these
1334     def check_netflow (self): return self._check_system_slice ('netflow')
1335     def check_drl (self): return self._check_system_slice ('drl')
1336
1337     # we have the slices up already here, so it should not take too long
1338     def _check_system_slice (self, slicename, timeout_minutes=5, period_seconds=15):
1339         class CompleterTaskSystemSlice (CompleterTask):
1340             def __init__ (self, test_node, dry_run):
1341                 self.test_node=test_node
1342                 self.dry_run=dry_run
1343             def actual_run (self):
1344                 return self.test_node._check_system_slice (slicename, dry_run=self.dry_run)
1345             def message (self):
1346                 return "System slice %s @ %s"%(slicename, self.test_node.name())
1347             def failure_message (self):
1348                 return "COULD not find system slice %s @ %s"%(slicename, self.test_node.name())
1349         timeout = timedelta(minutes=timeout_minutes)
1350         silent  = timedelta (0)
1351         period  = timedelta (seconds=period_seconds)
1352         tasks = [ CompleterTaskSystemSlice (test_node, self.options.dry_run) \
1353                       for test_node in self.all_nodes() ]
1354         return Completer (tasks) . run (timeout, silent, period)
1355
1356     def plcsh_stress_test (self):
1357         "runs PLCAPI stress test, that checks Add/Update/Delete on all types - preserves contents"
1358         # install the stress-test in the plc image
1359         location = "/usr/share/plc_api/plcsh_stress_test.py"
1360         remote="%s/%s"%(self.vm_root_in_host(),location)
1361         self.test_ssh.copy_abs("plcsh_stress_test.py",remote)
1362         command = location
1363         command += " -- --check"
1364         if self.options.size == 1:
1365             command +=  " --tiny"
1366         return ( self.run_in_guest(command) == 0)
1367
1368     # populate runs the same utility without slightly different options
1369     # in particular runs with --preserve (dont cleanup) and without --check
1370     # also it gets run twice, once with the --foreign option for creating fake foreign entries
1371
1372     def sfa_install_all (self):
1373         "yum install sfa sfa-plc sfa-sfatables sfa-client"
1374         return self.yum_install ("sfa sfa-plc sfa-sfatables sfa-client")
1375
1376     def sfa_install_core(self):
1377         "yum install sfa"
1378         return self.yum_install ("sfa")
1379
1380     def sfa_install_plc(self):
1381         "yum install sfa-plc"
1382         return self.yum_install("sfa-plc")
1383
1384     def sfa_install_sfatables(self):
1385         "yum install sfa-sfatables"
1386         return self.yum_install ("sfa-sfatables")
1387
1388     # for some very odd reason, this sometimes fails with the following symptom
1389     # # yum install sfa-client
1390     # Setting up Install Process
1391     # ...
1392     # Downloading Packages:
1393     # Running rpm_check_debug
1394     # Running Transaction Test
1395     # Transaction Test Succeeded
1396     # Running Transaction
1397     # Transaction couldn't start:
1398     # installing package sfa-client-2.1-7.onelab.2012.05.23.i686 needs 68KB on the / filesystem
1399     # [('installing package sfa-client-2.1-7.onelab.2012.05.23.i686 needs 68KB on the / filesystem', (9, '/', 69632L))]
1400     # even though in the same context I have
1401     # [2012.05.23--f14-32-sfastd1-1-vplc07] / # df -h
1402     # Filesystem            Size  Used Avail Use% Mounted on
1403     # /dev/hdv1             806G  264G  501G  35% /
1404     # none                   16M   36K   16M   1% /tmp
1405     #
1406     # so as a workaround, we first try yum install, and then invoke rpm on the cached rpm...
1407     def sfa_install_client(self):
1408         "yum install sfa-client"
1409         first_try=self.yum_install("sfa-client")
1410         if first_try: return True
1411         utils.header ("********** Regular yum failed - special workaround in place, 2nd chance")
1412         (code,cached_rpm_path)=utils.output_of(self.actual_command_in_guest('find /var/cache/yum -name sfa-client\*.rpm'))
1413         utils.header("rpm_path=<<%s>>"%rpm_path)
1414         # just for checking
1415         self.run_in_guest("rpm -i %s"%cached_rpm_path)
1416         return self.yum_check_installed ("sfa-client")
1417
1418     def sfa_dbclean(self):
1419         "thoroughly wipes off the SFA database"
1420         return self.run_in_guest("sfaadmin reg nuke")==0 or \
1421             self.run_in_guest("sfa-nuke.py")==0 or \
1422             self.run_in_guest("sfa-nuke-plc.py")==0
1423
1424     def sfa_fsclean(self):
1425         "cleanup /etc/sfa/trusted_roots and /var/lib/sfa"
1426         self.run_in_guest("rm -rf /etc/sfa/trusted_roots /var/lib/sfa/authorities")
1427         return True
1428
1429     def sfa_plcclean(self):
1430         "cleans the PLC entries that were created as a side effect of running the script"
1431         # ignore result
1432         sfa_spec=self.plc_spec['sfa']
1433
1434         for auth_sfa_spec in sfa_spec['auth_sfa_specs']:
1435             login_base=auth_sfa_spec['login_base']
1436             try: self.apiserver.DeleteSite (self.auth_root(),login_base)
1437             except: print "Site %s already absent from PLC db"%login_base
1438
1439             for spec_name in ['pi_spec','user_spec']:
1440                 user_spec=auth_sfa_spec[spec_name]
1441                 username=user_spec['email']
1442                 try: self.apiserver.DeletePerson(self.auth_root(),username)
1443                 except:
1444                     # this in fact is expected as sites delete their members
1445                     #print "User %s already absent from PLC db"%username
1446                     pass
1447
1448         print "REMEMBER TO RUN sfa_import AGAIN"
1449         return True
1450
1451     def sfa_uninstall(self):
1452         "uses rpm to uninstall sfa - ignore result"
1453         self.run_in_guest("rpm -e sfa sfa-sfatables sfa-client sfa-plc")
1454         self.run_in_guest("rm -rf /var/lib/sfa")
1455         self.run_in_guest("rm -rf /etc/sfa")
1456         self.run_in_guest("rm -rf /var/log/sfa_access.log /var/log/sfa_import_plc.log /var/log/sfa.daemon")
1457         # xxx tmp
1458         self.run_in_guest("rpm -e --noscripts sfa-plc")
1459         return True
1460
1461     ### run unit tests for SFA
1462     # NOTE: for some reason on f14/i386, yum install sfa-tests fails for no reason
1463     # Running Transaction
1464     # Transaction couldn't start:
1465     # installing package sfa-tests-1.0-21.onelab.i686 needs 204KB on the / filesystem
1466     # [('installing package sfa-tests-1.0-21.onelab.i686 needs 204KB on the / filesystem', (9, '/', 208896L))]
1467     # no matter how many Gbs are available on the testplc
1468     # could not figure out what's wrong, so...
1469     # if the yum install phase fails, consider the test is successful
1470     # other combinations will eventually run it hopefully
1471     def sfa_utest(self):
1472         "yum install sfa-tests and run SFA unittests"
1473         self.run_in_guest("yum -y install sfa-tests")
1474         # failed to install - forget it
1475         if self.run_in_guest("rpm -q sfa-tests")!=0:
1476             utils.header("WARNING: SFA unit tests failed to install, ignoring")
1477             return True
1478         return self.run_in_guest("/usr/share/sfa/tests/testAll.py")==0
1479
1480     ###
1481     def confdir(self):
1482         dirname="conf.%s"%self.plc_spec['name']
1483         if not os.path.isdir(dirname):
1484             utils.system("mkdir -p %s"%dirname)
1485         if not os.path.isdir(dirname):
1486             raise Exception,"Cannot create config dir for plc %s"%self.name()
1487         return dirname
1488
1489     def conffile(self,filename):
1490         return "%s/%s"%(self.confdir(),filename)
1491     def confsubdir(self,dirname,clean,dry_run=False):
1492         subdirname="%s/%s"%(self.confdir(),dirname)
1493         if clean:
1494             utils.system("rm -rf %s"%subdirname)
1495         if not os.path.isdir(subdirname):
1496             utils.system("mkdir -p %s"%subdirname)
1497         if not dry_run and not os.path.isdir(subdirname):
1498             raise "Cannot create config subdir %s for plc %s"%(dirname,self.name())
1499         return subdirname
1500
1501     def conffile_clean (self,filename):
1502         filename=self.conffile(filename)
1503         return utils.system("rm -rf %s"%filename)==0
1504
1505     ###
1506     def sfa_configure(self):
1507         "run sfa-config-tty"
1508         tmpname=self.conffile("sfa-config-tty")
1509         fileconf=open(tmpname,'w')
1510         for var in [ 'SFA_REGISTRY_ROOT_AUTH',
1511                      'SFA_INTERFACE_HRN',
1512                      'SFA_REGISTRY_LEVEL1_AUTH',
1513                      'SFA_REGISTRY_HOST',
1514                      'SFA_AGGREGATE_HOST',
1515                      'SFA_SM_HOST',
1516                      'SFA_PLC_URL',
1517                      'SFA_PLC_USER',
1518                      'SFA_PLC_PASSWORD',
1519                      'SFA_DB_HOST',
1520                      'SFA_DB_USER',
1521                      'SFA_DB_PASSWORD',
1522                      'SFA_DB_NAME',
1523                      'SFA_API_LOGLEVEL',
1524                      'SFA_GENERIC_FLAVOUR',
1525                      'SFA_AGGREGATE_ENABLED',
1526                      ]:
1527             if self.plc_spec['sfa'].has_key(var):
1528                 fileconf.write ('e %s\n%s\n'%(var,self.plc_spec['sfa'][var]))
1529         # the way plc_config handles booleans just sucks..
1530         for var in []:
1531             val='false'
1532             if self.plc_spec['sfa'][var]: val='true'
1533             fileconf.write ('e %s\n%s\n'%(var,val))
1534         fileconf.write('w\n')
1535         fileconf.write('R\n')
1536         fileconf.write('q\n')
1537         fileconf.close()
1538         utils.system('cat %s'%tmpname)
1539         self.run_in_guest_piped('cat %s'%tmpname,'sfa-config-tty')
1540         return True
1541
1542     def aggregate_xml_line(self):
1543         port=self.plc_spec['sfa']['neighbours-port']
1544         return '<aggregate addr="%s" hrn="%s" port="%r"/>' % \
1545             (self.vserverip,self.plc_spec['sfa']['SFA_REGISTRY_ROOT_AUTH'],port)
1546
1547     def registry_xml_line(self):
1548         return '<registry addr="%s" hrn="%s" port="12345"/>' % \
1549             (self.vserverip,self.plc_spec['sfa']['SFA_REGISTRY_ROOT_AUTH'])
1550
1551
1552     # a cross step that takes all other plcs in argument
1553     def cross_sfa_configure(self, other_plcs):
1554         "writes aggregates.xml and registries.xml that point to all other PLCs in the test"
1555         # of course with a single plc, other_plcs is an empty list
1556         if not other_plcs:
1557             return True
1558         agg_fname=self.conffile("agg.xml")
1559         file(agg_fname,"w").write("<aggregates>%s</aggregates>\n" % \
1560                                      " ".join([ plc.aggregate_xml_line() for plc in other_plcs ]))
1561         utils.header ("(Over)wrote %s"%agg_fname)
1562         reg_fname=self.conffile("reg.xml")
1563         file(reg_fname,"w").write("<registries>%s</registries>\n" % \
1564                                      " ".join([ plc.registry_xml_line() for plc in other_plcs ]))
1565         utils.header ("(Over)wrote %s"%reg_fname)
1566         return self.test_ssh.copy_abs(agg_fname,'/%s/etc/sfa/aggregates.xml'%self.vm_root_in_host())==0 \
1567             and  self.test_ssh.copy_abs(reg_fname,'/%s/etc/sfa/registries.xml'%self.vm_root_in_host())==0
1568
1569     def sfa_import(self):
1570         "use sfaadmin to import from plc"
1571         auth=self.plc_spec['sfa']['SFA_REGISTRY_ROOT_AUTH']
1572         return self.run_in_guest('sfaadmin reg import_registry')==0
1573
1574     def sfa_start(self):
1575         "service sfa start"
1576         return self.start_service('sfa')
1577
1578
1579     def sfi_configure(self):
1580         "Create /root/sfi on the plc side for sfi client configuration"
1581         if self.options.dry_run:
1582             utils.header("DRY RUN - skipping step")
1583             return True
1584         sfa_spec=self.plc_spec['sfa']
1585         # cannot use auth_sfa_mapper to pass dir_name
1586         for slice_spec in self.plc_spec['sfa']['auth_sfa_specs']:
1587             test_slice=TestAuthSfa(self,slice_spec)
1588             dir_basename=os.path.basename(test_slice.sfi_path())
1589             dir_name=self.confsubdir("dot-sfi/%s"%dir_basename,clean=True,dry_run=self.options.dry_run)
1590             test_slice.sfi_configure(dir_name)
1591             # push into the remote /root/sfi area
1592             location = test_slice.sfi_path()
1593             remote="%s/%s"%(self.vm_root_in_host(),location)
1594             self.test_ssh.mkdir(remote,abs=True)
1595             # need to strip last level or remote otherwise we get an extra dir level
1596             self.test_ssh.copy_abs(dir_name, os.path.dirname(remote), recursive=True)
1597
1598         return True
1599
1600     def sfi_clean (self):
1601         "clean up /root/sfi on the plc side"
1602         self.run_in_guest("rm -rf /root/sfi")
1603         return True
1604
1605     @auth_sfa_mapper
1606     def sfa_register_site (self): pass
1607     @auth_sfa_mapper
1608     def sfa_register_pi (self): pass
1609     @auth_sfa_mapper
1610     def sfa_register_user(self): pass
1611     @auth_sfa_mapper
1612     def sfa_update_user(self): pass
1613     @auth_sfa_mapper
1614     def sfa_register_slice(self): pass
1615     @auth_sfa_mapper
1616     def sfa_renew_slice(self): pass
1617     @auth_sfa_mapper
1618     def sfa_discover(self): pass
1619     @auth_sfa_mapper
1620     def sfa_create_slice(self): pass
1621     @auth_sfa_mapper
1622     def sfa_check_slice_plc(self): pass
1623     @auth_sfa_mapper
1624     def sfa_update_slice(self): pass
1625     @auth_sfa_mapper
1626     def sfa_remove_user_from_slice(self): pass
1627     @auth_sfa_mapper
1628     def sfa_insert_user_in_slice(self): pass
1629     @auth_sfa_mapper
1630     def sfi_list(self): pass
1631     @auth_sfa_mapper
1632     def sfi_show_site(self): pass
1633     @auth_sfa_mapper
1634     def sfi_show_slice(self): pass
1635     @auth_sfa_mapper
1636     def sfi_show_slice_researchers(self): pass
1637     @auth_sfa_mapper
1638     def ssh_slice_sfa(self): pass
1639     @auth_sfa_mapper
1640     def sfa_delete_user(self): pass
1641     @auth_sfa_mapper
1642     def sfa_delete_slice(self): pass
1643
1644     def sfa_stop(self):
1645         "service sfa stop"
1646         return self.stop_service ('sfa')
1647
1648     def populate (self):
1649         "creates random entries in the PLCAPI"
1650         # install the stress-test in the plc image
1651         location = "/usr/share/plc_api/plcsh_stress_test.py"
1652         remote="%s/%s"%(self.vm_root_in_host(),location)
1653         self.test_ssh.copy_abs("plcsh_stress_test.py",remote)
1654         command = location
1655         command += " -- --preserve --short-names"
1656         local = (self.run_in_guest(command) == 0);
1657         # second run with --foreign
1658         command += ' --foreign'
1659         remote = (self.run_in_guest(command) == 0);
1660         return ( local and remote)
1661
1662     def gather_logs (self):
1663         "gets all possible logs from plc's/qemu node's/slice's for future reference"
1664         # (1.a) get the plc's /var/log/ and store it locally in logs/myplc.var-log.<plcname>/*
1665         # (1.b) get the plc's  /var/lib/pgsql/data/pg_log/ -> logs/myplc.pgsql-log.<plcname>/*
1666         # (1.c) get the plc's /root/sfi -> logs/sfi.<plcname>/
1667         # (2) get all the nodes qemu log and store it as logs/node.qemu.<node>.log
1668         # (3) get the nodes /var/log and store is as logs/node.var-log.<node>/*
1669         # (4) as far as possible get the slice's /var/log as logs/sliver.var-log.<sliver>/*
1670         # (1.a)
1671         print "-------------------- TestPlc.gather_logs : PLC's /var/log"
1672         self.gather_var_logs ()
1673         # (1.b)
1674         print "-------------------- TestPlc.gather_logs : PLC's /var/lib/psql/data/pg_log/"
1675         self.gather_pgsql_logs ()
1676         # (1.c)
1677         print "-------------------- TestPlc.gather_logs : PLC's /root/sfi/"
1678         self.gather_root_sfi ()
1679         # (2)
1680         print "-------------------- TestPlc.gather_logs : nodes's QEMU logs"
1681         for site_spec in self.plc_spec['sites']:
1682             test_site = TestSite (self,site_spec)
1683             for node_spec in site_spec['nodes']:
1684                 test_node=TestNode(self,test_site,node_spec)
1685                 test_node.gather_qemu_logs()
1686         # (3)
1687         print "-------------------- TestPlc.gather_logs : nodes's /var/log"
1688         self.gather_nodes_var_logs()
1689         # (4)
1690         print "-------------------- TestPlc.gather_logs : sample sliver's /var/log"
1691         self.gather_slivers_var_logs()
1692         return True
1693
1694     def gather_slivers_var_logs(self):
1695         for test_sliver in self.all_sliver_objs():
1696             remote = test_sliver.tar_var_logs()
1697             utils.system("mkdir -p logs/sliver.var-log.%s"%test_sliver.name())
1698             command = remote + " | tar -C logs/sliver.var-log.%s -xf -"%test_sliver.name()
1699             utils.system(command)
1700         return True
1701
1702     def gather_var_logs (self):
1703         utils.system("mkdir -p logs/myplc.var-log.%s"%self.name())
1704         to_plc = self.actual_command_in_guest("tar -C /var/log/ -cf - .")
1705         command = to_plc + "| tar -C logs/myplc.var-log.%s -xf -"%self.name()
1706         utils.system(command)
1707         command = "chmod a+r,a+x logs/myplc.var-log.%s/httpd"%self.name()
1708         utils.system(command)
1709
1710     def gather_pgsql_logs (self):
1711         utils.system("mkdir -p logs/myplc.pgsql-log.%s"%self.name())
1712         to_plc = self.actual_command_in_guest("tar -C /var/lib/pgsql/data/pg_log/ -cf - .")
1713         command = to_plc + "| tar -C logs/myplc.pgsql-log.%s -xf -"%self.name()
1714         utils.system(command)
1715
1716     def gather_root_sfi (self):
1717         utils.system("mkdir -p logs/sfi.%s"%self.name())
1718         to_plc = self.actual_command_in_guest("tar -C /root/sfi/ -cf - .")
1719         command = to_plc + "| tar -C logs/sfi.%s -xf -"%self.name()
1720         utils.system(command)
1721
1722     def gather_nodes_var_logs (self):
1723         for site_spec in self.plc_spec['sites']:
1724             test_site = TestSite (self,site_spec)
1725             for node_spec in site_spec['nodes']:
1726                 test_node=TestNode(self,test_site,node_spec)
1727                 test_ssh = TestSsh (test_node.name(),key="keys/key_admin.rsa")
1728                 command = test_ssh.actual_command("tar -C /var/log -cf - .")
1729                 command = command + "| tar -C logs/node.var-log.%s -xf -"%test_node.name()
1730                 utils.system("mkdir -p logs/node.var-log.%s"%test_node.name())
1731                 utils.system(command)
1732
1733
1734     # returns the filename to use for sql dump/restore, using options.dbname if set
1735     def dbfile (self, database):
1736         # uses options.dbname if it is found
1737         try:
1738             name=self.options.dbname
1739             if not isinstance(name,StringTypes):
1740                 raise Exception
1741         except:
1742             t=datetime.now()
1743             d=t.date()
1744             name=str(d)
1745         return "/root/%s-%s.sql"%(database,name)
1746
1747     def plc_db_dump(self):
1748         'dump the planetlab5 DB in /root in the PLC - filename has time'
1749         dump=self.dbfile("planetab5")
1750         self.run_in_guest('pg_dump -U pgsqluser planetlab5 -f '+ dump)
1751         utils.header('Dumped planetlab5 database in %s'%dump)
1752         return True
1753
1754     def plc_db_restore(self):
1755         'restore the planetlab5 DB - looks broken, but run -n might help'
1756         dump=self.dbfile("planetab5")
1757         ##stop httpd service
1758         self.run_in_guest('service httpd stop')
1759         # xxx - need another wrapper
1760         self.run_in_guest_piped('echo drop database planetlab5','psql --user=pgsqluser template1')
1761         self.run_in_guest('createdb -U postgres --encoding=UNICODE --owner=pgsqluser planetlab5')
1762         self.run_in_guest('psql -U pgsqluser planetlab5 -f '+dump)
1763         ##starting httpd service
1764         self.run_in_guest('service httpd start')
1765
1766         utils.header('Database restored from ' + dump)
1767
1768     @staticmethod
1769     def create_ignore_steps ():
1770         for step in TestPlc.default_steps + TestPlc.other_steps:
1771             # default step can have a plc qualifier
1772             if '@' in step: (step,qualifier)=step.split('@')
1773             # or be defined as forced or ignored by default
1774             for keyword in ['_ignore','_force']:
1775                 if step.endswith (keyword): step=step.replace(keyword,'')
1776             if step == SEP or step == SEPSFA : continue
1777             method=getattr(TestPlc,step)
1778             name=step+'_ignore'
1779             wrapped=ignore_result(method)
1780 #            wrapped.__doc__ = method.__doc__ + " (run in ignore-result mode)"
1781             setattr(TestPlc, name, wrapped)
1782
1783 #    @ignore_result
1784 #    def ssh_slice_again_ignore (self): pass
1785 #    @ignore_result
1786 #    def check_initscripts_ignore (self): pass
1787
1788     def standby_1_through_20(self):
1789         """convenience function to wait for a specified number of minutes"""
1790         pass
1791     @standby_generic
1792     def standby_1(): pass
1793     @standby_generic
1794     def standby_2(): pass
1795     @standby_generic
1796     def standby_3(): pass
1797     @standby_generic
1798     def standby_4(): pass
1799     @standby_generic
1800     def standby_5(): pass
1801     @standby_generic
1802     def standby_6(): pass
1803     @standby_generic
1804     def standby_7(): pass
1805     @standby_generic
1806     def standby_8(): pass
1807     @standby_generic
1808     def standby_9(): pass
1809     @standby_generic
1810     def standby_10(): pass
1811     @standby_generic
1812     def standby_11(): pass
1813     @standby_generic
1814     def standby_12(): pass
1815     @standby_generic
1816     def standby_13(): pass
1817     @standby_generic
1818     def standby_14(): pass
1819     @standby_generic
1820     def standby_15(): pass
1821     @standby_generic
1822     def standby_16(): pass
1823     @standby_generic
1824     def standby_17(): pass
1825     @standby_generic
1826     def standby_18(): pass
1827     @standby_generic
1828     def standby_19(): pass
1829     @standby_generic
1830     def standby_20(): pass
1831
1832     # convenience for debugging the test logic
1833     def yes (self): return True
1834     def no (self): return False