6a7e7cce4d
This change introduces a common delete API that can be applied to every proxy method that revolves around deleting a resource. In particular, the change applies that base method to deleting a server. The method takes either a resource or an ID and calls delete on the corresponding resource, after obtaining the canonical ID for that value out of Resource.get_id. This value is checked before making the request to see if we can determine it's of the wrong resource type by the _check_resource decorator. Additionally, in the case of a 404, by default this is ignored, but if ignore_missing is set to False, we handle a 404 and raise exceptions.ResourceNotFound as a more descriptive exception. Change-Id: I755c57e9bd9cec597a5bcf84c527e7bd6d710fb3
85 lines
3.6 KiB
Python
85 lines
3.6 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.
|
|
|
|
from openstack import exceptions
|
|
from openstack import resource
|
|
|
|
|
|
# The _check_resource decorator is used on BaseProxy methods to ensure that
|
|
# the `actual` argument is in fact the type of the `expected` argument.
|
|
# It does so under two cases:
|
|
# 1. When strict=False, if and only if `actual` is a Resource instance,
|
|
# it is checked to see that it's an instance of the `expected` class.
|
|
# This allows `actual` to be other types, such as strings, when it makes
|
|
# sense to accept a raw id value.
|
|
# 2. When strict=True, `actual` must be an instance of the `expected` class.
|
|
def _check_resource(strict=False):
|
|
def wrap(method):
|
|
def check(self, expected, actual=None, *args, **kwargs):
|
|
if (strict and actual is not None and not
|
|
isinstance(actual, resource.Resource)):
|
|
raise ValueError("A %s must be passed" % expected.__name__)
|
|
elif (isinstance(actual, resource.Resource) and not
|
|
isinstance(actual, expected)):
|
|
raise ValueError("Expected %s but received %s" % (
|
|
expected.__name__, actual.__class__.__name__))
|
|
|
|
return method(self, expected, actual, *args, **kwargs)
|
|
return check
|
|
return wrap
|
|
|
|
|
|
class BaseProxy(object):
|
|
|
|
def __init__(self, session):
|
|
self.session = session
|
|
|
|
@_check_resource(strict=False)
|
|
def _delete(self, resource_type, value, ignore_missing=True):
|
|
"""Delete a resource
|
|
|
|
:param resource_type: The type of resource to delete. This should
|
|
be a :class:`~openstack.resource.Resource`
|
|
subclass with a ``from_id`` method.
|
|
:param value: The value to delete. Can be either the ID of a
|
|
resource or a :class:`~openstack.resource.Resource`
|
|
subclass.
|
|
:param bool ignore_missing: When set to ``False``
|
|
:class:`~openstack.exceptions.ResourceNotFound` will be
|
|
raised when the resource does not exist.
|
|
When set to ``True``, no exception will be set when
|
|
attempting to delete a nonexistent server.
|
|
|
|
:returns: The result of the ``delete``
|
|
:raises: ``ValueError`` if ``value`` is a
|
|
:class:`~openstack.resource.Resource` that doesn't match
|
|
the ``resource_type``.
|
|
:class:`~openstack.exceptions.ResourceNotFound` when
|
|
ignore_missing if ``False`` and a nonexistent resource
|
|
is attempted to be deleted.
|
|
|
|
"""
|
|
res = resource_type.existing(id=resource.Resource.get_id(value))
|
|
|
|
try:
|
|
rv = res.delete(self.session)
|
|
except exceptions.NotFoundException as exc:
|
|
if ignore_missing:
|
|
return None
|
|
else:
|
|
# Reraise with a more specific type and message
|
|
raise exceptions.ResourceNotFound(
|
|
"No %s found for %s" % (resource_type.__name__, value),
|
|
details=exc.details, status_code=exc.status_code)
|
|
|
|
return rv
|