85 lines
3.0 KiB
Python
85 lines
3.0 KiB
Python
# 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 functools
|
|
|
|
import microversion_parse as mvp
|
|
from webob import exc
|
|
|
|
from ironic.common.i18n import _
|
|
|
|
|
|
@functools.total_ordering
|
|
class Version(object):
|
|
"""API Version object."""
|
|
|
|
string = 'X-OpenStack-Ironic-API-Version'
|
|
"""HTTP Header string carrying the requested version"""
|
|
|
|
min_string = 'X-OpenStack-Ironic-API-Minimum-Version'
|
|
"""HTTP response header"""
|
|
|
|
max_string = 'X-OpenStack-Ironic-API-Maximum-Version'
|
|
"""HTTP response header"""
|
|
|
|
def __init__(self, headers, default_version, latest_version):
|
|
"""Create an API Version object from the supplied headers.
|
|
|
|
:param headers: webob headers
|
|
:param default_version: version to use if not specified in headers
|
|
:param latest_version: version to use if latest is requested
|
|
:raises: webob.HTTPNotAcceptable
|
|
"""
|
|
(self.major, self.minor) = Version.parse_headers(
|
|
headers, default_version, latest_version)
|
|
|
|
def __repr__(self):
|
|
return '%s.%s' % (self.major, self.minor)
|
|
|
|
@staticmethod
|
|
def parse_headers(headers, default_version, latest_version):
|
|
"""Determine the API version requested based on the headers supplied.
|
|
|
|
:param headers: webob headers
|
|
:param default_version: version to use if not specified in headers
|
|
:param latest_version: version to use if latest is requested
|
|
:returns: a tuple of (major, minor) version numbers
|
|
:raises: webob.HTTPNotAcceptable
|
|
"""
|
|
try:
|
|
version_str = mvp.get_version(headers,
|
|
service_type='baremetal',
|
|
legacy_headers=[Version.string])
|
|
if not version_str:
|
|
version_str = default_version
|
|
if version_str.lower() == 'latest':
|
|
version_str = latest_version
|
|
|
|
version = mvp.parse_version_string(version_str)
|
|
if len(version) != 2:
|
|
raise ValueError
|
|
except (ValueError, TypeError, AttributeError):
|
|
raise exc.HTTPNotAcceptable(_(
|
|
"Invalid value for %s header") % Version.string)
|
|
return version
|
|
|
|
def __gt__(self, other):
|
|
return (self.major, self.minor) > (other.major, other.minor)
|
|
|
|
def __eq__(self, other):
|
|
return (self.major, self.minor) == (other.major, other.minor)
|
|
|
|
def __ne__(self, other):
|
|
return not self.__eq__(other)
|