system/TestPlc.py

   1 # Thierry Parmentelat <thierry.parmentelat@inria.fr>
   2 # Copyright (C) 2010 INRIA
   3 #
   4 import os, os.path
   5 import datetime
   6 import time
   7 import sys
   8 import traceback
   9 from types import StringTypes
  10 import socket
  11
  12 import utils
  13 from TestSite import TestSite
  14 from TestNode import TestNode
  15 from TestUser import TestUser
  16 from TestKey import TestKey
  17 from TestSlice import TestSlice
  18 from TestSliver import TestSliver
  19 from TestBox import TestBox
  20 from TestSsh import TestSsh
  21 from TestApiserver import TestApiserver
  22 from TestSliceSfa import TestSliceSfa
  23 from TestUserSfa import TestUserSfa
  24
  25 # step methods must take (self) and return a boolean (options is a member of the class)
  26
  27 def standby(minutes,dry_run):
  28     utils.header('Entering StandBy for %d mn'%minutes)
  29     if dry_run:
  30         print 'dry_run'
  31     else:
  32         time.sleep(60*minutes)
  33     return True
  34
  35 def standby_generic (func):
  36     def actual(self):
  37         minutes=int(func.__name__.split("_")[1])
  38         return standby(minutes,self.options.dry_run)
  39     return actual
  40
  41 def node_mapper (method):
  42     def actual(self):
  43         overall=True
  44         node_method = TestNode.__dict__[method.__name__]
  45         for site_spec in self.plc_spec['sites']:
  46             test_site = TestSite (self,site_spec)
  47             for node_spec in site_spec['nodes']:
  48                 test_node = TestNode (self,test_site,node_spec)
  49                 if not node_method(test_node): overall=False
  50         return overall
  51     # restore the doc text
  52     actual.__doc__=method.__doc__
  53     return actual
  54
  55 def slice_mapper_options (method):
  56     def actual(self):
  57         overall=True
  58         slice_method = TestSlice.__dict__[method.__name__]
  59         for slice_spec in self.plc_spec['slices']:
  60             site_spec = self.locate_site (slice_spec['sitename'])
  61             test_site = TestSite(self,site_spec)
  62             test_slice=TestSlice(self,test_site,slice_spec)
  63             if not slice_method(test_slice,self.options): overall=False
  64         return overall
  65     # restore the doc text
  66     actual.__doc__=method.__doc__
  67     return actual
  68
  69 def slice_mapper_options_sfa (method):
  70     def actual(self):
  71         test_plc=self
  72         overall=True
  73         slice_method = TestSliceSfa.__dict__[method.__name__]
  74         for slice_spec in self.plc_spec['sfa']['slices_sfa']:
  75             site_spec = self.locate_site (slice_spec['sitename'])
  76             test_site = TestSite(self,site_spec)
  77             test_slice=TestSliceSfa(test_plc,test_site,slice_spec)
  78             if not slice_method(test_slice,self.options): overall=False
  79         return overall
  80     # restore the doc text
  81     actual.__doc__=method.__doc__
  82     return actual
  83
  84 SEP='<sep>'
  85 SEPSFA='<sep_sfa>'
  86
  87 class TestPlc:
  88
  89     default_steps = [
  90         'display', 'resources_pre', SEP,
  91         'delete_vs','create_vs','install', 'configure', 'start', SEP,
  92         'fetch_keys', 'store_keys', 'clear_known_hosts', SEP,
  93         'initscripts', 'sites', 'nodes', 'slices', 'nodegroups', 'leases', SEP,
  94         'reinstall_node', 'init_node','bootcd', 'configure_qemu', 'export_qemu',
  95         'kill_all_qemus', 'start_node', SEP,
  96         # better use of time: do this now that the nodes are taking off
  97         'plcsh_stress_test', SEP,
  98         'install_sfa', 'configure_sfa', 'import_sfa', 'start_sfa', SEPSFA,
  99         'setup_sfa', 'add_sfa', 'update_sfa', 'view_sfa', SEPSFA,
 100         'nodes_ssh_debug', 'nodes_ssh_boot', 'check_slice', 'check_initscripts', SEPSFA,
 101         'check_slice_sfa', 'delete_sfa', 'stop_sfa', SEPSFA,
 102         'check_tcp',  'check_hooks',  SEP,
 103         'force_gather_logs', 'force_resources_post', SEP,
 104         ]
 105     other_steps = [
 106         'show_boxes', 'resources_list','resources_release','resources_release_plc','resources_release_qemu',SEP,
 107         'stop', 'vs_start', SEP,
 108         'clean_initscripts', 'clean_nodegroups','clean_all_sites', SEP,
 109         'clean_sites', 'clean_nodes', 'clean_slices', 'clean_keys', SEP,
 110         'clean_leases', 'list_leases', SEP,
 111         'populate' , SEP,
 112         'list_all_qemus', 'list_qemus', 'kill_qemus', SEP,
 113         'db_dump' , 'db_restore', SEP,
 114         'standby_1 through 20',SEP,
 115         ]
 116
 117     @staticmethod
 118     def printable_steps (list):
 119         single_line=" ".join(list)+" "
 120         return single_line.replace(" "+SEP+" "," \\\n").replace(" "+SEPSFA+" "," \\\n")
 121     @staticmethod
 122     def valid_step (step):
 123         return step != SEP and step != SEPSFA
 124
 125     # turn off the sfa-related steps when build has skipped SFA
 126     # this is originally for centos5 as recent SFAs won't build on this platformb
 127     @staticmethod
 128     def check_whether_build_has_sfa (rpms_url):
 129         retcod=os.system ("curl --silent %s/ | grep -q sfa"%rpms_url)
 130         # full builds are expected to return with 0 here
 131         if retcod!=0:
 132             # move all steps containing 'sfa' from default_steps to other_steps
 133             sfa_steps= [ step for step in TestPlc.default_steps if step.find('sfa')>=0 ]
 134             TestPlc.other_steps += sfa_steps
 135             for step in sfa_steps: TestPlc.default_steps.remove(step)
 136
 137     def __init__ (self,plc_spec,options):
 138         self.plc_spec=plc_spec
 139         self.options=options
 140         self.test_ssh=TestSsh(self.plc_spec['hostname'],self.options.buildname)
 141         try:
 142             self.vserverip=plc_spec['vserverip']
 143             self.vservername=plc_spec['vservername']
 144             self.url="https://%s:443/PLCAPI/"%plc_spec['vserverip']
 145             self.vserver=True
 146         except:
 147             raise Exception,'chroot-based myplc testing is deprecated'
 148         self.apiserver=TestApiserver(self.url,options.dry_run)
 149
 150     def name(self):
 151         name=self.plc_spec['name']
 152         return "%s.%s"%(name,self.vservername)
 153
 154     def hostname(self):
 155         return self.plc_spec['hostname']
 156
 157     def is_local (self):
 158         return self.test_ssh.is_local()
 159
 160     # define the API methods on this object through xmlrpc
 161     # would help, but not strictly necessary
 162     def connect (self):
 163         pass
 164
 165     def actual_command_in_guest (self,command):
 166         return self.test_ssh.actual_command(self.host_to_guest(command))
 167
 168     def start_guest (self):
 169       return utils.system(self.test_ssh.actual_command(self.start_guest_in_host()))
 170
 171     def run_in_guest (self,command):
 172         return utils.system(self.actual_command_in_guest(command))
 173
 174     def run_in_host (self,command):
 175         return self.test_ssh.run_in_buildname(command)
 176
 177     #command gets run in the vserver
 178     def host_to_guest(self,command):
 179         return "vserver %s exec %s"%(self.vservername,command)
 180
 181     #command gets run in the vserver
 182     def start_guest_in_host(self):
 183         return "vserver %s start"%(self.vservername)
 184
 185     # xxx quick n dirty
 186     def run_in_guest_piped (self,local,remote):
 187         return utils.system(local+" | "+self.test_ssh.actual_command(self.host_to_guest(remote),keep_stdin=True))
 188
 189     def auth_root (self):
 190         return {'Username':self.plc_spec['PLC_ROOT_USER'],
 191                 'AuthMethod':'password',
 192                 'AuthString':self.plc_spec['PLC_ROOT_PASSWORD'],
 193                 'Role' : self.plc_spec['role']
 194                 }
 195     def locate_site (self,sitename):
 196         for site in self.plc_spec['sites']:
 197             if site['site_fields']['name'] == sitename:
 198                 return site
 199             if site['site_fields']['login_base'] == sitename:
 200                 return site
 201         raise Exception,"Cannot locate site %s"%sitename
 202
 203     def locate_node (self,nodename):
 204         for site in self.plc_spec['sites']:
 205             for node in site['nodes']:
 206                 if node['name'] == nodename:
 207                     return (site,node)
 208         raise Exception,"Cannot locate node %s"%nodename
 209
 210     def locate_hostname (self,hostname):
 211         for site in self.plc_spec['sites']:
 212             for node in site['nodes']:
 213                 if node['node_fields']['hostname'] == hostname:
 214                     return (site,node)
 215         raise Exception,"Cannot locate hostname %s"%hostname
 216
 217     def locate_key (self,keyname):
 218         for key in self.plc_spec['keys']:
 219             if key['name'] == keyname:
 220                 return key
 221         raise Exception,"Cannot locate key %s"%keyname
 222
 223     def locate_slice (self, slicename):
 224         for slice in self.plc_spec['slices']:
 225             if slice['slice_fields']['name'] == slicename:
 226                 return slice
 227         raise Exception,"Cannot locate slice %s"%slicename
 228
 229     def all_sliver_objs (self):
 230         result=[]
 231         for slice_spec in self.plc_spec['slices']:
 232             slicename = slice_spec['slice_fields']['name']
 233             for nodename in slice_spec['nodenames']:
 234                 result.append(self.locate_sliver_obj (nodename,slicename))
 235         return result
 236
 237     def locate_sliver_obj (self,nodename,slicename):
 238         (site,node) = self.locate_node(nodename)
 239         slice = self.locate_slice (slicename)
 240         # build objects
 241         test_site = TestSite (self, site)
 242         test_node = TestNode (self, test_site,node)
 243         # xxx the slice site is assumed to be the node site - mhh - probably harmless
 244         test_slice = TestSlice (self, test_site, slice)
 245         return TestSliver (self, test_node, test_slice)
 246
 247     def locate_first_node(self):
 248         nodename=self.plc_spec['slices'][0]['nodenames'][0]
 249         (site,node) = self.locate_node(nodename)
 250         test_site = TestSite (self, site)
 251         test_node = TestNode (self, test_site,node)
 252         return test_node
 253
 254     def locate_first_sliver (self):
 255         slice_spec=self.plc_spec['slices'][0]
 256         slicename=slice_spec['slice_fields']['name']
 257         nodename=slice_spec['nodenames'][0]
 258         return self.locate_sliver_obj(nodename,slicename)
 259
 260     # all different hostboxes used in this plc
 261     def gather_hostBoxes(self):
 262         # maps on sites and nodes, return [ (host_box,test_node) ]
 263         tuples=[]
 264         for site_spec in self.plc_spec['sites']:
 265             test_site = TestSite (self,site_spec)
 266             for node_spec in site_spec['nodes']:
 267                 test_node = TestNode (self, test_site, node_spec)
 268                 if not test_node.is_real():
 269                     tuples.append( (test_node.host_box(),test_node) )
 270         # transform into a dict { 'host_box' -> [ test_node .. ] }
 271         result = {}
 272         for (box,node) in tuples:
 273             if not result.has_key(box):
 274                 result[box]=[node]
 275             else:
 276                 result[box].append(node)
 277         return result
 278
 279     # a step for checking this stuff
 280     def show_boxes (self):
 281         'print summary of nodes location'
 282         for (box,nodes) in self.gather_hostBoxes().iteritems():
 283             print box,":"," + ".join( [ node.name() for node in nodes ] )
 284         return True
 285
 286     # make this a valid step
 287     def kill_all_qemus(self):
 288         'kill all qemu instances on the qemu boxes involved by this setup'
 289         # this is the brute force version, kill all qemus on that host box
 290         for (box,nodes) in self.gather_hostBoxes().iteritems():
 291             # pass the first nodename, as we don't push template-qemu on testboxes
 292             nodedir=nodes[0].nodedir()
 293             TestBox(box,self.options.buildname).kill_all_qemus(nodedir)
 294         return True
 295
 296     # make this a valid step
 297     def list_all_qemus(self):
 298         'list all qemu instances on the qemu boxes involved by this setup'
 299         for (box,nodes) in self.gather_hostBoxes().iteritems():
 300             # this is the brute force version, kill all qemus on that host box
 301             TestBox(box,self.options.buildname).list_all_qemus()
 302         return True
 303
 304     # kill only the right qemus
 305     def list_qemus(self):
 306         'list qemu instances for our nodes'
 307         for (box,nodes) in self.gather_hostBoxes().iteritems():
 308             # the fine-grain version
 309             for node in nodes:
 310                 node.list_qemu()
 311         return True
 312
 313     # kill only the right qemus
 314     def kill_qemus(self):
 315         'kill the qemu instances for our nodes'
 316         for (box,nodes) in self.gather_hostBoxes().iteritems():
 317             # the fine-grain version
 318             for node in nodes:
 319                 node.kill_qemu()
 320         return True
 321
 322     #################### display config
 323     def display (self):
 324         "show test configuration after localization"
 325         self.display_pass (1)
 326         self.display_pass (2)
 327         return True
 328
 329     # entry point
 330     always_display_keys=['PLC_WWW_HOST','nodes','sites',]
 331     def display_pass (self,passno):
 332         for (key,val) in self.plc_spec.iteritems():
 333             if not self.options.verbose and key not in TestPlc.always_display_keys: continue
 334             if passno == 2:
 335                 if key == 'sites':
 336                     for site in val:
 337                         self.display_site_spec(site)
 338                         for node in site['nodes']:
 339                             self.display_node_spec(node)
 340                 elif key=='initscripts':
 341                     for initscript in val:
 342                         self.display_initscript_spec (initscript)
 343                 elif key=='slices':
 344                     for slice in val:
 345                         self.display_slice_spec (slice)
 346                 elif key=='keys':
 347                     for key in val:
 348                         self.display_key_spec (key)
 349             elif passno == 1:
 350                 if key not in ['sites','initscripts','slices','keys', 'sfa']:
 351                     print '+   ',key,':',val
 352
 353     def display_site_spec (self,site):
 354         print '+ ======== site',site['site_fields']['name']
 355         for (k,v) in site.iteritems():
 356             if not self.options.verbose and k not in TestPlc.always_display_keys: continue
 357             if k=='nodes':
 358                 if v:
 359                     print '+       ','nodes : ',
 360                     for node in v:
 361                         print node['node_fields']['hostname'],'',
 362                     print ''
 363             elif k=='users':
 364                 if v:
 365                     print '+       users : ',
 366                     for user in v:
 367                         print user['name'],'',
 368                     print ''
 369             elif k == 'site_fields':
 370                 print '+       login_base',':',v['login_base']
 371             elif k == 'address_fields':
 372                 pass
 373             else:
 374                 print '+       ',
 375                 utils.pprint(k,v)
 376
 377     def display_initscript_spec (self,initscript):
 378         print '+ ======== initscript',initscript['initscript_fields']['name']
 379
 380     def display_key_spec (self,key):
 381         print '+ ======== key',key['name']
 382
 383     def display_slice_spec (self,slice):
 384         print '+ ======== slice',slice['slice_fields']['name']
 385         for (k,v) in slice.iteritems():
 386             if k=='nodenames':
 387                 if v:
 388                     print '+       nodes : ',
 389                     for nodename in v:
 390                         print nodename,'',
 391                     print ''
 392             elif k=='usernames':
 393                 if v:
 394                     print '+       users : ',
 395                     for username in v:
 396                         print username,'',
 397                     print ''
 398             elif k=='slice_fields':
 399                 print '+       fields',':',
 400                 print 'max_nodes=',v['max_nodes'],
 401                 print ''
 402             else:
 403                 print '+       ',k,v
 404
 405     def display_node_spec (self,node):
 406         print "+           node=%s host_box=%s"%(node['name'],node['host_box']),
 407         print "hostname=",node['node_fields']['hostname'],
 408         print "ip=",node['interface_fields']['ip']
 409         if self.options.verbose:
 410             utils.pprint("node details",node,depth=3)
 411
 412     # another entry point for just showing the boxes involved
 413     def display_mapping (self):
 414         TestPlc.display_mapping_plc(self.plc_spec)
 415         return True
 416
 417     @staticmethod
 418     def display_mapping_plc (plc_spec):
 419         print '+ MyPLC',plc_spec['name']
 420         print '+\tvserver address = root@%s:/vservers/%s'%(plc_spec['hostname'],plc_spec['vservername'])
 421         print '+\tIP = %s/%s'%(plc_spec['PLC_API_HOST'],plc_spec['vserverip'])
 422         for site_spec in plc_spec['sites']:
 423             for node_spec in site_spec['nodes']:
 424                 TestPlc.display_mapping_node(node_spec)
 425
 426     @staticmethod
 427     def display_mapping_node (node_spec):
 428         print '+   NODE %s'%(node_spec['name'])
 429         print '+\tqemu box %s'%node_spec['host_box']
 430         print '+\thostname=%s'%node_spec['node_fields']['hostname']
 431
 432     def resources_pre (self):
 433         "run site-dependant pre-test script as defined in LocalTestResources"
 434         from LocalTestResources import local_resources
 435         return local_resources.step_pre(self)
 436
 437     def resources_post (self):
 438         "run site-dependant post-test script as defined in LocalTestResources"
 439         from LocalTestResources import local_resources
 440         return local_resources.step_post(self)
 441
 442     def resources_list (self):
 443         "run site-dependant list script as defined in LocalTestResources"
 444         from LocalTestResources import local_resources
 445         return local_resources.step_list(self)
 446
 447     def resources_release (self):
 448         "run site-dependant release script as defined in LocalTestResources"
 449         from LocalTestResources import local_resources
 450         return local_resources.step_release(self)
 451
 452     def resources_release_plc (self):
 453         "run site-dependant release script as defined in LocalTestResources"
 454         from LocalTestResources import local_resources
 455         return local_resources.step_release_plc(self)
 456
 457     def resources_release_qemu (self):
 458         "run site-dependant release script as defined in LocalTestResources"
 459         from LocalTestResources import local_resources
 460         return local_resources.step_release_qemu(self)
 461
 462     def delete_vs(self):
 463         "vserver delete the test myplc"
 464         self.run_in_host("vserver --silent %s delete"%self.vservername)
 465         return True
 466
 467     ### install
 468     # historically the build was being fetched by the tests
 469     # now the build pushes itself as a subdir of the tests workdir
 470     # so that the tests do not have to worry about extracting the build (svn, git, or whatever)
 471     def create_vs (self):
 472         "vserver creation (no install done)"
 473         # push the local build/ dir to the testplc box
 474         if self.is_local():
 475             # a full path for the local calls
 476             build_dir=os.path.dirname(sys.argv[0])
 477             # sometimes this is empty - set to "." in such a case
 478             if not build_dir: build_dir="."
 479             build_dir += "/build"
 480         else:
 481             # use a standard name - will be relative to remote buildname
 482             build_dir="build"
 483             # remove for safety; do *not* mkdir first, otherwise we end up with build/build/
 484             self.test_ssh.rmdir(build_dir)
 485             self.test_ssh.copy(build_dir,recursive=True)
 486         # the repo url is taken from arch-rpms-url
 487         # with the last step (i386) removed
 488         repo_url = self.options.arch_rpms_url
 489         for level in [ 'arch' ]:
 490             repo_url = os.path.dirname(repo_url)
 491         # pass the vbuild-nightly options to vtest-init-vserver
 492         test_env_options=""
 493         test_env_options += " -p %s"%self.options.personality
 494         test_env_options += " -d %s"%self.options.pldistro
 495         test_env_options += " -f %s"%self.options.fcdistro
 496         script="vtest-init-vserver.sh"
 497         vserver_name = self.vservername
 498         vserver_options="--netdev eth0 --interface %s"%self.vserverip
 499         try:
 500             vserver_hostname=socket.gethostbyaddr(self.vserverip)[0]
 501             vserver_options += " --hostname %s"%vserver_hostname
 502         except:
 503             print "Cannot reverse lookup %s"%self.vserverip
 504             print "This is considered fatal, as this might pollute the test results"
 505             return False
 506         create_vserver="%(build_dir)s/%(script)s %(test_env_options)s %(vserver_name)s %(repo_url)s -- %(vserver_options)s"%locals()
 507         return self.run_in_host(create_vserver) == 0
 508
 509     ### install_rpm
 510     def install(self):
 511         "yum install myplc, noderepo, and the plain bootstrapfs"
 512
 513         # workaround for getting pgsql8.2 on centos5
 514         if self.options.fcdistro == "centos5":
 515             self.run_in_guest("rpm -Uvh http://download.fedora.redhat.com/pub/epel/5/i386/epel-release-5-3.noarch.rpm")
 516
 517         if self.options.personality == "linux32":
 518             arch = "i386"
 519         elif self.options.personality == "linux64":
 520             arch = "x86_64"
 521         else:
 522             raise Exception, "Unsupported personality %r"%self.options.personality
 523
 524         nodefamily="%s-%s-%s"%(self.options.pldistro,self.options.fcdistro,arch)
 525
 526         # try to install slicerepo - not fatal yet
 527         self.run_in_guest("yum -y install slicerepo-%s"%nodefamily)
 528
 529         return \
 530             self.run_in_guest("yum -y install myplc")==0 and \
 531             self.run_in_guest("yum -y install noderepo-%s"%nodefamily)==0 and \
 532             self.run_in_guest("yum -y install bootstrapfs-%s-plain"%nodefamily)==0
 533
 534     ###
 535     def configure(self):
 536         "run plc-config-tty"
 537         tmpname='%s.plc-config-tty'%(self.name())
 538         fileconf=open(tmpname,'w')
 539         for var in [ 'PLC_NAME',
 540                      'PLC_ROOT_PASSWORD',
 541                      'PLC_ROOT_USER',
 542                      'PLC_MAIL_ENABLED',
 543                      'PLC_MAIL_SUPPORT_ADDRESS',
 544                      'PLC_DB_HOST',
 545                      'PLC_DB_PASSWORD',
 546                      # Above line was added for integrating SFA Testing
 547                      'PLC_API_HOST',
 548                      'PLC_WWW_HOST',
 549                      'PLC_BOOT_HOST',
 550                      'PLC_NET_DNS1',
 551                      'PLC_NET_DNS2',
 552                      'PLC_RESERVATION_GRANULARITY',
 553                      'PLC_OMF_ENABLED',
 554                      ]:
 555             fileconf.write ('e %s\n%s\n'%(var,self.plc_spec[var]))
 556         fileconf.write('w\n')
 557         fileconf.write('q\n')
 558         fileconf.close()
 559         utils.system('cat %s'%tmpname)
 560         self.run_in_guest_piped('cat %s'%tmpname,'plc-config-tty')
 561         utils.system('rm %s'%tmpname)
 562         return True
 563
 564     def start(self):
 565         "service plc start"
 566         self.run_in_guest('service plc start')
 567         return True
 568
 569     def stop(self):
 570         "service plc stop"
 571         self.run_in_guest('service plc stop')
 572         return True
 573
 574     def vs_start (self):
 575         "start the PLC vserver"
 576         self.start_guest()
 577         return True
 578
 579     # stores the keys from the config for further use
 580     def store_keys(self):
 581         "stores test users ssh keys in keys/"
 582         for key_spec in self.plc_spec['keys']:
 583                 TestKey(self,key_spec).store_key()
 584         return True
 585
 586     def clean_keys(self):
 587         "removes keys cached in keys/"
 588         utils.system("rm -rf %s/keys/"%os.path(sys.argv[0]))
 589
 590     # fetches the ssh keys in the plc's /etc/planetlab and stores them in keys/
 591     # for later direct access to the nodes
 592     def fetch_keys(self):
 593         "gets ssh keys in /etc/planetlab/ and stores them locally in keys/"
 594         dir="./keys"
 595         if not os.path.isdir(dir):
 596             os.mkdir(dir)
 597         vservername=self.vservername
 598         overall=True
 599         prefix = 'debug_ssh_key'
 600         for ext in [ 'pub', 'rsa' ] :
 601             src="/vservers/%(vservername)s/etc/planetlab/%(prefix)s.%(ext)s"%locals()
 602             dst="keys/%(vservername)s-debug.%(ext)s"%locals()
 603             if self.test_ssh.fetch(src,dst) != 0: overall=False
 604         return overall
 605
 606     def sites (self):
 607         "create sites with PLCAPI"
 608         return self.do_sites()
 609
 610     def clean_sites (self):
 611         "delete sites with PLCAPI"
 612         return self.do_sites(action="delete")
 613
 614     def do_sites (self,action="add"):
 615         for site_spec in self.plc_spec['sites']:
 616             test_site = TestSite (self,site_spec)
 617             if (action != "add"):
 618                 utils.header("Deleting site %s in %s"%(test_site.name(),self.name()))
 619                 test_site.delete_site()
 620                 # deleted with the site
 621                 #test_site.delete_users()
 622                 continue
 623             else:
 624                 utils.header("Creating site %s & users in %s"%(test_site.name(),self.name()))
 625                 test_site.create_site()
 626                 test_site.create_users()
 627         return True
 628
 629     def clean_all_sites (self):
 630         "Delete all sites in PLC, and related objects"
 631         print 'auth_root',self.auth_root()
 632         site_ids = [s['site_id'] for s in self.apiserver.GetSites(self.auth_root(), {}, ['site_id'])]
 633         for site_id in site_ids:
 634             print 'Deleting site_id',site_id
 635             self.apiserver.DeleteSite(self.auth_root(),site_id)
 636
 637     def nodes (self):
 638         "create nodes with PLCAPI"
 639         return self.do_nodes()
 640     def clean_nodes (self):
 641         "delete nodes with PLCAPI"
 642         return self.do_nodes(action="delete")
 643
 644     def do_nodes (self,action="add"):
 645         for site_spec in self.plc_spec['sites']:
 646             test_site = TestSite (self,site_spec)
 647             if action != "add":
 648                 utils.header("Deleting nodes in site %s"%test_site.name())
 649                 for node_spec in site_spec['nodes']:
 650                     test_node=TestNode(self,test_site,node_spec)
 651                     utils.header("Deleting %s"%test_node.name())
 652                     test_node.delete_node()
 653             else:
 654                 utils.header("Creating nodes for site %s in %s"%(test_site.name(),self.name()))
 655                 for node_spec in site_spec['nodes']:
 656                     utils.pprint('Creating node %s'%node_spec,node_spec)
 657                     test_node = TestNode (self,test_site,node_spec)
 658                     test_node.create_node ()
 659         return True
 660
 661     def nodegroups (self):
 662         "create nodegroups with PLCAPI"
 663         return self.do_nodegroups("add")
 664     def clean_nodegroups (self):
 665         "delete nodegroups with PLCAPI"
 666         return self.do_nodegroups("delete")
 667
 668     YEAR = 365*24*3600
 669     @staticmethod
 670     def translate_timestamp (start,grain,timestamp):
 671         if timestamp < TestPlc.YEAR:    return start+timestamp*grain
 672         else:                           return timestamp
 673
 674     @staticmethod
 675     def timestamp_printable (timestamp):
 676         return time.strftime('%m-%d %H:%M:%S UTC',time.gmtime(timestamp))
 677
 678     def leases(self):
 679         "create leases (on reservable nodes only, use e.g. run -c default -c resa)"
 680         now=int(time.time())
 681         grain=self.apiserver.GetLeaseGranularity(self.auth_root())
 682         print 'API answered grain=',grain
 683         start=(now/grain)*grain
 684         start += grain
 685         # find out all nodes that are reservable
 686         nodes=self.all_reservable_nodenames()
 687         if not nodes:
 688             utils.header ("No reservable node found - proceeding without leases")
 689             return True
 690         ok=True
 691         # attach them to the leases as specified in plc_specs
 692         # this is where the 'leases' field gets interpreted as relative of absolute
 693         for lease_spec in self.plc_spec['leases']:
 694             # skip the ones that come with a null slice id
 695             if not lease_spec['slice']: continue
 696             lease_spec['t_from']=TestPlc.translate_timestamp(start,grain,lease_spec['t_from'])
 697             lease_spec['t_until']=TestPlc.translate_timestamp(start,grain,lease_spec['t_until'])
 698             lease_addition=self.apiserver.AddLeases(self.auth_root(),nodes,
 699                                                     lease_spec['slice'],lease_spec['t_from'],lease_spec['t_until'])
 700             if lease_addition['errors']:
 701                 utils.header("Cannot create leases, %s"%lease_addition['errors'])
 702                 ok=False
 703             else:
 704                 utils.header('Leases on nodes %r for %s from %d (%s) until %d (%s)'%\
 705                               (nodes,lease_spec['slice'],
 706                                lease_spec['t_from'],TestPlc.timestamp_printable(lease_spec['t_from']),
 707                                lease_spec['t_until'],TestPlc.timestamp_printable(lease_spec['t_until'])))
 708
 709         return ok
 710
 711     def clean_leases (self):
 712         "remove all leases in the myplc side"
 713         lease_ids= [ l['lease_id'] for l in self.apiserver.GetLeases(self.auth_root())]
 714         utils.header("Cleaning leases %r"%lease_ids)
 715         self.apiserver.DeleteLeases(self.auth_root(),lease_ids)
 716         return True
 717
 718     def list_leases (self):
 719         "list all leases known to the myplc"
 720         leases = self.apiserver.GetLeases(self.auth_root())
 721         now=int(time.time())
 722         for l in leases:
 723             current=l['t_until']>=now
 724             if self.options.verbose or current:
 725                 utils.header("%s %s from %s until %s"%(l['hostname'],l['name'],
 726                                                        TestPlc.timestamp_printable(l['t_from']),
 727                                                        TestPlc.timestamp_printable(l['t_until'])))
 728         return True
 729
 730     # create nodegroups if needed, and populate
 731     def do_nodegroups (self, action="add"):
 732         # 1st pass to scan contents
 733         groups_dict = {}
 734         for site_spec in self.plc_spec['sites']:
 735             test_site = TestSite (self,site_spec)
 736             for node_spec in site_spec['nodes']:
 737                 test_node=TestNode (self,test_site,node_spec)
 738                 if node_spec.has_key('nodegroups'):
 739                     nodegroupnames=node_spec['nodegroups']
 740                     if isinstance(nodegroupnames,StringTypes):
 741                         nodegroupnames = [ nodegroupnames ]
 742                     for nodegroupname in nodegroupnames:
 743                         if not groups_dict.has_key(nodegroupname):
 744                             groups_dict[nodegroupname]=[]
 745                         groups_dict[nodegroupname].append(test_node.name())
 746         auth=self.auth_root()
 747         overall = True
 748         for (nodegroupname,group_nodes) in groups_dict.iteritems():
 749             if action == "add":
 750                 print 'nodegroups:','dealing with nodegroup',nodegroupname,'on nodes',group_nodes
 751                 # first, check if the nodetagtype is here
 752                 tag_types = self.apiserver.GetTagTypes(auth,{'tagname':nodegroupname})
 753                 if tag_types:
 754                     tag_type_id = tag_types[0]['tag_type_id']
 755                 else:
 756                     tag_type_id = self.apiserver.AddTagType(auth,
 757                                                             {'tagname':nodegroupname,
 758                                                              'description': 'for nodegroup %s'%nodegroupname,
 759                                                              'category':'test',
 760                                                              'min_role_id':10})
 761                 print 'located tag (type)',nodegroupname,'as',tag_type_id
 762                 # create nodegroup
 763                 nodegroups = self.apiserver.GetNodeGroups (auth, {'groupname':nodegroupname})
 764                 if not nodegroups:
 765                     self.apiserver.AddNodeGroup(auth, nodegroupname, tag_type_id, 'yes')
 766                     print 'created nodegroup',nodegroupname,'from tagname',nodegroupname,'and value','yes'
 767                 # set node tag on all nodes, value='yes'
 768                 for nodename in group_nodes:
 769                     try:
 770                         self.apiserver.AddNodeTag(auth, nodename, nodegroupname, "yes")
 771                     except:
 772                         traceback.print_exc()
 773                         print 'node',nodename,'seems to already have tag',nodegroupname
 774                     # check anyway
 775                     try:
 776                         expect_yes = self.apiserver.GetNodeTags(auth,
 777                                                                 {'hostname':nodename,
 778                                                                  'tagname':nodegroupname},
 779                                                                 ['value'])[0]['value']
 780                         if expect_yes != "yes":
 781                             print 'Mismatch node tag on node',nodename,'got',expect_yes
 782                             overall=False
 783                     except:
 784                         if not self.options.dry_run:
 785                             print 'Cannot find tag',nodegroupname,'on node',nodename
 786                             overall = False
 787             else:
 788                 try:
 789                     print 'cleaning nodegroup',nodegroupname
 790                     self.apiserver.DeleteNodeGroup(auth,nodegroupname)
 791                 except:
 792                     traceback.print_exc()
 793                     overall=False
 794         return overall
 795
 796     # return a list of tuples (nodename,qemuname)
 797     def all_node_infos (self) :
 798         node_infos = []
 799         for site_spec in self.plc_spec['sites']:
 800             node_infos += [ (node_spec['node_fields']['hostname'],node_spec['host_box']) \
 801                                 for node_spec in site_spec['nodes'] ]
 802         return node_infos
 803
 804     def all_nodenames (self): return [ x[0] for x in self.all_node_infos() ]
 805     def all_reservable_nodenames (self):
 806         res=[]
 807         for site_spec in self.plc_spec['sites']:
 808             for node_spec in site_spec['nodes']:
 809                 node_fields=node_spec['node_fields']
 810                 if 'node_type' in node_fields and node_fields['node_type']=='reservable':
 811                     res.append(node_fields['hostname'])
 812         return res
 813
 814     # silent_minutes : during the first <silent_minutes> minutes nothing gets printed
 815     def nodes_check_boot_state (self, target_boot_state, timeout_minutes, silent_minutes,period=15):
 816         if self.options.dry_run:
 817             print 'dry_run'
 818             return True
 819         # compute timeout
 820         timeout = datetime.datetime.now()+datetime.timedelta(minutes=timeout_minutes)
 821         graceout = datetime.datetime.now()+datetime.timedelta(minutes=silent_minutes)
 822         # the nodes that haven't checked yet - start with a full list and shrink over time
 823         tocheck = self.all_hostnames()
 824         utils.header("checking nodes %r"%tocheck)
 825         # create a dict hostname -> status
 826         status = dict ( [ (hostname,'undef') for hostname in tocheck ] )
 827         while tocheck:
 828             # get their status
 829             tocheck_status=self.apiserver.GetNodes(self.auth_root(), tocheck, ['hostname','boot_state' ] )
 830             # update status
 831             for array in tocheck_status:
 832                 hostname=array['hostname']
 833                 boot_state=array['boot_state']
 834                 if boot_state == target_boot_state:
 835                     utils.header ("%s has reached the %s state"%(hostname,target_boot_state))
 836                 else:
 837                     # if it's a real node, never mind
 838                     (site_spec,node_spec)=self.locate_hostname(hostname)
 839                     if TestNode.is_real_model(node_spec['node_fields']['model']):
 840                         utils.header("WARNING - Real node %s in %s - ignored"%(hostname,boot_state))
 841                         # let's cheat
 842                         boot_state = target_boot_state
 843                     elif datetime.datetime.now() > graceout:
 844                         utils.header ("%s still in '%s' state"%(hostname,boot_state))
 845                         graceout=datetime.datetime.now()+datetime.timedelta(1)
 846                 status[hostname] = boot_state
 847             # refresh tocheck
 848             tocheck = [ hostname for (hostname,boot_state) in status.iteritems() if boot_state != target_boot_state ]
 849             if not tocheck:
 850                 return True
 851             if datetime.datetime.now() > timeout:
 852                 for hostname in tocheck:
 853                     utils.header("FAILURE due to %s in '%s' state"%(hostname,status[hostname]))
 854                 return False
 855             # otherwise, sleep for a while
 856             time.sleep(period)
 857         # only useful in empty plcs
 858         return True
 859
 860     def nodes_booted(self):
 861         return self.nodes_check_boot_state('boot',timeout_minutes=30,silent_minutes=20)
 862
 863     def check_nodes_ssh(self,debug,timeout_minutes,silent_minutes,period=15):
 864         # compute timeout
 865         timeout = datetime.datetime.now()+datetime.timedelta(minutes=timeout_minutes)
 866         graceout = datetime.datetime.now()+datetime.timedelta(minutes=silent_minutes)
 867         vservername=self.vservername
 868         if debug:
 869             message="debug"
 870             local_key = "keys/%(vservername)s-debug.rsa"%locals()
 871         else:
 872             message="boot"
 873             local_key = "keys/key1.rsa"
 874         node_infos = self.all_node_infos()
 875         utils.header("checking ssh access (expected in %s mode) to nodes:"%message)
 876         for (nodename,qemuname) in node_infos:
 877             utils.header("hostname=%s -- qemubox=%s"%(nodename,qemuname))
 878         utils.header("max timeout is %d minutes, silent for %d minutes (period is %s)"%\
 879                          (timeout_minutes,silent_minutes,period))
 880         while node_infos:
 881             for node_info in node_infos:
 882                 (hostname,qemuname) = node_info
 883                 # try to run 'hostname' in the node
 884                 command = TestSsh (hostname,key=local_key).actual_command("hostname;uname -a")
 885                 # don't spam logs - show the command only after the grace period
 886                 success = utils.system ( command, silent=datetime.datetime.now() < graceout)
 887                 if success==0:
 888                     utils.header('Successfully entered root@%s (%s)'%(hostname,message))
 889                     # refresh node_infos
 890                     node_infos.remove(node_info)
 891                 else:
 892                     # we will have tried real nodes once, in case they're up - but if not, just skip
 893                     (site_spec,node_spec)=self.locate_hostname(hostname)
 894                     if TestNode.is_real_model(node_spec['node_fields']['model']):
 895                         utils.header ("WARNING : check ssh access into real node %s - skipped"%hostname)
 896                         node_infos.remove(node_info)
 897             if  not node_infos:
 898                 return True
 899             if datetime.datetime.now() > timeout:
 900                 for (hostname,qemuname) in node_infos:
 901                     utils.header("FAILURE to ssh into %s (on %s)"%(hostname,qemuname))
 902                 return False
 903             # otherwise, sleep for a while
 904             time.sleep(period)
 905         # only useful in empty plcs
 906         return True
 907
 908     def nodes_ssh_debug(self):
 909         "Tries to ssh into nodes in debug mode with the debug ssh key"
 910         return self.check_nodes_ssh(debug=True,timeout_minutes=10,silent_minutes=5)
 911
 912     def nodes_ssh_boot(self):
 913         "Tries to ssh into nodes in production mode with the root ssh key"
 914         return self.check_nodes_ssh(debug=False,timeout_minutes=40,silent_minutes=15)
 915
 916     @node_mapper
 917     def init_node (self):
 918         "all nodes : init a clean local directory for holding node-dep stuff like iso image..."
 919         pass
 920     @node_mapper
 921     def bootcd (self):
 922         "all nodes: invoke GetBootMedium and store result locally"
 923         pass
 924     @node_mapper
 925     def configure_qemu (self):
 926         "all nodes: compute qemu config qemu.conf and store it locally"
 927         pass
 928     @node_mapper
 929     def reinstall_node (self):
 930         "all nodes: mark PLCAPI boot_state as reinstall"
 931         pass
 932     @node_mapper
 933     def export_qemu (self):
 934         "all nodes: push local node-dep directory on the qemu box"
 935         pass
 936
 937     ### check hooks : invoke scripts from hooks/{node,slice}
 938     def check_hooks_node (self):
 939         return self.locate_first_node().check_hooks()
 940     def check_hooks_sliver (self) :
 941         return self.locate_first_sliver().check_hooks()
 942
 943     def check_hooks (self):
 944         "runs unit tests in the node and slice contexts - see hooks/{node,slice}"
 945         return self.check_hooks_node() and self.check_hooks_sliver()
 946
 947     ### initscripts
 948     def do_check_initscripts(self):
 949         overall = True
 950         for slice_spec in self.plc_spec['slices']:
 951             if not slice_spec.has_key('initscriptname'):
 952                 continue
 953             initscript=slice_spec['initscriptname']
 954             for nodename in slice_spec['nodenames']:
 955                 (site,node) = self.locate_node (nodename)
 956                 # xxx - passing the wrong site - probably harmless
 957                 test_site = TestSite (self,site)
 958                 test_slice = TestSlice (self,test_site,slice_spec)
 959                 test_node = TestNode (self,test_site,node)
 960                 test_sliver = TestSliver (self, test_node, test_slice)
 961                 if not test_sliver.check_initscript(initscript):
 962                     overall = False
 963         return overall
 964
 965     def check_initscripts(self):
 966         "check that the initscripts have triggered"
 967         return self.do_check_initscripts()
 968
 969     def initscripts (self):
 970         "create initscripts with PLCAPI"
 971         for initscript in self.plc_spec['initscripts']:
 972             utils.pprint('Adding Initscript in plc %s'%self.plc_spec['name'],initscript)
 973             self.apiserver.AddInitScript(self.auth_root(),initscript['initscript_fields'])
 974         return True
 975
 976     def clean_initscripts (self):
 977         "delete initscripts with PLCAPI"
 978         for initscript in self.plc_spec['initscripts']:
 979             initscript_name = initscript['initscript_fields']['name']
 980             print('Attempting to delete %s in plc %s'%(initscript_name,self.plc_spec['name']))
 981             try:
 982                 self.apiserver.DeleteInitScript(self.auth_root(),initscript_name)
 983                 print initscript_name,'deleted'
 984             except:
 985                 print 'deletion went wrong - probably did not exist'
 986         return True
 987
 988     ### manage slices
 989     def slices (self):
 990         "create slices with PLCAPI"
 991         return self.do_slices()
 992
 993     def clean_slices (self):
 994         "delete slices with PLCAPI"
 995         return self.do_slices("delete")
 996
 997     def do_slices (self,  action="add"):
 998         for slice in self.plc_spec['slices']:
 999             site_spec = self.locate_site (slice['sitename'])
1000             test_site = TestSite(self,site_spec)
1001             test_slice=TestSlice(self,test_site,slice)
1002             if action != "add":
1003                 utils.header("Deleting slices in site %s"%test_site.name())
1004                 test_slice.delete_slice()
1005             else:
1006                 utils.pprint("Creating slice",slice)
1007                 test_slice.create_slice()
1008                 utils.header('Created Slice %s'%slice['slice_fields']['name'])
1009         return True
1010
1011     @slice_mapper_options
1012     def check_slice(self):
1013         "tries to ssh-enter the slice with the user key, to ensure slice creation"
1014         pass
1015
1016     @node_mapper
1017     def clear_known_hosts (self):
1018         "remove test nodes entries from the local known_hosts file"
1019         pass
1020
1021     @node_mapper
1022     def start_node (self) :
1023         "all nodes: start the qemu instance (also runs qemu-bridge-init start)"
1024         pass
1025
1026     def check_tcp (self):
1027         "check TCP connectivity between 2 slices (or in loopback if only one is defined)"
1028         specs = self.plc_spec['tcp_test']
1029         overall=True
1030         for spec in specs:
1031             port = spec['port']
1032             # server side
1033             s_test_sliver = self.locate_sliver_obj (spec['server_node'],spec['server_slice'])
1034             if not s_test_sliver.run_tcp_server(port,timeout=10):
1035                 overall=False
1036                 break
1037
1038             # idem for the client side
1039             c_test_sliver = self.locate_sliver_obj(spec['server_node'],spec['server_slice'])
1040             if not c_test_sliver.run_tcp_client(s_test_sliver.test_node.name(),port):
1041                 overall=False
1042         return overall
1043
1044     def plcsh_stress_test (self):
1045         "runs PLCAPI stress test, that checks Add/Update/Delete on all types - preserves contents"
1046         # install the stress-test in the plc image
1047         location = "/usr/share/plc_api/plcsh_stress_test.py"
1048         remote="/vservers/%s/%s"%(self.vservername,location)
1049         self.test_ssh.copy_abs("plcsh_stress_test.py",remote)
1050         command = location
1051         command += " -- --check"
1052         if self.options.size == 1:
1053             command +=  " --tiny"
1054         return ( self.run_in_guest(command) == 0)
1055
1056     # populate runs the same utility without slightly different options
1057     # in particular runs with --preserve (dont cleanup) and without --check
1058     # also it gets run twice, once with the --foreign option for creating fake foreign entries
1059
1060     ### install_sfa_rpm
1061     def install_sfa(self):
1062         "yum install sfa, sfa-plc and sfa-client"
1063         if self.options.personality == "linux32":
1064             arch = "i386"
1065         elif self.options.personality == "linux64":
1066             arch = "x86_64"
1067         else:
1068             raise Exception, "Unsupported personality %r"%self.options.personality
1069         return self.run_in_guest("yum -y install sfa sfa-client sfa-plc sfa-sfatables")==0
1070
1071     ###
1072     def configure_sfa(self):
1073         "run sfa-config-tty"
1074         tmpname='%s.sfa-config-tty'%(self.name())
1075         fileconf=open(tmpname,'w')
1076         for var in [ 'SFA_REGISTRY_ROOT_AUTH',
1077                      'SFA_REGISTRY_LEVEL1_AUTH',
1078                      'SFA_REGISTRY_HOST',
1079                      'SFA_AGGREGATE_HOST',
1080                      'SFA_SM_HOST',
1081                      'SFA_PLC_USER',
1082                      'SFA_PLC_PASSWORD',
1083                      'SFA_PLC_DB_HOST',
1084                      'SFA_PLC_DB_USER',
1085                      'SFA_PLC_DB_PASSWORD',
1086                      'SFA_PLC_URL']:
1087             fileconf.write ('e %s\n%s\n'%(var,self.plc_spec['sfa'][var]))
1088         fileconf.write('w\n')
1089         fileconf.write('R\n')
1090         fileconf.write('q\n')
1091         fileconf.close()
1092         utils.system('cat %s'%tmpname)
1093         self.run_in_guest_piped('cat %s'%tmpname,'sfa-config-tty')
1094         utils.system('rm %s'%tmpname)
1095         return True
1096
1097     def import_sfa(self):
1098         "sfa-import-plc"
1099         auth=self.plc_spec['sfa']['SFA_REGISTRY_ROOT_AUTH']
1100         return self.run_in_guest('sfa-import-plc.py')==0
1101 # not needed anymore
1102 #        self.run_in_guest('cp /etc/sfa/authorities/%s/%s.pkey /etc/sfa/authorities/server.key'%(auth,auth))
1103
1104     def start_sfa(self):
1105         "service sfa start"
1106         return self.run_in_guest('service sfa start')==0
1107
1108     def setup_sfa(self):
1109         "sfi client configuration"
1110         dir_name=".sfi"
1111         if os.path.exists(dir_name):
1112            utils.system('rm -rf %s'%dir_name)
1113         utils.system('mkdir %s'%dir_name)
1114         file_name=dir_name + os.sep + 'fake-pi1.pkey'
1115         fileconf=open(file_name,'w')
1116         fileconf.write (self.plc_spec['keys'][0]['private'])
1117         fileconf.close()
1118
1119         file_name=dir_name + os.sep + 'sfi_config'
1120         fileconf=open(file_name,'w')
1121         SFI_AUTH=self.plc_spec['sfa']['SFA_REGISTRY_ROOT_AUTH']+".main"
1122         fileconf.write ("SFI_AUTH='%s'"%SFI_AUTH)
1123         fileconf.write('\n')
1124         SFI_USER=SFI_AUTH+'.fake-pi1'
1125         fileconf.write ("SFI_USER='%s'"%SFI_USER)
1126         fileconf.write('\n')
1127         SFI_REGISTRY='http://' + self.plc_spec['sfa']['SFA_PLC_DB_HOST'] + ':12345/'
1128         fileconf.write ("SFI_REGISTRY='%s'"%SFI_REGISTRY)
1129         fileconf.write('\n')
1130         SFI_SM='http://' + self.plc_spec['sfa']['SFA_PLC_DB_HOST'] + ':12347/'
1131         fileconf.write ("SFI_SM='%s'"%SFI_SM)
1132         fileconf.write('\n')
1133         fileconf.close()
1134
1135         file_name=dir_name + os.sep + 'person.xml'
1136         fileconf=open(file_name,'w')
1137         for record in self.plc_spec['sfa']['sfa_person_xml']:
1138            person_record=record
1139         fileconf.write(person_record)
1140         fileconf.write('\n')
1141         fileconf.close()
1142
1143         file_name=dir_name + os.sep + 'slice.xml'
1144         fileconf=open(file_name,'w')
1145         for record in self.plc_spec['sfa']['sfa_slice_xml']:
1146             slice_record=record
1147         #slice_record=self.plc_spec['sfa']['sfa_slice_xml']
1148         fileconf.write(slice_record)
1149         fileconf.write('\n')
1150         fileconf.close()
1151
1152         file_name=dir_name + os.sep + 'slice.rspec'
1153         fileconf=open(file_name,'w')
1154         slice_rspec=''
1155         for (key, value) in self.plc_spec['sfa']['sfa_slice_rspec'].items():
1156             slice_rspec +=value
1157         fileconf.write(slice_rspec)
1158         fileconf.write('\n')
1159         fileconf.close()
1160         location = "root/"
1161         remote="/vservers/%s/%s"%(self.vservername,location)
1162         self.test_ssh.copy_abs(dir_name, remote, recursive=True)
1163
1164         #utils.system('cat %s'%tmpname)
1165         utils.system('rm -rf %s'%dir_name)
1166         return True
1167
1168     def add_sfa(self):
1169         "run sfi.py add (on Registry) and sfi.py create (on SM) to form new objects"
1170         test_plc=self
1171         test_user_sfa=TestUserSfa(test_plc,self.plc_spec['sfa'])
1172         success=test_user_sfa.add_user()
1173
1174         for slice_spec in self.plc_spec['sfa']['slices_sfa']:
1175             site_spec = self.locate_site (slice_spec['sitename'])
1176             test_site = TestSite(self,site_spec)
1177             test_slice_sfa=TestSliceSfa(test_plc,test_site,slice_spec)
1178             success1=test_slice_sfa.add_slice()
1179             success2=test_slice_sfa.create_slice()
1180         return success and success1 and success2
1181
1182     def update_sfa(self):
1183         "run sfi.py update (on Registry) and sfi.py create (on SM) on existing objects"
1184         test_plc=self
1185         test_user_sfa=TestUserSfa(test_plc,self.plc_spec['sfa'])
1186         success1=test_user_sfa.update_user()
1187
1188         for slice_spec in self.plc_spec['sfa']['slices_sfa']:
1189             site_spec = self.locate_site (slice_spec['sitename'])
1190             test_site = TestSite(self,site_spec)
1191             test_slice_sfa=TestSliceSfa(test_plc,test_site,slice_spec)
1192             success2=test_slice_sfa.update_slice()
1193         return success1 and success2
1194
1195     def view_sfa(self):
1196         "run sfi.py list and sfi.py show (both on Registry) and sfi.py slices and sfi.py resources (both on SM)"
1197         auth=self.plc_spec['sfa']['SFA_REGISTRY_ROOT_AUTH']
1198         return \
1199         self.run_in_guest("sfi.py -d /root/.sfi/ list %s.main"%auth)==0 and \
1200         self.run_in_guest("sfi.py -d /root/.sfi/ show %s.main"%auth)==0 and \
1201         self.run_in_guest("sfi.py -d /root/.sfi/ slices")==0 and \
1202         self.run_in_guest("sfi.py -d /root/.sfi/ resources -o resources")==0
1203
1204     @slice_mapper_options_sfa
1205     def check_slice_sfa(self):
1206         "tries to ssh-enter the SFA slice"
1207         pass
1208
1209     def delete_sfa(self):
1210         "run sfi.py delete (on SM), sfi.py remove (on Registry)"
1211         test_plc=self
1212         test_user_sfa=TestUserSfa(test_plc,self.plc_spec['sfa'])
1213         success1=test_user_sfa.delete_user()
1214         for slice_spec in self.plc_spec['sfa']['slices_sfa']:
1215             site_spec = self.locate_site (slice_spec['sitename'])
1216             test_site = TestSite(self,site_spec)
1217             test_slice_sfa=TestSliceSfa(test_plc,test_site,slice_spec)
1218             success2=test_slice_sfa.delete_slice()
1219
1220         return success1 and success2
1221
1222     def stop_sfa(self):
1223         "service sfa stop"
1224         return self.run_in_guest('service sfa stop')==0
1225
1226     def populate (self):
1227         "creates random entries in the PLCAPI"
1228         # install the stress-test in the plc image
1229         location = "/usr/share/plc_api/plcsh_stress_test.py"
1230         remote="/vservers/%s/%s"%(self.vservername,location)
1231         self.test_ssh.copy_abs("plcsh_stress_test.py",remote)
1232         command = location
1233         command += " -- --preserve --short-names"
1234         local = (self.run_in_guest(command) == 0);
1235         # second run with --foreign
1236         command += ' --foreign'
1237         remote = (self.run_in_guest(command) == 0);
1238         return ( local and remote)
1239
1240     def gather_logs (self):
1241         "gets all possible logs from plc's/qemu node's/slice's for future reference"
1242         # (1.a) get the plc's /var/log/ and store it locally in logs/myplc.var-log.<plcname>/*
1243         # (1.b) get the plc's  /var/lib/pgsql/data/pg_log/ -> logs/myplc.pgsql-log.<plcname>/*
1244         # (2) get all the nodes qemu log and store it as logs/node.qemu.<node>.log
1245         # (3) get the nodes /var/log and store is as logs/node.var-log.<node>/*
1246         # (4) as far as possible get the slice's /var/log as logs/sliver.var-log.<sliver>/*
1247         # (1.a)
1248         print "-------------------- TestPlc.gather_logs : PLC's /var/log"
1249         self.gather_var_logs ()
1250         # (1.b)
1251         print "-------------------- TestPlc.gather_logs : PLC's /var/lib/psql/data/pg_log/"
1252         self.gather_pgsql_logs ()
1253         # (2)
1254         print "-------------------- TestPlc.gather_logs : nodes's QEMU logs"
1255         for site_spec in self.plc_spec['sites']:
1256             test_site = TestSite (self,site_spec)
1257             for node_spec in site_spec['nodes']:
1258                 test_node=TestNode(self,test_site,node_spec)
1259                 test_node.gather_qemu_logs()
1260         # (3)
1261         print "-------------------- TestPlc.gather_logs : nodes's /var/log"
1262         self.gather_nodes_var_logs()
1263         # (4)
1264         print "-------------------- TestPlc.gather_logs : sample sliver's /var/log"
1265         self.gather_slivers_var_logs()
1266         return True
1267
1268     def gather_slivers_var_logs(self):
1269         for test_sliver in self.all_sliver_objs():
1270             remote = test_sliver.tar_var_logs()
1271             utils.system("mkdir -p logs/sliver.var-log.%s"%test_sliver.name())
1272             command = remote + " | tar -C logs/sliver.var-log.%s -xf -"%test_sliver.name()
1273             utils.system(command)
1274         return True
1275
1276     def gather_var_logs (self):
1277         utils.system("mkdir -p logs/myplc.var-log.%s"%self.name())
1278         to_plc = self.actual_command_in_guest("tar -C /var/log/ -cf - .")
1279         command = to_plc + "| tar -C logs/myplc.var-log.%s -xf -"%self.name()
1280         utils.system(command)
1281         command = "chmod a+r,a+x logs/myplc.var-log.%s/httpd"%self.name()
1282         utils.system(command)
1283
1284     def gather_pgsql_logs (self):
1285         utils.system("mkdir -p logs/myplc.pgsql-log.%s"%self.name())
1286         to_plc = self.actual_command_in_guest("tar -C /var/lib/pgsql/data/pg_log/ -cf - .")
1287         command = to_plc + "| tar -C logs/myplc.pgsql-log.%s -xf -"%self.name()
1288         utils.system(command)
1289
1290     def gather_nodes_var_logs (self):
1291         for site_spec in self.plc_spec['sites']:
1292             test_site = TestSite (self,site_spec)
1293             for node_spec in site_spec['nodes']:
1294                 test_node=TestNode(self,test_site,node_spec)
1295                 test_ssh = TestSsh (test_node.name(),key="keys/key1.rsa")
1296                 command = test_ssh.actual_command("tar -C /var/log -cf - .")
1297                 command = command + "| tar -C logs/node.var-log.%s -xf -"%test_node.name()
1298                 utils.system("mkdir -p logs/node.var-log.%s"%test_node.name())
1299                 utils.system(command)
1300
1301
1302     # returns the filename to use for sql dump/restore, using options.dbname if set
1303     def dbfile (self, database):
1304         # uses options.dbname if it is found
1305         try:
1306             name=self.options.dbname
1307             if not isinstance(name,StringTypes):
1308                 raise Exception
1309         except:
1310             t=datetime.datetime.now()
1311             d=t.date()
1312             name=str(d)
1313         return "/root/%s-%s.sql"%(database,name)
1314
1315     def db_dump(self):
1316         'dump the planetlab5 DB in /root in the PLC - filename has time'
1317         dump=self.dbfile("planetab5")
1318         self.run_in_guest('pg_dump -U pgsqluser planetlab5 -f '+ dump)
1319         utils.header('Dumped planetlab5 database in %s'%dump)
1320         return True
1321
1322     def db_restore(self):
1323         'restore the planetlab5 DB - looks broken, but run -n might help'
1324         dump=self.dbfile("planetab5")
1325         ##stop httpd service
1326         self.run_in_guest('service httpd stop')
1327         # xxx - need another wrapper
1328         self.run_in_guest_piped('echo drop database planetlab5','psql --user=pgsqluser template1')
1329         self.run_in_guest('createdb -U postgres --encoding=UNICODE --owner=pgsqluser planetlab5')
1330         self.run_in_guest('psql -U pgsqluser planetlab5 -f '+dump)
1331         ##starting httpd service
1332         self.run_in_guest('service httpd start')
1333
1334         utils.header('Database restored from ' + dump)
1335
1336     @standby_generic
1337     def standby_1(): pass
1338     @standby_generic
1339     def standby_2(): pass
1340     @standby_generic
1341     def standby_3(): pass
1342     @standby_generic
1343     def standby_4(): pass
1344     @standby_generic
1345     def standby_5(): pass
1346     @standby_generic
1347     def standby_6(): pass
1348     @standby_generic
1349     def standby_7(): pass
1350     @standby_generic
1351     def standby_8(): pass
1352     @standby_generic
1353     def standby_9(): pass
1354     @standby_generic
1355     def standby_10(): pass
1356     @standby_generic
1357     def standby_11(): pass
1358     @standby_generic
1359     def standby_12(): pass
1360     @standby_generic
1361     def standby_13(): pass
1362     @standby_generic
1363     def standby_14(): pass
1364     @standby_generic
1365     def standby_15(): pass
1366     @standby_generic
1367     def standby_16(): pass
1368     @standby_generic
1369     def standby_17(): pass
1370     @standby_generic
1371     def standby_18(): pass
1372     @standby_generic
1373     def standby_19(): pass
1374     @standby_generic
1375     def standby_20(): pass