From c6ea206bf81830ce949f33bde928226435c99f4b Mon Sep 17 00:00:00 2001 From: Brian Waldon Date: Thu, 15 Dec 2011 00:55:00 -0500 Subject: Creating mechanism that loads Admin API extensions Related to blueprint separate-nova-adminapi Change-Id: I2491267e370f053b5ae4e844aba1d82c3b0f0d86 --- nova/api/openstack/v2/contrib/admin_actions.py | 13 ++------- nova/api/openstack/v2/contrib/extended_status.py | 15 +++++----- nova/api/openstack/v2/contrib/hosts.py | 7 ++--- .../openstack/v2/contrib/simple_tenant_usage.py | 8 ++---- nova/api/openstack/v2/extensions.py | 33 +++++++++------------- 5 files changed, 28 insertions(+), 48 deletions(-) (limited to 'nova/api') diff --git a/nova/api/openstack/v2/contrib/admin_actions.py b/nova/api/openstack/v2/contrib/admin_actions.py index 632a8dc0e..46a4ec6f0 100644 --- a/nova/api/openstack/v2/contrib/admin_actions.py +++ b/nova/api/openstack/v2/contrib/admin_actions.py @@ -12,8 +12,6 @@ # License for the specific language governing permissions and limitations # under the License. -"""The rescue mode extension.""" - import traceback import webob @@ -40,12 +38,12 @@ class Admin_actions(extensions.ExtensionDescriptor): alias = "os-admin-actions" namespace = "http://docs.openstack.org/ext/admin-actions/api/v1.1" updated = "2011-09-20T00:00:00+00:00" + admin_only = True def __init__(self, ext_mgr): super(Admin_actions, self).__init__(ext_mgr) self.compute_api = compute.API() - @extensions.admin_only @exception.novaclient_converter @scheduler_api.redirect_handler def _pause(self, input_dict, req, id): @@ -60,7 +58,6 @@ class Admin_actions(extensions.ExtensionDescriptor): raise exc.HTTPUnprocessableEntity() return webob.Response(status_int=202) - @extensions.admin_only @exception.novaclient_converter @scheduler_api.redirect_handler def _unpause(self, input_dict, req, id): @@ -75,7 +72,6 @@ class Admin_actions(extensions.ExtensionDescriptor): raise exc.HTTPUnprocessableEntity() return webob.Response(status_int=202) - @extensions.admin_only @exception.novaclient_converter @scheduler_api.redirect_handler def _suspend(self, input_dict, req, id): @@ -90,7 +86,6 @@ class Admin_actions(extensions.ExtensionDescriptor): raise exc.HTTPUnprocessableEntity() return webob.Response(status_int=202) - @extensions.admin_only @exception.novaclient_converter @scheduler_api.redirect_handler def _resume(self, input_dict, req, id): @@ -105,7 +100,6 @@ class Admin_actions(extensions.ExtensionDescriptor): raise exc.HTTPUnprocessableEntity() return webob.Response(status_int=202) - @extensions.admin_only @exception.novaclient_converter @scheduler_api.redirect_handler def _migrate(self, input_dict, req, id): @@ -117,7 +111,6 @@ class Admin_actions(extensions.ExtensionDescriptor): raise exc.HTTPBadRequest() return webob.Response(status_int=202) - @extensions.admin_only @exception.novaclient_converter @scheduler_api.redirect_handler def _reset_network(self, input_dict, req, id): @@ -132,7 +125,6 @@ class Admin_actions(extensions.ExtensionDescriptor): raise exc.HTTPUnprocessableEntity() return webob.Response(status_int=202) - @extensions.admin_only @exception.novaclient_converter @scheduler_api.redirect_handler def _inject_network_info(self, input_dict, req, id): @@ -149,7 +141,6 @@ class Admin_actions(extensions.ExtensionDescriptor): raise exc.HTTPUnprocessableEntity() return webob.Response(status_int=202) - @extensions.admin_only @exception.novaclient_converter @scheduler_api.redirect_handler def _lock(self, input_dict, req, id): @@ -166,7 +157,6 @@ class Admin_actions(extensions.ExtensionDescriptor): raise exc.HTTPUnprocessableEntity() return webob.Response(status_int=202) - @extensions.admin_only @exception.novaclient_converter @scheduler_api.redirect_handler def _unlock(self, input_dict, req, id): @@ -185,6 +175,7 @@ class Admin_actions(extensions.ExtensionDescriptor): def get_actions(self): actions = [ + #TODO(bcwaldon): These actions should be prefixed with 'os-' extensions.ActionExtension("servers", "pause", self._pause), extensions.ActionExtension("servers", "unpause", self._unpause), extensions.ActionExtension("servers", "suspend", self._suspend), diff --git a/nova/api/openstack/v2/contrib/extended_status.py b/nova/api/openstack/v2/contrib/extended_status.py index 5e0a69780..d2e2fe914 100644 --- a/nova/api/openstack/v2/contrib/extended_status.py +++ b/nova/api/openstack/v2/contrib/extended_status.py @@ -14,9 +14,6 @@ """The Extended Status Admin API extension.""" -import traceback - -import webob from webob import exc from nova.api.openstack.v2 import extensions @@ -38,6 +35,7 @@ class Extended_status(extensions.ExtensionDescriptor): alias = "OS-EXT-STS" namespace = "http://docs.openstack.org/ext/extended_status/api/v1.1" updated = "2011-11-03T00:00:00+00:00" + admin_only = True def get_request_extensions(self): request_extensions = [] @@ -69,6 +67,8 @@ class Extended_status(extensions.ExtensionDescriptor): explanation = _("Server not found.") raise exc.HTTPNotFound(explanation=explanation) + #TODO(bcwaldon): these attributes should be prefixed with + # something specific to this extension for state in ['task_state', 'vm_state', 'power_state']: key = "%s:%s" % (Extended_status.alias, state) server[key] = inst_ref[state] @@ -87,11 +87,10 @@ class Extended_status(extensions.ExtensionDescriptor): _get_and_extend_all(context, body) return res - if FLAGS.allow_admin_api: - req_ext = extensions.RequestExtension('GET', - '/:(project_id)/servers/:(id)', - _extended_status_handler) - request_extensions.append(req_ext) + req_ext = extensions.RequestExtension('GET', + '/:(project_id)/servers/:(id)', + _extended_status_handler) + request_extensions.append(req_ext) return request_extensions diff --git a/nova/api/openstack/v2/contrib/hosts.py b/nova/api/openstack/v2/contrib/hosts.py index b422a80ab..bf1dd10da 100644 --- a/nova/api/openstack/v2/contrib/hosts.py +++ b/nova/api/openstack/v2/contrib/hosts.py @@ -19,7 +19,6 @@ import webob.exc from xml.dom import minidom from xml.parsers import expat -from nova.api.openstack import common from nova.api.openstack import wsgi from nova.api.openstack import xmlutil from nova.api.openstack.v2 import extensions @@ -107,15 +106,12 @@ class HostController(object): raise webob.exc.HTTPBadRequest(explanation=e.msg) return {"host": host, "power_action": result} - @extensions.admin_only def startup(self, req, id): return self._host_power_action(req, host=id, action="startup") - @extensions.admin_only def shutdown(self, req, id): return self._host_power_action(req, host=id, action="shutdown") - @extensions.admin_only def reboot(self, req, id): return self._host_power_action(req, host=id, action="reboot") @@ -179,12 +175,13 @@ class HostDeserializer(wsgi.XMLDeserializer): class Hosts(extensions.ExtensionDescriptor): - """Host administration""" + """Admin-only host administration""" name = "Hosts" alias = "os-hosts" namespace = "http://docs.openstack.org/ext/hosts/api/v1.1" updated = "2011-06-29T00:00:00+00:00" + admin_only = True def get_resources(self): body_serializers = { diff --git a/nova/api/openstack/v2/contrib/simple_tenant_usage.py b/nova/api/openstack/v2/contrib/simple_tenant_usage.py index 4204c53bf..1d3053420 100644 --- a/nova/api/openstack/v2/contrib/simple_tenant_usage.py +++ b/nova/api/openstack/v2/contrib/simple_tenant_usage.py @@ -19,14 +19,11 @@ from datetime import datetime import urlparse import webob -from webob import exc from nova.api.openstack.v2 import extensions -from nova.api.openstack.v2 import views from nova.api.openstack import wsgi from nova.api.openstack import xmlutil from nova.compute import api -from nova.db.sqlalchemy.session import get_session from nova import exception from nova import flags @@ -181,7 +178,7 @@ class SimpleTenantUsageController(object): """Retrive tenant_usage for all tenants""" context = req.environ['nova.context'] - if not context.is_admin and FLAGS.allow_admin_api: + if not context.is_admin: return webob.Response(status_int=403) (period_start, period_stop, detailed) = self._get_datetime_range(req) @@ -196,7 +193,7 @@ class SimpleTenantUsageController(object): tenant_id = id context = req.environ['nova.context'] - if not context.is_admin and FLAGS.allow_admin_api: + if not context.is_admin: if tenant_id != context.project_id: return webob.Response(status_int=403) @@ -261,6 +258,7 @@ class Simple_tenant_usage(extensions.ExtensionDescriptor): alias = "os-simple-tenant-usage" namespace = "http://docs.openstack.org/ext/os-simple-tenant-usage/api/v1.1" updated = "2011-08-19T00:00:00+00:00" + admin_only = True def get_resources(self): resources = [] diff --git a/nova/api/openstack/v2/extensions.py b/nova/api/openstack/v2/extensions.py index b3fbfc923..b6ed897cb 100644 --- a/nova/api/openstack/v2/extensions.py +++ b/nova/api/openstack/v2/extensions.py @@ -16,19 +16,11 @@ # License for the specific language governing permissions and limitations # under the License. -import functools -import imp -import inspect -import os -import sys - -from lxml import etree import routes import webob.dec import webob.exc import nova.api.openstack.v2 -from nova.api.openstack import common from nova.api.openstack import wsgi from nova.api.openstack import xmlutil from nova import exception @@ -68,6 +60,10 @@ class ExtensionDescriptor(object): # '2011-01-22T13:25:27-06:00' updated = None + # This attribute causes the extension to load only when + # the admin api is enabled + admin_only = False + def __init__(self, ext_mgr): """Register extension with the extension manager.""" @@ -426,9 +422,15 @@ class ExtensionManager(object): ' '.join(extension.__doc__.strip().split())) LOG.debug(_('Ext namespace: %s'), extension.namespace) LOG.debug(_('Ext updated: %s'), extension.updated) + LOG.debug(_('Ext admin_only: %s'), extension.admin_only) except AttributeError as ex: LOG.exception(_("Exception loading extension: %s"), unicode(ex)) return False + + # Don't load admin api extensions if the admin api isn't enabled + if not FLAGS.allow_admin_api and extension.admin_only: + return False + return True def load_extension(self, ext_factory): @@ -443,6 +445,7 @@ class ExtensionManager(object): LOG.debug(_("Loading extension %s"), ext_factory) # Load the factory + factory = utils.import_class(ext_factory) # Call it @@ -452,7 +455,9 @@ class ExtensionManager(object): def _load_extensions(self): """Load extensions specified on the command line.""" - for ext_factory in FLAGS.osapi_extension: + extensions = list(FLAGS.osapi_extension) + + for ext_factory in extensions: try: self.load_extension(ext_factory) except Exception as exc: @@ -542,16 +547,6 @@ class ExtensionsXMLSerializer(xmlutil.XMLTemplateSerializer): return ExtensionTemplate() -def admin_only(fnc): - @functools.wraps(fnc) - def _wrapped(self, *args, **kwargs): - if FLAGS.allow_admin_api: - return fnc(self, *args, **kwargs) - raise webob.exc.HTTPNotFound() - _wrapped.func_name = fnc.func_name - return _wrapped - - def wrap_errors(fn): """Ensure errors are not passed along.""" def wrapped(*args): -- cgit