better support for reporting available api versions
[sfa.git] / sfa / managers / aggregate_manager.py
index 458d46b..6893131 100644 (file)
@@ -1,9 +1,12 @@
-import soctet
+import socket
 from sfa.rspecs.version_manager import VersionManager
 from sfa.util.version import version_core
 from sfa.util.xrn import Xrn
 from sfa.util.callids import Callids
 from sfa.util.sfalogging import logger
+from sfa.util.faults import SfaInvalidArgument, InvalidRSpecVersion
+from sfa.server.api_versions import ApiVersions
+
 
 class AggregateManager:
 
@@ -12,7 +15,7 @@ class AggregateManager:
     # essentially a union of the core version, the generic version (this code) and
     # whatever the driver needs to expose
 
-    def _rspec_versions(self):
+    def rspec_versions(self):
         version_manager = VersionManager()
         ad_rspec_versions = []
         request_rspec_versions = []
@@ -22,162 +25,134 @@ class AggregateManager:
             if rspec_version.content_type in ['*', 'request']:
                 request_rspec_versions.append(rspec_version.to_dict())
         return {
-            'testbed':self.testbed_name(),
             'geni_request_rspec_versions': request_rspec_versions,
             'geni_ad_rspec_versions': ad_rspec_versions,
             }
 
+    def get_rspec_version_string(self, rspec_version, options={}):
+        version_string = "rspec_%s" % (rspec_version)
+
+        #panos adding the info option to the caching key (can be improved)
+        if options.get('info'):
+            version_string = version_string + "_"+options.get('info', 'default')
+
+        # Adding the list_leases option to the caching key
+        if options.get('list_leases'):
+            version_string = version_string + "_"+options.get('list_leases', 'default')
+
+        # Adding geni_available to caching key
+        if options.get('geni_available'):
+            version_string = version_string + "_" + str(options.get('geni_available'))
+
+        return version_string
+
     def GetVersion(self, api, options):
-        xrn=Xrn(api.hrn)
+        xrn=Xrn(api.hrn, type='authority')
         version = version_core()
+        cred_types = [{'geni_type': 'geni_sfa', 'geni_version': str(i)} for i in range(4)[-2:]]
+        geni_api_versions = ApiVersions().get_versions()
+        geni_api_versions.append({'3': 'http://%s:%s' % (socket.gethostname(), api.config.sfa_aggregate_port)})
         version_generic = {
             'testbed': self.driver.testbed_name(),
             'interface':'aggregate',
             'hrn':xrn.get_hrn(),
             'urn':xrn.get_urn(),
             'geni_api': 3,
-            'geni_api_versions': {'3': 'http://%s:%s' % (socket.gethostname(), api.config.sfa_aggregate_port)},
+            'geni_api_versions': geni_api_versions,
             'geni_single_allocation': 0, # Accept operations that act on as subset of slivers in a given state.
             'geni_allocate': 'geni_many',# Multiple slivers can exist and be incrementally added, including those which connect or overlap in some way.
-            'geni_best_effort': 'true',
-            'geni_credential_types': [{
-                'geni_type': 'geni_sfa',
-                'geni_version': 3,
-            }],
+            'geni_credential_types': cred_types,
         }
         version.update(version_generic)
+        version.update(self.rspec_versions())
         testbed_version = self.driver.aggregate_version()
         version.update(testbed_version)
         return version
     
-    def ListSlices(self, api, creds, options):
-        call_id = options.get('call_id')
-        if Callids().already_handled(call_id): return []
-        
-        # look in cache first
-        if self.driver.cache:
-            slices = self.driver.cache.get('slices')
-            if slices:
-                logger.debug("%s.list_slices returns from cache" % (self.driver.__module__))
-                return slices
-
-        # call driver
-        slices = self.driver.list_slices(creds, options)
-
-        # cache the result
-        if self.driver.cache:
-            logger.debug ("%s.list_slices stores value in cache" % (self.driver.__module__))
-            self.driver.cache.add('slices', instance_urns)
-
-        return self.driver.list_slices (creds, options)
-
     def ListResources(self, api, creds, options):
         call_id = options.get('call_id')
         if Callids().already_handled(call_id): return ""
 
-        version_manager = VersionManager()
         # get the rspec's return format from options
+        version_manager = VersionManager()
         rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
-        version_string = "rspec_%s" % (rspec_version)
-
-        #panos adding the info option to the caching key (can be improved)
-        if options.get('info'):
-            version_string = version_string + "_"+options.get('info', 'default')
-
-        # Adding the list_leases option to the caching key
-        if options.get('list_leases'):
-            version_string = version_string + "_"+options.get('list_leases', 'default')
-
-        # Adding geni_available to caching key
-        if options.get('geni_available'):
-            version_string = version_string + "_" + str(options.get('geni_available'))
+        version_string = self.get_rspec_version_string(rspec_version, options)
 
         # look in cache first
         cached_requested = options.get('cached', True)
-        if cached_requested and self.driver.cache and not slice_hrn:
+        if cached_requested and self.driver.cache:
             rspec = self.driver.cache.get(version_string)
             if rspec:
                 logger.debug("%s.ListResources returning cached advertisement" % (self.driver.__module__))
                 return rspec
        
-        rspec = self.driver.list_resources (creds, options) 
+        rspec = self.driver.list_resources (rspec_version, options) 
         if self.driver.cache:
             logger.debug("%s.ListResources stores advertisement in cache" % (self.driver.__module__))
             self.driver.cache.add(version_string, rspec)    
-        return self.driver.list_resources (creds, options)
+        return rspec
     
     def Describe(self, api, creds, urns, options):
         call_id = options.get('call_id')
         if Callids().already_handled(call_id): return ""
 
-        return self.driver.describe (creds, urns, options)
+        version_manager = VersionManager()
+        rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
+        return self.driver.describe(urns, rspec_version, options)
         
     
-    def SliverStatus (self, api, xrn, creds, options):
+    def Status (self, api, urns, creds, options):
         call_id = options.get('call_id')
         if Callids().already_handled(call_id): return {}
-    
-        xrn = Xrn(xrn,'slice')
-        slice_urn=xrn.get_urn()
-        slice_hrn=xrn.get_hrn()
-        return self.driver.sliver_status (slice_urn, slice_hrn)
-    
-    def CreateSliver(self, api, xrn, creds, rspec_string, users, options):
+        return self.driver.status (urns, options=options)
+   
+
+    def Allocate(self, api, xrn, creds, rspec_string, expiration, options):
+        """
+        Allocate resources as described in a request RSpec argument 
+        to a slice with the named URN.
+        """
+        call_id = options.get('call_id')
+        if Callids().already_handled(call_id): return ""
+        return self.driver.allocate(xrn, rspec_string, expiration, options)
+    def Provision(self, api, xrns, creds, options):
         """
         Create the sliver[s] (slice) at this aggregate.    
         Verify HRN and initialize the slice record in PLC if necessary.
         """
         call_id = options.get('call_id')
         if Callids().already_handled(call_id): return ""
-    
-        xrn = Xrn(xrn, 'slice')
-        slice_urn=xrn.get_urn()
-        slice_hrn=xrn.get_hrn()
 
-        return self.driver.create_sliver (slice_urn, slice_hrn, creds, rspec_string, users, options)
+        # make sure geni_rspec_version is specified in options
+        if 'geni_rspec_version' not in options:
+            msg = 'geni_rspec_version is required and must be set in options struct'
+            raise SfaInvalidArgument(msg, 'geni_rspec_version')
+        # make sure we support the requested rspec version
+        version_manager = VersionManager()
+        rspec_version = version_manager.get_version(options['geni_rspec_version']) 
+        if not rspec_version:
+            raise InvalidRSpecVersion(options['geni_rspec_version'])
+                       
+        return self.driver.provision(xrns, options)
     
-    def DeleteSliver(self, api, xrn, creds, options):
+    def Delete(self, api, xrns, creds, options):
         call_id = options.get('call_id')
         if Callids().already_handled(call_id): return True
+        return self.driver.delete(xrns, options)
 
-        xrn = Xrn(xrn, 'slice')
-        slice_urn=xrn.get_urn()
-        slice_hrn=xrn.get_hrn()
-        return self.driver.delete_sliver (slice_urn, slice_hrn, creds, options)
-
-    def RenewSliver(self, api, xrn, creds, expiration_time, options):
+    def Renew(self, api, xrns, creds, expiration_time, options):
         call_id = options.get('call_id')
         if Callids().already_handled(call_id): return True
-        
-        xrn = Xrn(xrn, 'slice')
-        slice_urn=xrn.get_urn()
-        slice_hrn=xrn.get_hrn()
-        return self.driver.renew_sliver (slice_urn, slice_hrn, creds, expiration_time, options)
-    
-    ### these methods could use an options extension for at least call_id
-    def start_slice(self, api, xrn, creds):
-        xrn = Xrn(xrn)
-        slice_urn=xrn.get_urn()
-        slice_hrn=xrn.get_hrn()
-        return self.driver.start_slice (slice_urn, slice_hrn, creds)
-     
-    def stop_slice(self, api, xrn, creds):
-        xrn = Xrn(xrn)
-        slice_urn=xrn.get_urn()
-        slice_hrn=xrn.get_hrn()
-        return self.driver.stop_slice (slice_urn, slice_hrn, creds)
-
-    def reset_slice(self, api, xrn):
-        xrn = Xrn(xrn)
-        slice_urn=xrn.get_urn()
-        slice_hrn=xrn.get_hrn()
-        return self.driver.reset_slice (slice_urn, slice_hrn)
-
-    def GetTicket(self, api, xrn, creds, rspec, users, options):
-    
-        xrn = Xrn(xrn)
-        slice_urn=xrn.get_urn()
-        slice_hrn=xrn.get_hrn()
+        return self.driver.renew(xrns, expiration_time, options)
 
-        return self.driver.get_ticket (slice_urn, slice_hrn, creds, rspec, options)
+    def PerformOperationalAction(self, api, xrns, creds, action, options={}):
+        call_id = options.get('call_id')
+        if Callids().already_handled(call_id): return True
+        return self.driver.perform_operational_action(xrns, action, options) 
 
+    def Shutdown(self, api, xrn, creds, options={}):
+        call_id = options.get('call_id')
+        if Callids().already_handled(call_id): return True
+        return self.driver.shutdown(xrn, options) 
+