0d39323775a0c15b826318818b156ce270d1c9a8
[sfa.git] / sfa / rspecs / versions / iotlabv1.py
1 from __future__ import print_function
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 " %(hostname), file=sys.stderr)
84         nodes = self.get_nodes({'component_id': '*%s*' %hostname})
85         attribs = []
86         print("\r\n \r\n \r\n \t\t SLABV1.PY  get_sliver_attributes-----------------nodes %s  " %(nodes), file=sys.stderr)
87         if nodes is not None and isinstance(nodes, list) and len(nodes) > 0:
88             node = nodes[0]
89         #if node :
90             #sliver = node.xpath('./default:sliver | ./sliver')
91             #sliver = node.xpath('./default:sliver', namespaces=self.namespaces)
92             sliver = node['slivers']
93
94             if sliver is not None and isinstance(sliver, list) and len(sliver) > 0:
95                 sliver = sliver[0]
96                 attribs = sliver
97                 #attribs = self.attributes_list(sliver)
98                 print("\r\n \r\n \r\n \t\t SLABV1.PY  get_sliver_attributes----------NN------- sliver %s self.namespaces %s attribs %s " %(sliver, self.namespaces,attribs), file=sys.stderr)
99         return attribs
100
101     def get_slice_attributes(self, network=None):
102
103         slice_attributes = []
104
105         nodes_with_slivers = self.get_nodes_with_slivers()
106
107         # TODO: default sliver attributes in the PG rspec?
108         default_ns_prefix = self.namespaces['default']
109         for node in nodes_with_slivers:
110             sliver_attributes = self.get_sliver_attributes(node['component_id'],node, network)
111             for sliver_attribute in sliver_attributes:
112                 name = str(sliver_attribute[0])
113                 text = str(sliver_attribute[1])
114                 attribs = sliver_attribute[2]
115                 # we currently only suppor the <initscript> and <flack> attributes
116                 #if  'info' in name:
117                     #attribute = {'name': 'flack_info', 'value': str(attribs), 'node_id': node}
118                     #slice_attributes.append(attribute)
119                 #elif 'initscript' in name:
120                 if 'initscript' in name:
121                     if attribs is not None and 'name' in attribs:
122                         value = attribs['name']
123                     else:
124                         value = text
125                     attribute = {'name': 'initscript', 'value': value, 'node_id': node}
126                     slice_attributes.append(attribute)
127
128
129         return slice_attributes
130
131     def attributes_list(self, elem):
132         opts = []
133         if elem is not None:
134             for e in elem:
135                 opts.append((e.tag, str(e.text).strip(), e.attrib))
136         return opts
137
138     def get_default_sliver_attributes(self, network=None):
139         return []
140
141     def add_default_sliver_attribute(self, name, value, network=None):
142         pass
143
144     def add_slivers(self, hostnames, attributes=None, sliver_urn=None, append=False):
145         if attributes is None: attributes=[]
146         # all nodes hould already be present in the rspec. Remove all
147         # nodes that done have slivers
148         print("\r\n \r\n \r\n \t\t\t Iotlabv1.PY add_slivers  ----->get_node ", file=sys.stderr)
149         for hostname in hostnames:
150             node_elems = self.get_nodes({'component_id': '*%s*' % hostname})
151             if not node_elems:
152                 continue
153             node_elem = node_elems[0]
154
155             # determine sliver types for this node
156             #TODO : add_slivers valid type of sliver needs to be changed 13/07/12 SA
157             valid_sliver_types = ['iotlab-node', 'emulab-openvz', 'raw-pc', 'plab-vserver', 'plab-vnode']
158             #valid_sliver_types = ['emulab-openvz', 'raw-pc', 'plab-vserver', 'plab-vnode']
159             requested_sliver_type = None
160             for sliver_type in node_elem.get('slivers', []):
161                 if sliver_type.get('type') in valid_sliver_types:
162                     requested_sliver_type = sliver_type['type']
163
164             if not requested_sliver_type:
165                 continue
166             sliver = {'type': requested_sliver_type,
167                      'pl_tags': attributes}
168             print("\r\n \r\n \r\n \t\t\t Iotlabv1.PY add_slivers  node_elem %s sliver_type %s \r\n \r\n " %(node_elem, sliver_type), file=sys.stderr)
169             # remove available element
170             for available_elem in node_elem.xpath('./default:available | ./available'):
171                 node_elem.remove(available_elem)
172
173             # remove interface elements
174             for interface_elem in node_elem.xpath('./default:interface | ./interface'):
175                 node_elem.remove(interface_elem)
176
177             # remove existing sliver_type elements
178             for sliver_type in node_elem.get('slivers', []):
179                 node_elem.element.remove(sliver_type.element)
180
181             # set the client id
182             node_elem.element.set('client_id', hostname)
183             if sliver_urn:
184                 pass
185                 # TODO
186                 # set the sliver id
187                 #slice_id = sliver_info.get('slice_id', -1)
188                 #node_id = sliver_info.get('node_id', -1)
189                 #sliver_id = urn_to_sliver_id(sliver_urn, slice_id, node_id)
190                 #node_elem.set('sliver_id', sliver_id)
191
192             # add the sliver type elemnt
193             Iotlabv1Sliver.add_slivers(node_elem.element, sliver)
194             #Iotlabv1SliverType.add_slivers(node_elem.element, sliver)
195
196         # remove all nodes without slivers
197         if not append:
198             for node_elem in self.get_nodes():
199                 if not node_elem['client_id']:
200                     parent = node_elem.element.getparent()
201                     parent.remove(node_elem.element)
202
203     def remove_slivers(self, slivers, network=None, no_dupes=False):
204         Iotlabv1Node.remove_slivers(self.xml, slivers)
205
206
207     # Utility
208
209     def merge(self, in_rspec):
210         """
211         Merge contents for specified rspec with current rspec
212         """
213
214         if not in_rspec:
215             return
216
217         from sfa.rspecs.rspec import RSpec
218
219         if isinstance(in_rspec, RSpec):
220             rspec = in_rspec
221         else:
222             rspec = RSpec(in_rspec)
223         if rspec.version.type.lower() == 'protogeni':
224             from sfa.rspecs.rspec_converter import RSpecConverter
225             in_rspec = RSpecConverter.to_sfa_rspec(rspec.toxml())
226             rspec = RSpec(in_rspec)
227         # just copy over all networks
228         #Attention special get_networks using //default:network xpath
229         current_networks = self.get_networks()
230         networks = rspec.version.get_networks()
231         for network in networks:
232             current_network = network.get('name')
233             if current_network and current_network not in current_networks:
234                 self.xml.append(network.element)
235                 current_networks.append(current_network)
236
237
238
239
240
241     # Leases
242
243     def get_leases(self, lease_filter=None):
244         return SFAv1Lease.get_leases(self.xml, lease_filter)
245         #return Iotlabv1Lease.get_leases(self.xml, lease_filter)
246
247     def add_leases(self, leases, network = None, no_dupes=False):
248         SFAv1Lease.add_leases(self.xml, leases)
249         #Iotlabv1Lease.add_leases(self.xml, leases)
250
251     # Spectrum
252
253     def get_channels(self, filter=None):
254         return []
255
256     def add_channels(self, channels, network = None, no_dupes=False):
257         pass
258
259     # Links
260
261     def get_links(self, network=None):
262         return []
263
264     def get_link_requests(self):
265         return []
266
267     def add_links(self, links):
268         pass
269     def add_link_requests(self, links):
270         pass
271
272
273     def cleanup(self):
274         # remove unncecessary elements, attributes
275         if self.type in ['request', 'manifest']:
276             # remove 'available' element from remaining node elements
277             self.xml.remove_element('//default:available | //available')
278
279
280 class Iotlabv1Ad(Iotlabv1):
281     enabled = True
282     content_type = 'ad'
283     schema = 'http://senslab.info/resources/rspec/1/ad.xsd'
284     #http://www.geni.net/resources/rspec/3/ad.xsd'
285     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"/>'
286
287 class Iotlabv1Request(Iotlabv1):
288     enabled = True
289     content_type = 'request'
290     schema = 'http://senslab.info/resources/rspec/1/request.xsd'
291     #http://www.geni.net/resources/rspec/3/request.xsd
292     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"/>'
293
294 class Iotlabv1Manifest(Iotlabv1):
295     enabled = True
296     content_type = 'manifest'
297     schema = 'http://senslab.info/resources/rspec/1/manifest.xsd'
298     #http://www.geni.net/resources/rspec/3/manifest.xsd
299     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"/>'
300
301
302 if __name__ == '__main__':
303     from sfa.rspecs.rspec import RSpec
304     from sfa.rspecs.rspec_elements import *
305     r = RSpec('/tmp/iotlab.rspec')
306     r.load_rspec_elements(Iotlabv1.elements)
307     r.namespaces = Iotlabv1.namespaces
308     print(r.get(RSpecElements.NODE))