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.
6 from sfa.util.xrn import hrn_to_urn, urn_to_hrn, get_authority
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
18 from sfa.rspecs.elements.versions.iotlabv1Node import IotlabPosition, \
19 IotlabNode, IotlabLocation
21 from sfa.util.sfalogging import logger
22 from sfa.util.xrn import Xrn
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)
30 :returns: node's hostname.
34 return Xrn.unescape(Xrn(xrn=xrn, type='node').get_leaf())
37 def iotlab_xrn_object(root_auth, hostname):
38 """Creates a valid xrn object from the node's hostname and the authority
41 :param hostname: the node's hostname.
42 :param root_auth: the SFA root authority.
43 :type hostname: string
44 :type root_auth: string
46 :returns: the iotlab node's xrn
50 return Xrn('.'.join([root_auth, Xrn.escape(hostname)]), type='node')
53 class IotlabAggregate:
54 """Aggregate manager class for Iotlab. """
67 def __init__(self, driver):
70 def get_slice_and_slivers(self, slice_xrn, login=None):
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.
81 :param slice_xrn: xrn of the slice
82 :param login: user's login on iotlab ldap
84 :type slice_xrn: string
86 :returns: a list of slices dict and a list of Sliver object
89 .. note: There is no real slivers in iotlab, only leases. The goal
90 is to be consistent with the SFA standard.
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
101 # GetSlices always returns a list, even if there is only one element
102 slices = self.driver.iotlab_api.GetSlices(slice_filter=str(slice_name),
103 slice_filter_type='slice_hrn',
106 logger.debug("IotlabAggregate api \tget_slice_and_slivers \
107 slice_hrn %s \r\n slices %s self.driver.hrn %s"
108 % (slice_hrn, slices, self.driver.hrn))
110 return (sfa_slice, slivers)
112 # sort slivers by node id , if there is a job
113 #and therefore, node allocated to this slice
114 # for sfa_slice in slices:
115 sfa_slice = slices[0]
117 node_ids_list = sfa_slice['node_ids']
119 logger.log_exc("IOTLABAGGREGATE \t \
120 get_slice_and_slivers No nodes in the slice \
125 for node in node_ids_list:
126 sliver_xrn = Xrn(slice_urn, type='sliver', id=node)
127 sliver_xrn.set_authority(self.driver.hrn)
128 sliver = Sliver({'sliver_id': sliver_xrn.urn,
129 'name': sfa_slice['hrn'],
130 'type': 'iotlab-node',
133 slivers[node] = sliver
135 #Add default sliver attribute :
136 #connection information for iotlab
137 # if get_authority(sfa_slice['hrn']) == self.driver.iotlab_api.root_auth:
138 # tmp = sfa_slice['hrn'].split('.')
139 # ldap_username = tmp[1].split('_')[0]
141 # slivers['default_sliver'] = {'ssh': ssh_access,
142 # 'login': ldap_username}
144 ldap_username = self.find_ldap_username_from_slice(sfa_slice)
146 if ldap_username is not None:
148 slivers['default_sliver'] = {'ssh': ssh_access,
149 'login': ldap_username}
152 logger.debug("IOTLABAGGREGATE api get_slice_and_slivers slivers %s "
154 return (slices, slivers)
156 def find_ldap_username_from_slice(self, sfa_slice):
157 researchers = [sfa_slice['reg_researchers'][0].__dict__]
160 ret = self.driver.iotlab_api.GetPersons(researchers)
162 ldap_username = ret[0]['uid']
167 def get_nodes(self, slices=None, slivers=[], options=None):
168 """Returns the nodes in the slice using the rspec format, with all the
171 Fetch the nodes ids in the slices dictionary and get all the nodes
172 properties from OAR. Makes a rspec dicitonary out of this and returns
173 it. If the slice does not have any job running or scheduled, that is
174 it has no reserved nodes, then returns an empty list.
176 :param slices: list of slices (record dictionaries)
177 :param slivers: the list of slivers in all the slices
178 :type slices: list of dicts
179 :type slivers: list of Sliver object (dictionaries)
180 :returns: An empty list if the slice has no reserved nodes, a rspec
181 list with all the nodes and their properties (a dict per node)
185 .. seealso:: get_slice_and_slivers
188 # NT: the semantic of this function is not clear to me :
189 # if slice is not defined, then all the nodes should be returned
190 # if slice is defined, we should return only the nodes that
191 # are part of this slice
192 # but what is the role of the slivers parameter ?
193 # So i assume that slice['node_ids'] will be the same as slivers for us
194 slice_nodes_list = []
195 if slices is not None:
196 for one_slice in slices:
198 slice_nodes_list = one_slice['node_ids']
199 # if we are dealing with a slice that has no node just
200 # return an empty list. In iotlab a slice can have multiple
201 # jobs scheduled, so it either has at least one lease or
206 # get the granularity in second for the reservation system
207 grain = self.driver.iotlab_api.GetLeaseGranularity()
209 nodes = self.driver.iotlab_api.GetNodes()
213 #if slices, this means we got to list all the nodes given to this slice
214 # Make a list of all the nodes in the slice before getting their
218 logger.debug("IOTLABAGGREGATE api get_nodes slices %s "
222 reserved_nodes = self.driver.iotlab_api.GetNodesCurrentlyInUse()
223 logger.debug("IOTLABAGGREGATE api get_nodes slice_nodes_list %s "
224 % (slice_nodes_list))
226 nodes_dict[node['node_id']] = node
227 if slice_nodes_list == [] or node['hostname'] in slice_nodes_list:
229 rspec_node = IotlabNode()
230 # xxx how to retrieve site['login_base']
231 #site_id=node['site_id']
232 #site=sites_dict[site_id]
234 rspec_node['mobile'] = node['mobile']
235 rspec_node['archi'] = node['archi']
236 rspec_node['radio'] = node['radio']
238 iotlab_xrn = iotlab_xrn_object(self.driver.iotlab_api.root_auth,
240 rspec_node['component_id'] = iotlab_xrn.urn
241 rspec_node['component_name'] = node['hostname']
242 rspec_node['component_manager_id'] = \
243 hrn_to_urn(self.driver.iotlab_api.root_auth,
246 # Iotlab's nodes are federated : there is only one authority
247 # for all Iotlab sites, registered in SFA.
248 # Removing the part including the site
249 # in authority_id SA 27/07/12
250 rspec_node['authority_id'] = rspec_node['component_manager_id']
252 # do not include boot state (<available> element)
253 #in the manifest rspec
256 rspec_node['boot_state'] = node['boot_state']
257 if node['hostname'] in reserved_nodes:
258 rspec_node['boot_state'] = "Reserved"
259 rspec_node['exclusive'] = 'true'
260 rspec_node['hardware_types'] = [HardwareType({'name': \
264 location = IotlabLocation({'country':'France', 'site': \
266 rspec_node['location'] = location
269 position = IotlabPosition()
270 for field in position :
272 position[field] = node[field]
273 except KeyError, error :
274 logger.log_exc("IOTLABAGGREGATE\t get_nodes \
275 position %s "% (error))
277 rspec_node['position'] = position
278 #rspec_node['interfaces'] = []
281 granularity = Granularity({'grain': grain})
282 rspec_node['granularity'] = granularity
283 rspec_node['tags'] = []
284 if node['hostname'] in slivers:
286 sliver = slivers[node['hostname']]
287 rspec_node['sliver_id'] = sliver['sliver_id']
288 rspec_node['client_id'] = node['hostname']
289 rspec_node['slivers'] = [sliver]
291 # slivers always provide the ssh service
292 login = Login({'authentication': 'ssh-keys', \
293 'hostname': node['hostname'], 'port':'22', \
294 'username': sliver['name']})
295 service = Services({'login': login})
296 rspec_node['services'] = [service]
297 rspec_nodes.append(rspec_node)
301 def get_all_leases(self, ldap_username):
304 Get list of lease dictionaries which all have the mandatory keys
305 ('lease_id', 'hostname', 'site_id', 'name', 'start_time', 'duration').
306 All the leases running or scheduled are returned.
308 :param ldap_username: if ldap uid is not None, looks for the leases
309 belonging to this user.
310 :type ldap_username: string
311 :returns: rspec lease dictionary with keys lease_id, component_id,
312 slice_id, start_time, duration.
315 .. note::There is no filtering of leases within a given time frame.
316 All the running or scheduled leases are returned. options
317 removed SA 15/05/2013
322 #now = int(time.time())
323 #lease_filter = {'clip': now }
326 #lease_filter.update({'name': slice_record['name']})
328 #leases = self.driver.iotlab_api.GetLeases(lease_filter)
330 logger.debug("IOTLABAGGREGATE get_all_leases ldap_username %s "
332 leases = self.driver.iotlab_api.GetLeases(login=ldap_username)
333 grain = self.driver.iotlab_api.GetLeaseGranularity()
337 #as many leases as there are nodes in the job
338 for node in lease['reserved_nodes']:
339 rspec_lease = Lease()
340 rspec_lease['lease_id'] = lease['lease_id']
341 #site = node['site_id']
342 iotlab_xrn = iotlab_xrn_object(self.driver.iotlab_api.root_auth,
344 rspec_lease['component_id'] = iotlab_xrn.urn
345 #rspec_lease['component_id'] = hostname_to_urn(self.driver.hrn,\
346 #site, node['hostname'])
348 rspec_lease['slice_id'] = lease['slice_id']
350 #No info on the slice used in testbed_xp table
352 rspec_lease['start_time'] = lease['t_from']
353 rspec_lease['duration'] = (lease['t_until'] - lease['t_from']) \
355 rspec_leases.append(rspec_lease)
358 def get_rspec(self, slice_xrn=None, login=None, version=None,
362 - a full advertisement rspec with the testbed resources if slice_xrn is
363 not specified.If a lease option is given, also returns the leases
364 scheduled on the testbed.
365 - a manifest Rspec with the leases and nodes in slice's leases if
366 slice_xrn is not None.
368 :param slice_xrn: srn of the slice
369 :type slice_xrn: string
370 :param login: user'uid (ldap login) on iotlab
372 :param version: can be set to sfa or iotlab
373 :type version: RSpecVersion
374 :param options: used to specify if the leases should also be included in
386 version_manager = VersionManager()
387 version = version_manager.get_version(version)
388 logger.debug("IotlabAggregate \t get_rspec ***version %s \
389 version.type %s version.version %s options %s \r\n"
390 % (version, version.type, version.version, options))
392 if slice_xrn is None:
393 rspec_version = version_manager._get_version(version.type,
394 version.version, 'ad')
397 rspec_version = version_manager._get_version(
398 version.type, version.version, 'manifest')
400 slices, slivers = self.get_slice_and_slivers(slice_xrn, login)
401 if slice_xrn and slices is not None:
402 #Get user associated with this slice
403 #for one_slice in slices :
404 ldap_username = self.find_ldap_username_from_slice(slices[0])
405 # ldap_username = slices[0]['reg_researchers'][0].__dict__['hrn']
406 # # ldap_username = slices[0]['user']
407 # tmp = ldap_username.split('.')
408 # ldap_username = tmp[1]
409 logger.debug("IotlabAggregate \tget_rspec **** \
410 LDAP USERNAME %s \r\n" \
412 #at this point sliver may be empty if no iotlab job
413 #is running for this user/slice.
414 rspec = RSpec(version=rspec_version, user_options=options)
416 logger.debug("\r\n \r\n IotlabAggregate \tget_rspec *** \
417 slice_xrn %s slices %s\r\n \r\n"
418 % (slice_xrn, slices))
420 if options is not None:
421 lease_option = options['list_leases']
423 #If no options are specified, at least print the resources
426 #lease_option = 'all'
428 if lease_option in ['all', 'resources']:
429 #if not options.get('list_leases') or options.get('list_leases')
430 #and options['list_leases'] != 'leases':
431 nodes = self.get_nodes(slices, slivers)
433 logger.debug("IotlabAggregate \t lease_option %s \
434 get rspec ******* nodes %s"
435 % (lease_option, nodes))
437 sites_set = set([node['location']['site'] for node in nodes])
439 #In case creating a job, slice_xrn is not set to None
440 rspec.version.add_nodes(nodes)
441 if slice_xrn and slices is not None:
442 # #Get user associated with this slice
443 # #for one_slice in slices :
444 # ldap_username = slices[0]['reg_researchers']
445 # # ldap_username = slices[0]['user']
446 # tmp = ldap_username.split('.')
447 # ldap_username = tmp[1]
448 # # ldap_username = tmp[1].split('_')[0]
450 logger.debug("IotlabAggregate \tget_rspec **** \
451 version type %s ldap_ user %s \r\n" \
452 % (version.type, ldap_username))
453 if version.type == "Iotlab":
454 rspec.version.add_connection_information(
455 ldap_username, sites_set)
457 default_sliver = slivers.get('default_sliver', [])
458 if default_sliver and len(nodes) is not 0:
459 #default_sliver_attribs = default_sliver.get('tags', [])
460 logger.debug("IotlabAggregate \tget_rspec **** \
461 default_sliver%s \r\n" % (default_sliver))
462 for attrib in default_sliver:
463 rspec.version.add_default_sliver_attribute(
464 attrib, default_sliver[attrib])
466 if lease_option in ['all','leases']:
467 leases = self.get_all_leases(ldap_username)
468 rspec.version.add_leases(leases)
469 logger.debug("IotlabAggregate \tget_rspec **** \
470 FINAL RSPEC %s \r\n" % (rspec.toxml()))