renamed rspec_version into baseversion after the defined class
[sfa.git] / sfa / rspecs / versions / sfav1.py
1 from copy import deepcopy
2 from lxml import etree
3 from sfa.util.xrn import hrn_to_urn, urn_to_hrn
4 from sfa.util.plxrn import PlXrn
5 from sfa.rspecs.baseversion import BaseVersion
6 from sfa.rspecs.elements.element import Element
7 from sfa.rspecs.elements.versions.pgv2Link import PGv2Link
8 from sfa.rspecs.elements.versions.sfav1Node import SFAv1Node
9
10 class SFAv1(BaseVersion):
11     enabled = True
12     type = 'SFA'
13     content_type = '*'
14     version = '1'
15     schema = None
16     namespace = None
17     extensions = {}
18     namespaces = None
19     elements = [] 
20     template = '<RSpec type="%s"></RSpec>' % type
21
22
23     def get_networks(self):
24         return Element.get_elements(self.xml, '//network', Element)
25
26     def get_nodes(self, network=None):
27         return SFAv1Node.get_nodes(self.xml)
28
29     def get_nodes_with_slivers(self, network = None):
30         return SFAv1Node.get_nodes_with_slivers(self.xml)
31
32     def attributes_list(self, elem):
33         # convert a list of attribute tags into list of tuples
34         # (tagnme, text_value)
35         opts = []
36         if elem is not None:
37             for e in elem:
38                 opts.append((e.tag, str(e.text).strip()))
39         return opts
40
41     def get_default_sliver_attributes(self, network=None):
42         if network:
43             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
44         else:
45             defaults = self.xml.xpath("//sliver_defaults")
46         if isinstance(defaults, list) and defaults:
47             defaults = defaults[0]
48         return self.attributes_list(defaults)
49
50     def get_sliver_attributes(self, hostname, network=None):
51         attributes = []
52         node = self.get_node_element(hostname, network)
53         #sliver = node.find("sliver")
54         slivers = node.xpath('./sliver')
55         if isinstance(slivers, list) and slivers:
56             attributes = self.attributes_list(slivers[0])
57         return attributes
58
59     def get_slice_attributes(self, network=None):
60         slice_attributes = []
61         nodes_with_slivers = self.get_nodes_with_slivers(network)
62         for default_attribute in self.get_default_sliver_attributes(network):
63             attribute = {'name': str(default_attribute[0]), 'value': str(default_attribute[1]), 'node_id': None}
64             slice_attributes.append(attribute)
65         for node in nodes_with_slivers:
66             sliver_attributes = self.get_sliver_attributes(node, network)
67             for sliver_attribute in sliver_attributes:
68                 attribute = {'name': str(sliver_attribute[0]), 'value': str(sliver_attribute[1]), 'node_id': node}
69                 slice_attributes.append(attribute)
70         return slice_attributes
71
72     def get_links(self, network=None):
73         return PGv2Link.get_links(self.xml)
74
75     def get_link_requests(self):
76         return PGv2Link.get_link_requests(self.xml) 
77
78     ##################
79     # Builder
80     ##################
81
82     def add_network(self, network):
83         network_tags = self.xml.xpath('//network[@name="%s"]' % network)
84         if not network_tags:
85             network_tag = etree.SubElement(self.xml.root, 'network', name=network)
86         else:
87             network_tag = network_tags[0]
88         return network_tag
89
90     def add_nodes(self, nodes, network = None, no_dupes=False):
91         SFAv1Node.add_nodes(self.xml, nodes)
92
93     def merge_node(self, source_node_tag, network, no_dupes=False):
94         if no_dupes and self.get_node_element(node['hostname']):
95             # node already exists
96             return
97
98         network_tag = self.add_network(network)
99         network_tag.append(deepcopy(source_node_tag))
100
101     def add_links(self, links):
102         networks = self.get_networks()
103         if len(networks) > 0:
104             xml = networks[0]
105         else:
106             xml = self.xml    
107         PGv2Link.add_links(xml, links)
108
109     def add_link_requests(self, links):
110         PGv2Link.add_link_requests(self.xml, links)
111
112     def add_slivers(self, slivers, network=None, sliver_urn=None, no_dupes=False, append=False):
113         # add slice name to network tag
114         network_tags = self.xml.xpath('//network')
115         if network_tags:
116             network_tag = network_tags[0]
117             network_tag.set('slice', urn_to_hrn(sliver_urn)[0])
118         
119         all_nodes = self.get_nodes()
120         nodes_with_slivers = [sliver['hostname'] for sliver in slivers]
121         nodes_without_slivers = set(all_nodes).difference(nodes_with_slivers)
122         
123         # add slivers
124         for sliver in slivers:
125             node_elem = self.get_node_element(sliver['hostname'], network)
126             if not node_elem: continue
127             sliver_elem = etree.SubElement(node_elem, 'sliver')
128             if 'tags' in sliver:
129                 for tag in sliver['tags']:
130                     etree.SubElement(sliver_elem, tag['tagname']).text = value=tag['value']
131             
132         # remove all nodes without slivers
133         if not append:
134             for node in nodes_without_slivers:
135                 node_elem = self.get_node_element(node)
136                 parent = node_elem.getparent()
137                 parent.remove(node_elem)
138
139     def remove_slivers(self, slivers, network=None, no_dupes=False):
140         SFAv1Node.remove_slivers(self.xml, slivers)
141
142     def add_default_sliver_attribute(self, name, value, network=None):
143         if network:
144             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
145         else:
146             defaults = self.xml.xpath("//sliver_defaults" % network)
147         if not defaults :
148             network_tag = self.xml.xpath("//network[@name='%s']" % network)
149             if isinstance(network_tag, list):
150                 network_tag = network_tag[0]
151             defaults = self.xml.add_element('sliver_defaults', attrs={}, parent=network_tag)
152         elif isinstance(defaults, list):
153             defaults = defaults[0]
154         self.xml.add_attribute(defaults, name, value)
155
156     def add_sliver_attribute(self, hostname, name, value, network=None):
157         node = self.get_node_element(hostname, network)
158         sliver = node.find("sliver")
159         self.xml.add_attribute(sliver, name, value)
160
161     def remove_default_sliver_attribute(self, name, value, network=None):
162         if network:
163             defaults = self.xml.xpath("//network[@name='%s']/sliver_defaults" % network)
164         else:
165             defaults = self.xml.xpath("//sliver_defaults" % network)
166         self.xml.remove_attribute(defaults, name, value)
167
168     def remove_sliver_attribute(self, hostname, name, value, network=None):
169         node = self.get_node_element(hostname, network)
170         sliver = node.find("sliver")
171         self.xml.remove_attribute(sliver, name, value)
172
173     def merge(self, in_rspec):
174         """
175         Merge contents for specified rspec with current rspec
176         """
177
178         from sfa.rspecs.rspec import RSpec
179         if isinstance(in_rspec, RSpec):
180             rspec = in_rspec
181         else:
182             rspec = RSpec(in_rspec)
183         if rspec.version.type.lower() == 'protogeni':
184             from sfa.rspecs.rspec_converter import RSpecConverter
185             in_rspec = RSpecConverter.to_sfa_rspec(rspec.toxml())
186             rspec = RSpec(in_rspec)
187
188         # just copy over all networks
189         current_networks = self.get_networks()
190         networks = rspec.version.get_networks()
191         for network in networks:
192             current_network = network.get('name')
193             if current_network and current_network not in current_networks:
194                 self.xml.root.append(network.element)
195                 current_networks.append(current_network)
196
197 if __name__ == '__main__':
198     from sfa.rspecs.rspec import RSpec
199     from sfa.rspecs.rspec_elements import *
200     r = RSpec('/tmp/resources.rspec')
201     r.load_rspec_elements(SFAv1.elements)
202     print r.get(RSpecElements.NODE)