318 lines
11 KiB
Python
318 lines
11 KiB
Python
# 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 restores api."""
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log as logging
|
|
from oslo_serialization import jsonutils
|
|
from oslo_utils import uuidutils
|
|
|
|
from webob import exc
|
|
|
|
import smaug
|
|
from smaug.api import common
|
|
from smaug.api.openstack import wsgi
|
|
from smaug import exception
|
|
from smaug.i18n import _, _LI
|
|
|
|
from smaug import objects
|
|
from smaug.objects import base as objects_base
|
|
import smaug.policy
|
|
from smaug.services.protection import api as protection_api
|
|
from smaug import utils
|
|
|
|
import six
|
|
|
|
query_restore_filters_opt = cfg.ListOpt(
|
|
'query_restore_filters',
|
|
default=['status'],
|
|
help="Restore filter options which "
|
|
"non-admin user could use to "
|
|
"query restores. Default values "
|
|
"are: ['status']")
|
|
CONF = cfg.CONF
|
|
CONF.register_opt(query_restore_filters_opt)
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def check_policy(context, action, target_obj=None):
|
|
target = {
|
|
'project_id': context.project_id,
|
|
'user_id': context.user_id,
|
|
}
|
|
|
|
if isinstance(target_obj, objects_base.SmaugObject):
|
|
# Turn object into dict so target.update can work
|
|
target.update(
|
|
target_obj.obj_to_primitive() or {})
|
|
else:
|
|
target.update(target_obj or {})
|
|
|
|
_action = 'restore:%s' % action
|
|
smaug.policy.enforce(context, _action, target)
|
|
|
|
|
|
class RestoreViewBuilder(common.ViewBuilder):
|
|
"""Model a server API response as a python dictionary."""
|
|
|
|
_collection_name = "restores"
|
|
|
|
def __init__(self):
|
|
"""Initialize view builder."""
|
|
super(RestoreViewBuilder, self).__init__()
|
|
|
|
def detail(self, request, restore):
|
|
"""Detailed view of a single restore."""
|
|
restore_ref = {
|
|
'restore': {
|
|
'id': restore.get('id'),
|
|
'project_id': restore.get('project_id'),
|
|
'provider_id': restore.get('provider_id'),
|
|
'checkpoint_id': restore.get('checkpoint_id'),
|
|
'restore_target': restore.get('restore_target'),
|
|
'parameters': restore.get('parameters'),
|
|
'status': restore.get('status'),
|
|
}
|
|
}
|
|
return restore_ref
|
|
|
|
def detail_list(self, request, restores, restore_count=None):
|
|
"""Detailed view of a list of restores."""
|
|
return self._list_view(self.detail, request, restores,
|
|
restore_count,
|
|
self._collection_name)
|
|
|
|
def _list_view(self, func, request, restores, restore_count,
|
|
coll_name=_collection_name):
|
|
"""Provide a view for a list of restores.
|
|
|
|
:param func: Function used to format the restore data
|
|
:param request: API request
|
|
:param restores: List of restores in dictionary format
|
|
:param restore_count: Length of the original list of restores
|
|
:param coll_name: Name of collection, used to generate the next link
|
|
for a pagination query
|
|
:returns: restore data in dictionary format
|
|
"""
|
|
restores_list = [func(request, restore)['restore']
|
|
for restore in restores]
|
|
restores_links = self._get_collection_links(request,
|
|
restores,
|
|
coll_name,
|
|
restore_count)
|
|
restores_dict = {
|
|
'restores': restores_list
|
|
}
|
|
if restores_links:
|
|
restores_dict['restores_links'] = restores_links
|
|
|
|
return restores_dict
|
|
|
|
|
|
class RestoresController(wsgi.Controller):
|
|
"""The Restores API controller for the OpenStack API."""
|
|
|
|
_view_builder_class = RestoreViewBuilder
|
|
|
|
def __init__(self):
|
|
self.protection_api = protection_api.API()
|
|
super(RestoresController, self).__init__()
|
|
|
|
def show(self, req, id):
|
|
"""Return data about the given restore."""
|
|
context = req.environ['smaug.context']
|
|
|
|
LOG.info(_LI("Show restore with id: %s"), id, context=context)
|
|
|
|
if not uuidutils.is_uuid_like(id):
|
|
msg = _("Invalid restore id provided.")
|
|
raise exc.HTTPBadRequest(explanation=msg)
|
|
|
|
try:
|
|
restore = self._restore_get(context, id)
|
|
except exception.RestoreNotFound as error:
|
|
raise exc.HTTPNotFound(explanation=error.msg)
|
|
|
|
LOG.info(_LI("Show restore request issued successfully."),
|
|
resource={'id': restore.id})
|
|
return self._view_builder.detail(req, restore)
|
|
|
|
def index(self, req):
|
|
"""Returns a list of restores, transformed through view builder."""
|
|
context = req.environ['smaug.context']
|
|
|
|
LOG.info(_LI("Show restore list"), context=context)
|
|
|
|
params = req.params.copy()
|
|
marker, limit, offset = common.get_pagination_params(params)
|
|
sort_keys, sort_dirs = common.get_sort_params(params)
|
|
filters = params
|
|
|
|
utils.remove_invalid_filter_options(
|
|
context,
|
|
filters,
|
|
self._get_restore_filter_options())
|
|
|
|
utils.check_filters(filters)
|
|
restores = self._get_all(context, marker, limit,
|
|
sort_keys=sort_keys,
|
|
sort_dirs=sort_dirs,
|
|
filters=filters,
|
|
offset=offset)
|
|
|
|
retval_restores = self._view_builder.detail_list(req, restores)
|
|
|
|
LOG.info(_LI("Show restore list request issued successfully."))
|
|
|
|
return retval_restores
|
|
|
|
def _get_all(self, context, marker=None, limit=None, sort_keys=None,
|
|
sort_dirs=None, filters=None, offset=None):
|
|
check_policy(context, 'get_all')
|
|
|
|
if filters is None:
|
|
filters = {}
|
|
|
|
all_tenants = utils.get_bool_param('all_tenants', filters)
|
|
|
|
try:
|
|
if limit is not None:
|
|
limit = int(limit)
|
|
if limit <= 0:
|
|
msg = _('limit param must be positive')
|
|
raise exception.InvalidInput(reason=msg)
|
|
except ValueError:
|
|
msg = _('limit param must be an integer')
|
|
raise exception.InvalidInput(reason=msg)
|
|
|
|
if filters:
|
|
LOG.debug("Searching by: %s.", six.text_type(filters))
|
|
|
|
if context.is_admin and all_tenants:
|
|
# Need to remove all_tenants to pass the filtering below.
|
|
del filters['all_tenants']
|
|
restores = objects.RestoreList.get_all(
|
|
context, marker, limit,
|
|
sort_keys=sort_keys,
|
|
sort_dirs=sort_dirs,
|
|
filters=filters,
|
|
offset=offset)
|
|
else:
|
|
restores = objects.RestoreList.get_all_by_project(
|
|
context, context.project_id, marker, limit,
|
|
sort_keys=sort_keys, sort_dirs=sort_dirs, filters=filters,
|
|
offset=offset)
|
|
|
|
LOG.info(_LI("Get all restores completed successfully."))
|
|
return restores
|
|
|
|
def _get_restore_filter_options(self):
|
|
"""Return restores search options allowed by non-admin."""
|
|
return CONF.query_restore_filters
|
|
|
|
def create(self, req, body):
|
|
"""Creates a new restore."""
|
|
if not self.is_valid_body(body, 'restore'):
|
|
raise exc.HTTPUnprocessableEntity()
|
|
|
|
LOG.debug('Create restore request body: %s', body)
|
|
context = req.environ['smaug.context']
|
|
check_policy(context, 'create')
|
|
restore = body['restore']
|
|
LOG.debug('Create restore request : %s', restore)
|
|
|
|
if not restore.get("provider_id"):
|
|
msg = _("provider_id must be provided when creating "
|
|
"a restore.")
|
|
raise exception.InvalidInput(reason=msg)
|
|
|
|
if not restore.get("checkpoint_id"):
|
|
msg = _("checkpoint_id must be provided when creating "
|
|
"a restore.")
|
|
raise exception.InvalidInput(reason=msg)
|
|
|
|
parameters = restore.get("parameters")
|
|
if not isinstance(parameters, dict):
|
|
msg = _("parameters must be a dict when creating"
|
|
" a restore.")
|
|
raise exception.InvalidInput(reason=msg)
|
|
|
|
restore_properties = {
|
|
'project_id': context.project_id,
|
|
'provider_id': restore.get('provider_id'),
|
|
'checkpoint_id': restore.get('checkpoint_id'),
|
|
'restore_target': restore.get('restore_target'),
|
|
'parameters': jsonutils.dumps(parameters),
|
|
'status': 'started',
|
|
}
|
|
|
|
restoreobj = objects.Restore(context=context,
|
|
**restore_properties)
|
|
restoreobj.create()
|
|
LOG.debug('call restore RPC : restoreobj:%s', restoreobj)
|
|
|
|
# call restore rpc API of protection service
|
|
result = self.protection_api.restore(context, restoreobj)
|
|
if result is True:
|
|
status_update = "success"
|
|
else:
|
|
status_update = "failed"
|
|
# update the status of restore
|
|
update_dict = {
|
|
"status": status_update
|
|
}
|
|
|
|
check_policy(context, 'update', restoreobj)
|
|
self._restore_update(context,
|
|
restoreobj.get("id"), update_dict)
|
|
|
|
restoreobj.update(update_dict)
|
|
retval = self._view_builder.detail(req, restoreobj)
|
|
|
|
return retval
|
|
|
|
def _restore_get(self, context, restore_id):
|
|
if not uuidutils.is_uuid_like(restore_id):
|
|
msg = _("Invalid restore id provided.")
|
|
raise exc.HTTPBadRequest(explanation=msg)
|
|
|
|
restore = objects.Restore.get_by_id(context, restore_id)
|
|
try:
|
|
check_policy(context, 'get', restore)
|
|
except exception.PolicyNotAuthorized:
|
|
# raise RestoreNotFound instead to make sure smaug behaves
|
|
# as it used to
|
|
raise exception.RestoreNotFound(restore_id=restore_id)
|
|
LOG.info(_LI("Restore info retrieved successfully."))
|
|
return restore
|
|
|
|
def _restore_update(self, context, restore_id, fields):
|
|
try:
|
|
restore = self._restore_get(context, restore_id)
|
|
except exception.RestoreNotFound as error:
|
|
raise exc.HTTPNotFound(explanation=error.msg)
|
|
|
|
if isinstance(restore, objects_base.SmaugObject):
|
|
restore.update(fields)
|
|
restore.save()
|
|
LOG.info(_LI("restore updated successfully."))
|
|
else:
|
|
msg = _("The parameter restore must be a object of "
|
|
"SmaugObject class.")
|
|
raise exception.InvalidInput(reason=msg)
|
|
|
|
|
|
def create_resource():
|
|
return wsgi.Resource(RestoresController())
|