python-openstackclient 8.3.0__py3-none-any.whl → 10.0.0__py3-none-any.whl

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

@@ -912,7 +912,7 @@ class TestVolumeDelete(volume_fakes.TestVolume):
         arglist = [self.volumes[0].id]
         verifylist = [
             ("force", False),
-            ("purge", False),
+            ("cascade", False),
             ("volumes", [self.volumes[0].id]),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -931,7 +931,7 @@ class TestVolumeDelete(volume_fakes.TestVolume):
         arglist = [v.id for v in self.volumes]
         verifylist = [
             ('force', False),
-            ('purge', False),
+            ('cascade', False),
             ('volumes', arglist),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -958,7 +958,7 @@ class TestVolumeDelete(volume_fakes.TestVolume):
         ]
         verifylist = [
             ('force', False),
-            ('purge', False),
+            ('cascade', False),
             ('volumes', [self.volumes[0].id, 'unexist_volume']),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -989,7 +989,29 @@ class TestVolumeDelete(volume_fakes.TestVolume):
         ]
         verifylist = [
             ('force', False),
-            ('purge', True),
+            ('cascade', True),
+            ('volumes', [self.volumes[0].id]),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+        self.assertIsNone(result)
+
+        self.volume_sdk_client.find_volume.assert_called_once_with(
+            self.volumes[0].id, ignore_missing=False
+        )
+        self.volume_sdk_client.delete_volume.assert_called_once_with(
+            self.volumes[0].id, cascade=True, force=False
+        )
+
+    def test_volume_delete_with_cascade(self):
+        arglist = [
+            '--cascade',
+            self.volumes[0].id,
+        ]
+        verifylist = [
+            ('force', False),
+            ('cascade', True),
             ('volumes', [self.volumes[0].id]),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -1011,7 +1033,7 @@ class TestVolumeDelete(volume_fakes.TestVolume):
         ]
         verifylist = [
             ('force', True),
-            ('purge', False),
+            ('cascade', False),
             ('volumes', [self.volumes[0].id]),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -1031,7 +1053,7 @@ class TestVolumeDelete(volume_fakes.TestVolume):
         verifylist = [
             ("remote", True),
             ("force", False),
-            ("purge", False),
+            ("cascade", False),
             ("volumes", [self.volumes[0].id]),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -1052,7 +1074,7 @@ class TestVolumeDelete(volume_fakes.TestVolume):
         verifylist = [
             ('remote', True),
             ('force', False),
-            ('purge', False),
+            ('cascade', False),
             ('volumes', arglist[1:]),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -1077,7 +1099,6 @@ class TestVolumeDelete(volume_fakes.TestVolume):
         verifylist = [
             ('remote', True),
             ('force', False),
-            ('purge', True),
             ('volumes', [self.volumes[0].id]),
         ]
 
@@ -1086,7 +1107,7 @@ class TestVolumeDelete(volume_fakes.TestVolume):
             exceptions.CommandError, self.cmd.take_action, parsed_args
         )
         self.assertIn(
-            "The --force and --purge options are not supported with the "
+            "The --force and --cascade options are not supported with the "
             "--remote parameter.",
             str(exc),
         )
@@ -1104,7 +1125,7 @@ class TestVolumeDelete(volume_fakes.TestVolume):
         verifylist = [
             ('remote', True),
             ('force', True),
-            ('purge', False),
+            ('cascade', False),
             ('volumes', [self.volumes[0].id]),
         ]
 
@@ -1113,7 +1134,7 @@ class TestVolumeDelete(volume_fakes.TestVolume):
             exceptions.CommandError, self.cmd.take_action, parsed_args
         )
         self.assertIn(
-            "The --force and --purge options are not supported with the "
+            "The --force and --cascade options are not supported with the "
             "--remote parameter.",
             str(exc),
         )
@@ -1702,9 +1723,10 @@ class TestVolumeMigrate(volume_fakes.TestVolume):
             host="host@backend-name#pool",
             force_host_copy=False,
             lock_volume=False,
+            cluster=None,
         )
 
-    def test_volume_migrate_with_option(self):
+    def test_volume_migrate_with_host(self):
         arglist = [
             "--force-host-copy",
             "--lock-volume",
@@ -1731,9 +1753,66 @@ class TestVolumeMigrate(volume_fakes.TestVolume):
             host="host@backend-name#pool",
             force_host_copy=True,
             lock_volume=True,
+            cluster=None,
         )
 
-    def test_volume_migrate_without_host(self):
+    def test_volume_migrate_with_cluster(self):
+        self.set_volume_api_version('3.16')
+        arglist = [
+            "--cluster",
+            "cluster@backend-name#pool",
+            self.volume.id,
+        ]
+        verifylist = [
+            (
+                "cluster",
+                "cluster@backend-name#pool",
+            ),
+            ("volume", self.volume.id),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+        self.assertIsNone(result)
+
+        self.volume_sdk_client.find_volume.assert_called_with(
+            self.volume.id, ignore_missing=False
+        )
+        self.volume_sdk_client.migrate_volume.assert_called_once_with(
+            self.volume.id,
+            host=None,
+            force_host_copy=False,
+            lock_volume=False,
+            cluster="cluster@backend-name#pool",
+        )
+
+    def test_volume_migrate_with_cluster_pre_v316(self):
+        self.set_volume_api_version('3.15')
+        arglist = [
+            "--cluster",
+            "cluster@backend-name#pool",
+            self.volume.id,
+        ]
+        verifylist = [
+            (
+                "cluster",
+                "cluster@backend-name#pool",
+            ),
+            ("volume", self.volume.id),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.assertRaises(
+            exceptions.CommandError,
+            self.cmd.take_action,
+            parsed_args,
+        )
+
+        self.volume_sdk_client.migrate_volume.assert_not_called()
+
+    def test_volume_migrate_without_host_and_cluster(self):
         arglist = [
             self.volume.id,
         ]
@@ -1750,7 +1829,6 @@ class TestVolumeMigrate(volume_fakes.TestVolume):
             arglist,
             verifylist,
         )
-
         self.volume_sdk_client.find_volume.assert_not_called()
         self.volume_sdk_client.migrate_volume.assert_not_called()
 
@@ -1998,7 +2076,8 @@ class TestVolumeSet(volume_fakes.TestVolume):
         result = self.cmd.take_action(parsed_args)
         self.volumes_mock.retype.assert_not_called()
         mock_warning.assert_called_with(
-            "'--retype-policy' option will not work without '--type' option"
+            "'%s' option will not work without '--type' option",
+            '--retype-policy',
         )
         self.assertIsNone(result)
 

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

@@ -23,7 +23,7 @@ class TestVolumeAttachment(volume_fakes.TestVolume):
     def setUp(self):
         super().setUp()
 
-        self.projects_mock = self.app.client_manager.identity.projects
+        self.projects_mock = self.identity_client.projects
 
 
 class TestVolumeAttachmentCreate(TestVolumeAttachment):

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

@@ -319,11 +319,7 @@ class TestBackupList(volume_fakes.TestVolume):
         'Incremental',
         'Created At',
     )
-    columns_long = columns + (
-        'Availability Zone',
-        'Volume',
-        'Container',
-    )
+    columns_long = (*columns, 'Availability Zone', 'Volume', 'Container')
 
     def setUp(self):
         super().setUp()

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

@@ -180,6 +180,59 @@ class TestVolumeSnapshotCreate(volume_fakes.TestVolume):
         )
         self.volume_sdk_client.create_snapshot.assert_not_called()
 
+    def test_snapshot_create_pre_v366(self):
+        self.set_volume_api_version('3.65')
+
+        arglist = ["--force", self.snapshot.name]
+        verifylist = [("force", True), ("snapshot_name", self.snapshot.name)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # force parameter should be passed
+        self.volume_sdk_client.create_snapshot.assert_called_with(
+            volume_id=self.snapshot.volume_id,
+            force=True,
+            name=self.snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
+    def test_snapshot_create_v366_or_later(self):
+        self.set_volume_api_version('3.66')
+
+        arglist = [self.snapshot.name]
+        verifylist = [("force", False), ("snapshot_name", self.snapshot.name)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # force parameter should not be passed, for >=3.66
+        self.volume_sdk_client.create_snapshot.assert_called_with(
+            volume_id=self.snapshot.volume_id,
+            name=self.snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
+    def test_snapshot_create_v366_or_later_with_force(self):
+        """--force should be ignored for microversion >= 3.66."""
+        self.set_volume_api_version('3.66')
+
+        arglist = ["--force", self.snapshot.name]
+        verifylist = [("force", True), ("snapshot_name", self.snapshot.name)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # passed but ignored
+        self.volume_sdk_client.create_snapshot.assert_called_with(
+            volume_id=self.snapshot.volume_id,
+            name=self.snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
 
 class TestVolumeSnapshotDelete(volume_fakes.TestVolume):
     def setUp(self):
@@ -340,7 +393,8 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.project_mock.get.return_value = self.project
 
         self.columns = ("ID", "Name", "Description", "Status", "Size")
-        self.columns_long = self.columns + (
+        self.columns_long = (
+            *self.columns,
             "Created At",
             "Volume",
             "Properties",

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

@@ -331,7 +331,7 @@ class TestTypeList(TestType):
         "Name",
         "Is Public",
     ]
-    columns_long = columns + ["Description", "Properties"]
+    columns_long = [*columns, "Description", "Properties"]
     data_with_default_type = [(volume_types[0].id, volume_types[0].name, True)]
     data = []
     for t in volume_types:
@@ -509,9 +509,7 @@ class TestTypeList(TestType):
             'key_size': None,
             'control_location': 'front-end',
         }
-        encryption_columns = self.columns + [
-            "Encryption",
-        ]
+        encryption_columns = [*self.columns, "Encryption"]
         encryption_data = []
         encryption_data.append(
             (

openstackclient/volume/client.py

@@ -13,7 +13,9 @@
 #   under the License.
 #
 
+import argparse
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -34,7 +36,7 @@ API_VERSIONS = {
 _volume_api_version = None
 
 
-def make_client(instance):
+def make_client(instance: Any) -> Any:
     """Returns a volume service client."""
 
     # Defer client imports until we actually need them
@@ -92,7 +94,9 @@ def make_client(instance):
     return client
 
 
-def build_option_parser(parser):
+def build_option_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
     """Hook to add global options"""
     parser.add_argument(
         '--os-volume-api-version',
@@ -104,7 +108,7 @@ def build_option_parser(parser):
     return parser
 
 
-def check_api_version(check_version):
+def check_api_version(check_version: str) -> bool:
     """Validate version supplied by user
 
     Returns:

openstackclient/volume/v2/backup_record.py

@@ -14,7 +14,10 @@
 
 """Volume v2 Backup action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib import utils
 
@@ -33,7 +36,7 @@ Backup information can be imported into a new service instance to be able to
 restore."""
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "backup",
@@ -42,7 +45,9 @@ restore."""
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         volume_client = self.app.client_manager.volume
         backup = utils.find_resource(volume_client.backups, parsed_args.backup)
         backup_data = volume_client.backups.export_record(backup.id)
@@ -53,7 +58,8 @@ restore."""
             backup_data['Backup Service'] = backup_data.pop('backup_service')
             backup_data['Metadata'] = backup_data.pop('backup_url')
 
-        return zip(*sorted(backup_data.items()))
+        col_headers, col_data = zip(*sorted(backup_data.items()))
+        return col_headers, col_data
 
 
 class ImportBackupRecord(command.ShowOne):
@@ -64,7 +70,7 @@ Exported backup details contain the metadata necessary to restore to a new or
 rebuilt service instance"""
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "backup_service",
@@ -78,10 +84,13 @@ rebuilt service instance"""
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         volume_client = self.app.client_manager.volume
         backup_data = volume_client.backups.import_record(
             parsed_args.backup_service, parsed_args.backup_metadata
         )
         backup_data.pop('links', None)
-        return zip(*sorted(backup_data.items()))
+        col_headers, col_data = zip(*sorted(backup_data.items()))
+        return col_headers, col_data

openstackclient/volume/v2/consistency_group.py

@@ -16,6 +16,8 @@
 
 import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
@@ -28,7 +30,9 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _find_volumes(parsed_args_volumes, volume_client):
+def _find_volumes(
+    parsed_args_volumes: list[str], volume_client: Any
+) -> tuple[int, str]:
     result = 0
     uuid = ''
     for volume in parsed_args_volumes:
@@ -38,8 +42,8 @@ def _find_volumes(parsed_args_volumes, volume_client):
         except Exception as e:
             result += 1
             LOG.error(
-                _("Failed to find volume with name or ID '%(volume)s':%(e)s")
-                % {'volume': volume, 'e': e}
+                _("Failed to find volume with name or ID '%(volume)s':%(e)s"),
+                {'volume': volume, 'e': e},
             )
 
     return result, uuid
@@ -48,7 +52,7 @@ def _find_volumes(parsed_args_volumes, volume_client):
 class AddVolumeToConsistencyGroup(command.Command):
     _description = _("Add volume(s) to consistency group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'consistency_group',
@@ -66,15 +70,15 @@ class AddVolumeToConsistencyGroup(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         result, add_uuid = _find_volumes(parsed_args.volumes, volume_client)
 
         if result > 0:
             total = len(parsed_args.volumes)
             LOG.error(
-                _("%(result)s of %(total)s volumes failed to add.")
-                % {'result': result, 'total': total}
+                _("%(result)s of %(total)s volumes failed to add."),
+                {'result': result, 'total': total},
             )
 
         if add_uuid:
@@ -90,7 +94,7 @@ class AddVolumeToConsistencyGroup(command.Command):
 class CreateConsistencyGroup(command.ShowOne):
     _description = _("Create new consistency group.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "name",
@@ -144,7 +148,9 @@ class CreateConsistencyGroup(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         volume_client = self.app.client_manager.volume
         if parsed_args.volume_type:
             volume_type_id = utils.find_resource(
@@ -186,13 +192,14 @@ class CreateConsistencyGroup(command.ShowOne):
                 )
             )
 
-        return zip(*sorted(consistency_group._info.items()))
+        col_headers, col_data = zip(*sorted(consistency_group._info.items()))
+        return col_headers, col_data
 
 
 class DeleteConsistencyGroup(command.Command):
     _description = _("Delete consistency group(s).")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'consistency_groups',
@@ -208,7 +215,7 @@ class DeleteConsistencyGroup(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         result = 0
 
@@ -226,8 +233,8 @@ class DeleteConsistencyGroup(command.Command):
                     _(
                         "Failed to delete consistency group with "
                         "name or ID '%(consistency_group)s':%(e)s"
-                    )
-                    % {'consistency_group': i, 'e': e}
+                    ),
+                    {'consistency_group': i, 'e': e},
                 )
 
         if result > 0:
@@ -241,7 +248,7 @@ class DeleteConsistencyGroup(command.Command):
 class ListConsistencyGroup(command.Lister):
     _description = _("List consistency groups.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--all-projects',
@@ -258,7 +265,9 @@ class ListConsistencyGroup(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         if parsed_args.long:
             columns = [
                 'ID',
@@ -292,7 +301,7 @@ class ListConsistencyGroup(command.Lister):
 class RemoveVolumeFromConsistencyGroup(command.Command):
     _description = _("Remove volume(s) from consistency group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'consistency_group',
@@ -310,15 +319,15 @@ class RemoveVolumeFromConsistencyGroup(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         result, remove_uuid = _find_volumes(parsed_args.volumes, volume_client)
 
         if result > 0:
             total = len(parsed_args.volumes)
             LOG.error(
-                _("%(result)s of %(total)s volumes failed to remove.")
-                % {'result': result, 'total': total}
+                _("%(result)s of %(total)s volumes failed to remove."),
+                {'result': result, 'total': total},
             )
 
         if remove_uuid:
@@ -334,7 +343,7 @@ class RemoveVolumeFromConsistencyGroup(command.Command):
 class SetConsistencyGroup(command.Command):
     _description = _("Set consistency group properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'consistency_group',
@@ -353,7 +362,7 @@ class SetConsistencyGroup(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         kwargs = {}
         if parsed_args.name:
@@ -372,7 +381,7 @@ class SetConsistencyGroup(command.Command):
 class ShowConsistencyGroup(command.ShowOne):
     _description = _("Display consistency group details.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "consistency_group",
@@ -381,9 +390,12 @@ class ShowConsistencyGroup(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         volume_client = self.app.client_manager.volume
         consistency_group = utils.find_resource(
             volume_client.consistencygroups, parsed_args.consistency_group
         )
-        return zip(*sorted(consistency_group._info.items()))
+        col_headers, col_data = zip(*sorted(consistency_group._info.items()))
+        return col_headers, col_data