system/TestSlice.py

   1 # Thierry Parmentelat <thierry.parmentelat@inria.fr>
   2 # Copyright (C) 2010 INRIA
   3 #
   4 import utils
   5 import os, os.path
   6 from datetime import datetime, timedelta
   7 import time
   8
   9 from TestKey import TestKey
  10 from TestUser import TestUser
  11 from TestNode import TestNode
  12 from TestSsh import TestSsh
  13 from Completer import Completer, CompleterTask
  14
  15 class CompleterTaskSshSlice (CompleterTask):
  16
  17     def __init__ (self, test_plc, hostname, slicename, private_key,command, expected, dry_run):
  18         self.test_plc=test_plc
  19         self.hostname=hostname
  20         self.slicename=slicename
  21         self.private_key=private_key
  22         self.command=command
  23         self.dry_run=dry_run
  24         self.expected=expected
  25     def run (self, silent):
  26         (site_spec,node_spec) = self.test_plc.locate_hostname(self.hostname)
  27         test_ssh = TestSsh (self.hostname,key=self.private_key,username=self.slicename)
  28         full_command = test_ssh.actual_command(self.command)
  29         retcod = utils.system (full_command, silent=silent)
  30         if self.dry_run: return True
  31         if self.expected:       return retcod==0
  32         else:                   return retcod!=0
  33     def failure_message (self):
  34         return "Could not ssh into slice %s @ %s"%(self.slicename,self.hostname)
  35
  36 class TestSlice:
  37
  38     def __init__ (self,test_plc,test_site,slice_spec):
  39         self.test_plc=test_plc
  40         self.test_site=test_site
  41         self.slice_spec=slice_spec
  42         self.test_ssh=TestSsh(self.test_plc.test_ssh)
  43
  44     def name(self):
  45         return self.slice_spec['slice_fields']['name']
  46
  47     def get_slice(self,slice_name):
  48         for slice_spec in self.test_plc.plc_spec['slices']:
  49             if(slice_spec['slice_fields']['name']== slice_name):
  50                 return slice_spec
  51
  52     def owner_auth(self):
  53         owner_spec = self.test_site.locate_user(self.slice_spec['owner'])
  54         return TestUser(self,self.test_site,owner_spec).auth()
  55
  56     def slice_name (self):
  57         return self.slice_spec['slice_fields']['name']
  58
  59     # init slice with people, and then add nodes
  60     def create_slice(self):
  61         auth = self.owner_auth()
  62         slice_fields = self.slice_spec['slice_fields']
  63         slice_name = slice_fields['name']
  64         utils.header("Creating slice %s"%slice_name)
  65         self.test_plc.apiserver.AddSlice(auth,slice_fields)
  66         for username in self.slice_spec['usernames']:
  67                 user_spec=self.test_site.locate_user(username)
  68                 test_user=TestUser(self,self.test_site,user_spec)
  69                 self.test_plc.apiserver.AddPersonToSlice(auth, test_user.name(), slice_name)
  70         # add initscript code or name as appropriate
  71         if self.slice_spec.has_key('initscriptcode'):
  72             iscode=self.slice_spec['initscriptcode']
  73             utils.header("Adding initscript code %s in %s"%(iscode,slice_name))
  74             self.test_plc.apiserver.AddSliceTag(self.test_plc.auth_root(), slice_name,'initscript_code',iscode)
  75         elif self.slice_spec.has_key('initscriptname'):
  76             isname=self.slice_spec['initscriptname']
  77             utils.header("Adding initscript name %s in %s"%(isname,slice_name))
  78             self.test_plc.apiserver.AddSliceTag(self.test_plc.auth_root(), slice_name,'initscript',isname)
  79         if 'omf-friendly' in self.slice_spec:
  80             utils.header("Making slice %s OMF-friendly"%slice_name)
  81             self.test_plc.apiserver.AddSliceTag(self.test_plc.auth_root(), slice_name,'vref','omf')
  82             self.test_plc.apiserver.AddSliceTag(self.test_plc.auth_root(), slice_name,'omf_control','yes')
  83 # setting vref directly like this was useful for multi-arch tests long ago - see wifilab
  84 # however this should rather use other tags by now, so we drop this for now
  85 #        if self.slice_spec.has_key ('vref'):
  86 #            vref_value=self.slice_spec['vref']
  87 #            self.test_plc.apiserver.AddSliceTag(self.test_plc.auth_root(), slice_name,'vref',vref_value)
  88         # epilogue
  89         self.add_nodes()
  90
  91     def check_vsys_defaults (self, options, *args, **kwds):
  92         "check vsys tags match PLC_VSYS_DEFAULTS"
  93         auth = self.owner_auth()
  94         slice_fields = self.slice_spec['slice_fields']
  95         slice_name = slice_fields['name']
  96         vsys_tags = self.test_plc.apiserver.GetSliceTags (auth,{'tagname':'vsys','name':slice_name})
  97         values=[ st['value'] for st in vsys_tags ]
  98         expected=self.test_plc.plc_spec['expected_vsys_tags']
  99         result = set(values) == set(expected)
 100         if not result:
 101             print 'Check vsys defaults with slice %s'%slice_name
 102             print 'Expected %s'%expected
 103             print 'Got %s'%values
 104         return result
 105
 106     # just add the nodes and handle tags
 107     def add_nodes (self):
 108         auth = self.owner_auth()
 109         slice_name = self.slice_name()
 110         hostnames=[]
 111         for nodename in self.slice_spec['nodenames']:
 112             node_spec=self.test_site.locate_node(nodename)
 113             test_node=TestNode(self,self.test_site,node_spec)
 114             hostnames += [test_node.name()]
 115         utils.header("Adding %r in %s"%(hostnames,slice_name))
 116         self.test_plc.apiserver.AddSliceToNodes(auth, slice_name, hostnames)
 117
 118     # trash the slice altogether
 119     def delete_slice(self):
 120         auth = self.owner_auth()
 121         slice_name = self.slice_name()
 122         utils.header("Deleting slice %s"%slice_name)
 123         self.test_plc.apiserver.DeleteSlice(auth,slice_name)
 124
 125     # keep the slice alive and just delete nodes
 126     def delete_nodes (self):
 127         auth = self.owner_auth()
 128         slice_name = self.slice_name()
 129         print 'retrieving slice %s'%slice_name
 130         slice=self.test_plc.apiserver.GetSlices(auth,slice_name)[0]
 131         node_ids=slice['node_ids']
 132         utils.header ("Deleting %d nodes from slice %s"%\
 133                           (len(node_ids),slice_name))
 134         self.test_plc.apiserver.DeleteSliceFromNodes (auth,slice_name, node_ids)
 135
 136     def locate_private_key(self):
 137         key_names=[]
 138         for username in self.slice_spec['usernames']:
 139             user_spec=self.test_site.locate_user(username)
 140             key_names += user_spec['key_names']
 141         return self.test_plc.locate_private_key_from_key_names (key_names)
 142
 143     # trying to reach the slice through ssh - expected to answer
 144     def ssh_slice (self, options, *args, **kwds):
 145         "tries to ssh-enter the slice with the user key, to ensure slice creation"
 146         return self.do_ssh_slice(options, expected=True, *args, **kwds)
 147
 148     # when we expect the slice is not reachable
 149     def ssh_slice_off (self, options, *args, **kwds):
 150         "tries to ssh-enter the slice with the user key, expecting it to be unreachable"
 151         return self.do_ssh_slice(options, expected=False, *args, **kwds)
 152
 153     def do_ssh_slice(self,options,expected=True,
 154                      timeout_minutes=20,silent_minutes=10,period_seconds=15,command=None):
 155         "tries to enter a slice"
 156
 157         timeout  = timedelta(minutes=timeout_minutes)
 158         graceout = timedelta(minutes=silent_minutes)
 159         period   = timedelta(seconds=period_seconds)
 160         if not command:
 161             command="echo hostname ; hostname; echo id; id; echo uname -a ; uname -a"
 162         # locate a key
 163         private_key=self.locate_private_key()
 164         if not private_key :
 165             utils.header("WARNING: Cannot find a valid key for slice %s"%self.name())
 166             return False
 167
 168         # convert nodenames to real hostnames
 169         if expected:    msg="ssh slice access enabled"
 170         else:           msg="ssh slice access disabled"
 171         utils.header("checking for %s -- slice %s"%(msg,self.name()))
 172
 173         tasks=[]
 174         slicename=self.name()
 175         dry_run = getattr(options,'dry_run',False)
 176         for nodename in self.slice_spec['nodenames']:
 177             (site_spec,node_spec) = self.test_plc.locate_node(nodename)
 178             tasks.append( CompleterTaskSshSlice(self.test_plc,node_spec['node_fields']['hostname'],
 179                                                 slicename,private_key,command,expected,dry_run))
 180         return Completer (tasks).run (timeout, graceout, period)
 181
 182     def ssh_slice_basics (self, options, *args, **kwds):
 183         "the slice is expected to be UP and we just check a few simple sanity commands, including 'ps' to check for /proc"
 184         overall=True
 185         if not self.do_ssh_slice_once(options,expected=True,  command='true'): overall=False
 186         if not self.do_ssh_slice_once(options,expected=False, command='false'): overall=False
 187         if not self.do_ssh_slice_once(options,expected=False, command='someimprobablecommandname'): overall=False
 188         if not self.do_ssh_slice_once(options,expected=True,  command='ps'): overall=False
 189         return overall
 190
 191     # pick just one nodename and runs the ssh command once
 192     def do_ssh_slice_once(self,options,command,expected):
 193         # locate a key
 194         private_key=self.locate_private_key()
 195         if not private_key :
 196             utils.header("WARNING: Cannot find a valid key for slice %s"%self.name())
 197             return False
 198
 199         # convert nodenames to real hostnames
 200         slice_spec = self.slice_spec
 201         nodename=slice_spec['nodenames'][0]
 202         (site_spec,node_spec) = self.test_plc.locate_node(nodename)
 203         hostname=node_spec['node_fields']['hostname']
 204
 205         if expected:    msg="%s to return TRUE from ssh"%command
 206         else:           msg="%s to return FALSE from ssh"%command
 207
 208         utils.header("checking %s -- slice %s on node %s"%(msg,self.name(),hostname))
 209         (site_spec,node_spec) = self.test_plc.locate_hostname(hostname)
 210         test_ssh = TestSsh (hostname,key=private_key,username=self.name())
 211         full_command = test_ssh.actual_command(command)
 212         retcod = utils.system (full_command,silent=True)
 213         if getattr(options,'dry_run',None): return True
 214         if expected:    success = retcod==0
 215         else:           success = retcod!=0
 216         if not success: utils.header ("WRONG RESULT for %s"%msg)
 217         return success