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