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

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

@@ -17,6 +17,7 @@ from openstack.block_storage.v3 import backup as _backup
 from openstack.block_storage.v3 import snapshot as _snapshot
 from openstack.block_storage.v3 import volume as _volume
 from openstack import exceptions as sdk_exceptions
+from openstack.identity.v3 import project as _project
 from openstack.test import fakes as sdk_fakes
 from osc_lib import exceptions
 
@@ -381,6 +382,7 @@ class TestBackupList(volume_fakes.TestVolume):
             ("marker", None),
             ("limit", None),
             ('all_projects', False),
+            ("project", None),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -395,11 +397,14 @@ class TestBackupList(volume_fakes.TestVolume):
             all_tenants=False,
             marker=None,
             limit=None,
+            project_id=None,
         )
         self.assertEqual(self.columns, columns)
         self.assertCountEqual(self.data, list(data))
 
     def test_backup_list_with_options(self):
+        project = sdk_fakes.generate_fake_resource(_project.Project)
+        self.identity_sdk_client.find_project.return_value = project
         arglist = [
             "--long",
             "--name",
@@ -413,6 +418,8 @@ class TestBackupList(volume_fakes.TestVolume):
             "--all-projects",
             "--limit",
             "3",
+            "--project",
+            project.id,
         ]
         verifylist = [
             ("long", True),
@@ -422,6 +429,7 @@ class TestBackupList(volume_fakes.TestVolume):
             ("marker", self.backups[0].id),
             ('all_projects', True),
             ("limit", 3),
+            ("project", project.id),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -440,6 +448,7 @@ class TestBackupList(volume_fakes.TestVolume):
             all_tenants=True,
             marker=self.backups[0].id,
             limit=3,
+            project_id=project.id,
         )
         self.assertEqual(self.columns_long, columns)
         self.assertCountEqual(self.data_long, list(data))

openstackclient/volume/client.py

@@ -20,16 +20,14 @@ from osc_lib import utils
 
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
 DEFAULT_API_VERSION = '3'
 API_VERSION_OPTION = 'os_volume_api_version'
-API_NAME = "volume"
+API_NAME = 'volume'
 API_VERSIONS = {
-    "1": "cinderclient.v1.client.Client",
-    "2": "cinderclient.v2.client.Client",
-    "3": "cinderclient.v3.client.Client",
+    '2': 'cinderclient.v2.client.Client',
+    '3': 'cinderclient.v3.client.Client',
 }
 
 # Save the microversion if in use
@@ -45,11 +43,6 @@ def make_client(instance):
     from cinderclient.v3 import volume_snapshots
     from cinderclient.v3 import volumes
 
-    # Check whether the available cinderclient supports v1 or v2
-    try:
-        from cinderclient.v1 import services  # noqa
-    except Exception:
-        del API_VERSIONS['1']
     try:
         from cinderclient.v2 import services  # noqa
     except Exception:
@@ -127,21 +120,18 @@ def check_api_version(check_version):
 
     global _volume_api_version
 
-    # Copy some logic from novaclient 3.3.0 for basic version detection
-    # NOTE(dtroyer): This is only enough to resume operations using API
-    # version 3.0 or any valid version supplied by the user.
     _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 _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,
+                msg = _('versions supported by client: %(min)s - %(max)s') % {
+                    'min': api_versions.MIN_VERSION,
+                    'max': api_versions.MAX_VERSION,
                 }
                 raise exceptions.CommandError(msg)
 

openstackclient/volume/v2/backup_record.py

@@ -16,9 +16,9 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v2/consistency_group.py

@@ -18,10 +18,10 @@ import argparse
 import logging
 
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v2/consistency_group_snapshot.py

@@ -16,10 +16,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v2/qos_specs.py

@@ -19,10 +19,10 @@ import logging
 
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v2/service.py

@@ -14,10 +14,10 @@
 
 """Service action implementations"""
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 
@@ -126,7 +126,7 @@ class SetService(command.Command):
         volume_client = self.app.client_manager.sdk_connection.volume
 
         service = volume_client.find_service(
-            host=parsed_args.host, service=parsed_args.service
+            parsed_args.service, ignore_missing=False, host=parsed_args.host
         )
 
         if parsed_args.enable:

openstackclient/volume/v2/volume.py

@@ -18,15 +18,18 @@ import argparse
 import copy
 import functools
 import logging
+import typing as ty
 
 from cliff import columns as cliff_columns
+from openstack.block_storage.v2 import volume as _volume
 from openstack import exceptions as sdk_exceptions
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.api import volume_v2
+from openstackclient import command
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
@@ -58,7 +61,7 @@ class KeyValueHintAction(argparse.Action):
             )
 
 
-class AttachmentsColumn(cliff_columns.FormattableColumn):
+class AttachmentsColumn(cliff_columns.FormattableColumn[list[ty.Any]]):
     """Formattable column for attachments column.
 
     Unlike the parent FormattableColumn class, the initializer of the
@@ -89,6 +92,47 @@ class AttachmentsColumn(cliff_columns.FormattableColumn):
         return msg
 
 
+def _format_volume(volume: _volume.Volume) -> dict[str, ty.Any]:
+    # Some columns returned by openstacksdk should not be shown because they're
+    # either irrelevant or duplicates
+    ignored_columns = {
+        # computed columns
+        'location',
+        # create-only columns
+        'OS-SCH-HNT:scheduler_hints',
+        'imageRef',
+        # unnecessary columns
+        'links',
+    }
+    optional_columns = {
+        # only present if part of a consistency group
+        'consistencygroup_id',
+        # only present if there are image properties associated
+        'volume_image_metadata',
+    }
+
+    info = volume.to_dict(original_names=True)
+    data = {}
+    for key, value in info.items():
+        if key in ignored_columns:
+            continue
+
+        if key in optional_columns:
+            if info[key] is None:
+                continue
+
+        data[key] = value
+
+    data.update(
+        {
+            'properties': format_columns.DictColumn(data.pop('metadata')),
+            'type': data.pop('volume_type'),
+        }
+    )
+
+    return data
+
+
 class CreateVolume(command.ShowOne):
     _description = _("Create new volume")
 
@@ -226,22 +270,22 @@ class CreateVolume(command.ShowOne):
         # volume from snapshot or source volume
         size = parsed_args.size
 
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
         image_client = self.app.client_manager.image
 
         source_volume = None
         if parsed_args.source:
-            source_volume_obj = utils.find_resource(
-                volume_client.volumes, parsed_args.source
+            source_volume_obj = volume_client.find_volume(
+                parsed_args.source, ignore_missing=False
             )
             source_volume = source_volume_obj.id
             size = max(size or 0, source_volume_obj.size)
 
         consistency_group = None
         if parsed_args.consistency_group:
-            consistency_group = utils.find_resource(
-                volume_client.consistencygroups, parsed_args.consistency_group
-            ).id
+            consistency_group = volume_v2.find_consistency_group(
+                volume_client, parsed_args.consistency_group
+            )['id']
 
         image = None
         if parsed_args.image:
@@ -251,8 +295,8 @@ class CreateVolume(command.ShowOne):
 
         snapshot = None
         if parsed_args.snapshot:
-            snapshot_obj = utils.find_resource(
-                volume_client.volume_snapshots, parsed_args.snapshot
+            snapshot_obj = volume_client.find_snapshot(
+                parsed_args.snapshot, ignore_missing=False
             )
             snapshot = snapshot_obj.id
             # Cinder requires a value for size when creating a volume
@@ -263,7 +307,7 @@ class CreateVolume(command.ShowOne):
             # snapshot size.
             size = max(size or 0, snapshot_obj.size)
 
-        volume = volume_client.volumes.create(
+        volume = volume_client.create_volume(
             size=size,
             snapshot_id=snapshot,
             name=parsed_args.name,
@@ -271,23 +315,23 @@ class CreateVolume(command.ShowOne):
             volume_type=parsed_args.type,
             availability_zone=parsed_args.availability_zone,
             metadata=parsed_args.properties,
-            imageRef=image,
-            source_volid=source_volume,
-            consistencygroup_id=consistency_group,
+            image_id=image,
+            source_volume_id=source_volume,
+            consistency_group_id=consistency_group,
             scheduler_hints=parsed_args.hint,
         )
 
         if parsed_args.bootable is not None:
             try:
                 if utils.wait_for_status(
-                    volume_client.volumes.get,
+                    volume_client.get_volume,
                     volume.id,
                     success_status=['available'],
                     error_status=['error'],
                     sleep_time=1,
                 ):
-                    volume_client.volumes.set_bootable(
-                        volume.id, parsed_args.bootable
+                    volume_client.set_volume_bootable_status(
+                        volume, parsed_args.bootable
                     )
                 else:
                     msg = _(
@@ -300,14 +344,14 @@ class CreateVolume(command.ShowOne):
         if parsed_args.read_only is not None:
             try:
                 if utils.wait_for_status(
-                    volume_client.volumes.get,
+                    volume_client.get_volume,
                     volume.id,
                     success_status=['available'],
                     error_status=['error'],
                     sleep_time=1,
                 ):
-                    volume_client.volumes.update_readonly_flag(
-                        volume.id, parsed_args.read_only
+                    volume_client.set_volume_readonly(
+                        volume, parsed_args.read_only
                     )
                 else:
                     msg = _(
@@ -321,17 +365,8 @@ class CreateVolume(command.ShowOne):
                     e,
                 )
 
-        # Remove key links from being displayed
-        volume._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    volume._info.pop('metadata')
-                ),
-                'type': volume._info.pop('volume_type'),
-            }
-        )
-        volume._info.pop("links", None)
-        return zip(*sorted(volume._info.items()))
+        data = _format_volume(volume)
+        return zip(*sorted(data.items()))
 
 
 class DeleteVolume(command.Command):
@@ -578,13 +613,15 @@ class MigrateVolume(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
-        volume_client.volumes.migrate_volume(
+        volume_client = self.app.client_manager.sdk_connection.volume
+        volume = volume_client.find_volume(
+            parsed_args.volume, ignore_missing=False
+        )
+        volume_client.migrate_volume(
             volume.id,
-            parsed_args.host,
-            parsed_args.force_host_copy,
-            parsed_args.lock_volume,
+            host=parsed_args.host,
+            force_host_copy=parsed_args.force_host_copy,
+            lock_volume=parsed_args.lock_volume,
         )
 
 
@@ -918,24 +955,13 @@ class ShowVolume(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
+        volume_client = self.app.client_manager.sdk_connection.volume
+        volume = volume_client.find_volume(
+            parsed_args.volume, ignore_missing=False
+        )
 
-        # Special mapping for columns to make the output easier to read:
-        # 'metadata' --> 'properties'
-        # 'volume_type' --> 'type'
-        volume._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    volume._info.pop('metadata')
-                ),
-                'type': volume._info.pop('volume_type'),
-            },
-        )
-
-        # Remove key links from being displayed
-        volume._info.pop("links", None)
-        return zip(*sorted(volume._info.items()))
+        data = _format_volume(volume)
+        return zip(*sorted(data.items()))
 
 
 class UnsetVolume(command.Command):

openstackclient/volume/v2/volume_backend.py

@@ -15,9 +15,9 @@
 """Storage backend action implementations"""
 
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v2/volume_backup.py

@@ -18,17 +18,17 @@ import functools
 import logging
 
 from cliff import columns as cliff_columns
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
 
 
-class VolumeIdColumn(cliff_columns.FormattableColumn):
+class VolumeIdColumn(cliff_columns.FormattableColumn[str]):
     """Formattable column for volume ID column.
 
     Unlike the parent FormattableColumn class, the initializer of the
@@ -453,7 +453,9 @@ class ShowVolumeBackup(command.ShowOne):
 
     def take_action(self, parsed_args):
         volume_client = self.app.client_manager.sdk_connection.volume
-        backup = volume_client.find_backup(parsed_args.backup)
+        backup = volume_client.find_backup(
+            parsed_args.backup, ignore_missing=False
+        )
         columns: tuple[str, ...] = (
             "availability_zone",
             "container",

openstackclient/volume/v2/volume_host.py

@@ -14,8 +14,7 @@
 
 """Volume v2 host action implementations"""
 
-from osc_lib.command import command
-
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v2/volume_snapshot.py

@@ -22,10 +22,10 @@ from cliff import columns as cliff_columns
 from openstack.block_storage.v2 import snapshot as _snapshot
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
@@ -34,7 +34,7 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-class VolumeIdColumn(cliff_columns.FormattableColumn):
+class VolumeIdColumn(cliff_columns.FormattableColumn[str]):
     """Formattable column for volume ID column.
 
     Unlike the parent FormattableColumn class, the initializer of the

openstackclient/volume/v2/volume_transfer_request.py

@@ -16,10 +16,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v2/volume_type.py

@@ -16,14 +16,15 @@
 
 import functools
 import logging
+import typing as ty
 
 from cliff import columns as cliff_columns
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -31,7 +32,7 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-class EncryptionInfoColumn(cliff_columns.FormattableColumn):
+class EncryptionInfoColumn(cliff_columns.FormattableColumn[ty.Any]):
     """Formattable column for encryption info column.
 
     Unlike the parent FormattableColumn class, the initializer of the
@@ -171,7 +172,8 @@ class CreateVolumeType(command.ShowOne):
             default=False,
             help=_(
                 "Enabled replication for this volume type "
-                "(this is an alias for '--property replication_enabled=<is> True') "
+                "(this is an alias for "
+                "'--property replication_enabled=<is> True') "
                 "(requires driver support)"
             ),
         )
@@ -181,7 +183,8 @@ class CreateVolumeType(command.ShowOne):
             dest='availability_zones',
             help=_(
                 "Set an availability zone for this volume type "
-                "(this is an alias for '--property RESKEY:availability_zones:<az>') "
+                "(this is an alias for "
+                "'--property RESKEY:availability_zones:<az>') "
                 "(repeat option to set multiple availability zones)"
             ),
         )
@@ -534,7 +537,8 @@ class SetVolumeType(command.Command):
             default=False,
             help=_(
                 "Enabled replication for this volume type "
-                "(this is an alias for '--property replication_enabled=<is> True') "
+                "(this is an alias for "
+                "'--property replication_enabled=<is> True') "
                 "(requires driver support)"
             ),
         )
@@ -544,7 +548,8 @@ class SetVolumeType(command.Command):
             dest='availability_zones',
             help=_(
                 "Set an availability zone for this volume type "
-                "(this is an alias for '--property RESKEY:availability_zones:<az>') "
+                "(this is an alias for "
+                "'--property RESKEY:availability_zones:<az>') "
                 "(repeat option to set multiple availability zones)"
             ),
         )

openstackclient/volume/v3/block_storage_cleanup.py

@@ -11,9 +11,9 @@
 # under the License.
 
 from cinderclient import api_versions
-from osc_lib.command import command
 from osc_lib import exceptions
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v3/block_storage_cluster.py

@@ -11,10 +11,10 @@
 # under the License.
 
 from cinderclient import api_versions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v3/block_storage_log_level.py

@@ -15,9 +15,9 @@
 """Block Storage Service action implementations"""
 
 from openstack import utils as sdk_utils
-from osc_lib.command import command
 from osc_lib import exceptions
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v3/block_storage_manage.py

@@ -16,10 +16,10 @@
 import argparse
 
 from cinderclient import api_versions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v3/block_storage_resource_filter.py

@@ -14,10 +14,10 @@
 
 from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v3/service.py

@@ -15,10 +15,10 @@
 """Service action implementations"""
 
 from openstack import utils as sdk_utils
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 
@@ -133,7 +133,7 @@ class SetService(command.Command):
         volume_client = self.app.client_manager.sdk_connection.volume
 
         service = volume_client.find_service(
-            host=parsed_args.host, service=parsed_args.service
+            parsed_args.service, ignore_missing=False, host=parsed_args.host
         )
 
         if parsed_args.enable: