volume: Migrate 'block storage cluster *' to SDK

stephenfin · stephenfin · commit 8a723ab19585 · 2026-06-26T01:20:24.000+01:00
Change-Id: Ib7d5069af7b81810df66234efe8f063eeae1ab20
Signed-off-by: Stephen Finucane &lt;stephenfin@redhat.com&gt;
diff --git a/openstackclient/tests/unit/volume/v3/test_block_storage_cluster.py b/openstackclient/tests/unit/volume/v3/test_block_storage_cluster.py
@@ -10,31 +10,24 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+from openstack.block_storage.v3 import cluster as _cluster
+from openstack.test import fakes as sdk_fakes
 from osc_lib import exceptions
 
 from openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
 from openstackclient.volume.v3 import block_storage_cluster
 
 
-class TestBlockStorageCluster(volume_fakes.TestVolume):
-    def setUp(self):
-        super().setUp()
-
-        # Get a shortcut to the BlockStorageClusterManager Mock
-        self.cluster_mock = self.volume_client.clusters
-        self.cluster_mock.reset_mock()
-
-
-class TestBlockStorageClusterList(TestBlockStorageCluster):
-    # The cluster to be listed
-    fake_clusters = volume_fakes.create_clusters()
+class TestBlockStorageClusterList(volume_fakes.TestVolume):
+    fake_clusters = list(
+        sdk_fakes.generate_fake_resources(_cluster.Cluster, count=2)
+    )
 
     def setUp(self):
         super().setUp()
 
-        self.cluster_mock.list.return_value = self.fake_clusters
+        self.volume_sdk_client.clusters.return_value = self.fake_clusters
 
-        # Get the command object to test
         self.cmd = block_storage_cluster.ListBlockStorageCluster(
             self.app, None
         )
@@ -69,15 +62,14 @@ def test_cluster_list(self):
         self.assertEqual(expected_columns, columns)
         self.assertEqual(expected_data, tuple(data))
 
-        # checking if proper call was made to list clusters
-        self.cluster_mock.list.assert_called_with(
+        self.volume_sdk_client.clusters.assert_called_once_with(
             name=None,
             binary=None,
             is_up=None,
             disabled=None,
             num_hosts=None,
             num_down_hosts=None,
-            detailed=False,
+            details=False,
         )
 
     def test_cluster_list_with_full_options(self):
@@ -139,15 +131,14 @@ def test_cluster_list_with_full_options(self):
         self.assertEqual(expected_columns, columns)
         self.assertEqual(expected_data, tuple(data))
 
-        # checking if proper call was made to list clusters
-        self.cluster_mock.list.assert_called_with(
+        self.volume_sdk_client.clusters.assert_called_once_with(
             name='foo',
             binary='bar',
             is_up=True,
             disabled=True,
             num_hosts=5,
             num_down_hosts=0,
-            detailed=True,
+            details=True,
         )
 
     def test_cluster_list_pre_v37(self):
@@ -173,8 +164,8 @@ def test_cluster_list_pre_v37(self):
         )
 
 
-class TestBlockStorageClusterSet(TestBlockStorageCluster):
-    cluster = volume_fakes.create_one_cluster()
+class TestBlockStorageClusterSet(volume_fakes.TestVolume):
+    cluster = sdk_fakes.generate_fake_resource(_cluster.Cluster)
     columns = (
         'Name',
         'Binary',
@@ -209,11 +200,12 @@ class TestBlockStorageClusterSet(TestBlockStorageCluster):
     def setUp(self):
         super().setUp()
 
-        self.cluster_mock.update.return_value = self.cluster
+        self.volume_sdk_client.enable_cluster.return_value = self.cluster
+        self.volume_sdk_client.disable_cluster.return_value = self.cluster
 
         self.cmd = block_storage_cluster.SetBlockStorageCluster(self.app, None)
 
-    def test_cluster_set(self):
+    def test_cluster_set_enable(self):
         self.set_volume_api_version('3.7')
 
         arglist = [
@@ -233,12 +225,10 @@ def test_cluster_set(self):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, tuple(data))
 
-        self.cluster_mock.update.assert_called_once_with(
-            self.cluster.name,
-            'cinder-volume',
-            disabled=False,
-            disabled_reason=None,
+        self.volume_sdk_client.enable_cluster.assert_called_once_with(
+            _cluster.Cluster(name=self.cluster.name, binary='cinder-volume')
         )
+        self.volume_sdk_client.disable_cluster.assert_not_called()
 
     def test_cluster_set_disable_with_reason(self):
         self.set_volume_api_version('3.7')
@@ -263,12 +253,13 @@ def test_cluster_set_disable_with_reason(self):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, tuple(data))
 
-        self.cluster_mock.update.assert_called_once_with(
-            self.cluster.name,
-            self.cluster.binary,
-            disabled=True,
-            disabled_reason='foo',
+        self.volume_sdk_client.disable_cluster.assert_called_once_with(
+            _cluster.Cluster(
+                name=self.cluster.name, binary=self.cluster.binary
+            ),
+            reason='foo',
         )
+        self.volume_sdk_client.enable_cluster.assert_not_called()
 
     def test_cluster_set_only_with_disable_reason(self):
         self.set_volume_api_version('3.7')
@@ -341,8 +332,8 @@ def test_cluster_set_pre_v37(self):
         )
 
 
-class TestBlockStorageClusterShow(TestBlockStorageCluster):
-    cluster = volume_fakes.create_one_cluster()
+class TestBlockStorageClusterShow(volume_fakes.TestVolume):
+    cluster = sdk_fakes.generate_fake_resource(_cluster.Cluster)
     columns = (
         'Name',
         'Binary',
@@ -377,7 +368,7 @@ class TestBlockStorageClusterShow(TestBlockStorageCluster):
     def setUp(self):
         super().setUp()
 
-        self.cluster_mock.show.return_value = self.cluster
+        self.volume_sdk_client.get_cluster.return_value = self.cluster
 
         self.cmd = block_storage_cluster.ShowBlockStorageCluster(
             self.app, None
@@ -387,13 +378,11 @@ def test_cluster_show(self):
         self.set_volume_api_version('3.7')
 
         arglist = [
-            '--binary',
-            self.cluster.binary,
             self.cluster.name,
         ]
         verifylist = [
             ('cluster', self.cluster.name),
-            ('binary', self.cluster.binary),
+            ('binary', None),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -402,22 +391,19 @@ def test_cluster_show(self):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, tuple(data))
 
-        self.cluster_mock.show.assert_called_once_with(
-            self.cluster.name,
-            binary=self.cluster.binary,
+        self.volume_sdk_client.get_cluster.assert_called_once_with(
+            self.cluster.name
         )
 
     def test_cluster_show_pre_v37(self):
         self.set_volume_api_version('3.6')
 
         arglist = [
-            '--binary',
-            self.cluster.binary,
             self.cluster.name,
         ]
         verifylist = [
             ('cluster', self.cluster.name),
-            ('binary', self.cluster.binary),
+            ('binary', None),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
diff --git a/openstackclient/volume/v3/block_storage_cluster.py b/openstackclient/volume/v3/block_storage_cluster.py
@@ -14,7 +14,8 @@
 from collections.abc import Iterable, Sequence
 from typing import Any
 
-from cinderclient import api_versions
+from openstack.block_storage.v3 import cluster as _cluster
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -146,9 +147,11 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
-        volume_client = self.app.client_manager.volume
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
-        if volume_client.api_version < api_versions.APIVersion('3.7'):
+        if not sdk_utils.supports_microversion(volume_client, '3.7'):
             msg = _(
                 "--os-volume-api-version 3.7 or greater is required to "
                 "support the 'block storage cluster list' command"
@@ -166,14 +169,14 @@ def take_action(
                 'Updated At',
             )
 
-        data = volume_client.clusters.list(
+        data = volume_client.clusters(
             name=parsed_args.cluster,
             binary=parsed_args.binary,
             is_up=parsed_args.is_up,
             disabled=parsed_args.is_disabled,
             num_hosts=parsed_args.num_hosts,
             num_down_hosts=parsed_args.num_down_hosts,
-            detailed=parsed_args.long,
+            details=parsed_args.long,
         )
 
         return (
@@ -232,9 +235,11 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
-        volume_client = self.app.client_manager.volume
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
-        if volume_client.api_version < api_versions.APIVersion('3.7'):
+        if not sdk_utils.supports_microversion(volume_client, '3.7'):
             msg = _(
                 "--os-volume-api-version 3.7 or greater is required to "
                 "support the 'block storage cluster set' command"
@@ -245,13 +250,19 @@ def take_action(
             msg = _("Cannot specify --disable-reason without --disable")
             raise exceptions.CommandError(msg)
 
-        cluster = volume_client.clusters.update(
-            parsed_args.cluster,
-            parsed_args.binary,
-            disabled=parsed_args.disabled,
-            disabled_reason=parsed_args.disabled_reason,
+        cluster_obj = _cluster.Cluster(
+            name=parsed_args.cluster,
+            binary=parsed_args.binary,
         )
 
+        if parsed_args.disabled:
+            cluster = volume_client.disable_cluster(
+                cluster_obj,
+                reason=parsed_args.disabled_reason,
+            )
+        else:
+            cluster = volume_client.enable_cluster(cluster_obj)
+
         return _format_cluster(cluster, detailed=True)
 
 
@@ -278,18 +289,17 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
-        volume_client = self.app.client_manager.volume
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
-        if volume_client.api_version < api_versions.APIVersion('3.7'):
+        if not sdk_utils.supports_microversion(volume_client, '3.7'):
             msg = _(
                 "--os-volume-api-version 3.7 or greater is required to "
                 "support the 'block storage cluster show' command"
             )
             raise exceptions.CommandError(msg)
 
-        cluster = volume_client.clusters.show(
-            parsed_args.cluster,
-            binary=parsed_args.binary,
-        )
+        cluster = volume_client.get_cluster(parsed_args.cluster)
 
         return _format_cluster(cluster, detailed=True)
