190 lines
7.0 KiB
Python
190 lines
7.0 KiB
Python
# Copyright 2014 IBM Corp.
|
|
# Copyright 2015 Clinton Knight
|
|
# 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.
|
|
|
|
import re
|
|
|
|
from cinder.api.openstack import versioned_method
|
|
from cinder import exception
|
|
from cinder.i18n import _
|
|
from cinder import utils
|
|
|
|
# Define the minimum and maximum version of the API across all of the
|
|
# REST API. The format of the version is:
|
|
# X.Y where:
|
|
#
|
|
# - X will only be changed if a significant backwards incompatible API
|
|
# change is made which affects the API as whole. That is, something
|
|
# that is only very very rarely incremented.
|
|
#
|
|
# - Y when you make any change to the API. Note that this includes
|
|
# semantic changes which may not affect the input or output formats or
|
|
# even originate in the API code layer. We are not distinguishing
|
|
# between backwards compatible and backwards incompatible changes in
|
|
# the versioning system. It must be made clear in the documentation as
|
|
# to what is a backwards compatible change and what is a backwards
|
|
# incompatible one.
|
|
|
|
#
|
|
# You must update the API version history string below with a one or
|
|
# two line description as well as update rest_api_version_history.rst
|
|
REST_API_VERSION_HISTORY = """
|
|
|
|
REST API Version History:
|
|
|
|
* 3.0 - Includes all V2 APIs and extensions. V1 API is still supported.
|
|
* 3.0 - Versions API updated to reflect beginning of microversions epoch.
|
|
* 3.1 - Adds visibility and protected to _volume_upload_image parameters.
|
|
* 3.2 - Bootable filters in volume GET call no longer treats all values
|
|
passed to it as true.
|
|
* 3.3 - Add user messages APIs.
|
|
* 3.4 - Adds glance_metadata filter to list/detail volumes in _get_volumes.
|
|
* 3.5 - Add pagination support to messages API.
|
|
* 3.6 - Allows to set empty description and empty name for consistency
|
|
group in consisgroup-update operation.
|
|
* 3.7 - Add cluster API and cluster_name field to service list API
|
|
* 3.8 - Adds resources from volume_manage and snapshot_manage extensions.
|
|
* 3.9 - Add backup update interface.
|
|
* 3.10 - Add group_id filter to list/detail volumes in _get_volumes.
|
|
* 3.11 - Add group types and group specs API.
|
|
* 3.12 - Add volumes summary API.
|
|
* 3.13 - Add generic volume groups API.
|
|
|
|
"""
|
|
|
|
# The minimum and maximum versions of the API supported
|
|
# The default api version request is defined to be the
|
|
# minimum version of the API supported.
|
|
# Explicitly using /v1 or /v2 enpoints will still work
|
|
_MIN_API_VERSION = "3.0"
|
|
_MAX_API_VERSION = "3.13"
|
|
_LEGACY_API_VERSION1 = "1.0"
|
|
_LEGACY_API_VERSION2 = "2.0"
|
|
|
|
|
|
# NOTE(cyeoh): min and max versions declared as functions so we can
|
|
# mock them for unittests. Do not use the constants directly anywhere
|
|
# else.
|
|
def min_api_version():
|
|
return APIVersionRequest(_MIN_API_VERSION)
|
|
|
|
|
|
def max_api_version():
|
|
return APIVersionRequest(_MAX_API_VERSION)
|
|
|
|
|
|
def legacy_api_version1():
|
|
return APIVersionRequest(_LEGACY_API_VERSION1)
|
|
|
|
|
|
def legacy_api_version2():
|
|
return APIVersionRequest(_LEGACY_API_VERSION2)
|
|
|
|
|
|
class APIVersionRequest(utils.ComparableMixin):
|
|
"""This class represents an API Version Request.
|
|
|
|
This class includes convenience methods for manipulation
|
|
and comparison of version numbers as needed to implement
|
|
API microversions.
|
|
"""
|
|
|
|
def __init__(self, version_string=None, experimental=False):
|
|
"""Create an API version request object."""
|
|
self._ver_major = None
|
|
self._ver_minor = None
|
|
|
|
if version_string is not None:
|
|
match = re.match(r"^([1-9]\d*)\.([1-9]\d*|0)$",
|
|
version_string)
|
|
if match:
|
|
self._ver_major = int(match.group(1))
|
|
self._ver_minor = int(match.group(2))
|
|
else:
|
|
raise exception.InvalidAPIVersionString(version=version_string)
|
|
|
|
def __str__(self):
|
|
"""Debug/Logging representation of object."""
|
|
return ("API Version Request Major: %(major)s, Minor: %(minor)s"
|
|
% {'major': self._ver_major, 'minor': self._ver_minor})
|
|
|
|
def is_null(self):
|
|
return self._ver_major is None and self._ver_minor is None
|
|
|
|
def _cmpkey(self):
|
|
"""Return the value used by ComparableMixin for rich comparisons."""
|
|
return self._ver_major, self._ver_minor
|
|
|
|
def matches_versioned_method(self, method):
|
|
"""Compares this version to that of a versioned method."""
|
|
|
|
if type(method) != versioned_method.VersionedMethod:
|
|
msg = _('An API version request must be compared '
|
|
'to a VersionedMethod object.')
|
|
raise exception.InvalidParameterValue(err=msg)
|
|
|
|
return self.matches(method.start_version,
|
|
method.end_version,
|
|
method.experimental)
|
|
|
|
def matches(self, min_version, max_version=None, experimental=False):
|
|
"""Compares this version to the specified min/max range.
|
|
|
|
Returns whether the version object represents a version
|
|
greater than or equal to the minimum version and less than
|
|
or equal to the maximum version.
|
|
|
|
If min_version is null then there is no minimum limit.
|
|
If max_version is null then there is no maximum limit.
|
|
If self is null then raise ValueError.
|
|
|
|
:param min_version: Minimum acceptable version.
|
|
:param max_version: Maximum acceptable version.
|
|
:param experimental: Whether to match experimental APIs.
|
|
:returns: boolean
|
|
"""
|
|
|
|
if self.is_null():
|
|
raise ValueError
|
|
|
|
if isinstance(min_version, str):
|
|
min_version = APIVersionRequest(version_string=min_version)
|
|
if isinstance(max_version, str):
|
|
max_version = APIVersionRequest(version_string=max_version)
|
|
|
|
if not min_version and not max_version:
|
|
return True
|
|
elif ((min_version and max_version) and
|
|
max_version.is_null() and min_version.is_null()):
|
|
return True
|
|
|
|
elif not max_version or max_version.is_null():
|
|
return min_version <= self
|
|
elif not min_version or min_version.is_null():
|
|
return self <= max_version
|
|
else:
|
|
return min_version <= self <= max_version
|
|
|
|
def get_string(self):
|
|
"""Returns a string representation of this object.
|
|
|
|
If this method is used to create an APIVersionRequest,
|
|
the resulting object will be an equivalent request.
|
|
"""
|
|
if self.is_null():
|
|
raise ValueError
|
|
return ("%(major)s.%(minor)s" %
|
|
{'major': self._ver_major, 'minor': self._ver_minor})
|