Merge Master in geni-v3 conflict resolution
[sfa.git] / sfa / senslab / slabaggregate.py
1 import time
2 from sfa.util.xrn import hrn_to_urn, urn_to_hrn, get_authority
3
4 from sfa.rspecs.rspec import RSpec
5 #from sfa.rspecs.elements.location import Location
6 from sfa.rspecs.elements.hardware_type import HardwareType
7 from sfa.rspecs.elements.login import Login
8 from sfa.rspecs.elements.services import Services
9 from sfa.rspecs.elements.sliver import Sliver
10 from sfa.rspecs.elements.lease import Lease
11 from sfa.rspecs.elements.granularity import Granularity
12 from sfa.rspecs.version_manager import VersionManager
13
14
15 from sfa.rspecs.elements.versions.slabv1Node import SlabPosition, SlabNode, \
16                                                             SlabLocation
17 from sfa.util.sfalogging import logger
18
19 from sfa.util.xrn import Xrn
20
21 def slab_xrn_to_hostname(xrn):
22     return Xrn.unescape(Xrn(xrn=xrn, type='node').get_leaf())
23
24 def slab_xrn_object(root_auth, hostname):
25     """Attributes are urn and hrn.
26     Get the hostname using slab_xrn_to_hostname on the urn.
27     
28     """
29     return Xrn('.'.join( [root_auth, Xrn.escape(hostname)]), type='node')
30
31 class SlabAggregate:
32
33     sites = {}
34     nodes = {}
35     api = None
36     interfaces = {}
37     links = {}
38     node_tags = {}
39     
40     prepared = False
41
42     user_options = {}
43     
44     def __init__(self, driver):
45         self.driver = driver
46
47     def get_slice_and_slivers(self, slice_xrn, login=None):
48         """
49         Returns a dict of slivers keyed on the sliver's node_id
50         """
51         slivers = {}
52         sfa_slice = None
53         if not slice_xrn:
54             return (sfa_slice, slivers)
55         slice_urn = hrn_to_urn(slice_xrn, 'slice')
56         slice_hrn, _ = urn_to_hrn(slice_xrn)
57         slice_name = slice_hrn
58
59         slices = self.driver.slab_api.GetSlices(slice_filter= str(slice_name), \
60                                             slice_filter_type = 'slice_hrn', \
61                                             login=login)
62         
63         logger.debug("Slabaggregate api \tget_slice_and_slivers \
64                         sfa_slice %s \r\n slices %s self.driver.hrn %s" \
65                         %(sfa_slice, slices, self.driver.hrn))
66         if not slices:
67             return (sfa_slice, slivers)
68         #if isinstance(sfa_slice, list):
69             #sfa_slice = slices[0]
70         #else:
71             #sfa_slice = slices
72
73         # sort slivers by node id , if there is a job
74         #and therfore, node allocated to this slice
75         for sfa_slice in slices:
76             try:
77                 node_ids_list =  sfa_slice['node_ids']  
78             except KeyError:
79                 logger.log_exc("SLABAGGREGATE \t \
80                                         get_slice_and_slivers KeyError ")
81                 continue
82                                         
83             for node in node_ids_list:
84                 sliver_xrn = Xrn(slice_urn, type='sliver', id=node)
85                 sliver_xrn.set_authority(self.driver.hrn)
86                 sliver = Sliver({'sliver_id':sliver_xrn.urn, 
87                                 'name': sfa_slice['hrn'],
88                                 'type': 'slab-node', 
89                                 'tags': []})
90                 
91                 slivers[node] = sliver
92           
93         
94         #Add default sliver attribute :
95         #connection information for senslab
96         if get_authority (sfa_slice['hrn']) == self.driver.slab_api.root_auth: 
97             tmp = sfa_slice['hrn'].split('.')
98             ldap_username = tmp[1].split('_')[0]
99             ssh_access = None
100             slivers['default_sliver'] =  {'ssh': ssh_access , \
101                                         'login': ldap_username}
102             
103         #TODO get_slice_and_slivers Find the login of the external user
104
105         logger.debug("SLABAGGREGATE api get_slice_and_slivers  slivers %s "\
106                                                              %(slivers))
107         return (slices, slivers)
108             
109
110         
111     def get_nodes(self, slices=None, slivers=[], options={}):
112         # NT: the semantic of this function is not clear to me :
113         # if slice is not defined, then all the nodes should be returned
114         # if slice is defined, we should return only the nodes that 
115         # are part of this slice
116         # but what is the role of the slivers parameter ?
117         # So i assume that slice['node_ids'] will be the same as slivers for us
118         #filter_dict = {}
119         #if slice_xrn:
120             #if not slices or not slices['node_ids']:
121                 #return ([],[])
122         #tags_filter = {}
123         
124         # get the granularity in second for the reservation system
125         grain = self.driver.slab_api.GetLeaseGranularity()
126         
127         # Commenting this part since all nodes should be returned, 
128         # even if a slice is provided
129         #if slice :
130         #    if 'node_ids' in slice and slice['node_ids']:
131         #        #first case, a non empty slice was provided
132         #        filter['hostname'] = slice['node_ids']
133         #        tags_filter=filter.copy()
134         #        nodes = self.driver.slab_api.GetNodes(filter['hostname'])
135         #    else :
136         #        #second case, a slice was provided, but is empty
137         #        nodes={}
138         #else :
139         #    #third case, no slice was provided
140         #    nodes = self.driver.slab_api.GetNodes()
141         nodes = self.driver.slab_api.GetNodes()
142         #geni_available = options.get('geni_available')    
143         #if geni_available:
144             #filter['boot_state'] = 'boot'     
145        
146         #filter.update({'peer_id': None})
147         #nodes = self.driver.slab_api.GetNodes(filter['hostname'])
148         
149         #site_ids = []
150         #interface_ids = []
151         #tag_ids = []
152         nodes_dict = {}
153         for node in nodes:
154            
155             nodes_dict[node['node_id']] = node
156         #logger.debug("SLABAGGREGATE api get_nodes nodes  %s "\
157                                                              #%(nodes ))
158         # get sites
159         #sites_dict  = self.get_sites({'site_id': site_ids}) 
160         # get interfaces
161         #interfaces = self.get_interfaces({'interface_id':interface_ids}) 
162         # get tags
163         #node_tags = self.get_node_tags(tags_filter)
164         
165         #if slices, this means we got to list all the nodes given to this slice
166         # Make a list of all the nodes in the slice before getting their attributes
167         rspec_nodes = []
168         slice_nodes_list = []
169         logger.debug("SLABAGGREGATE api get_nodes slice_nodes_list  %s "\
170                                                              %(slices )) 
171         if slices:
172             for one_slice in slices:
173                 try:
174                     slice_nodes_list = one_slice['node_ids']
175                 except KeyError:
176                     pass
177                 #for node in one_slice['node_ids']:
178                     #slice_nodes_list.append(node)
179                    
180         reserved_nodes = self.driver.slab_api.GetNodesCurrentlyInUse()
181         logger.debug("SLABAGGREGATE api get_nodes slice_nodes_list  %s "\
182                                                              %(slice_nodes_list)) 
183         for node in nodes:
184             # skip whitelisted nodes
185             #if node['slice_ids_whitelist']:
186                 #if not slice or slice['slice_id'] not in node['slice_ids_whitelist']:
187                     #continue
188             #rspec_node = Node()
189             #logger.debug("SLABAGGREGATE api get_nodes node  %s "\
190                                                              #%(node)) 
191             if slice_nodes_list == [] or node['hostname'] in slice_nodes_list:
192                    
193                 rspec_node = SlabNode()
194                 # xxx how to retrieve site['login_base']
195                 #site_id=node['site_id']
196                 #site=sites_dict[site_id]
197
198                 rspec_node['mobile'] = node['mobile']
199                 rspec_node['archi'] = node['archi']
200                 rspec_node['radio'] = node['radio']
201     
202                 slab_xrn = slab_xrn_object(self.driver.slab_api.root_auth, \
203                                                     node['hostname'])
204                 rspec_node['component_id'] = slab_xrn.urn
205                 rspec_node['component_name'] = node['hostname']  
206                 rspec_node['component_manager_id'] = \
207                                 hrn_to_urn(self.driver.slab_api.root_auth, 'authority+sa')
208                 
209                 # Senslab's nodes are federated : there is only one authority 
210                 # for all Senslab sites, registered in SFA.
211                 # Removing the part including the site 
212                 # in authority_id SA 27/07/12
213                 rspec_node['authority_id'] = rspec_node['component_manager_id']  
214     
215                 # do not include boot state (<available> element)
216                 #in the manifest rspec
217                 
218                
219                 rspec_node['boot_state'] = node['boot_state']
220                 if node['hostname'] in reserved_nodes:
221                     rspec_node['boot_state'] = "Reserved"
222                 rspec_node['exclusive'] = 'true'
223                 rspec_node['hardware_types'] = [HardwareType({'name': \
224                                                 'slab-node'})]
225     
226                 # only doing this because protogeni rspec needs
227                 # to advertise available initscripts 
228                 # add site/interface info to nodes.
229                 # assumes that sites, interfaces and tags have already been             
230                 #prepared.
231
232                 location = SlabLocation({'country':'France','site': \
233                                             node['site']})
234                 rspec_node['location'] = location
235
236             
237                 position = SlabPosition()
238                 for field in position :
239                     try:
240                         position[field] = node[field]
241                     except KeyError, error :
242                         logger.log_exc("SLABAGGREGATE\t get_nodes \
243                                                         position %s "%(error))
244     
245                 rspec_node['position'] = position
246                 #rspec_node['interfaces'] = []
247                
248                 # Granularity
249                 granularity = Granularity({'grain': grain})
250                 rspec_node['granularity'] = granularity
251                 rspec_node['tags'] = []
252                 if node['hostname'] in slivers:
253                     # add sliver info
254                     sliver = slivers[node['hostname']]
255                     rspec_node['sliver_id'] = sliver['sliver_id']
256                     rspec_node['client_id'] = node['hostname']
257                     rspec_node['slivers'] = [sliver]
258                     
259                     # slivers always provide the ssh service
260                     login = Login({'authentication': 'ssh-keys', 'hostname': node['hostname'], 'port':'22', 'username': sliver['name']})
261                     service = Services({'login': login})
262                     rspec_node['services'] = [service]
263                 rspec_nodes.append(rspec_node)
264
265         return (rspec_nodes)       
266
267     def get_leases(self, slice_record = None, options = {}):
268     
269         now = int(time.time())
270         lease_filter = {'clip': now }
271
272         #if slice_record:
273             #lease_filter.update({'name': slice_record['name']})
274         return_fields = ['lease_id', 'hostname', 'site_id', \
275                             'name', 'start_time', 'duration']
276         #leases = self.driver.slab_api.GetLeases(lease_filter)
277         leases = self.driver.slab_api.GetLeases()
278         grain = self.driver.slab_api.GetLeaseGranularity()
279         site_ids = []
280         rspec_leases = []
281         for lease in leases:
282             #as many leases as there are nodes in the job 
283             for node in lease['reserved_nodes']: 
284                 rspec_lease = Lease()
285                 rspec_lease['lease_id'] = lease['lease_id']
286                 #site = node['site_id']
287                 slab_xrn = slab_xrn_object(self.driver.slab_api.root_auth, node)
288                 rspec_lease['component_id'] = slab_xrn.urn
289                 #rspec_lease['component_id'] = hostname_to_urn(self.driver.hrn, \
290                                         #site, node['hostname'])
291                 try:
292                     rspec_lease['slice_id'] = lease['slice_id']
293                 except KeyError:
294                     #No info on the slice used in slab_xp table
295                     pass
296                 rspec_lease['start_time'] = lease['t_from']
297                 rspec_lease['duration'] = (lease['t_until'] - lease['t_from']) \
298                                                                     / grain   
299                 rspec_leases.append(rspec_lease)
300         return rspec_leases    
301         
302    
303         #rspec_leases = []
304         #for lease in leases:
305        
306             #rspec_lease = Lease()
307             
308             ## xxx how to retrieve site['login_base']
309
310             #rspec_lease['lease_id'] = lease['lease_id']
311             #rspec_lease['component_id'] = hostname_to_urn(self.driver.hrn, \
312                                         #site['login_base'], lease['hostname'])
313             #slice_hrn = slicename_to_hrn(self.driver.hrn, lease['name'])
314             #slice_urn = hrn_to_urn(slice_hrn, 'slice')
315             #rspec_lease['slice_id'] = slice_urn
316             #rspec_lease['t_from'] = lease['t_from']
317             #rspec_lease['t_until'] = lease['t_until']          
318             #rspec_leases.append(rspec_lease)
319         #return rspec_leases   
320 #from plc/aggregate.py 
321     def get_rspec(self, slice_xrn=None, login=None, version = None, options={}):
322
323         rspec = None
324         version_manager = VersionManager()      
325         version = version_manager.get_version(version)
326         logger.debug("SlabAggregate \t get_rspec ***version %s \
327                     version.type %s  version.version %s options %s \r\n" \
328                     %(version,version.type,version.version,options))
329
330         if not slice_xrn:
331             rspec_version = version_manager._get_version(version.type, \
332                                                     version.version, 'ad')
333
334         else:
335             rspec_version = version_manager._get_version(version.type, \
336                                                 version.version, 'manifest')
337            
338         slices, slivers = self.get_slice_and_slivers(slice_xrn, login)
339         #at this point sliver may be empty if no senslab job 
340         #is running for this user/slice.
341         rspec = RSpec(version=rspec_version, user_options=options)
342
343         
344         #if slice and 'expires' in slice:
345            #rspec.xml.set('expires',  datetime_to_epoch(slice['expires']))
346          # add sliver defaults
347         #nodes, links = self.get_nodes(slice, slivers)
348         logger.debug("\r\n \r\n SlabAggregate \tget_rspec ******* slice_xrn %s slices  %s\r\n \r\n"\
349                                             %(slice_xrn, slices)) 
350                                             
351         try:                                    
352             lease_option = options['list_leases']
353         except KeyError:
354             #If no options are specified, at least print the resources
355             lease_option = 'all'
356            #if slice_xrn :
357                #lease_option = 'all'
358             pass 
359         
360         if lease_option in ['all', 'resources']:
361         #if not options.get('list_leases') or options.get('list_leases') and options['list_leases'] != 'leases':
362             nodes = self.get_nodes(slices, slivers) 
363             logger.debug("\r\n \r\n SlabAggregate \ lease_option %s get rspec  ******* nodes %s"\
364                                             %(lease_option, nodes[0]))
365
366             sites_set = set([node['location']['site'] for node in nodes] )    
367
368             #In case creating a job,  slice_xrn is not set to None
369             rspec.version.add_nodes(nodes)
370             if slice_xrn :
371                 #Get user associated with this slice
372                 #user = dbsession.query(RegRecord).filter_by(record_id = \
373                                                 #slices['record_id_user']).first()
374
375                 #ldap_username = (user.hrn).split('.')[1]
376                 
377                 
378                 #for one_slice in slices :
379                 ldap_username = slices[0]['hrn']
380                 tmp = ldap_username.split('.')
381                 ldap_username = tmp[1].split('_')[0]
382               
383                 if version.type == "Slab":
384                     rspec.version.add_connection_information(ldap_username, sites_set)
385
386             default_sliver = slivers.get('default_sliver', [])
387             if default_sliver:
388                 #default_sliver_attribs = default_sliver.get('tags', [])
389                 logger.debug("SlabAggregate \tget_rspec **** \
390                         default_sliver%s \r\n" %(default_sliver))
391                 for attrib in default_sliver:
392                     rspec.version.add_default_sliver_attribute(attrib, \
393                                                                default_sliver[attrib])  
394         if lease_option in ['all','leases']:                                                         
395         #if options.get('list_leases') or options.get('list_leases') and options['list_leases'] != 'resources':
396             leases = self.get_leases(slices)
397             rspec.version.add_leases(leases)
398             
399         #logger.debug("SlabAggregate \tget_rspec ******* rspec_toxml %s \r\n"\
400                                             #%(rspec.toxml())) 
401         return rspec.toxml()