python3 - 2to3 + miscell obvious tweaks
[sfa.git] / sfa / rspecs / versions / iotlabv1.py
1
2
3 from copy import deepcopy
4
5
6 from sfa.rspecs.version import RSpecVersion
7 import sys
8 # from sfa.rspecs.elements.versions.iotlabv1Lease import Iotlabv1Lease
9 from sfa.rspecs.elements.versions.iotlabv1Node import Iotlabv1Node
10 from sfa.rspecs.elements.versions.iotlabv1Sliver import Iotlabv1Sliver
11
12
13 from sfa.rspecs.elements.versions.sfav1Lease import SFAv1Lease
14
15 from sfa.util.sfalogging import logger
16
17
18 class Iotlabv1(RSpecVersion):
19     """
20     Defines Iotlab style RSpec and associated methods to parse and create a
21     valid Iotlab XML Rspec.
22     """
23     #enabled = True
24     type = 'Iotlab'
25     content_type = 'ad'
26     version = '1'
27     #template = '<RSpec type="%s"></RSpec>' % type
28
29     schema = 'http://senslab.info/resources/rspec/1/ad.xsd'
30     namespace = 'http://www.geni.net/resources/rspec/3'
31     extensions = {
32         'flack': "http://www.protogeni.net/resources/rspec/ext/flack/1",
33         'planetlab': "http://www.planet-lab.org/resources/sfa/ext/planetlab/1",
34     }
35     namespaces = dict(list(extensions.items()) + [('default', namespace)])
36     elements = []
37
38     # Network
39     def get_networks(self):
40         # WARNING Added //default:network to the xpath
41         # otherwise network element not detected 16/07/12 SA
42
43         network_elems = self.xml.xpath('//network | //default:network')
44         networks = [network_elem.get_instance(fields=['name', 'slice']) for
45                     network_elem in network_elems]
46         return networks
47
48     def add_network(self, network):
49         network_tags = self.xml.xpath('//network[@name="%s"]' % network)
50         if not network_tags:
51             network_tag = self.xml.add_element('network', name=network)
52         else:
53             network_tag = network_tags[0]
54         return network_tag
55
56     # Nodes
57     def get_nodes(self, filter=None):
58         return Iotlabv1Node.get_nodes(self.xml, filter)
59
60     def get_nodes_with_slivers(self):
61         return Iotlabv1Node.get_nodes_with_slivers(self.xml)
62
63     def get_slice_timeslot(self):
64         return Iotlabv1Timeslot.get_slice_timeslot(self.xml)
65
66     def add_connection_information(self, ldap_username, sites_set):
67         return Iotlabv1Node.add_connection_information(self.xml, ldap_username, sites_set)
68
69     def add_nodes(self, nodes, check_for_dupes=False, rspec_content_type=None):
70         return Iotlabv1Node.add_nodes(self.xml, nodes, rspec_content_type)
71
72     def merge_node(self, source_node_tag, network, no_dupes=False):
73         logger.debug("SLABV1 merge_node")
74         # if no_dupes and self.get_node_element(node['hostname']):
75         # node already exists
76         # return
77         network_tag = self.add_network(network)
78         network_tag.append(deepcopy(source_node_tag))
79
80     # Slivers
81
82     def get_sliver_attributes(self, hostname, node, network=None):
83         print("\r\n \r\n \r\n \t\t SLABV1.PY  get_sliver_attributes hostname %s " % (
84             hostname), file=sys.stderr)
85         nodes = self.get_nodes({'component_id': '*%s*' % hostname})
86         attribs = []
87         print("\r\n \r\n \r\n \t\t SLABV1.PY  get_sliver_attributes-----------------nodes %s  " %
88               (nodes), file=sys.stderr)
89         if nodes is not None and isinstance(nodes, list) and len(nodes) > 0:
90             node = nodes[0]
91         # if node :
92             #sliver = node.xpath('./default:sliver | ./sliver')
93             #sliver = node.xpath('./default:sliver', namespaces=self.namespaces)
94             sliver = node['slivers']
95
96             if sliver is not None and isinstance(sliver, list) and len(sliver) > 0:
97                 sliver = sliver[0]
98                 attribs = sliver
99                 #attribs = self.attributes_list(sliver)
100                 print("\r\n \r\n \r\n \t\t SLABV1.PY  get_sliver_attributes----------NN------- sliver %s self.namespaces %s attribs %s " %
101                       (sliver, self.namespaces, attribs), file=sys.stderr)
102         return attribs
103
104     def get_slice_attributes(self, network=None):
105
106         slice_attributes = []
107
108         nodes_with_slivers = self.get_nodes_with_slivers()
109
110         # TODO: default sliver attributes in the PG rspec?
111         default_ns_prefix = self.namespaces['default']
112         for node in nodes_with_slivers:
113             sliver_attributes = self.get_sliver_attributes(
114                 node['component_id'], node, network)
115             for sliver_attribute in sliver_attributes:
116                 name = str(sliver_attribute[0])
117                 text = str(sliver_attribute[1])
118                 attribs = sliver_attribute[2]
119                 # we currently only suppor the <initscript> and <flack> attributes
120                 # if  'info' in name:
121                 #attribute = {'name': 'flack_info', 'value': str(attribs), 'node_id': node}
122                 # slice_attributes.append(attribute)
123                 # elif 'initscript' in name:
124                 if 'initscript' in name:
125                     if attribs is not None and 'name' in attribs:
126                         value = attribs['name']
127                     else:
128                         value = text
129                     attribute = {'name': 'initscript',
130                                  'value': value, 'node_id': node}
131                     slice_attributes.append(attribute)
132
133         return slice_attributes
134
135     def attributes_list(self, elem):
136         opts = []
137         if elem is not None:
138             for e in elem:
139                 opts.append((e.tag, str(e.text).strip(), e.attrib))
140         return opts
141
142     def get_default_sliver_attributes(self, network=None):
143         return []
144
145     def add_default_sliver_attribute(self, name, value, network=None):
146         pass
147
148     def add_slivers(self, hostnames, attributes=None, sliver_urn=None, append=False):
149         if attributes is None:
150             attributes = []
151         # all nodes hould already be present in the rspec. Remove all
152         # nodes that done have slivers
153         print("\r\n \r\n \r\n \t\t\t Iotlabv1.PY add_slivers  ----->get_node ", file=sys.stderr)
154         for hostname in hostnames:
155             node_elems = self.get_nodes({'component_id': '*%s*' % hostname})
156             if not node_elems:
157                 continue
158             node_elem = node_elems[0]
159
160             # determine sliver types for this node
161             # TODO : add_slivers valid type of sliver needs to be changed
162             # 13/07/12 SA
163             valid_sliver_types = [
164                 'iotlab-node', 'emulab-openvz', 'raw-pc', 'plab-vserver', 'plab-vnode']
165             #valid_sliver_types = ['emulab-openvz', 'raw-pc', 'plab-vserver', 'plab-vnode']
166             requested_sliver_type = None
167             for sliver_type in node_elem.get('slivers', []):
168                 if sliver_type.get('type') in valid_sliver_types:
169                     requested_sliver_type = sliver_type['type']
170
171             if not requested_sliver_type:
172                 continue
173             sliver = {'type': requested_sliver_type,
174                       'pl_tags': attributes}
175             print("\r\n \r\n \r\n \t\t\t Iotlabv1.PY add_slivers  node_elem %s sliver_type %s \r\n \r\n " % (
176                 node_elem, sliver_type), file=sys.stderr)
177             # remove available element
178             for available_elem in node_elem.xpath('./default:available | ./available'):
179                 node_elem.remove(available_elem)
180
181             # remove interface elements
182             for interface_elem in node_elem.xpath('./default:interface | ./interface'):
183                 node_elem.remove(interface_elem)
184
185             # remove existing sliver_type elements
186             for sliver_type in node_elem.get('slivers', []):
187                 node_elem.element.remove(sliver_type.element)
188
189             # set the client id
190             node_elem.element.set('client_id', hostname)
191             if sliver_urn:
192                 pass
193                 # TODO
194                 # set the sliver id
195                 #slice_id = sliver_info.get('slice_id', -1)
196                 #node_id = sliver_info.get('node_id', -1)
197                 #sliver_id = urn_to_sliver_id(sliver_urn, slice_id, node_id)
198                 #node_elem.set('sliver_id', sliver_id)
199
200             # add the sliver type elemnt
201             Iotlabv1Sliver.add_slivers(node_elem.element, sliver)
202             #Iotlabv1SliverType.add_slivers(node_elem.element, sliver)
203
204         # remove all nodes without slivers
205         if not append:
206             for node_elem in self.get_nodes():
207                 if not node_elem['client_id']:
208                     parent = node_elem.element.getparent()
209                     parent.remove(node_elem.element)
210
211     def remove_slivers(self, slivers, network=None, no_dupes=False):
212         Iotlabv1Node.remove_slivers(self.xml, slivers)
213
214     # Utility
215
216     def merge(self, in_rspec):
217         """
218         Merge contents for specified rspec with current rspec
219         """
220
221         if not in_rspec:
222             return
223
224         from sfa.rspecs.rspec import RSpec
225
226         if isinstance(in_rspec, RSpec):
227             rspec = in_rspec
228         else:
229             rspec = RSpec(in_rspec)
230         if rspec.version.type.lower() == 'protogeni':
231             from sfa.rspecs.rspec_converter import RSpecConverter
232             in_rspec = RSpecConverter.to_sfa_rspec(rspec.toxml())
233             rspec = RSpec(in_rspec)
234         # just copy over all networks
235         # Attention special get_networks using //default:network xpath
236         current_networks = self.get_networks()
237         networks = rspec.version.get_networks()
238         for network in networks:
239             current_network = network.get('name')
240             if current_network and current_network not in current_networks:
241                 self.xml.append(network.element)
242                 current_networks.append(current_network)
243
244     # Leases
245
246     def get_leases(self, lease_filter=None):
247         return SFAv1Lease.get_leases(self.xml, lease_filter)
248         # return Iotlabv1Lease.get_leases(self.xml, lease_filter)
249
250     def add_leases(self, leases, network=None, no_dupes=False):
251         SFAv1Lease.add_leases(self.xml, leases)
252         #Iotlabv1Lease.add_leases(self.xml, leases)
253
254     # Spectrum
255
256     def get_channels(self, filter=None):
257         return []
258
259     def add_channels(self, channels, network=None, no_dupes=False):
260         pass
261
262     # Links
263
264     def get_links(self, network=None):
265         return []
266
267     def get_link_requests(self):
268         return []
269
270     def add_links(self, links):
271         pass
272
273     def add_link_requests(self, links):
274         pass
275
276     def cleanup(self):
277         # remove unncecessary elements, attributes
278         if self.type in ['request', 'manifest']:
279             # remove 'available' element from remaining node elements
280             self.xml.remove_element('//default:available | //available')
281
282
283 class Iotlabv1Ad(Iotlabv1):
284     enabled = True
285     content_type = 'ad'
286     schema = 'http://senslab.info/resources/rspec/1/ad.xsd'
287     # http://www.geni.net/resources/rspec/3/ad.xsd'
288     template = '<rspec type="advertisement" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://senslab.info/resources/rspec/1" xmlns:flack="http://senslab.info/resources/rspec/ext/flack/1" xmlns:planetlab="http://www.planet-lab.org/resources/sfa/ext/planetlab/1" xsi:schemaLocation="http://senslab.info/resources/rspec/1 http://senslab.info/resources/rspec/1/ad.xsd http://www.planet-lab.org/resources/sfa/ext/planetlab/1 http://www.planet-lab.org/resources/sfa/ext/planetlab/1/planetlab.xsd"/>'
289
290
291 class Iotlabv1Request(Iotlabv1):
292     enabled = True
293     content_type = 'request'
294     schema = 'http://senslab.info/resources/rspec/1/request.xsd'
295     # http://www.geni.net/resources/rspec/3/request.xsd
296     template = '<rspec type="request" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://senslab.info/resources/rspec/1" xmlns:flack="http://senslab.info/resources/rspec/ext/flack/1" xmlns:planetlab="http://www.planet-lab.org/resources/sfa/ext/planetlab/1" xsi:schemaLocation="http://senslab.info/resources/rspec/1 http://senslab.info/resources/rspec/1/request.xsd http://www.planet-lab.org/resources/sfa/ext/planetlab/1 http://www.planet-lab.org/resources/sfa/ext/planetlab/1/planetlab.xsd"/>'
297
298
299 class Iotlabv1Manifest(Iotlabv1):
300     enabled = True
301     content_type = 'manifest'
302     schema = 'http://senslab.info/resources/rspec/1/manifest.xsd'
303     # http://www.geni.net/resources/rspec/3/manifest.xsd
304     template = '<rspec type="manifest" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://senslab.info/resources/rspec/1" xmlns:flack="http://senslab.info/resources/rspec/ext/flack/1" xmlns:planetlab="http://www.planet-lab.org/resources/sfa/ext/planetlab/1" xsi:schemaLocation="http://senslab.info/resources/rspec/1 http://senslab.info/resources/rspec/1/manifest.xsd http://www.planet-lab.org/resources/sfa/ext/planetlab/1 http://www.planet-lab.org/resources/sfa/ext/planetlab/1/planetlab.xsd"/>'
305
306
307 if __name__ == '__main__':
308     from sfa.rspecs.rspec import RSpec
309     from sfa.rspecs.rspec_elements import *
310     r = RSpec('/tmp/iotlab.rspec')
311     r.load_rspec_elements(Iotlabv1.elements)
312     r.namespaces = Iotlabv1.namespaces
313     print(r.get(RSpecElements.NODE))