Merge "volume: Migrate to 'volume' client alias"

Author: Zuul

openstackclient/common/availability_zone.py

@@ -166,7 +166,7 @@ def _get_volume_availability_zones(
         self, parsed_args: argparse.Namespace
     ) -> list[dict[str, str]]:
         volume_client = sdk_utils.ensure_service_version(
-            self.app.client_manager.sdk_connection.volume, '3'
+            self.app.client_manager.volume, '3'
         )
         data = []
         try:

openstackclient/common/clientmanager.py

@@ -23,6 +23,8 @@
 from typing import Any, Protocol, TypeVar, runtime_checkable
 
 from keystoneauth1 import access as ksa_access
+from openstack.block_storage import v2 as volume_v2
+from openstack.block_storage import v3 as volume_v3
 from openstack.compute import v2 as compute_v2
 from openstack.image import v2 as image_v2
 from openstack.network import v2 as network_v2
@@ -51,15 +53,15 @@ class ClientManager(clientmanager.ClientManager):
 
     # this is a hack to keep mypy happy: the actual attributes are set in
     # get_plugin_modules below
-    # TODO(stephenfin): Change the types of identity, object store and volume
+    # TODO(stephenfin): Change the types of identity, object store and share
     # once we've migrated everything to SDK
     compute: compute_v2.Proxy
     identity: Any
     image: image_v2.Proxy
     network: network_v2.Proxy
     object_store: object_store_v1.APIv1
     share: Any
-    volume: Any
+    volume: volume_v2.Proxy | volume_v3.Proxy
 
     def __init__(
         self,

openstackclient/common/extension.py

@@ -120,7 +120,7 @@ def take_action(
                 LOG.warning(message)
 
         if parsed_args.volume or show_all:
-            volume_client = self.app.client_manager.sdk_connection.volume
+            volume_client = self.app.client_manager.volume
             try:
                 data += volume_client.extensions()
             except Exception:

openstackclient/common/limits.py

@@ -127,7 +127,7 @@ def take_action(
             )
 
         if self.app.client_manager.is_volume_endpoint_enabled():
-            volume_client = self.app.client_manager.sdk_connection.volume
+            volume_client = self.app.client_manager.volume
             volume_limits = volume_client.get_limits(
                 project=project_id,
             )

openstackclient/common/quota.py

@@ -157,7 +157,7 @@ def get_volume_quotas(
     default: bool = False,
 ) -> dict[str, Any]:
     try:
-        client = app.client_manager.sdk_connection.volume
+        client = app.client_manager.volume
         if default:
             quota = client.get_quota_set_defaults(project_id)
         else:
@@ -338,7 +338,7 @@ def _list_quota_volume(
         parsed_args: argparse.Namespace,
         project_ids: list[str],
     ) -> tuple[tuple[str, ...], Any]:
-        volume_client = self.app.client_manager.sdk_connection.volume
+        volume_client = self.app.client_manager.volume
         result = []
 
         for project_id in project_ids:
@@ -613,7 +613,7 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
                 compute_kwargs['force'] = parsed_args.force
 
         if self.app.client_manager.is_volume_endpoint_enabled():
-            volume_client = self.app.client_manager.sdk_connection.volume
+            volume_client = self.app.client_manager.volume
 
             for k, v in VOLUME_QUOTAS.items():
                 value = getattr(parsed_args, k, None)
@@ -949,7 +949,7 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
             parsed_args.service == 'all'
             and self.app.client_manager.is_volume_endpoint_enabled()
         ):
-            volume_client = self.app.client_manager.sdk_connection.volume
+            volume_client = self.app.client_manager.volume
             volume_client.revert_quota_set(project.id)
 
         # network quotas (but only if we're not using nova-network, otherwise

openstackclient/compute/v2/server.py

@@ -787,7 +787,7 @@ def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
         compute_client = self.app.client_manager.compute
-        volume_client = self.app.client_manager.sdk_connection.volume
+        volume_client = self.app.client_manager.volume
 
         server = compute_client.find_server(
             parsed_args.server,
@@ -1596,7 +1596,7 @@ def _show_progress(progress: int | None) -> None:
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.compute
-        volume_client = self.app.client_manager.sdk_connection.volume
+        volume_client = self.app.client_manager.volume
         image_client = self.app.client_manager.image
 
         # Lookup parsed_args.image
@@ -4268,7 +4268,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
         volume_client = sdk_utils.ensure_service_version(
-            self.app.client_manager.sdk_connection.volume, '3'
+            self.app.client_manager.volume, '3'
         )
 
         server = compute_client.find_server(

openstackclient/compute/v2/server_volume.py

@@ -122,7 +122,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
         volume_client = sdk_utils.ensure_service_version(
-            self.app.client_manager.sdk_connection.volume, '3'
+            self.app.client_manager.volume, '3'
         )
 
         if parsed_args.delete_on_termination is not None:

openstackclient/image/v1/image.py

@@ -297,7 +297,7 @@ def take_action(
 
         if not parsed_args.location and not parsed_args.copy_from:
             if parsed_args.volume:
-                volume_client = self.app.client_manager.sdk_connection.volume
+                volume_client = self.app.client_manager.volume
                 source_volume = volume_client.find_volume(
                     parsed_args.volume, ignore_missing=False
                 )
@@ -762,9 +762,7 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
 
             if not parsed_args.location and not parsed_args.copy_from:
                 if parsed_args.volume:
-                    volume_client = (
-                        self.app.client_manager.sdk_connection.volume
-                    )
+                    volume_client = self.app.client_manager.volume
                     source_volume = volume_client.find_volume(
                         parsed_args.volume, ignore_missing=False
                     )

openstackclient/image/v2/image.py

@@ -604,7 +604,7 @@ def _take_action_volume(
         self, parsed_args: argparse.Namespace
     ) -> dict[str, Any]:
         volume_client = sdk_utils.ensure_service_version(
-            self.app.client_manager.sdk_connection.volume, '3'
+            self.app.client_manager.volume, '3'
         )
 
         unsupported_opts = {

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

@@ -39,11 +39,9 @@ def setUp(self):
 
         # 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
-        )
-        self.app.client_manager.sdk_connection.volume.api_version = '2'
-        self.volume_sdk_client = self.app.client_manager.sdk_connection.volume
+        self.app.client_manager.volume = mock.Mock(spec=block_storage_v2.Proxy)
+        self.app.client_manager.volume.api_version = '2'
+        self.volume_sdk_client = self.app.client_manager.volume
 
 
 def create_one_image(attrs=None):