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