changing mobility-type to mobility_type
[sfa.git] / sfa / rspecs / elements / versions / iotlabv1Node.py
1 """
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.
5 """
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
16
17
18 class IotlabNode(Node):
19     """ Defines what kind of information is displayed on the first line of
20     the Rspec describing a node.
21     """
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'])
26
27
28 class IotlabPosition(Element):
29     """ Defines the fields needed to diplay node's coordinates in the RSpec. """
30     fields = ['posx', 'posy', 'posz']
31
32
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'])
37
38
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']
43
44
45
46 class Iotlabv1Node:
47
48     @staticmethod
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.
53
54         """
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]
60
61             iotlab_network_dict = {}
62             iotlab_network_dict['login'] = ldap_username
63
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']))
70
71     @staticmethod
72     def add_nodes(xml, nodes):
73         """Adds the nodes to the xml.
74
75         Adds the nodes as well as dedicated iotlab fields to the node xml
76         element.
77
78         :param xml: the xml being constructed.
79         :type xml: xml
80         :param nodes: list of node dict
81         :type nodes: list
82         :returns: a list of node elements.
83         :rtype: list
84
85         """
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())
94         else:
95             network_elem = xml
96
97         node_elems = []
98         #Then add nodes items to the network item in the xml
99         for node in nodes:
100             #Attach this node to the network element
101             node_fields = ['component_manager_id', 'component_id', 'exclusive',
102                            'boot_state', 'mobile']
103             node_elem = network_elem.add_instance('node', node, node_fields)
104             node_elems.append(node_elem)
105
106             #Set the attibutes of this node element
107             for attribute in node:
108             # set component name
109                 if attribute is 'component_name':
110                     component_name = node['component_name']
111                     node_elem.set('component_name', component_name)
112
113             # set hardware types, extend fields to add Iotlab's architecture
114             #and radio type
115
116                 if attribute is 'hardware_types':
117                     for hardware_type in node.get('hardware_types', []):
118                         fields = HardwareType.fields
119                         fields.extend(['archi', 'radio'])
120                         node_elem.add_instance('hardware_types', node, fields)
121
122             # set mobility
123                 if attribute is 'mobility':
124                     node_elem.add_instance('mobility', node['mobility'],
125                                            IotlabMobility.fields)
126             # set location
127                 if attribute is 'location':
128                     node_elem.add_instance('location', node['location'],
129                                             IotlabLocation.fields)
130
131              # add granularity of the reservation system
132              #TODO put the granularity in network instead SA 18/07/12
133                 if attribute is 'granularity':
134                     granularity = node['granularity']
135                     if granularity:
136                         node_elem.add_instance('granularity',
137                                                granularity, granularity.fields)
138
139             # set available element
140                 if attribute is 'boot_state':
141                     if node.get('boot_state').lower() == 'alive':
142                         available_elem = node_elem.add_element('available',
143                                                                now='true')
144                     else:
145                         available_elem = node_elem.add_element('available',
146                                                                now='false')
147
148             #set position
149                 if attribute is 'position':
150                     node_elem.add_instance('position', node['position'],
151                                            IotlabPosition.fields)
152             ## add services
153             #PGv2Services.add_services(node_elem, node.get('services', []))
154             # add slivers
155                 if attribute is 'slivers':
156                     slivers = node.get('slivers', [])
157                     if not slivers:
158                     # we must still advertise the available sliver types
159                         slivers = Sliver({'type': 'iotlab-node'})
160                     # we must also advertise the available initscripts
161                     #slivers['tags'] = []
162                     #if node.get('pl_initscripts'):
163                         #for initscript in node.get('pl_initscripts', []):
164                             #slivers['tags'].append({'name': 'initscript', \
165                                                     #'value': initscript['name']})
166
167                     Iotlabv1Sliver.add_slivers(node_elem, slivers)
168         return node_elems
169
170     @staticmethod
171     def get_nodes(xml, filter={}):
172         """
173         Parsing method called upon receiving a Rspec request in the iotlab
174         format. (Format is given in the XML header, where 'request' is
175         specified).
176
177         :returns: call to get_node_objs .a list of nodes with their properties
178         :rtype: list of dict
179
180         .. note:: doesn't seem to be used outside sfiListNodes if the iotlab
181             format is specified.
182
183         .. seealso:: get_node_objs
184         """
185         xpath = '//node%s | //default:node%s' % (XpathFilter.xpath(filter),
186                                                  XpathFilter.xpath(filter))
187         node_elems = xml.xpath(xpath)
188         return Iotlabv1Node.get_node_objs(node_elems)
189
190     @staticmethod
191     def get_nodes_with_slivers(xml, sliver_filter={}):
192         """
193         With the nodes found in the Rspec, find the nodes which the user wants
194         to use, based on the definition of a sliver on a node. Search for those
195         nodes.
196
197         :param sliver_filter: unused
198         :returns: call to get_node_objs. A list of nodes where a sliver is
199             defined with their properties;
200         :rtype: list of dict
201
202         .. note:: used by CreateSliver.
203         .. seealso:: get_node_objs
204         """
205
206         xpath = '//node[count(sliver)>0] | \
207                                 //default:node[count(default:sliver) > 0]'
208         node_elems = xml.xpath(xpath)
209         logger.debug("SLABV1NODE \tget_nodes_with_slivers  \
210                                 node_elems %s" % (node_elems))
211         return Iotlabv1Node.get_node_objs(node_elems)
212
213     @staticmethod
214     def get_node_objs(node_elems):
215         """
216         Get information on the nodes on the xml. Gets the attributes in the
217         Rspec.
218
219         :param node_elems: xml node elements
220         :type node_elems: xml xpath return type
221
222         :returns: a list of nodes where a sliver is defined with their
223             properties
224         :rtype: list of dict
225
226         .. seealso:: get_nodes_with_slivers, get_nodes
227
228         """
229         nodes = []
230         for node_elem in node_elems:
231             node = Node(node_elem.attrib, node_elem)
232             nodes.append(node)
233             if 'component_id' in node_elem.attrib:
234                 node['authority_id'] = \
235                     Xrn(node_elem.attrib['component_id']).get_authority_urn()
236
237             # get hardware types
238             hardware_type_elems = node_elem.xpath('./default:hardware_type | \
239                                                             ./hardware_type')
240             node['hardware_types'] = [hw_type.get_instance(HardwareType)
241                                       for hw_type in hardware_type_elems]
242
243             # get location
244             location_elems = node_elem.xpath('./default:location | ./location')
245             locations = [location_elem.get_instance(Location)
246                          for location_elem in location_elems]
247             if len(locations) > 0:
248                 node['location'] = locations[0]
249
250
251             # get interfaces
252             iface_elems = node_elem.xpath('./default:interface | ./interface')
253             node['interfaces'] = [iface_elem.get_instance(Interface)
254                                   for iface_elem in iface_elems]
255
256             # get position
257             position_elems = node_elem.xpath('./default:position | ./position')
258             if position_elems:
259                 position_elem = position_elems[0]
260                 node['position'] = position_elem.get_instance(IotlabPosition)
261
262             # get services
263             #node['services'] = PGv2Services.get_services(node_elem)
264
265             # get slivers
266             node['slivers'] = Iotlabv1Sliver.get_slivers(node_elem)
267             available_elems = node_elem.xpath('./default:available | \
268                                                                 ./available')
269             if len(available_elems) > 0 and 'name' in available_elems[0].attrib:
270                 if available_elems[0].attrib.get('now', '').lower() == 'true':
271                     node['boot_state'] = 'boot'
272                 else:
273                     node['boot_state'] = 'disabled'
274
275         logger.debug("SLABV1NODE \tget_nodes_objs  \
276                                 #nodes %s" % (nodes))
277         return nodes
278
279     @staticmethod
280     def add_slivers(xml, slivers):
281         """Add the slivers in parameter to the nodes, by modifying the
282         xml and adding the sliver element in the RSpec.
283
284         :param slivers: list of slivers, which can be either strings or  dict.
285         :type: list
286
287         :returns: None
288         :rtype: None
289
290         .. seealso:: Iotlabv1Sliver : add_slivers
291         .. note:: used by sfiAddSliver and add_nodes (in the file)
292
293         """
294         logger.debug("Iotlabv1NODE \tadd_slivers ")
295         component_ids = []
296         for sliver in slivers:
297             filter_sliver = {}
298             if isinstance(sliver, str):
299                 filter_sliver['component_id'] = '*%s*' % sliver
300                 sliver = {}
301             elif 'component_id' in sliver and sliver['component_id']:
302                 filter_sliver['component_id'] = '*%s*' % sliver['component_id']
303             if not filter_sliver:
304                 continue
305             nodes = Iotlabv1Node.get_nodes(xml, filter_sliver)
306             if not nodes:
307                 continue
308             node = nodes[0]
309             Iotlabv1Sliver.add_slivers(node, sliver)
310
311     @staticmethod
312     def remove_slivers(xml, hostnames):
313         """
314         Removes the slivers for the nodes whose hostnames are on the list.
315
316         :param hostnames: list of nodes' hostnames whose sliver have to be
317             removed.
318         :type hostnames: list
319         """
320         for hostname in hostnames:
321             nodes = Iotlabv1Node.get_nodes(xml, {'component_id': '*%s*'
322                                            % hostname})
323             for node in nodes:
324                 slivers = Iotlabv1Sliver.get_slivers(node.element)
325                 for sliver in slivers:
326                     node.element.remove(sliver.element)