python3 - 2to3 + miscell obvious tweaks
[sfa.git] / sfa / rspecs / elements / versions / iotlabv1Node.py
1
2 from sfa.util.xrn import Xrn
3 from sfa.util.xml import XpathFilter
4 from sfa.rspecs.elements.node import NodeElement
5 from sfa.rspecs.elements.sliver import Sliver
6 from sfa.rspecs.elements.location import Location
7 from sfa.rspecs.elements.hardware_type import HardwareType
8 from sfa.rspecs.elements.element import Element
9 from sfa.rspecs.elements.interface import Interface
10 from sfa.rspecs.elements.versions.iotlabv1Sliver import Iotlabv1Sliver
11 from sfa.util.sfalogging import logger
12
13
14 class IotlabNode(NodeElement):
15     # First get the fields already defined in the class Node
16     fields = list(NodeElement.fields)
17     # Extend it with iotlab's specific fields
18     fields.extend(['archi', 'radio', 'mobile', 'position'])
19
20
21 class IotlabPosition(Element):
22     fields = ['x', 'y', 'z']
23
24
25 class IotlabLocation(Location):
26     fields = list(Location.fields)
27     fields.extend(['site'])
28
29
30 class IotlabMobility(Element):
31     """ Class to give information of a node's mobility, and what kind of
32     mobility it is (train, roomba robot ...) """
33     fields = ['mobile', 'mobility_type']
34
35
36 class Iotlabv1Node:
37
38     @staticmethod
39     def add_connection_information(xml, ldap_username, sites_set):
40         """ Adds login and ssh connection info in the network item in
41         the xml. Does not create the network element, therefore
42         should be used after add_nodes, which creates the network item.
43
44         """
45         logger.debug(" add_connection_information ")
46         # Get network item in the xml
47         network_elems = xml.xpath('//network')
48         if len(network_elems) > 0:
49             network_elem = network_elems[0]
50
51             iotlab_network_dict = {}
52             iotlab_network_dict['login'] = ldap_username
53
54             iotlab_network_dict['ssh'] = \
55                 ['ssh ' + ldap_username + '@' + site + '.iotlab.info'
56                  for site in sites_set]
57             network_elem.set('ssh',
58                              str(iotlab_network_dict['ssh']))
59             network_elem.set('login', str(iotlab_network_dict['login']))
60
61     @staticmethod
62     def add_nodes(xml, nodes, rspec_content_type=None):
63         """Adds the nodes to the xml.
64
65         Adds the nodes as well as dedicated iotlab fields to the node xml
66         element.
67
68         :param xml: the xml being constructed.
69         :type xml: xml
70         :param nodes: list of node dict
71         :type nodes: list
72         :returns: a list of node elements.
73         :rtype: list
74
75         """
76         # Add network item in the xml
77         network_elems = xml.xpath('//network')
78         if len(network_elems) > 0:
79             network_elem = network_elems[0]
80         elif len(nodes) > 0 and nodes[0].get('component_manager_id'):
81             network_urn = nodes[0]['component_manager_id']
82             network_elem = xml.add_element('network',
83                                            name=Xrn(network_urn).get_hrn())
84         else:
85             network_elem = xml
86
87         node_elems = []
88         # Then add nodes items to the network item in the xml
89         for node in nodes:
90             # Attach this node to the network element
91             node_fields = ['component_manager_id', 'component_id', 'exclusive',
92                            'boot_state', 'mobile']
93             node_elem = network_elem.add_instance('node', node, node_fields)
94             node_elems.append(node_elem)
95
96             # Set the attibutes of this node element
97             for attribute in node:
98                 # set component name
99                 if attribute is 'component_name':
100                     component_name = node['component_name']
101                     node_elem.set('component_name', component_name)
102
103             # set hardware types, extend fields to add Iotlab's architecture
104             # and radio type
105
106                 if attribute is 'hardware_types':
107                     for hardware_type in node.get('hardware_types', []):
108                         fields = HardwareType.fields
109                         fields.extend(['archi', 'radio'])
110                         node_elem.add_instance('hardware_types', node, fields)
111
112             # set mobility
113                 if attribute is 'mobility':
114                     node_elem.add_instance('mobility', node['mobility'],
115                                            IotlabMobility.fields)
116             # set location
117                 if attribute is 'location':
118                     node_elem.add_instance('location', node['location'],
119                                            IotlabLocation.fields)
120
121              # add granularity of the reservation system
122              # TODO put the granularity in network instead SA 18/07/12
123                 if attribute is 'granularity':
124                     granularity = node['granularity']
125                     if granularity:
126                         node_elem.add_instance('granularity',
127                                                granularity, granularity.fields)
128
129             # set available element
130                 if attribute is 'boot_state':
131                     if node.get('boot_state').lower() == 'alive':
132                         available_elem = node_elem.add_element('available',
133                                                                now='true')
134                     else:
135                         available_elem = node_elem.add_element('available',
136                                                                now='false')
137
138             # set position
139                 if attribute is 'position':
140                     node_elem.add_instance('position', node['position'],
141                                            IotlabPosition.fields)
142             # add services
143             #PGv2Services.add_services(node_elem, node.get('services', []))
144             # add slivers
145                 if attribute is 'slivers':
146                     slivers = node.get('slivers', [])
147                     if not slivers:
148                         # we must still advertise the available sliver types
149                         slivers = Sliver({'type': 'iotlab-node'})
150                     # we must also advertise the available initscripts
151                     #slivers['tags'] = []
152                     # if node.get('pl_initscripts'):
153                         # for initscript in node.get('pl_initscripts', []):
154                         # slivers['tags'].append({'name': 'initscript', \
155                         #'value': initscript['name']})
156
157                     Iotlabv1Sliver.add_slivers(node_elem, slivers)
158                 # add sliver tag in Request Rspec
159             if rspec_content_type == "request":
160                 node_elem.add_instance('sliver', '', [])
161         return node_elems
162
163     @staticmethod
164     def get_nodes(xml, filter=None):
165         if filter is None:
166             filter = {}
167         xpath = '//node%s | //default:node%s' % (XpathFilter.xpath(filter),
168                                                  XpathFilter.xpath(filter))
169         node_elems = xml.xpath(xpath)
170         return Iotlabv1Node.get_node_objs(node_elems)
171
172     @staticmethod
173     def get_nodes_with_slivers(xml, sliver_filter=None):
174         if sliver_filter is None:
175             sliver_filter = {}
176
177         xpath = '//node[count(sliver)>0] | \
178                                 //default:node[count(default:sliver) > 0]'
179         node_elems = xml.xpath(xpath)
180         logger.debug("SLABV1NODE \tget_nodes_with_slivers  \
181                                 node_elems %s" % (node_elems))
182         return Iotlabv1Node.get_node_objs(node_elems)
183
184     @staticmethod
185     def get_node_objs(node_elems):
186         nodes = []
187         for node_elem in node_elems:
188             node = NodeElement(node_elem.attrib, node_elem)
189             nodes.append(node)
190             if 'component_id' in node_elem.attrib:
191                 node['authority_id'] = \
192                     Xrn(node_elem.attrib['component_id']).get_authority_urn()
193
194             # get hardware types
195             hardware_type_elems = node_elem.xpath('./default:hardware_type | \
196                                                             ./hardware_type')
197             node['hardware_types'] = [hw_type.get_instance(HardwareType)
198                                       for hw_type in hardware_type_elems]
199
200             # get location
201             location_elems = node_elem.xpath('./default:location | ./location')
202             locations = [location_elem.get_instance(Location)
203                          for location_elem in location_elems]
204             if len(locations) > 0:
205                 node['location'] = locations[0]
206
207             # get interfaces
208             iface_elems = node_elem.xpath('./default:interface | ./interface')
209             node['interfaces'] = [iface_elem.get_instance(Interface)
210                                   for iface_elem in iface_elems]
211
212             # get position
213             position_elems = node_elem.xpath('./default:position | ./position')
214             if position_elems:
215                 position_elem = position_elems[0]
216                 node['position'] = position_elem.get_instance(IotlabPosition)
217
218             # get services
219             #node['services'] = PGv2Services.get_services(node_elem)
220
221             # get slivers
222             node['slivers'] = Iotlabv1Sliver.get_slivers(node_elem)
223             available_elems = node_elem.xpath('./default:available | \
224                                                                 ./available')
225             if len(available_elems) > 0 and 'name' in available_elems[0].attrib:
226                 if available_elems[0].attrib.get('now', '').lower() == 'true':
227                     node['boot_state'] = 'boot'
228                 else:
229                     node['boot_state'] = 'disabled'
230
231         logger.debug("SLABV1NODE \tget_nodes_objs  \
232                                 #nodes %s" % (nodes))
233         return nodes
234
235     @staticmethod
236     def add_slivers(xml, slivers):
237         logger.debug("Iotlabv1NODE \tadd_slivers ")
238         component_ids = []
239         for sliver in slivers:
240             filter_sliver = {}
241             if isinstance(sliver, str):
242                 filter_sliver['component_id'] = '*%s*' % sliver
243                 sliver = {}
244             elif 'component_id' in sliver and sliver['component_id']:
245                 filter_sliver['component_id'] = '*%s*' % sliver['component_id']
246             if not filter_sliver:
247                 continue
248             nodes = Iotlabv1Node.get_nodes(xml, filter_sliver)
249             if not nodes:
250                 continue
251             node = nodes[0]
252             Iotlabv1Sliver.add_slivers(node, sliver)
253
254     @staticmethod
255     def remove_slivers(xml, hostnames):
256         for hostname in hostnames:
257             nodes = Iotlabv1Node.get_nodes(xml,
258                                            {'component_id': '*%s*' % hostname})
259             for node in nodes:
260                 slivers = Iotlabv1Sliver.get_slivers(node.element)
261                 for sliver in slivers:
262                     node.element.remove(sliver.element)