Provision requires the geni_rspec_version option
[sfa.git] / sfa / managers / aggregate_manager.py
1 import socket
2 from sfa.rspecs.version_manager import VersionManager
3 from sfa.util.version import version_core
4 from sfa.util.xrn import Xrn
5 from sfa.util.callids import Callids
6 from sfa.util.sfalogging import logger
7 from sfa.util.faults import SfaInvalidArgument, InvalidRSpecVersion
8
9
10 class AggregateManager:
11
12     def __init__ (self, config): pass
13     
14     # essentially a union of the core version, the generic version (this code) and
15     # whatever the driver needs to expose
16
17     def rspec_versions(self):
18         version_manager = VersionManager()
19         ad_rspec_versions = []
20         request_rspec_versions = []
21         for rspec_version in version_manager.versions:
22             if rspec_version.content_type in ['*', 'ad']:
23                 ad_rspec_versions.append(rspec_version.to_dict())
24             if rspec_version.content_type in ['*', 'request']:
25                 request_rspec_versions.append(rspec_version.to_dict())
26         return {
27             'geni_request_rspec_versions': request_rspec_versions,
28             'geni_ad_rspec_versions': ad_rspec_versions,
29             }
30
31     def get_rspec_version_string(self, rspec_version, options={}):
32         version_string = "rspec_%s" % (rspec_version)
33
34         #panos adding the info option to the caching key (can be improved)
35         if options.get('info'):
36             version_string = version_string + "_"+options.get('info', 'default')
37
38         # Adding the list_leases option to the caching key
39         if options.get('list_leases'):
40             version_string = version_string + "_"+options.get('list_leases', 'default')
41
42         # Adding geni_available to caching key
43         if options.get('geni_available'):
44             version_string = version_string + "_" + str(options.get('geni_available'))
45
46         return version_string
47
48     def GetVersion(self, api, options):
49         xrn=Xrn(api.hrn, type='authority')
50         version = version_core()
51         cred_types = [{'geni_type': 'geni_sfa', 'geni_version': str(i)} for i in range(4)[-2:]]
52         version_generic = {
53             'testbed': self.driver.testbed_name(),
54             'interface':'aggregate',
55             'hrn':xrn.get_hrn(),
56             'urn':xrn.get_urn(),
57             'geni_api': 3,
58             'geni_api_versions': {'3': 'http://%s:%s' % (socket.gethostname(), api.config.sfa_aggregate_port)},
59             'geni_single_allocation': 0, # Accept operations that act on as subset of slivers in a given state.
60             'geni_allocate': 'geni_many',# Multiple slivers can exist and be incrementally added, including those which connect or overlap in some way.
61             'geni_best_effort': 'true',
62             'geni_credential_types': cred_types,
63         }
64         version.update(version_generic)
65         version.update(self.rspec_versions())
66         testbed_version = self.driver.aggregate_version()
67         version.update(testbed_version)
68         return version
69     
70     def ListResources(self, api, creds, options):
71         call_id = options.get('call_id')
72         if Callids().already_handled(call_id): return ""
73
74         # get the rspec's return format from options
75         version_manager = VersionManager()
76         rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
77         version_string = self.get_rspec_version_string(rspec_version, options)
78
79         # look in cache first
80         cached_requested = options.get('cached', True)
81         if cached_requested and self.driver.cache:
82             rspec = self.driver.cache.get(version_string)
83             if rspec:
84                 logger.debug("%s.ListResources returning cached advertisement" % (self.driver.__module__))
85                 return rspec
86        
87         rspec = self.driver.list_resources (rspec_version, options) 
88         if self.driver.cache:
89             logger.debug("%s.ListResources stores advertisement in cache" % (self.driver.__module__))
90             self.driver.cache.add(version_string, rspec)    
91         return rspec
92     
93     def Describe(self, api, creds, urns, options):
94         call_id = options.get('call_id')
95         if Callids().already_handled(call_id): return ""
96
97         version_manager = VersionManager()
98         rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
99         return self.driver.describe(urns, rspec_version, options)
100         
101     
102     def Status (self, api, urns, creds, options):
103         call_id = options.get('call_id')
104         if Callids().already_handled(call_id): return {}
105         return self.driver.status (urns, options=options)
106    
107
108     def Allocate(self, api, xrn, creds, rspec_string, options):
109         """
110         Allocate resources as described in a request RSpec argument 
111         to a slice with the named URN.
112         """
113         call_id = options.get('call_id')
114         if Callids().already_handled(call_id): return ""
115         return self.driver.allocate(xrn, rspec_string, options)
116  
117     def Provision(self, api, xrns, creds, options):
118         """
119         Create the sliver[s] (slice) at this aggregate.    
120         Verify HRN and initialize the slice record in PLC if necessary.
121         """
122         call_id = options.get('call_id')
123         if Callids().already_handled(call_id): return ""
124
125         # make sure geni_rspec_version is specified in options
126         if 'geni_rspec_version' not in options:
127             msg = 'geni_rspec_version is required and must be set in options struct'
128             raise SfaInvalidArgument(msg, 'geni_rspec_version')
129         # make sure we support the requested rspec version
130         version_manager = VersionManager()
131         rspec_version = version_manager.get_version(options['geni_rspec_version']) 
132         if not rspec_version:
133             raise InvalidRSpecVersion(options['geni_rspec_version'])
134                        
135         return self.driver.provision(xrns, options)
136     
137     def Delete(self, api, xrns, creds, options):
138         call_id = options.get('call_id')
139         if Callids().already_handled(call_id): return True
140         return self.driver.delete(xrns, options)
141
142     def Renew(self, api, xrns, creds, expiration_time, options):
143         call_id = options.get('call_id')
144         if Callids().already_handled(call_id): return True
145         return self.driver.renew(xrns, expiration_time, options)
146
147     def PerformOperationalAction(self, api, xrns, creds, action, options={}):
148         call_id = options.get('call_id')
149         if Callids().already_handled(call_id): return True
150         return self.driver.perform_operational_action(xrns, action, options) 
151
152     def Shutdown(self, api, xrn, creds, options={}):
153         call_id = options.get('call_id')
154         if Callids().already_handled(call_id): return True
155         return self.driver.shutdown(xrn, options) 
156