This function is needed to cache the results of API calls, which for a godforsaken...
[plcapi.git] / PLC / Methods / GetSlivers.py
index ca410ef..d54784d 100644 (file)
@@ -18,11 +18,16 @@ from PLC.Roles import Roles
 from PLC.Keys import Key, Keys
 from PLC.SliceTags import SliceTag, SliceTags
 from PLC.InitScripts import InitScript, InitScripts
+from PLC.Leases import Lease, Leases
+from PLC.Timestamp import Duration
 from PLC.Methods.GetSliceFamily import GetSliceFamily
 
+from PLC.Accessors.Accessors_standard import *
+
 # XXX used to check if slice expiration time is sane
 MAXINT =  2L**31-1
 
+# slice_filter essentially contains the slice_ids for the relevant slices (on the node + system & delegated slices)
 def get_slivers(api, auth, slice_filter, node = None):
     # Get slice information
     slices = Slices(api, slice_filter, ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids'])
@@ -73,7 +78,7 @@ def get_slivers(api, auth, slice_filter, node = None):
         # Per-node sliver attributes take precedence over global
         # slice attributes, so set them first.
         # Then comes nodegroup slice attributes
-       # Followed by global slice attributes
+        # Followed by global slice attributes
         sliver_attributes = []
 
         if node is not None:
@@ -82,14 +87,14 @@ def get_slivers(api, auth, slice_filter, node = None):
                 attributes.append({'tagname': sliver_attribute['tagname'],
                                    'value': sliver_attribute['value']})
 
-           # set nodegroup slice attributes
-           for slice_tag in [ a for a in slice_tags if a['nodegroup_id'] in node['nodegroup_ids'] ]:
-               # Do not set any nodegroup slice attributes for
+            # set nodegroup slice attributes
+            for slice_tag in [ a for a in slice_tags if a['nodegroup_id'] in node['nodegroup_ids'] ]:
+                # Do not set any nodegroup slice attributes for
                 # which there is at least one sliver attribute
                 # already set.
-               if slice_tag not in slice_tags:
-                   attributes.append({'tagname': slice_tag['tagname'],
-                                  'value': slice_tag['value']})
+                if slice_tag not in slice_tags:
+                    attributes.append({'tagname': slice_tag['tagname'],
+                                   'value': slice_tag['value']})
 
         for slice_tag in [ a for a in slice_tags if a['node_id'] is None ]:
             # Do not set any global slice attributes for
@@ -118,6 +123,24 @@ def get_slivers(api, auth, slice_filter, node = None):
 
     return slivers
 
+### The pickle module, used in conjunction with caching has a restriction that it does not
+### work on "connection objects." It doesn't matter if the connection object has
+### an 'str' or 'repr' method, there is a taint check that throws an exception if
+### the pickled class is found to derive from a connection.
+### (To be moved to Method.py)
+
+def sanitize_for_pickle (obj):
+    if (isinstance(obj, dict)):
+        parent = dict(obj)
+        for k in parent.keys(): parent[k] = sanitize_for_pickle (parent[k])
+        return parent
+    elif (isinstance(obj, list)):
+        parent = list(obj)
+        parent = map(sanitize_for_pickle, parent)
+        return parent
+    else:
+        return obj
+
 class GetSlivers(Method):
     """
     Returns a struct containing information about the specified node
@@ -145,7 +168,7 @@ class GetSlivers(Method):
         'interfaces': [Interface.fields],
         'groups': [NodeGroup.fields['groupname']],
         'conf_files': [ConfFile.fields],
-       'initscripts': [InitScript.fields],
+        'initscripts': [InitScript.fields],
         'accounts': [{
             'name': Parameter(str, "unix style account name", max = 254),
             'keys': [{
@@ -167,10 +190,20 @@ class GetSlivers(Method):
                 'value': SliceTag.fields['value']
             }]
         }],
+        # how to reach the xmpp server
         'xmpp': {'server':Parameter(str,"hostname for the XMPP server"),
                  'user':Parameter(str,"username for the XMPP server"),
                  'password':Parameter(str,"username for the XMPP server"),
                  },
+        # we consider three policies (reservation-policy)
+        # none : the traditional way to use a node
+        # lease_or_idle : 0 or 1 slice runs at a given time
+        # lease_or_shared : 1 slice is running during a lease, otherwise all the slices come back
+        'reservation_policy': Parameter(str,"one among none, lease_or_idle, lease_or_shared"),
+        'leases': [  { 'slice_id' : Lease.fields['slice_id'],
+                       't_from' : Lease.fields['t_from'],
+                       't_until' : Lease.fields['t_until'],
+                       }],
     }
 
     def call(self, auth, node_id_or_hostname = None):
@@ -208,7 +241,7 @@ class GetSlivers(Method):
         for conf_file in all_conf_files.values():
             if not conf_file['node_ids'] and not conf_file['nodegroup_ids']:
                 conf_files[conf_file['dest']] = conf_file
-        
+
         # Node group configuration files take precedence over global
         # ones. If a node belongs to multiple node groups for which
         # the same configuration file is defined, it is undefined
@@ -218,28 +251,28 @@ class GetSlivers(Method):
                 if conf_file_id in all_conf_files:
                     conf_file = all_conf_files[conf_file_id]
                     conf_files[conf_file['dest']] = conf_file
-        
+
         # Node configuration files take precedence over node group
         # configuration files.
         for conf_file_id in node['conf_file_ids']:
             if conf_file_id in all_conf_files:
                 conf_file = all_conf_files[conf_file_id]
-                conf_files[conf_file['dest']] = conf_file            
+                conf_files[conf_file['dest']] = conf_file
 
-       # Get all (enabled) initscripts
-       initscripts = InitScripts(self.api, {'enabled': True})  
+        # Get all (enabled) initscripts
+        initscripts = InitScripts(self.api, {'enabled': True})
 
         # Get system slices
         system_slice_tags = SliceTags(self.api, {'tagname': 'system', 'value': '1'}).dict('slice_id')
         system_slice_ids = system_slice_tags.keys()
-       
-       # Get nm-controller slices
+
+        # Get nm-controller slices
         # xxx Thierry: should these really be exposed regardless of their mapping to nodes ?
-       controller_and_delegated_slices = Slices(self.api, {'instantiation': ['nm-controller', 'delegated']}, ['slice_id']).dict('slice_id')
-       controller_and_delegated_slice_ids = controller_and_delegated_slices.keys()
-       slice_ids = system_slice_ids + controller_and_delegated_slice_ids + node['slice_ids']
+        controller_and_delegated_slices = Slices(self.api, {'instantiation': ['nm-controller', 'delegated']}, ['slice_id']).dict('slice_id')
+        controller_and_delegated_slice_ids = controller_and_delegated_slices.keys()
+        slice_ids = system_slice_ids + controller_and_delegated_slice_ids + node['slice_ids']
 
-       slivers = get_slivers(self.api, auth, slice_ids, node)
+        slivers = get_slivers(self.api, auth, slice_ids, node)
 
         # get the special accounts and keys needed for the node
         # root
@@ -256,19 +289,19 @@ class GetSlivers(Method):
         # power users are pis and techs
         def get_site_power_user_keys(api,site_id_or_name):
             site = Sites (api,site_id_or_name,['person_ids'])[0]
-            key_ids = reduce (reduce_flatten_list, 
+            key_ids = reduce (reduce_flatten_list,
                               [ p['key_ids'] for p in \
-                                    Persons(api,{ 'person_id':site['person_ids'], 
-                                                  'enabled':True, '|role_ids' : [20, 40] }, 
+                                    Persons(api,{ 'person_id':site['person_ids'],
+                                                  'enabled':True, '|role_ids' : [20, 40] },
                                             ['key_ids']) ],
                               [])
             return [ key['key'] for key in Keys (api, key_ids) if key['key_type']=='ssh']
 
         # all admins regardless of their site
         def get_all_admin_keys(api):
-            key_ids = reduce (reduce_flatten_list, 
+            key_ids = reduce (reduce_flatten_list,
                               [ p['key_ids'] for p in \
-                                    Persons(api, {'peer_id':None, 'enabled':True, '|role_ids':[10] }, 
+                                    Persons(api, {'peer_id':None, 'enabled':True, '|role_ids':[10] },
                                             ['key_ids']) ],
                               [])
             return [ key['key'] for key in Keys (api, key_ids) if key['key_type']=='ssh']
@@ -281,9 +314,9 @@ class GetSlivers(Method):
         personsitekeys=get_all_admin_keys(self.api)
         accounts.append({'name':'root','keys':personsitekeys})
 
-       node.update_last_contact()
+        hrn = GetNodeHrn(self.api).call(auth,node['node_id'])
 
-        # XMPP config
+        # XMPP config for omf federation
         try:
             if not self.api.config.PLC_OMF_ENABLED:
                 raise Exception,"OMF disabled"
@@ -293,6 +326,25 @@ class GetSlivers(Method):
                   }
         except:
             xmpp={'server':None,'user':None,'password':None}
+
+        node.update_last_contact()
+
+        # expose leases & reservation policy
+        # in a first implementation we only support none and lease_or_idle
+        lease_exposed_fields = [ 'slice_id', 't_from', 't_until', 'name', ]
+        leases=None
+        if node['node_type'] != 'reservable':
+            reservation_policy='none'
+        else:
+            reservation_policy='lease_or_idle'
+            # expose the leases for the next 24 hours
+            leases = [ dict ( [ (k,l[k]) for k in lease_exposed_fields ] )
+                       for l in Leases (self.api, {'node_id':node['node_id'],
+                                                   'clip': (timestamp, timestamp+24*Duration.HOUR),
+                                                   '-SORT': 't_from',
+                                                   }) ]
+        granularity=self.api.config.PLC_RESERVATION_GRANULARITY
+
         return {
             'timestamp': timestamp,
             'node_id': node['node_id'],
@@ -300,8 +352,12 @@ class GetSlivers(Method):
             'interfaces': interfaces,
             'groups': groups,
             'conf_files': conf_files.values(),
-           'initscripts': initscripts,
+            'initscripts': initscripts,
             'slivers': slivers,
             'accounts': accounts,
             'xmpp':xmpp,
+            'hrn':hrn,
+            'reservation_policy': reservation_policy,
+            'leases':leases,
+            'lease_granularity': granularity,
             }