system/TestPlc.py

   1 # $Id$
   2 import os, os.path
   3 import datetime
   4 import time
   5 import sys
   6 import traceback
   7 from types import StringTypes
   8 import socket
   9
  10 import utils
  11 from TestSite import TestSite
  12 from TestNode import TestNode
  13 from TestUser import TestUser
  14 from TestKey import TestKey
  15 from TestSlice import TestSlice
  16 from TestSliver import TestSliver
  17 from TestBox import TestBox
  18 from TestSsh import TestSsh
  19 from TestApiserver import TestApiserver
  20
  21 # step methods must take (self) and return a boolean (options is a member of the class)
  22
  23 def standby(minutes,dry_run):
  24     utils.header('Entering StandBy for %d mn'%minutes)
  25     if dry_run:
  26         print 'dry_run'
  27     else:
  28         time.sleep(60*minutes)
  29     return True
  30
  31 def standby_generic (func):
  32     def actual(self):
  33         minutes=int(func.__name__.split("_")[1])
  34         return standby(minutes,self.options.dry_run)
  35     return actual
  36
  37 def node_mapper (method):
  38     def actual(self):
  39         overall=True
  40         node_method = TestNode.__dict__[method.__name__]
  41         for site_spec in self.plc_spec['sites']:
  42             test_site = TestSite (self,site_spec)
  43             for node_spec in site_spec['nodes']:
  44                 test_node = TestNode (self,test_site,node_spec)
  45                 if not node_method(test_node): overall=False
  46         return overall
  47     return actual
  48
  49 def slice_mapper_options (method):
  50     def actual(self):
  51         overall=True
  52         slice_method = TestSlice.__dict__[method.__name__]
  53         for slice_spec in self.plc_spec['slices']:
  54             site_spec = self.locate_site (slice_spec['sitename'])
  55             test_site = TestSite(self,site_spec)
  56             test_slice=TestSlice(self,test_site,slice_spec)
  57             if not slice_method(test_slice,self.options): overall=False
  58         return overall
  59     return actual
  60
  61 SEP='<sep>'
  62
  63 class TestPlc:
  64
  65     default_steps = ['uninstall','install','install_rpm',
  66                      'configure', 'start', SEP,
  67                      'store_keys', 'clear_known_hosts', 'initscripts', SEP,
  68                      'sites', 'nodes', 'slices', 'nodegroups', SEP,
  69                      'init_node','bootcd', 'configure_qemu', 'export_qemu',
  70                      'kill_all_qemus', 'reinstall_node','start_node', SEP,
  71                      'nodes_booted', 'nodes_ssh', 'check_slice',
  72                      'check_initscripts', 'check_tcp', 'plcsh_stress_test', SEP,
  73                      'force_gather_logs', 'force_kill_qemus', 'force_record_tracker','force_free_tracker' ]
  74     other_steps = [ 'stop_all_vservers','fresh_install', 'cache_rpm', 'stop', 'vs_start', SEP,
  75                     'clean_initscripts', 'clean_all_sites',
  76                     'clean_sites', 'clean_nodes',
  77                     'clean_slices', 'clean_keys', SEP,
  78                     'show_boxes', 'list_all_qemus', 'list_qemus', SEP,
  79                     'db_dump' , 'db_restore', ' cleanup_tracker',
  80                     'standby_1 through 20'
  81                     ]
  82
  83     @staticmethod
  84     def printable_steps (list):
  85         return " ".join(list).replace(" "+SEP+" "," \\\n")
  86     @staticmethod
  87     def valid_step (step):
  88         return step != SEP
  89
  90     def __init__ (self,plc_spec,options):
  91         self.plc_spec=plc_spec
  92         self.options=options
  93         self.test_ssh=TestSsh(self.plc_spec['hostname'],self.options.buildname)
  94         try:
  95             self.vserverip=plc_spec['vserverip']
  96             self.vservername=plc_spec['vservername']
  97             self.url="https://%s:443/PLCAPI/"%plc_spec['vserverip']
  98             self.vserver=True
  99         except:
 100             raise Exception,'chroot-based myplc testing is deprecated'
 101         self.apiserver=TestApiserver(self.url,options.dry_run)
 102
 103     def name(self):
 104         name=self.plc_spec['name']
 105         return "%s.%s"%(name,self.vservername)
 106
 107     def hostname(self):
 108         return self.plc_spec['hostname']
 109
 110     def is_local (self):
 111         return self.test_ssh.is_local()
 112
 113     # define the API methods on this object through xmlrpc
 114     # would help, but not strictly necessary
 115     def connect (self):
 116         pass
 117
 118     def actual_command_in_guest (self,command):
 119         return self.test_ssh.actual_command(self.host_to_guest(command))
 120
 121     def start_guest (self):
 122       return utils.system(self.test_ssh.actual_command(self.start_guest_in_host()))
 123
 124     def run_in_guest (self,command):
 125         return utils.system(self.actual_command_in_guest(command))
 126
 127     def run_in_host (self,command):
 128         return self.test_ssh.run_in_buildname(command)
 129
 130     #command gets run in the vserver
 131     def host_to_guest(self,command):
 132         return "vserver %s exec %s"%(self.vservername,command)
 133
 134     #command gets run in the vserver
 135     def start_guest_in_host(self):
 136         return "vserver %s start"%(self.vservername)
 137
 138     # xxx quick n dirty
 139     def run_in_guest_piped (self,local,remote):
 140         return utils.system(local+" | "+self.test_ssh.actual_command(self.host_to_guest(remote),keep_stdin=True))
 141
 142     def auth_root (self):
 143         return {'Username':self.plc_spec['PLC_ROOT_USER'],
 144                 'AuthMethod':'password',
 145                 'AuthString':self.plc_spec['PLC_ROOT_PASSWORD'],
 146                 'Role' : self.plc_spec['role']
 147                 }
 148     def locate_site (self,sitename):
 149         for site in self.plc_spec['sites']:
 150             if site['site_fields']['name'] == sitename:
 151                 return site
 152             if site['site_fields']['login_base'] == sitename:
 153                 return site
 154         raise Exception,"Cannot locate site %s"%sitename
 155
 156     def locate_node (self,nodename):
 157         for site in self.plc_spec['sites']:
 158             for node in site['nodes']:
 159                 if node['name'] == nodename:
 160                     return (site,node)
 161         raise Exception,"Cannot locate node %s"%nodename
 162
 163     def locate_hostname (self,hostname):
 164         for site in self.plc_spec['sites']:
 165             for node in site['nodes']:
 166                 if node['node_fields']['hostname'] == hostname:
 167                     return (site,node)
 168         raise Exception,"Cannot locate hostname %s"%hostname
 169
 170     def locate_key (self,keyname):
 171         for key in self.plc_spec['keys']:
 172             if key['name'] == keyname:
 173                 return key
 174         raise Exception,"Cannot locate key %s"%keyname
 175
 176     def locate_slice (self, slicename):
 177         for slice in self.plc_spec['slices']:
 178             if slice['slice_fields']['name'] == slicename:
 179                 return slice
 180         raise Exception,"Cannot locate slice %s"%slicename
 181
 182     # all different hostboxes used in this plc
 183     def gather_hostBoxes(self):
 184         # maps on sites and nodes, return [ (host_box,test_node) ]
 185         tuples=[]
 186         for site_spec in self.plc_spec['sites']:
 187             test_site = TestSite (self,site_spec)
 188             for node_spec in site_spec['nodes']:
 189                 test_node = TestNode (self, test_site, node_spec)
 190                 if not test_node.is_real():
 191                     tuples.append( (test_node.host_box(),test_node) )
 192         # transform into a dict { 'host_box' -> [ test_node .. ] }
 193         result = {}
 194         for (box,node) in tuples:
 195             if not result.has_key(box):
 196                 result[box]=[node]
 197             else:
 198                 result[box].append(node)
 199         return result
 200
 201     # a step for checking this stuff
 202     def show_boxes (self):
 203         for (box,nodes) in self.gather_hostBoxes().iteritems():
 204             print box,":"," + ".join( [ node.name() for node in nodes ] )
 205         return True
 206
 207     # make this a valid step
 208     def kill_all_qemus(self):
 209         # this is the brute force version, kill all qemus on that host box
 210         for (box,nodes) in self.gather_hostBoxes().iteritems():
 211             # pass the first nodename, as we don't push template-qemu on testboxes
 212             nodedir=nodes[0].nodedir()
 213             TestBox(box,self.options.buildname).kill_all_qemus(nodedir)
 214         return True
 215
 216     # make this a valid step
 217     def list_all_qemus(self):
 218         for (box,nodes) in self.gather_hostBoxes().iteritems():
 219             # this is the brute force version, kill all qemus on that host box
 220             TestBox(box,self.options.buildname).list_all_qemus()
 221         return True
 222
 223     # kill only the right qemus
 224     def list_qemus(self):
 225         for (box,nodes) in self.gather_hostBoxes().iteritems():
 226             # the fine-grain version
 227             for node in nodes:
 228                 node.list_qemu()
 229         return True
 230
 231     # kill only the right qemus
 232     def kill_qemus(self):
 233         for (box,nodes) in self.gather_hostBoxes().iteritems():
 234             # the fine-grain version
 235             for node in nodes:
 236                 node.kill_qemu()
 237         return True
 238
 239
 240     ### utility methods for handling the pool of IP addresses allocated to plcs
 241     # Logic
 242     # (*) running plcs are recorded in the file named ~/running-test-plcs
 243     # (*) this file contains a line for each running plc, older first
 244     # (*) each line contains the vserver name + the hostname of the (vserver) testbox where it sits
 245     # (*) the free_tracker method performs a vserver stop on the oldest entry
 246     # (*) the record_tracker method adds an entry at the bottom of the file
 247     # (*) the cleanup_tracker method stops all known vservers and removes the tracker file
 248
 249     TRACKER_FILE="~/running-test-plcs"
 250
 251     def record_tracker (self):
 252         command="echo %s %s >> %s"%(self.vservername,self.test_ssh.hostname,TestPlc.TRACKER_FILE)
 253         (code,output) = utils.output_of (self.test_ssh.actual_command(command))
 254         if code != 0:
 255             print "WARNING : COULD NOT record_tracker %s as a running plc on %s"%(self.vservername,self.test_ssh.hostname)
 256             return False
 257         print "Recorded %s in running plcs on host %s"%(self.vservername,self.test_ssh.hostname)
 258         return True
 259
 260     def free_tracker (self):
 261         command="head -1 %s"%TestPlc.TRACKER_FILE
 262         (code,line) = utils.output_of(self.test_ssh.actual_command(command))
 263         if code != 0:
 264             print "No entry found in %s on %s"%(TestPlc.TRACKER_FILE,self.test_ssh.hostname)
 265             return False
 266         try:
 267             [vserver_to_stop,hostname] = line.split()
 268         except:
 269             print "WARNING: free_tracker: Could not parse %s - skipped"%TestPlc.TRACKER_FILE
 270             return False
 271         stop_command = "vserver --silent %s stop"%vserver_to_stop
 272         utils.system(self.test_ssh.actual_command(stop_command))
 273         x=TestPlc.TRACKER_FILE
 274         flush_command = "tail --lines=+2 %s > %s.tmp ; mv %s.tmp %s"%(x,x,x,x)
 275         utils.system(self.test_ssh.actual_command(flush_command))
 276         return True
 277
 278     # this should/could stop only the ones in TRACKER_FILE if that turns out to be reliable
 279     def cleanup_tracker (self):
 280         stop_all = "cd /vservers ; for i in * ; do vserver --silent $i stop ; done"
 281         utils.system(self.test_ssh.actual_command(stop_all))
 282         clean_tracker = "rm -f %s"%TestPlc.TRACKER_FILE
 283         utils.system(self.test_ssh.actual_command(clean_tracker))
 284
 285     def uninstall(self):
 286         self.run_in_host("vserver --silent %s delete"%self.vservername)
 287         return True
 288
 289     ### install
 290     def install(self):
 291         if self.is_local():
 292             # a full path for the local calls
 293             build_dir=os.path.dirname(sys.argv[0])
 294             # sometimes this is empty - set to "." in such a case
 295             if not build_dir: build_dir="."
 296             build_dir += "/build"
 297         else:
 298             # use a standard name - will be relative to remote buildname
 299             build_dir="build"
 300         # run checkout in any case - would do an update if already exists
 301         build_checkout = "svn checkout %s %s"%(self.options.build_url,build_dir)
 302         if self.run_in_host(build_checkout) != 0:
 303             return False
 304         # the repo url is taken from arch-rpms-url
 305         # with the last step (i386.) removed
 306         repo_url = self.options.arch_rpms_url
 307         for level in [ 'arch' ]:
 308             repo_url = os.path.dirname(repo_url)
 309         if self.options.arch == "i386":
 310             personality_option="-p linux32"
 311         else:
 312             personality_option="-p linux64"
 313         script="vtest-init-vserver.sh"
 314         vserver_name = self.vservername
 315         vserver_options="--netdev eth0 --interface %s"%self.vserverip
 316         try:
 317             vserver_hostname=socket.gethostbyaddr(self.vserverip)[0]
 318             vserver_options += " --hostname %s"%vserver_hostname
 319         except:
 320             pass
 321         create_vserver="%(build_dir)s/%(script)s %(personality_option)s %(vserver_name)s %(repo_url)s -- %(vserver_options)s"%locals()
 322         return self.run_in_host(create_vserver) == 0
 323
 324     ### install_rpm
 325     def install_rpm(self):
 326         return self.run_in_guest("yum -y install myplc-native")==0
 327
 328     ###
 329     def configure(self):
 330         tmpname='%s.plc-config-tty'%(self.name())
 331         fileconf=open(tmpname,'w')
 332         for var in [ 'PLC_NAME',
 333                      'PLC_ROOT_PASSWORD',
 334                      'PLC_ROOT_USER',
 335                      'PLC_MAIL_ENABLED',
 336                      'PLC_MAIL_SUPPORT_ADDRESS',
 337                      'PLC_DB_HOST',
 338                      'PLC_API_HOST',
 339                      'PLC_WWW_HOST',
 340                      'PLC_BOOT_HOST',
 341                      'PLC_NET_DNS1',
 342                      'PLC_NET_DNS2']:
 343             fileconf.write ('e %s\n%s\n'%(var,self.plc_spec[var]))
 344         fileconf.write('w\n')
 345         fileconf.write('q\n')
 346         fileconf.close()
 347         utils.system('cat %s'%tmpname)
 348         self.run_in_guest_piped('cat %s'%tmpname,'plc-config-tty')
 349         utils.system('rm %s'%tmpname)
 350         return True
 351
 352     def start(self):
 353         self.run_in_guest('service plc start')
 354         return True
 355
 356     def stop(self):
 357         self.run_in_guest('service plc stop')
 358         return True
 359
 360     def vs_start (self):
 361         self.start_guest()
 362         return True
 363
 364     # could use a TestKey class
 365     def store_keys(self):
 366         for key_spec in self.plc_spec['keys']:
 367                 TestKey(self,key_spec).store_key()
 368         return True
 369
 370     def clean_keys(self):
 371         utils.system("rm -rf %s/keys/"%os.path(sys.argv[0]))
 372
 373     def sites (self):
 374         return self.do_sites()
 375
 376     def clean_sites (self):
 377         return self.do_sites(action="delete")
 378
 379     def do_sites (self,action="add"):
 380         for site_spec in self.plc_spec['sites']:
 381             test_site = TestSite (self,site_spec)
 382             if (action != "add"):
 383                 utils.header("Deleting site %s in %s"%(test_site.name(),self.name()))
 384                 test_site.delete_site()
 385                 # deleted with the site
 386                 #test_site.delete_users()
 387                 continue
 388             else:
 389                 utils.header("Creating site %s & users in %s"%(test_site.name(),self.name()))
 390                 test_site.create_site()
 391                 test_site.create_users()
 392         return True
 393
 394     def clean_all_sites (self):
 395         print 'auth_root',self.auth_root()
 396         site_ids = [s['site_id'] for s in self.apiserver.GetSites(self.auth_root(), {}, ['site_id'])]
 397         for site_id in site_ids:
 398             print 'Deleting site_id',site_id
 399             self.apiserver.DeleteSite(self.auth_root(),site_id)
 400
 401     def nodes (self):
 402         return self.do_nodes()
 403     def clean_nodes (self):
 404         return self.do_nodes(action="delete")
 405
 406     def do_nodes (self,action="add"):
 407         for site_spec in self.plc_spec['sites']:
 408             test_site = TestSite (self,site_spec)
 409             if action != "add":
 410                 utils.header("Deleting nodes in site %s"%test_site.name())
 411                 for node_spec in site_spec['nodes']:
 412                     test_node=TestNode(self,test_site,node_spec)
 413                     utils.header("Deleting %s"%test_node.name())
 414                     test_node.delete_node()
 415             else:
 416                 utils.header("Creating nodes for site %s in %s"%(test_site.name(),self.name()))
 417                 for node_spec in site_spec['nodes']:
 418                     utils.pprint('Creating node %s'%node_spec,node_spec)
 419                     test_node = TestNode (self,test_site,node_spec)
 420                     test_node.create_node ()
 421         return True
 422
 423     # create nodegroups if needed, and populate
 424     # no need for a clean_nodegroups if we are careful enough
 425     def nodegroups (self):
 426         # 1st pass to scan contents
 427         groups_dict = {}
 428         for site_spec in self.plc_spec['sites']:
 429             test_site = TestSite (self,site_spec)
 430             for node_spec in site_spec['nodes']:
 431                 test_node=TestNode (self,test_site,node_spec)
 432                 if node_spec.has_key('nodegroups'):
 433                     nodegroupnames=node_spec['nodegroups']
 434                     if isinstance(nodegroupnames,StringTypes):
 435                         nodegroupnames = [ nodegroupnames ]
 436                     for nodegroupname in nodegroupnames:
 437                         if not groups_dict.has_key(nodegroupname):
 438                             groups_dict[nodegroupname]=[]
 439                         groups_dict[nodegroupname].append(test_node.name())
 440         auth=self.auth_root()
 441         for (nodegroupname,group_nodes) in groups_dict.iteritems():
 442             print 'nodegroups:','dealing with nodegroup',nodegroupname,'on nodes',group_nodes
 443             # first, check if the nodetagtype is here
 444             tag_types = self.apiserver.GetTagTypes(auth,{'tagname':nodegroupname})
 445             if tag_types:
 446                 tag_type_id = tag_types[0]['node_tag_type_id']
 447             else:
 448                 tag_type_id = self.apiserver.AddNodeTagType(auth,
 449                                                             {'tagname':nodegroupname,
 450                                                              'description': 'for nodegroup %s'%nodegroupname,
 451                                                              'category':'test',
 452                                                              'min_role_id':10})
 453             # create nodegroup
 454             nodegroups = self.apiserver.GetNodeGroups (auth, {'groupname':nodegroupname})
 455             if not nodegroups:
 456                 self.apiserver.AddNodeGroup(auth, nodegroupname, tag_type_id, 'yes')
 457             # set node tag on all nodes, value='yes'
 458             overall = True
 459             for nodename in group_nodes:
 460                 try:
 461                     self.apiserver.AddNodeTag(auth, nodename, nodegroupname, "yes")
 462                 except:
 463                     print 'node',nodename,'seems to already have tag',nodegroupname
 464                 # check anyway
 465                 try:
 466                     expect_yes = self.apiserver.GetNodeTags(
 467                         auth,
 468                         {'hostname':nodename,
 469                          'tagname':nodegroupname},
 470                         ['tagvalue'])[0]['tagvalue']
 471                     if expect_yes != "yes":
 472                         print 'Mismatch node tag on node',nodename,'got',expect_yes
 473                         overall=False
 474                 except:
 475                     if not self.options.dry_run:
 476                         print 'Cannot find tag',nodegroupname,'on node',nodename
 477                         overall = False
 478         return overall
 479
 480     def all_hostnames (self) :
 481         hostnames = []
 482         for site_spec in self.plc_spec['sites']:
 483             hostnames += [ node_spec['node_fields']['hostname'] \
 484                            for node_spec in site_spec['nodes'] ]
 485         return hostnames
 486
 487     # gracetime : during the first <gracetime> minutes nothing gets printed
 488     def do_nodes_booted (self, minutes, gracetime,period=15):
 489         if self.options.dry_run:
 490             print 'dry_run'
 491             return True
 492         # compute timeout
 493         timeout = datetime.datetime.now()+datetime.timedelta(minutes=minutes)
 494         graceout = datetime.datetime.now()+datetime.timedelta(minutes=gracetime)
 495         # the nodes that haven't checked yet - start with a full list and shrink over time
 496         tocheck = self.all_hostnames()
 497         utils.header("checking nodes %r"%tocheck)
 498         # create a dict hostname -> status
 499         status = dict ( [ (hostname,'undef') for hostname in tocheck ] )
 500         while tocheck:
 501             # get their status
 502             tocheck_status=self.apiserver.GetNodes(self.auth_root(), tocheck, ['hostname','boot_state' ] )
 503             # update status
 504             for array in tocheck_status:
 505                 hostname=array['hostname']
 506                 boot_state=array['boot_state']
 507                 if boot_state == 'boot':
 508                     utils.header ("%s has reached the 'boot' state"%hostname)
 509                 else:
 510                     # if it's a real node, never mind
 511                     (site_spec,node_spec)=self.locate_hostname(hostname)
 512                     if TestNode.is_real_model(node_spec['node_fields']['model']):
 513                         utils.header("WARNING - Real node %s in %s - ignored"%(hostname,boot_state))
 514                         # let's cheat
 515                         boot_state = 'boot'
 516                     elif datetime.datetime.now() > graceout:
 517                         utils.header ("%s still in '%s' state"%(hostname,boot_state))
 518                         graceout=datetime.datetime.now()+datetime.timedelta(1)
 519                 status[hostname] = boot_state
 520             # refresh tocheck
 521             tocheck = [ hostname for (hostname,boot_state) in status.iteritems() if boot_state != 'boot' ]
 522             if not tocheck:
 523                 return True
 524             if datetime.datetime.now() > timeout:
 525                 for hostname in tocheck:
 526                     utils.header("FAILURE due to %s in '%s' state"%(hostname,status[hostname]))
 527                 return False
 528             # otherwise, sleep for a while
 529             time.sleep(period)
 530         # only useful in empty plcs
 531         return True
 532
 533     def nodes_booted(self):
 534         return self.do_nodes_booted(minutes=20,gracetime=15)
 535
 536     def do_nodes_ssh(self,minutes,gracetime,period=15):
 537         # compute timeout
 538         timeout = datetime.datetime.now()+datetime.timedelta(minutes=minutes)
 539         graceout = datetime.datetime.now()+datetime.timedelta(minutes=gracetime)
 540         tocheck = self.all_hostnames()
 541 #        self.scan_publicKeys(tocheck)
 542         utils.header("checking Connectivity on nodes %r"%tocheck)
 543         while tocheck:
 544             for hostname in tocheck:
 545                 # try to ssh in nodes
 546                 node_test_ssh = TestSsh (hostname,key="/etc/planetlab/root_ssh_key.rsa")
 547                 success=self.run_in_guest(node_test_ssh.actual_command("hostname"))==0
 548                 if success:
 549                     utils.header('The node %s is sshable -->'%hostname)
 550                     # refresh tocheck
 551                     tocheck.remove(hostname)
 552                 else:
 553                     # we will have tried real nodes once, in case they're up - but if not, just skip
 554                     (site_spec,node_spec)=self.locate_hostname(hostname)
 555                     if TestNode.is_real_model(node_spec['node_fields']['model']):
 556                         utils.header ("WARNING : check ssh access into real node %s - skipped"%hostname)
 557                         tocheck.remove(hostname)
 558                     elif datetime.datetime.now() > graceout:
 559                         utils.header("Could not ssh-enter root context on %s"%hostname)
 560             if  not tocheck:
 561                 return True
 562             if datetime.datetime.now() > timeout:
 563                 for hostname in tocheck:
 564                     utils.header("FAILURE to ssh into %s"%hostname)
 565                 return False
 566             # otherwise, sleep for a while
 567             time.sleep(period)
 568         # only useful in empty plcs
 569         return True
 570
 571     def nodes_ssh(self):
 572         return self.do_nodes_ssh(minutes=6,gracetime=4)
 573
 574     @node_mapper
 575     def init_node (self): pass
 576     @node_mapper
 577     def bootcd (self): pass
 578     @node_mapper
 579     def configure_qemu (self): pass
 580     @node_mapper
 581     def reinstall_node (self): pass
 582     @node_mapper
 583     def export_qemu (self): pass
 584
 585     def do_check_initscripts(self):
 586         overall = True
 587         for slice_spec in self.plc_spec['slices']:
 588             if not slice_spec.has_key('initscriptname'):
 589                 continue
 590             initscript=slice_spec['initscriptname']
 591             for nodename in slice_spec['nodenames']:
 592                 (site,node) = self.locate_node (nodename)
 593                 # xxx - passing the wrong site - probably harmless
 594                 test_site = TestSite (self,site)
 595                 test_slice = TestSlice (self,test_site,slice_spec)
 596                 test_node = TestNode (self,test_site,node)
 597                 test_sliver = TestSliver (self, test_node, test_slice)
 598                 if not test_sliver.check_initscript(initscript):
 599                     overall = False
 600         return overall
 601
 602     def check_initscripts(self):
 603             return self.do_check_initscripts()
 604
 605     def initscripts (self):
 606         for initscript in self.plc_spec['initscripts']:
 607             utils.pprint('Adding Initscript in plc %s'%self.plc_spec['name'],initscript)
 608             self.apiserver.AddInitScript(self.auth_root(),initscript['initscript_fields'])
 609         return True
 610
 611     def clean_initscripts (self):
 612         for initscript in self.plc_spec['initscripts']:
 613             initscript_name = initscript['initscript_fields']['name']
 614             print('Attempting to delete %s in plc %s'%(initscript_name,self.plc_spec['name']))
 615             try:
 616                 self.apiserver.DeleteInitScript(self.auth_root(),initscript_name)
 617                 print initscript_name,'deleted'
 618             except:
 619                 print 'deletion went wrong - probably did not exist'
 620         return True
 621
 622     def slices (self):
 623         return self.do_slices()
 624
 625     def clean_slices (self):
 626         return self.do_slices("delete")
 627
 628     def do_slices (self,  action="add"):
 629         for slice in self.plc_spec['slices']:
 630             site_spec = self.locate_site (slice['sitename'])
 631             test_site = TestSite(self,site_spec)
 632             test_slice=TestSlice(self,test_site,slice)
 633             if action != "add":
 634                 utils.header("Deleting slices in site %s"%test_site.name())
 635                 test_slice.delete_slice()
 636             else:
 637                 utils.pprint("Creating slice",slice)
 638                 test_slice.create_slice()
 639                 utils.header('Created Slice %s'%slice['slice_fields']['name'])
 640         return True
 641
 642     @slice_mapper_options
 643     def check_slice(self): pass
 644
 645     @node_mapper
 646     def clear_known_hosts (self): pass
 647
 648     @node_mapper
 649     def start_node (self) : pass
 650
 651     def all_sliver_objs (self):
 652         result=[]
 653         for slice_spec in self.plc_spec['slices']:
 654             slicename = slice_spec['slice_fields']['name']
 655             for nodename in slice_spec['nodenames']:
 656                 result.append(self.locate_sliver_obj (nodename,slicename))
 657         return result
 658
 659     def locate_sliver_obj (self,nodename,slicename):
 660         (site,node) = self.locate_node(nodename)
 661         slice = self.locate_slice (slicename)
 662         # build objects
 663         test_site = TestSite (self, site)
 664         test_node = TestNode (self, test_site,node)
 665         # xxx the slice site is assumed to be the node site - mhh - probably harmless
 666         test_slice = TestSlice (self, test_site, slice)
 667         return TestSliver (self, test_node, test_slice)
 668
 669     def check_tcp (self):
 670         specs = self.plc_spec['tcp_test']
 671         overall=True
 672         for spec in specs:
 673             port = spec['port']
 674             # server side
 675             s_test_sliver = self.locate_sliver_obj (spec['server_node'],spec['server_slice'])
 676             if not s_test_sliver.run_tcp_server(port,timeout=10):
 677                 overall=False
 678                 break
 679
 680             # idem for the client side
 681             c_test_sliver = self.locate_sliver_obj(spec['server_node'],spec['server_slice'])
 682             if not c_test_sliver.run_tcp_client(s_test_sliver.test_node.name(),port):
 683                 overall=False
 684         return overall
 685
 686     def plcsh_stress_test (self):
 687         # install the stress-test in the plc image
 688         location = "/usr/share/plc_api/plcsh-stress-test.py"
 689         remote="/vservers/%s/%s"%(self.vservername,location)
 690         self.test_ssh.copy_abs("plcsh-stress-test.py",remote)
 691         command = location
 692         command += " -- --check"
 693         if self.options.small_test:
 694             command +=  " --tiny"
 695         return ( self.run_in_guest(command) == 0)
 696
 697     def gather_logs (self):
 698         # (1) get the plc's /var/log and store it locally in logs/myplc.var-log.<plcname>/*
 699         # (2) get all the nodes qemu log and store it as logs/node.qemu.<node>.log
 700         # (3) get the nodes /var/log and store is as logs/node.var-log.<node>/*
 701         # (4) as far as possible get the slice's /var/log as logs/sliver.var-log.<sliver>/*
 702         # (1)
 703         print "-------------------- TestPlc.gather_logs : PLC's /var/log"
 704         self.gather_var_logs ()
 705         # (2)
 706         print "-------------------- TestPlc.gather_logs : nodes's QEMU logs"
 707         for site_spec in self.plc_spec['sites']:
 708             test_site = TestSite (self,site_spec)
 709             for node_spec in site_spec['nodes']:
 710                 test_node=TestNode(self,test_site,node_spec)
 711                 test_node.gather_qemu_logs()
 712         # (3)
 713         print "-------------------- TestPlc.gather_logs : nodes's /var/log"
 714         self.gather_nodes_var_logs()
 715         # (4)
 716         print "-------------------- TestPlc.gather_logs : sample sliver's /var/log"
 717         self.gather_slivers_var_logs()
 718         return True
 719
 720     def gather_slivers_var_logs(self):
 721         for test_sliver in self.all_sliver_objs():
 722             remote = test_sliver.tar_var_logs()
 723             utils.system("mkdir -p logs/sliver.var-log.%s"%test_sliver.name())
 724             command = remote + " | tar -C logs/sliver.var-log.%s -xf -"%test_sliver.name()
 725             utils.system(command)
 726         return True
 727
 728     def gather_var_logs (self):
 729         to_plc = self.actual_command_in_guest("tar -C /var/log/ -cf - .")
 730         command = to_plc + "| tar -C logs/myplc.var-log.%s -xf -"%self.name()
 731         utils.system("mkdir -p logs/myplc.var-log.%s"%self.name())
 732         utils.system(command)
 733
 734     def gather_nodes_var_logs (self):
 735         for site_spec in self.plc_spec['sites']:
 736             test_site = TestSite (self,site_spec)
 737             for node_spec in site_spec['nodes']:
 738                 test_node=TestNode(self,test_site,node_spec)
 739                 test_ssh = TestSsh (test_node.name(),key="/etc/planetlab/root_ssh_key.rsa")
 740                 to_plc = self.actual_command_in_guest ( test_ssh.actual_command("tar -C /var/log -cf - ."))
 741                 command = to_plc + "| tar -C logs/node.var-log.%s -xf -"%test_node.name()
 742                 utils.system("mkdir -p logs/node.var-log.%s"%test_node.name())
 743                 utils.system(command)
 744
 745
 746     # returns the filename to use for sql dump/restore, using options.dbname if set
 747     def dbfile (self, database):
 748         # uses options.dbname if it is found
 749         try:
 750             name=self.options.dbname
 751             if not isinstance(name,StringTypes):
 752                 raise Exception
 753         except:
 754             t=datetime.datetime.now()
 755             d=t.date()
 756             name=str(d)
 757         return "/root/%s-%s.sql"%(database,name)
 758
 759     def db_dump(self):
 760         dump=self.dbfile("planetab4")
 761         self.run_in_guest('pg_dump -U pgsqluser planetlab4 -f '+ dump)
 762         utils.header('Dumped planetlab4 database in %s'%dump)
 763         return True
 764
 765     def db_restore(self):
 766         dump=self.dbfile("planetab4")
 767         ##stop httpd service
 768         self.run_in_guest('service httpd stop')
 769         # xxx - need another wrapper
 770         self.run_in_guest_piped('echo drop database planetlab4','psql --user=pgsqluser template1')
 771         self.run_in_guest('createdb -U postgres --encoding=UNICODE --owner=pgsqluser planetlab4')
 772         self.run_in_guest('psql -U pgsqluser planetlab4 -f '+dump)
 773         ##starting httpd service
 774         self.run_in_guest('service httpd start')
 775
 776         utils.header('Database restored from ' + dump)
 777
 778     @standby_generic
 779     def standby_1(): pass
 780     @standby_generic
 781     def standby_2(): pass
 782     @standby_generic
 783     def standby_3(): pass
 784     @standby_generic
 785     def standby_4(): pass
 786     @standby_generic
 787     def standby_5(): pass
 788     @standby_generic
 789     def standby_6(): pass
 790     @standby_generic
 791     def standby_7(): pass
 792     @standby_generic
 793     def standby_8(): pass
 794     @standby_generic
 795     def standby_9(): pass
 796     @standby_generic
 797     def standby_10(): pass
 798     @standby_generic
 799     def standby_11(): pass
 800     @standby_generic
 801     def standby_12(): pass
 802     @standby_generic
 803     def standby_13(): pass
 804     @standby_generic
 805     def standby_14(): pass
 806     @standby_generic
 807     def standby_15(): pass
 808     @standby_generic
 809     def standby_16(): pass
 810     @standby_generic
 811     def standby_17(): pass
 812     @standby_generic
 813     def standby_18(): pass
 814     @standby_generic
 815     def standby_19(): pass
 816     @standby_generic
 817     def standby_20(): pass
 818