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