c491c3ee61
Throughout the API code we keep catching NotFound exceptions in their various forms and converting them to webob.exc.HTTPNotFound exceptions, but we can leave the WSGI fault handler convert them on its own. This patch changes current behavior and removes the exception handling closer to the operation so that those exceptions can be handled at the WSGI level. This has the following benefits: - Reduces code complexity - Increases code readability - Provides consistent error responses, as messages are stored on the Exceptions. - Prevents raising errors with only partial information (we have cases now that were removing the UUID from the message because they used a custom message). For example: before returned error would be "The resource could not be found", and now we raise "Volume type encryption for type 4e9e6d23-eed0-426d-b90a-28f87a94b6fe does not exist." automatically. - Reduces workload for the translation team because we remove all unnecessary custom messages. Change-Id: I09f98921fdc2400cc3f6056e59001100abe06920
203 lines
6.7 KiB
Python
203 lines
6.7 KiB
Python
# Copyright 2011 Justin Santa Barbara
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
"""The volumes snapshots api."""
|
|
|
|
from oslo_log import log as logging
|
|
from oslo_utils import strutils
|
|
import webob
|
|
from webob import exc
|
|
|
|
from cinder.api import common
|
|
from cinder.api.openstack import wsgi
|
|
from cinder import exception
|
|
from cinder.i18n import _, _LI
|
|
from cinder import utils
|
|
from cinder import volume
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def _translate_snapshot_detail_view(snapshot):
|
|
"""Maps keys for snapshots details view."""
|
|
|
|
d = _translate_snapshot_summary_view(snapshot)
|
|
|
|
# NOTE(gagupta): No additional data / lookups at the moment
|
|
return d
|
|
|
|
|
|
def _translate_snapshot_summary_view(snapshot):
|
|
"""Maps keys for snapshots summary view."""
|
|
d = {}
|
|
|
|
d['id'] = snapshot['id']
|
|
d['created_at'] = snapshot['created_at']
|
|
d['display_name'] = snapshot['display_name']
|
|
d['display_description'] = snapshot['display_description']
|
|
d['volume_id'] = snapshot['volume_id']
|
|
d['status'] = snapshot['status']
|
|
d['size'] = snapshot['volume_size']
|
|
|
|
if snapshot.get('metadata') and isinstance(snapshot.get('metadata'),
|
|
dict):
|
|
d['metadata'] = snapshot['metadata']
|
|
else:
|
|
d['metadata'] = {}
|
|
return d
|
|
|
|
|
|
class SnapshotsController(wsgi.Controller):
|
|
"""The Snapshots API controller for the OpenStack API."""
|
|
|
|
def __init__(self, ext_mgr=None):
|
|
self.volume_api = volume.API()
|
|
self.ext_mgr = ext_mgr
|
|
super(SnapshotsController, self).__init__()
|
|
|
|
def show(self, req, id):
|
|
"""Return data about the given snapshot."""
|
|
context = req.environ['cinder.context']
|
|
|
|
# Not found exception will be handled at the wsgi level
|
|
snapshot = self.volume_api.get_snapshot(context, id)
|
|
req.cache_db_snapshot(snapshot)
|
|
|
|
return {'snapshot': _translate_snapshot_detail_view(snapshot)}
|
|
|
|
def delete(self, req, id):
|
|
"""Delete a snapshot."""
|
|
context = req.environ['cinder.context']
|
|
|
|
LOG.info(_LI("Delete snapshot with id: %s"), id, context=context)
|
|
|
|
# Not found exception will be handled at the wsgi level
|
|
snapshot = self.volume_api.get_snapshot(context, id)
|
|
self.volume_api.delete_snapshot(context, snapshot)
|
|
return webob.Response(status_int=202)
|
|
|
|
def index(self, req):
|
|
"""Returns a summary list of snapshots."""
|
|
return self._items(req, entity_maker=_translate_snapshot_summary_view)
|
|
|
|
def detail(self, req):
|
|
"""Returns a detailed list of snapshots."""
|
|
return self._items(req, entity_maker=_translate_snapshot_detail_view)
|
|
|
|
def _items(self, req, entity_maker):
|
|
"""Returns a list of snapshots, transformed through entity_maker."""
|
|
context = req.environ['cinder.context']
|
|
|
|
# pop out limit and offset , they are not search_opts
|
|
search_opts = req.GET.copy()
|
|
search_opts.pop('limit', None)
|
|
search_opts.pop('offset', None)
|
|
|
|
# filter out invalid option
|
|
allowed_search_options = ('status', 'volume_id', 'display_name')
|
|
utils.remove_invalid_filter_options(context, search_opts,
|
|
allowed_search_options)
|
|
|
|
snapshots = self.volume_api.get_all_snapshots(context,
|
|
search_opts=search_opts)
|
|
limited_list = common.limited(snapshots.objects, req)
|
|
req.cache_db_snapshots(limited_list)
|
|
res = [entity_maker(snapshot) for snapshot in limited_list]
|
|
return {'snapshots': res}
|
|
|
|
def create(self, req, body):
|
|
"""Creates a new snapshot."""
|
|
kwargs = {}
|
|
context = req.environ['cinder.context']
|
|
|
|
if not self.is_valid_body(body, 'snapshot'):
|
|
raise exc.HTTPUnprocessableEntity()
|
|
|
|
snapshot = body['snapshot']
|
|
kwargs['metadata'] = snapshot.get('metadata', None)
|
|
|
|
try:
|
|
volume_id = snapshot['volume_id']
|
|
except KeyError:
|
|
msg = _("'volume_id' must be specified")
|
|
raise exc.HTTPBadRequest(explanation=msg)
|
|
|
|
# Not found exception will be handled at the wsgi level
|
|
volume = self.volume_api.get(context, volume_id)
|
|
|
|
force = snapshot.get('force', False)
|
|
msg = _LI("Create snapshot from volume %s")
|
|
LOG.info(msg, volume_id, context=context)
|
|
|
|
if not utils.is_valid_boolstr(force):
|
|
msg = _("Invalid value '%s' for force. ") % force
|
|
raise exception.InvalidParameterValue(err=msg)
|
|
|
|
if strutils.bool_from_string(force):
|
|
new_snapshot = self.volume_api.create_snapshot_force(
|
|
context,
|
|
volume,
|
|
snapshot.get('display_name'),
|
|
snapshot.get('display_description'),
|
|
**kwargs)
|
|
else:
|
|
new_snapshot = self.volume_api.create_snapshot(
|
|
context,
|
|
volume,
|
|
snapshot.get('display_name'),
|
|
snapshot.get('display_description'),
|
|
**kwargs)
|
|
req.cache_db_snapshot(new_snapshot)
|
|
|
|
retval = _translate_snapshot_detail_view(new_snapshot)
|
|
|
|
return {'snapshot': retval}
|
|
|
|
def update(self, req, id, body):
|
|
"""Update a snapshot."""
|
|
context = req.environ['cinder.context']
|
|
|
|
if not body:
|
|
raise exc.HTTPUnprocessableEntity()
|
|
|
|
if 'snapshot' not in body:
|
|
raise exc.HTTPUnprocessableEntity()
|
|
|
|
snapshot = body['snapshot']
|
|
update_dict = {}
|
|
|
|
valid_update_keys = (
|
|
'display_name',
|
|
'display_description',
|
|
)
|
|
|
|
for key in valid_update_keys:
|
|
if key in snapshot:
|
|
update_dict[key] = snapshot[key]
|
|
|
|
# Not found exception will be handled at the wsgi level
|
|
snapshot = self.volume_api.get_snapshot(context, id)
|
|
self.volume_api.update_snapshot(context, snapshot, update_dict)
|
|
|
|
snapshot.update(update_dict)
|
|
req.cache_db_snapshot(snapshot)
|
|
|
|
return {'snapshot': _translate_snapshot_detail_view(snapshot)}
|
|
|
|
|
|
def create_resource(ext_mgr):
|
|
return wsgi.Resource(SnapshotsController(ext_mgr))
|