sfa/iotlab/iotlabaggregate.py

   1 """
   2 File providing methods to generate valid RSpecs for the Iotlab testbed.
   3 Contains methods to get information on slice, slivers, nodes and leases,
   4 formatting them and turn it into a RSpec.
   5 """
   6 from sfa.util.xrn import hrn_to_urn, urn_to_hrn, get_authority
   7
   8 from sfa.rspecs.rspec import RSpec
   9 #from sfa.rspecs.elements.location import Location
  10 from sfa.rspecs.elements.hardware_type import HardwareType
  11 from sfa.rspecs.elements.login import Login
  12 from sfa.rspecs.elements.services import Services
  13 from sfa.rspecs.elements.sliver import Sliver
  14 from sfa.rspecs.elements.lease import Lease
  15 from sfa.rspecs.elements.granularity import Granularity
  16 from sfa.rspecs.version_manager import VersionManager
  17
  18 from sfa.rspecs.elements.versions.iotlabv1Node import IotlabPosition, \
  19     IotlabNode, IotlabLocation
  20
  21 from sfa.util.sfalogging import logger
  22 from sfa.util.xrn import Xrn
  23
  24
  25 def iotlab_xrn_to_hostname(xrn):
  26     """Returns a node's hostname from its xrn.
  27     :param xrn: The nodes xrn identifier.
  28     :type xrn: Xrn (from sfa.util.xrn)
  29
  30     :returns: node's hostname.
  31     :rtype: string
  32
  33     """
  34     return Xrn.unescape(Xrn(xrn=xrn, type='node').get_leaf())
  35
  36
  37 def iotlab_xrn_object(root_auth, hostname):
  38     """Creates a valid xrn object from the node's hostname and the authority
  39     of the SFA server.
  40
  41     :param hostname: the node's hostname.
  42     :param root_auth: the SFA root authority.
  43     :type hostname: string
  44     :type root_auth: string
  45
  46     :returns: the iotlab node's xrn
  47     :rtype: Xrn
  48
  49     """
  50     return Xrn('.'.join([root_auth, Xrn.escape(hostname)]), type='node')
  51
  52
  53 class IotlabAggregate:
  54     """Aggregate manager class for Iotlab. """
  55
  56     sites = {}
  57     nodes = {}
  58     api = None
  59     interfaces = {}
  60     links = {}
  61     node_tags = {}
  62
  63     prepared = False
  64
  65     user_options = {}
  66
  67     def __init__(self, driver):
  68         self.driver = driver
  69
  70     def get_slice_and_slivers(self, slice_xrn, login=None):
  71         """
  72         Get the slices and the associated leases if any from the iotlab
  73             testbed. One slice can have mutliple leases.
  74             For each slice, get the nodes in the  associated lease
  75             and create a sliver with the necessary info and insert it into the
  76             sliver dictionary, keyed on the node hostnames.
  77             Returns a dict of slivers based on the sliver's node_id.
  78             Called by get_rspec.
  79
  80
  81         :param slice_xrn: xrn of the slice
  82         :param login: user's login on iotlab ldap
  83
  84         :type slice_xrn: string
  85         :type login: string
  86         :returns: a list of slices dict and a list of Sliver object
  87         :rtype: (list, list)
  88
  89         .. note: There is no real slivers in iotlab, only leases. The goal
  90             is to be consistent with the SFA standard.
  91
  92         """
  93         slivers = {}
  94         sfa_slice = None
  95         if slice_xrn is None:
  96             return (sfa_slice, slivers)
  97         slice_urn = hrn_to_urn(slice_xrn, 'slice')
  98         slice_hrn, _ = urn_to_hrn(slice_xrn)
  99         slice_name = slice_hrn
 100
 101         slices = self.driver.iotlab_api.GetSlices(slice_filter=str(slice_name),
 102                                                   slice_filter_type='slice_hrn',
 103                                                   login=login)
 104
 105         logger.debug("IotlabAggregate api \tget_slice_and_slivers \
 106                       sfa_slice %s \r\n slices %s self.driver.hrn %s"
 107                      % (sfa_slice, slices, self.driver.hrn))
 108         if slices == []:
 109             return (sfa_slice, slivers)
 110
 111         # sort slivers by node id , if there is a job
 112         #and therefore, node allocated to this slice
 113         for sfa_slice in slices:
 114             try:
 115                 node_ids_list = sfa_slice['node_ids']
 116             except KeyError:
 117                 logger.log_exc("IOTLABAGGREGATE \t \
 118                             get_slice_and_slivers No nodes in the slice \
 119                             - KeyError ")
 120                 continue
 121
 122             for node in node_ids_list:
 123                 sliver_xrn = Xrn(slice_urn, type='sliver', id=node)
 124                 sliver_xrn.set_authority(self.driver.hrn)
 125                 sliver = Sliver({'sliver_id': sliver_xrn.urn,
 126                                 'name': sfa_slice['hrn'],
 127                                 'type': 'iotlab-node',
 128                                 'tags': []})
 129
 130                 slivers[node] = sliver
 131
 132         #Add default sliver attribute :
 133         #connection information for iotlab
 134         if get_authority(sfa_slice['hrn']) == self.driver.iotlab_api.root_auth:
 135             tmp = sfa_slice['hrn'].split('.')
 136             ldap_username = tmp[1].split('_')[0]
 137             ssh_access = None
 138             slivers['default_sliver'] = {'ssh': ssh_access,
 139                                          'login': ldap_username}
 140
 141         #TODO get_slice_and_slivers Find the login of the external user
 142
 143         logger.debug("IOTLABAGGREGATE api get_slice_and_slivers  slivers %s "
 144                      % (slivers))
 145         return (slices, slivers)
 146
 147
 148     def get_nodes(self, slices=None, slivers=[], options=None):
 149         """Returns the nodes in the slice using the rspec format, with all the
 150         nodes' properties.
 151
 152         Fetch the nodes ids in the slices dictionary and get all the nodes
 153         properties from OAR. Makes a rspec dicitonary out of this and returns
 154         it. If the slice does not have any job running or scheduled, that is
 155         it has no reserved nodes, then returns an empty list.
 156
 157         :param slices: list of slices (record dictionaries)
 158         :param slivers: the list of slivers in all the slices
 159         :type slices: list of dicts
 160         :type slivers: list of Sliver object (dictionaries)
 161         :returns: An empty list if the slice has no reserved nodes, a rspec
 162             list with all the nodes and their properties (a dict per node)
 163             otherwise.
 164         :rtype: list
 165
 166         .. seealso:: get_slice_and_slivers
 167
 168         """
 169         # NT: the semantic of this function is not clear to me :
 170         # if slice is not defined, then all the nodes should be returned
 171         # if slice is defined, we should return only the nodes that
 172         # are part of this slice
 173         # but what is the role of the slivers parameter ?
 174         # So i assume that slice['node_ids'] will be the same as slivers for us
 175         if slices is not None:
 176             for one_slice in slices:
 177                 try:
 178                     slice_nodes_list = one_slice['node_ids']
 179                      # if we are dealing with a slice that has no node just
 180                      # return an empty list. In iotlab a slice can have multiple
 181                      # jobs scheduled, so it either has at least one lease or
 182                      # not at all.
 183                 except KeyError:
 184                     return []
 185
 186         # get the granularity in second for the reservation system
 187         grain = self.driver.iotlab_api.GetLeaseGranularity()
 188
 189         nodes = self.driver.iotlab_api.GetNodes()
 190
 191         nodes_dict = {}
 192
 193         #if slices, this means we got to list all the nodes given to this slice
 194         # Make a list of all the nodes in the slice before getting their
 195         #attributes
 196         rspec_nodes = []
 197         slice_nodes_list = []
 198         logger.debug("IOTLABAGGREGATE api get_nodes slice_nodes_list  %s "
 199                      % (slices))
 200
 201
 202         reserved_nodes = self.driver.iotlab_api.GetNodesCurrentlyInUse()
 203         logger.debug("IOTLABAGGREGATE api get_nodes slice_nodes_list  %s "
 204                      % (slice_nodes_list))
 205         for node in nodes:
 206             nodes_dict[node['node_id']] = node
 207             if slice_nodes_list == [] or node['hostname'] in slice_nodes_list:
 208
 209                 rspec_node = IotlabNode()
 210                 # xxx how to retrieve site['login_base']
 211                 #site_id=node['site_id']
 212                 #site=sites_dict[site_id]
 213
 214                 rspec_node['mobile'] = node['mobile']
 215                 rspec_node['archi'] = node['archi']
 216                 rspec_node['radio'] = node['radio']
 217
 218                 iotlab_xrn = iotlab_xrn_object(self.driver.iotlab_api.root_auth,
 219                                                node['hostname'])
 220                 rspec_node['component_id'] = iotlab_xrn.urn
 221                 rspec_node['component_name'] = node['hostname']
 222                 rspec_node['component_manager_id'] = \
 223                                 hrn_to_urn(self.driver.iotlab_api.root_auth,
 224                                 'authority+sa')
 225
 226                 # Iotlab's nodes are federated : there is only one authority
 227                 # for all Iotlab sites, registered in SFA.
 228                 # Removing the part including the site
 229                 # in authority_id SA 27/07/12
 230                 rspec_node['authority_id'] = rspec_node['component_manager_id']
 231
 232                 # do not include boot state (<available> element)
 233                 #in the manifest rspec
 234
 235
 236                 rspec_node['boot_state'] = node['boot_state']
 237                 if node['hostname'] in reserved_nodes:
 238                     rspec_node['boot_state'] = "Reserved"
 239                 rspec_node['exclusive'] = 'true'
 240                 rspec_node['hardware_types'] = [HardwareType({'name': \
 241                                                 'iotlab-node'})]
 242
 243
 244                 location = IotlabLocation({'country':'France', 'site': \
 245                                             node['site']})
 246                 rspec_node['location'] = location
 247
 248
 249                 position = IotlabPosition()
 250                 for field in position :
 251                     try:
 252                         position[field] = node[field]
 253                     except KeyError, error :
 254                         logger.log_exc("IOTLABAGGREGATE\t get_nodes \
 255                                                         position %s "% (error))
 256
 257                 rspec_node['position'] = position
 258                 #rspec_node['interfaces'] = []
 259
 260                 # Granularity
 261                 granularity = Granularity({'grain': grain})
 262                 rspec_node['granularity'] = granularity
 263                 rspec_node['tags'] = []
 264                 if node['hostname'] in slivers:
 265                     # add sliver info
 266                     sliver = slivers[node['hostname']]
 267                     rspec_node['sliver_id'] = sliver['sliver_id']
 268                     rspec_node['client_id'] = node['hostname']
 269                     rspec_node['slivers'] = [sliver]
 270
 271                     # slivers always provide the ssh service
 272                     login = Login({'authentication': 'ssh-keys', \
 273                             'hostname': node['hostname'], 'port':'22', \
 274                             'username': sliver['name']})
 275                     service = Services({'login': login})
 276                     rspec_node['services'] = [service]
 277                 rspec_nodes.append(rspec_node)
 278
 279         return (rspec_nodes)
 280
 281     def get_all_leases(self):
 282         """
 283
 284         Get list of lease dictionaries which all have the mandatory keys
 285         ('lease_id', 'hostname', 'site_id', 'name', 'start_time', 'duration').
 286         All the leases running or scheduled are returned.
 287
 288         :returns: rspec lease dictionary with keys lease_id, component_id,
 289             slice_id, start_time, duration.
 290         :rtype: dict
 291
 292         .. note::There is no filtering of leases within a given time frame.
 293             All the running or scheduled leases are returned. options
 294             removed SA 15/05/2013
 295
 296
 297         """
 298
 299         #now = int(time.time())
 300         #lease_filter = {'clip': now }
 301
 302         #if slice_record:
 303             #lease_filter.update({'name': slice_record['name']})
 304
 305         #leases = self.driver.iotlab_api.GetLeases(lease_filter)
 306         leases = self.driver.iotlab_api.GetLeases()
 307         grain = self.driver.iotlab_api.GetLeaseGranularity()
 308         # site_ids = []
 309         rspec_leases = []
 310         for lease in leases:
 311             #as many leases as there are nodes in the job
 312             for node in lease['reserved_nodes']:
 313                 rspec_lease = Lease()
 314                 rspec_lease['lease_id'] = lease['lease_id']
 315                 #site = node['site_id']
 316                 iotlab_xrn = iotlab_xrn_object(self.driver.iotlab_api.root_auth,
 317                                                node)
 318                 rspec_lease['component_id'] = iotlab_xrn.urn
 319                 #rspec_lease['component_id'] = hostname_to_urn(self.driver.hrn,\
 320                                         #site, node['hostname'])
 321                 try:
 322                     rspec_lease['slice_id'] = lease['slice_id']
 323                 except KeyError:
 324                     #No info on the slice used in iotlab_xp table
 325                     pass
 326                 rspec_lease['start_time'] = lease['t_from']
 327                 rspec_lease['duration'] = (lease['t_until'] - lease['t_from']) \
 328                     / grain
 329                 rspec_leases.append(rspec_lease)
 330         return rspec_leases
 331
 332     def get_rspec(self, slice_xrn=None, login=None, version=None,
 333                   options=None):
 334         """
 335
 336         Returns xml rspec:
 337             - a full advertisement rspec with the testbed resources if slice_xrn
 338              is not specified.If a lease option is given, also returns the
 339              leases scheduled on the testbed.
 340             - a manifest Rspec with the leases and nodes in slice's leases
 341             if slice_xrn is not None.
 342
 343         :param slice_xrn: srn of the slice
 344         :param login: user'uid (ldap login) on iotlab
 345         :param version: can be set to sfa or iotlab
 346         :param options: used to specify if the leases should also be included in
 347             the returned rspec.
 348         :type slice_xrn: string
 349         :type login: string
 350         :type version: RSpecVersion
 351         :type options: dict
 352
 353         :returns: Xml Rspec.
 354         :rtype: XML
 355
 356
 357         """
 358
 359         rspec = None
 360         version_manager = VersionManager()
 361         version = version_manager.get_version(version)
 362         logger.debug("IotlabAggregate \t get_rspec ***version %s \
 363                     version.type %s  version.version %s options %s \r\n"
 364                      % (version, version.type, version.version, options))
 365
 366         if slice_xrn is None:
 367             rspec_version = version_manager._get_version(version.type,
 368                                                          version.version, 'ad')
 369
 370         else:
 371             rspec_version = version_manager._get_version(
 372                 version.type, version.version, 'manifest')
 373
 374         slices, slivers = self.get_slice_and_slivers(slice_xrn, login)
 375         #at this point sliver may be empty if no iotlab job
 376         #is running for this user/slice.
 377         rspec = RSpec(version=rspec_version, user_options=options)
 378
 379         logger.debug("\r\n \r\n IotlabAggregate \tget_rspec *** \
 380                       slice_xrn %s slices  %s\r\n \r\n"
 381                      % (slice_xrn, slices))
 382
 383         if options is not None:
 384             lease_option = options['list_leases']
 385         else:
 386             #If no options are specified, at least print the resources
 387             lease_option = 'all'
 388            #if slice_xrn :
 389                #lease_option = 'all'
 390
 391         if lease_option in ['all', 'resources']:
 392         #if not options.get('list_leases') or options.get('list_leases')
 393         #and options['list_leases'] != 'leases':
 394             nodes = self.get_nodes(slices, slivers)
 395             logger.debug("\r\n \r\n IotlabAggregate \t lease_option %s \
 396                           get rspec  ******* nodes %s"
 397                          % (lease_option, nodes[0]))
 398
 399             sites_set = set([node['location']['site'] for node in nodes])
 400
 401             #In case creating a job,  slice_xrn is not set to None
 402             rspec.version.add_nodes(nodes)
 403             if slice_xrn:
 404                 #Get user associated with this slice
 405                 #for one_slice in slices :
 406                 ldap_username = slices[0]['hrn']
 407                 tmp = ldap_username.split('.')
 408                 ldap_username = tmp[1].split('_')[0]
 409
 410                 if version.type == "Iotlab":
 411                     rspec.version.add_connection_information(
 412                         ldap_username, sites_set)
 413
 414             default_sliver = slivers.get('default_sliver', [])
 415             if default_sliver:
 416                 #default_sliver_attribs = default_sliver.get('tags', [])
 417                 logger.debug("IotlabAggregate \tget_rspec **** \
 418                         default_sliver%s \r\n" % (default_sliver))
 419                 for attrib in default_sliver:
 420                     rspec.version.add_default_sliver_attribute(
 421                         attrib, default_sliver[attrib])
 422
 423         if lease_option in ['all','leases']:
 424             leases = self.get_all_leases()
 425             rspec.version.add_leases(leases)
 426         return rspec.toxml()