3abfea083a
novaclient 2.27.0 introduced the API microversion discovery and client.Client now wants an api_version argument to properly work out the correct API version in use. OSC needs to provide this when required. Letting the compute client plugin do the version validity checking makes more sense than encoding it into shell.py, so I've added a new OSC plugin interface function check_api_version() that is called from shell.py if it exists. If it either does not exist or it returns False the previous version checking using API_VERSIONS is still performed. compute.client.check_api_version() conditionally imports the new novaclient.api_versions module and uses it if successful. Otherwise check_api_version() returns False and the previous code path is resumed. One side-effect of this is that it is now valid to use --os-compute-api-version with any valid microversion supported by the installed python-novaclient. Closes-Bug: #1492467 Change-Id: I4535b38a5639a03a9597bf83f6394f9bb45c2b9e
125 lines
3.8 KiB
Python
125 lines
3.8 KiB
Python
# Copyright 2012-2013 OpenStack, LLC.
|
|
#
|
|
# 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 logging
|
|
|
|
from openstackclient.common import exceptions
|
|
from openstackclient.common import utils
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
DEFAULT_API_VERSION = '2'
|
|
API_VERSION_OPTION = 'os_compute_api_version'
|
|
API_NAME = 'compute'
|
|
API_VERSIONS = {
|
|
"2": "novaclient.client",
|
|
}
|
|
|
|
# Save the microversion if in use
|
|
_compute_api_version = None
|
|
|
|
|
|
def make_client(instance):
|
|
"""Returns a compute service client."""
|
|
|
|
# Defer client imports until we actually need them
|
|
from novaclient import client as nova_client
|
|
from novaclient import extension
|
|
try:
|
|
from novaclient.v2.contrib import list_extensions
|
|
except ImportError:
|
|
from novaclient.v1_1.contrib import list_extensions
|
|
|
|
compute_client = nova_client.get_client_class(
|
|
instance._api_version[API_NAME],
|
|
)
|
|
LOG.debug('Instantiating compute client: %s', compute_client)
|
|
|
|
# Set client http_log_debug to True if verbosity level is high enough
|
|
http_log_debug = utils.get_effective_log_level() <= logging.DEBUG
|
|
|
|
extensions = [extension.Extension('list_extensions', list_extensions)]
|
|
|
|
# Remember interface only if it is set
|
|
kwargs = utils.build_kwargs_dict('endpoint_type', instance._interface)
|
|
|
|
if _compute_api_version is not None:
|
|
kwargs.update({'api_version': _compute_api_version})
|
|
|
|
client = compute_client(
|
|
session=instance.session,
|
|
extensions=extensions,
|
|
http_log_debug=http_log_debug,
|
|
timings=instance.timing,
|
|
region_name=instance._region_name,
|
|
**kwargs
|
|
)
|
|
|
|
return client
|
|
|
|
|
|
def build_option_parser(parser):
|
|
"""Hook to add global options"""
|
|
parser.add_argument(
|
|
'--os-compute-api-version',
|
|
metavar='<compute-api-version>',
|
|
default=utils.env('OS_COMPUTE_API_VERSION'),
|
|
help='Compute API version, default=' +
|
|
DEFAULT_API_VERSION +
|
|
' (Env: OS_COMPUTE_API_VERSION)')
|
|
return parser
|
|
|
|
|
|
def check_api_version(check_version):
|
|
"""Validate version supplied by user
|
|
|
|
Returns:
|
|
* True if version is OK
|
|
* False if the version has not been checked and the previous plugin
|
|
check should be performed
|
|
* throws an exception if the version is no good
|
|
|
|
TODO(dtroyer): make the exception thrown a version-related one
|
|
"""
|
|
|
|
# Defer client imports until we actually need them
|
|
try:
|
|
from novaclient import api_versions
|
|
except ImportError:
|
|
# Retain previous behaviour
|
|
return False
|
|
|
|
import novaclient
|
|
|
|
global _compute_api_version
|
|
|
|
# Copy some logic from novaclient 2.27.0 for basic version detection
|
|
# NOTE(dtroyer): This is only enough to resume operations using API
|
|
# version 2.0 or any valid version supplied by the user.
|
|
_compute_api_version = api_versions.get_api_version(check_version)
|
|
|
|
if _compute_api_version > api_versions.APIVersion("2.0"):
|
|
if not _compute_api_version.matches(
|
|
novaclient.API_MIN_VERSION,
|
|
novaclient.API_MAX_VERSION,
|
|
):
|
|
raise exceptions.CommandError(
|
|
"versions supported by client: %s - %s" % (
|
|
novaclient.API_MIN_VERSION.get_string(),
|
|
novaclient.API_MAX_VERSION.get_string(),
|
|
),
|
|
)
|
|
return True
|