2 This file describes what the propreties of an iotlab nodes are, if an iotlab
3 rspec is asked. If additionnal node properties have to be defined and exposed
4 to the user, it should be done here.
6 from sfa.util.xrn import Xrn
7 from sfa.util.xml import XpathFilter
8 from sfa.rspecs.elements.node import Node
9 from sfa.rspecs.elements.sliver import Sliver
10 from sfa.rspecs.elements.location import Location
11 from sfa.rspecs.elements.hardware_type import HardwareType
12 from sfa.rspecs.elements.element import Element
13 from sfa.rspecs.elements.interface import Interface
14 from sfa.rspecs.elements.versions.iotlabv1Sliver import Iotlabv1Sliver
15 from sfa.util.sfalogging import logger
18 class IotlabNode(Node):
19 """ Defines what kind of information is displayed on the first line of
20 the Rspec describing a node.
22 #First get the fields already defined in the class Node
23 fields = list(Node.fields)
24 #Extend it with iotlab's specific fields
25 fields.extend(['archi', 'radio', 'mobile', 'position'])
28 class IotlabPosition(Element):
29 """ Defines the fields needed to diplay node's coordinates in the RSpec. """
30 fields = ['posx', 'posy', 'posz']
33 class IotlabLocation(Location):
34 """ Needed to display the localisation (Country and city) of a node."""
35 fields = list(Location.fields)
36 fields.extend(['site'])
39 class IotlabMobility(Element):
40 """ Class to give information of a node's mobility, and what kind of
41 mobility it is (train, roomba robot ...) """
42 fields = ['mobile', 'mobility-type']
49 def add_connection_information(xml, ldap_username, sites_set):
50 """ Adds login and ssh connection info in the network item in
51 the xml. Does not create the network element, therefore
52 should be used after add_nodes, which creates the network item.
55 logger.debug(" add_connection_information ")
56 #Get network item in the xml
57 network_elems = xml.xpath('//network')
58 if len(network_elems) > 0:
59 network_elem = network_elems[0]
61 iotlab_network_dict = {}
62 iotlab_network_dict['login'] = ldap_username
64 iotlab_network_dict['ssh'] = \
65 ['ssh ' + ldap_username + '@'+site+'.iotlab.info'
66 for site in sites_set]
67 network_elem.set('ssh',
68 unicode(iotlab_network_dict['ssh']))
69 network_elem.set('login', unicode(iotlab_network_dict['login']))
72 def add_nodes(xml, nodes, rspec_content_type=None):
73 """Adds the nodes to the xml.
75 Adds the nodes as well as dedicated iotlab fields to the node xml
78 :param xml: the xml being constructed.
80 :param nodes: list of node dict
82 :returns: a list of node elements.
86 #Add network item in the xml
87 network_elems = xml.xpath('//network')
88 if len(network_elems) > 0:
89 network_elem = network_elems[0]
90 elif len(nodes) > 0 and nodes[0].get('component_manager_id'):
91 network_urn = nodes[0]['component_manager_id']
92 network_elem = xml.add_element('network',
93 name=Xrn(network_urn).get_hrn())
97 logger.debug("iotlabv1Node \t add_nodes nodes %s \r\n " % (nodes[0]))
99 #Then add nodes items to the network item in the xml
101 #Attach this node to the network element
102 node_fields = ['component_manager_id', 'component_id', 'exclusive',
103 'boot_state', 'mobile']
104 node_elem = network_elem.add_instance('node', node, node_fields)
105 node_elems.append(node_elem)
107 #Set the attibutes of this node element
108 for attribute in node:
110 if attribute is 'component_name':
111 component_name = node['component_name']
112 node_elem.set('component_name', component_name)
114 # set hardware types, extend fields to add Iotlab's architecture
117 if attribute is 'hardware_types':
118 for hardware_type in node.get('hardware_types', []):
119 fields = HardwareType.fields
120 fields.extend(['archi', 'radio'])
121 node_elem.add_instance('hardware_types', node, fields)
124 if attribute is 'mobility':
125 node_elem.add_instance('mobility', node['mobility'],
126 IotlabMobility.fields)
128 if attribute is 'location':
129 node_elem.add_instance('location', node['location'],
130 IotlabLocation.fields)
132 # add granularity of the reservation system
133 #TODO put the granularity in network instead SA 18/07/12
134 if attribute is 'granularity':
135 granularity = node['granularity']
137 node_elem.add_instance('granularity',
138 granularity, granularity.fields)
140 # set available element
141 if attribute is 'boot_state':
142 if node.get('boot_state').lower() == 'alive':
143 available_elem = node_elem.add_element('available',
146 available_elem = node_elem.add_element('available',
150 logger.debug("Iotlabv1Node position node_elem %s" % (node_elem))
151 if attribute is 'position':
152 node_elem.add_instance('position', node['position'],
153 IotlabPosition.fields)
154 logger.debug("Iotlabv1Node position node[position] %s "
155 % (node['position']))
157 #PGv2Services.add_services(node_elem, node.get('services', []))
159 if attribute is 'slivers':
160 slivers = node.get('slivers', [])
162 # we must still advertise the available sliver types
163 slivers = Sliver({'type': 'iotlab-node'})
164 # we must also advertise the available initscripts
165 #slivers['tags'] = []
166 #if node.get('pl_initscripts'):
167 #for initscript in node.get('pl_initscripts', []):
168 #slivers['tags'].append({'name': 'initscript', \
169 #'value': initscript['name']})
171 Iotlabv1Sliver.add_slivers(node_elem, slivers)
173 # add sliver tag in Request Rspec
174 if rspec_content_type == "request":
175 node_elem.add_instance('sliver', '', [])
180 def get_nodes(xml, filter={}):
182 Parsing method called upon receiving a Rspec request in the iotlab
183 format. (Format is given in the XML header, where 'request' is
186 :returns: call to get_node_objs .a list of nodes with their properties
189 .. note:: doesn't seem to be used outside sfiListNodes if the iotlab
192 .. seealso:: get_node_objs
194 xpath = '//node%s | //default:node%s' % (XpathFilter.xpath(filter),
195 XpathFilter.xpath(filter))
196 node_elems = xml.xpath(xpath)
197 return Iotlabv1Node.get_node_objs(node_elems)
200 def get_nodes_with_slivers(xml, sliver_filter={}):
202 With the nodes found in the Rspec, find the nodes which the user wants
203 to use, based on the definition of a sliver on a node. Search for those
206 :param sliver_filter: unused
207 :returns: call to get_node_objs. A list of nodes where a sliver is
208 defined with their properties;
211 .. note:: used by CreateSliver.
212 .. seealso:: get_node_objs
215 xpath = '//node[count(sliver)>0] | \
216 //default:node[count(default:sliver) > 0]'
217 node_elems = xml.xpath(xpath)
218 logger.debug("SLABV1NODE \tget_nodes_with_slivers \
219 node_elems %s" % (node_elems))
220 return Iotlabv1Node.get_node_objs(node_elems)
223 def get_node_objs(node_elems):
225 Get information on the nodes on the xml. Gets the attributes in the
228 :param node_elems: xml node elements
229 :type node_elems: xml xpath return type
231 :returns: a list of nodes where a sliver is defined with their
235 .. seealso:: get_nodes_with_slivers, get_nodes
239 for node_elem in node_elems:
240 node = Node(node_elem.attrib, node_elem)
242 if 'component_id' in node_elem.attrib:
243 node['authority_id'] = \
244 Xrn(node_elem.attrib['component_id']).get_authority_urn()
247 hardware_type_elems = node_elem.xpath('./default:hardware_type | \
249 node['hardware_types'] = [hw_type.get_instance(HardwareType)
250 for hw_type in hardware_type_elems]
253 location_elems = node_elem.xpath('./default:location | ./location')
254 locations = [location_elem.get_instance(Location)
255 for location_elem in location_elems]
256 if len(locations) > 0:
257 node['location'] = locations[0]
261 iface_elems = node_elem.xpath('./default:interface | ./interface')
262 node['interfaces'] = [iface_elem.get_instance(Interface)
263 for iface_elem in iface_elems]
266 position_elems = node_elem.xpath('./default:position | ./position')
268 position_elem = position_elems[0]
269 node['position'] = position_elem.get_instance(IotlabPosition)
272 #node['services'] = PGv2Services.get_services(node_elem)
275 node['slivers'] = Iotlabv1Sliver.get_slivers(node_elem)
276 available_elems = node_elem.xpath('./default:available | \
278 if len(available_elems) > 0 and 'name' in available_elems[0].attrib:
279 if available_elems[0].attrib.get('now', '').lower() == 'true':
280 node['boot_state'] = 'boot'
282 node['boot_state'] = 'disabled'
284 logger.debug("SLABV1NODE \tget_nodes_objs \
285 #nodes %s" % (nodes))
289 def add_slivers(xml, slivers):
290 """Add the slivers in parameter to the nodes, by modifying the
291 xml and adding the sliver element in the RSpec.
293 :param slivers: list of slivers, which can be either strings or dict.
299 .. seealso:: Iotlabv1Sliver : add_slivers
300 .. note:: used by sfiAddSliver and add_nodes (in the file)
303 logger.debug("Iotlabv1NODE \tadd_slivers ")
305 for sliver in slivers:
307 if isinstance(sliver, str):
308 filter_sliver['component_id'] = '*%s*' % sliver
310 elif 'component_id' in sliver and sliver['component_id']:
311 filter_sliver['component_id'] = '*%s*' % sliver['component_id']
312 if not filter_sliver:
314 nodes = Iotlabv1Node.get_nodes(xml, filter_sliver)
318 Iotlabv1Sliver.add_slivers(node, sliver)
321 def remove_slivers(xml, hostnames):
323 Removes the slivers for the nodes whose hostnames are on the list.
325 :param hostnames: list of nodes' hostnames whose sliver have to be
327 :type hostnames: list
329 for hostname in hostnames:
330 nodes = Iotlabv1Node.get_nodes(xml, {'component_id': '*%s*'
333 slivers = Iotlabv1Sliver.get_slivers(node.element)
334 for sliver in slivers:
335 node.element.remove(sliver.element)