Merge "Remove python-cinderclient"

Author: Zuul

openstackclient/tests/unit/image/v1/fakes.py

@@ -19,9 +19,7 @@
 from openstack.image import v1 as image_v1
 from openstack.image.v1 import image
 
-from openstackclient.tests.unit import fakes
 from openstackclient.tests.unit import utils
-from openstackclient.tests.unit.volume.v2 import fakes as volume_fakes
 
 
 class FakeClientMixin:
@@ -39,12 +37,8 @@ class TestImagev1(FakeClientMixin, utils.TestCommand):
     def setUp(self):
         super().setUp()
 
-        self.app.client_manager.volume = volume_fakes.FakeVolumeClient(
-            endpoint=fakes.AUTH_URL,
-            token=fakes.AUTH_TOKEN,
-        )
-        self.volume_client = self.app.client_manager.volume
-
+        # TODO(stephenfin): Rename to 'volume_client' now that all commands are
+        # migrated to SDK
         self.app.client_manager.sdk_connection.volume = mock.Mock(
             spec=block_storage_v2.Proxy
         )

openstackclient/tests/unit/volume/test_find_resource.py

@@ -13,33 +13,19 @@
 
 from unittest import mock
 
-from cinderclient import api_versions
 from keystoneauth1 import discover
 from openstack.block_storage import v2 as block_storage_v2
 from openstack.image import v2 as image_v2
 
-from openstackclient.tests.unit import fakes
 from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
 from openstackclient.tests.unit import utils
 
 
-class FakeVolumeClient:
-    def __init__(self, **kwargs):
-        self.auth_token = kwargs['token']
-        self.management_url = kwargs['endpoint']
-        self.api_version = api_versions.APIVersion('2.0')
-
-
 class FakeClientMixin:
     def setUp(self):
         super().setUp()
 
-        self.app.client_manager.volume = FakeVolumeClient(
-            endpoint=fakes.AUTH_URL, token=fakes.AUTH_TOKEN
-        )
-        self.volume_client = self.app.client_manager.volume
-
-        # TODO(stephenfin): Rename to 'volume_client' once all commands are
+        # TODO(stephenfin): Rename to 'volume_client' now that all commands are
         # migrated to SDK
         self.app.client_manager.sdk_connection.volume = mock.Mock(
             spec=block_storage_v2.Proxy,
@@ -57,8 +43,6 @@ def set_volume_api_version(self, version: str | None = None):
         """
         assert version is None
 
-        self.volume_client.api_version = None
-
         self.volume_sdk_client.default_microversion = None
         self.volume_sdk_client.get_endpoint_data.return_value = (
             discover.EndpointData(

openstackclient/tests/unit/volume/v2/fakes.py

@@ -13,47 +13,20 @@
 import re
 from unittest import mock
 
-from cinderclient import api_versions
 from keystoneauth1 import discover
 from openstack.block_storage import v3 as block_storage_v3
 from openstack.compute import v2 as compute_v2
 from openstack.image import v2 as image_v2
 
-from openstackclient.tests.unit import fakes
 from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
 from openstackclient.tests.unit import utils
 
 
-class FakeVolumeClient:
-    def __init__(self, **kwargs):
-        self.auth_token = kwargs['token']
-        self.management_url = kwargs['endpoint']
-        self.api_version = api_versions.APIVersion('3.0')
-
-        self.clusters = mock.Mock()
-        self.clusters.resource_class = fakes.FakeResource(None, {})
-        self.services = mock.Mock()
-        self.services.resource_class = fakes.FakeResource(None, {})
-        self.volume_snapshots = mock.Mock()
-        self.volume_snapshots.resource_class = fakes.FakeResource(None, {})
-        self.volume_types = mock.Mock()
-        self.volume_types.resource_class = fakes.FakeResource(None, {})
-        self.volumes = mock.Mock()
-        self.volumes.resource_class = fakes.FakeResource(None, {})
-        self.workers = mock.Mock()
-        self.workers.resource_class = fakes.FakeResource(None, {})
-
-
 class FakeClientMixin:
     def setUp(self):
         super().setUp()
 
-        self.app.client_manager.volume = FakeVolumeClient(
-            endpoint=fakes.AUTH_URL, token=fakes.AUTH_TOKEN
-        )
-        self.volume_client = self.app.client_manager.volume
-
-        # TODO(stephenfin): Rename to 'volume_client' once all commands are
+        # TODO(stephenfin): Rename to 'volume_client' now that all commands are
         # migrated to SDK
         self.app.client_manager.sdk_connection.volume = mock.Mock(
             spec=block_storage_v3.Proxy
@@ -72,8 +45,6 @@ def set_volume_api_version(self, version: str = '3.0'):
         """
         assert re.match(r'3.\d+', version)
 
-        self.volume_client.api_version = api_versions.APIVersion(version)
-
         self.volume_sdk_client.default_microversion = version
         self.volume_sdk_client.get_endpoint_data.return_value = (
             discover.EndpointData(

openstackclient/tests/unit/volume/v3/fakes.py

@@ -899,9 +899,6 @@ class TestVolumeDelete(volume_fakes.TestVolume):
     def setUp(self):
         super().setUp()
 
-        self.volumes_mock = self.volume_client.volumes
-        self.volumes_mock.reset_mock()
-
         self.volumes = list(sdk_fakes.generate_fake_resources(_volume.Volume))
         self.volume_sdk_client.find_volume.side_effect = self.volumes
         self.volume_sdk_client.delete_volume.return_value = None

openstackclient/tests/unit/volume/v3/test_volume.py

@@ -11,87 +11,31 @@
 #   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 argparse
 import logging
 from typing import Any
 
-from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
 
+# global variables used when building the shell
 DEFAULT_API_VERSION = '3'
 API_VERSION_OPTION = 'os_volume_api_version'
 API_NAME = 'volume'
-API_VERSIONS = {
-    '2': 'cinderclient.v2.client.Client',
-    '3': 'cinderclient.v3.client.Client',
-}
-
-# Save the microversion if in use
-_volume_api_version = None
+API_VERSIONS = ('2', '3')
 
 
 def make_client(instance: Any) -> Any:
     """Returns a volume service client."""
-
-    # Defer client imports until we actually need them
-    from cinderclient import extension
-    from cinderclient.v3.contrib import list_extensions
-    from cinderclient.v3 import volume_snapshots
-    from cinderclient.v3 import volumes
-
-    try:
-        from cinderclient.v2 import services  # noqa
-    except Exception:
-        del API_VERSIONS['2']
-
-    if _volume_api_version is not None:
-        version = _volume_api_version
-    else:
-        version = instance._api_version[API_NAME]
-        from cinderclient import api_versions
-
-        # convert to APIVersion object
-        version = api_versions.get_api_version(version)
-
-    if version.ver_major == '1':
-        # Monkey patch for v1 cinderclient
-        volumes.Volume.NAME_ATTR = 'display_name'
-        volume_snapshots.Snapshot.NAME_ATTR = 'display_name'
-
-    volume_client = utils.get_client_class(
-        API_NAME, version.ver_major, API_VERSIONS
-    )
-    LOG.debug('Instantiating volume client: %s', volume_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)
-
-    endpoint_override = instance.sdk_connection.config.get_endpoint(
-        'block-storage'
-    )
-
-    client = volume_client(
-        session=instance.session,
-        extensions=extensions,
-        http_log_debug=http_log_debug,
-        region_name=instance.region_name,
-        endpoint_override=endpoint_override,
-        api_version=version,
-        **kwargs,
+    LOG.debug(
+        'Volume client initialized using OpenStack SDK: %s',
+        instance.sdk_connection.block_storage,
     )
-
-    return client
+    return instance.sdk_connection.block_storage
 
 
 def build_option_parser(
@@ -109,36 +53,5 @@ def build_option_parser(
 
 
 def check_api_version(check_version: str) -> bool:
-    """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
-    """
-
-    # Defer client imports until we actually need them
-    from cinderclient import api_versions
-
-    global _volume_api_version
-
-    _volume_api_version = api_versions.get_api_version(check_version)
-
-    # Bypass X.latest format microversion
-    if not _volume_api_version.is_latest():
-        if _volume_api_version > api_versions.APIVersion('3.0'):
-            if not _volume_api_version.matches(
-                api_versions.MIN_VERSION,
-                api_versions.MAX_VERSION,
-            ):
-                msg = _('versions supported by client: %(min)s - %(max)s') % {
-                    'min': api_versions.MIN_VERSION,
-                    'max': api_versions.MAX_VERSION,
-                }
-                raise exceptions.CommandError(msg)
-
-            return True
-
-    return False
+    # SDK supports auto-negotiation for us: always return True
+    return True

openstackclient/volume/client.py

@@ -9,7 +9,6 @@ openstacksdk>=4.16.0 # Apache-2.0
 osc-lib>=4.6.0 # Apache-2.0
 oslo.i18n>=3.15.3 # Apache-2.0
 python-keystoneclient>=3.22.0 # Apache-2.0
-python-cinderclient>=3.3.0 # Apache-2.0
 python-manilaclient>=6.0.0 # Apache-2.0
 requests>=2.27.0 # Apache-2.0
 stevedore>=2.0.1 # Apache-2.0