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

openstackclient/volume/v2/volume_snapshot.py

@@ -14,11 +14,12 @@
 
 """Volume v2 snapshot action implementations"""
 
-import copy
 import functools
 import logging
+import typing as ty
 
 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
@@ -60,6 +61,42 @@ class VolumeIdColumn(cliff_columns.FormattableColumn):
         return volume
 
 
+def _format_snapshot(snapshot: _snapshot.Snapshot) -> 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
+        'consumes_quota',
+        'force',
+        'group_snapshot_id',
+        # ignored columns
+        'os-extended-snapshot-attributes:progress',
+        'os-extended-snapshot-attributes:project_id',
+        'updated_at',
+        'user_id',
+        # unnecessary columns
+        'links',
+    }
+
+    info = snapshot.to_dict(original_names=True)
+    data = {}
+    for key, value in info.items():
+        if key in ignored_columns:
+            continue
+
+        data[key] = value
+
+    data.update(
+        {
+            'properties': format_columns.DictColumn(data.pop('metadata')),
+        }
+    )
+
+    return data
+
+
 class CreateVolumeSnapshot(command.ShowOne):
     _description = _("Create new volume snapshot")
 
@@ -94,6 +131,7 @@ class CreateVolumeSnapshot(command.ShowOne):
             "--property",
             metavar="<key=value>",
             action=parseractions.KeyValueAction,
+            dest="properties",
             help=_(
                 "Set a property to this snapshot "
                 "(repeat option to set multiple properties)"
@@ -113,11 +151,13 @@ class CreateVolumeSnapshot(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
+
         volume = parsed_args.volume
         if not parsed_args.volume:
             volume = parsed_args.snapshot_name
-        volume_id = utils.find_resource(volume_client.volumes, volume).id
+        volume_id = volume_client.find_volume(volume, ignore_missing=False).id
+
         if parsed_args.remote_source:
             # Create a new snapshot from an existing remote snapshot source
             if parsed_args.force:
@@ -127,30 +167,26 @@ class CreateVolumeSnapshot(command.ShowOne):
                     "volume snapshot"
                 )
                 LOG.warning(msg)
-            snapshot = volume_client.volume_snapshots.manage(
+
+            snapshot = volume_client.manage_snapshot(
                 volume_id=volume_id,
                 ref=parsed_args.remote_source,
                 name=parsed_args.snapshot_name,
                 description=parsed_args.description,
-                metadata=parsed_args.property,
+                metadata=parsed_args.properties,
             )
         else:
             # create a new snapshot from scratch
-            snapshot = volume_client.volume_snapshots.create(
-                volume_id,
+            snapshot = volume_client.create_snapshot(
+                volume_id=volume_id,
                 force=parsed_args.force,
                 name=parsed_args.snapshot_name,
                 description=parsed_args.description,
-                metadata=parsed_args.property,
+                metadata=parsed_args.properties,
             )
-        snapshot._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    snapshot._info.pop('metadata')
-                )
-            }
-        )
-        return zip(*sorted(snapshot._info.items()))
+
+        data = _format_snapshot(snapshot)
+        return zip(*sorted(data.items()))
 
 
 class DeleteVolumeSnapshot(command.Command):
@@ -175,16 +211,16 @@ class DeleteVolumeSnapshot(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
         result = 0
 
-        for i in parsed_args.snapshots:
+        for snapshot in parsed_args.snapshots:
             try:
-                snapshot_id = utils.find_resource(
-                    volume_client.volume_snapshots, i
+                snapshot_id = volume_client.find_snapshot(
+                    snapshot, ignore_missing=False
                 ).id
-                volume_client.volume_snapshots.delete(
-                    snapshot_id, parsed_args.force
+                volume_client.delete_snapshot(
+                    snapshot_id, force=parsed_args.force
                 )
             except Exception as e:
                 result += 1
@@ -193,7 +229,7 @@ class DeleteVolumeSnapshot(command.Command):
                         "Failed to delete snapshot with "
                         "name or ID '%(snapshot)s': %(e)s"
                     )
-                    % {'snapshot': i, 'e': e}
+                    % {'snapshot': snapshot, 'e': e}
                 )
 
         if result > 0:
@@ -260,31 +296,39 @@ class ListVolumeSnapshot(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
         identity_client = self.app.client_manager.identity
 
+        columns: tuple[str, ...] = (
+            'id',
+            'name',
+            'description',
+            'status',
+            'size',
+        )
+        column_headers: tuple[str, ...] = (
+            'ID',
+            'Name',
+            'Description',
+            'Status',
+            'Size',
+        )
         if parsed_args.long:
-            columns = [
-                'ID',
-                'Name',
-                'Description',
-                'Status',
-                'Size',
+            columns += (
+                'created_at',
+                'volume_id',
+                'metadata',
+            )
+            column_headers += (
                 'Created At',
-                'Volume ID',
-                'Metadata',
-            ]
-            column_headers = copy.deepcopy(columns)
-            column_headers[6] = 'Volume'
-            column_headers[7] = 'Properties'
-        else:
-            columns = ['ID', 'Name', 'Description', 'Status', 'Size']
-            column_headers = copy.deepcopy(columns)
+                'Volume',
+                'Properties',
+            )
 
         # Cache the volume list
         volume_cache = {}
         try:
-            for s in volume_client.volumes.list():
+            for s in volume_client.volumes():
                 volume_cache[s.id] = s
         except Exception:  # noqa: S110
             # Just forget it if there's any trouble
@@ -295,8 +339,8 @@ class ListVolumeSnapshot(command.Lister):
 
         volume_id = None
         if parsed_args.volume:
-            volume_id = utils.find_resource(
-                volume_client.volumes, parsed_args.volume
+            volume_id = volume_client.find_volume(
+                parsed_args.volume, ignore_missing=False
             ).id
 
         project_id = None
@@ -312,18 +356,14 @@ class ListVolumeSnapshot(command.Lister):
             True if parsed_args.project else parsed_args.all_projects
         )
 
-        search_opts = {
-            'all_tenants': all_projects,
-            'project_id': project_id,
-            'name': parsed_args.name,
-            'status': parsed_args.status,
-            'volume_id': volume_id,
-        }
-
-        data = volume_client.volume_snapshots.list(
-            search_opts=search_opts,
+        data = volume_client.snapshots(
             marker=parsed_args.marker,
             limit=parsed_args.limit,
+            all_projects=all_projects,
+            project_id=project_id,
+            name=parsed_args.name,
+            status=parsed_args.status,
+            volume_id=volume_id,
         )
         return (
             column_headers,
@@ -332,8 +372,8 @@ class ListVolumeSnapshot(command.Lister):
                     s,
                     columns,
                     formatters={
-                        'Metadata': format_columns.DictColumn,
-                        'Volume ID': _VolumeIdColumn,
+                        'metadata': format_columns.DictColumn,
+                        'volume_id': _VolumeIdColumn,
                     },
                 )
                 for s in data
@@ -374,6 +414,7 @@ class SetVolumeSnapshot(command.Command):
             '--property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='properties',
             help=_(
                 'Property to add/change for this snapshot '
                 '(repeat option to set multiple properties)'
@@ -400,27 +441,26 @@ class SetVolumeSnapshot(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        snapshot = utils.find_resource(
-            volume_client.volume_snapshots, parsed_args.snapshot
+        volume_client = self.app.client_manager.sdk_connection.volume
+
+        snapshot = volume_client.find_snapshot(
+            parsed_args.snapshot, ignore_missing=False
         )
 
         result = 0
         if parsed_args.no_property:
             try:
-                key_list = snapshot.metadata.keys()
-                volume_client.volume_snapshots.delete_metadata(
-                    snapshot.id,
-                    list(key_list),
+                volume_client.delete_snapshot_metadata(
+                    snapshot.id, keys=list(snapshot.metadata)
                 )
             except Exception as e:
                 LOG.error(_("Failed to clean snapshot properties: %s"), e)
                 result += 1
 
-        if parsed_args.property:
+        if parsed_args.properties:
             try:
-                volume_client.volume_snapshots.set_metadata(
-                    snapshot.id, parsed_args.property
+                volume_client.set_snapshot_metadata(
+                    snapshot.id, **parsed_args.properties
                 )
             except Exception as e:
                 LOG.error(_("Failed to set snapshot property: %s"), e)
@@ -428,7 +468,7 @@ class SetVolumeSnapshot(command.Command):
 
         if parsed_args.state:
             try:
-                volume_client.volume_snapshots.reset_state(
+                volume_client.reset_snapshot_status(
                     snapshot.id, parsed_args.state
                 )
             except Exception as e:
@@ -442,7 +482,7 @@ class SetVolumeSnapshot(command.Command):
             kwargs['description'] = parsed_args.description
         if kwargs:
             try:
-                volume_client.volume_snapshots.update(snapshot.id, **kwargs)
+                volume_client.update_snapshot(snapshot.id, **kwargs)
             except Exception as e:
                 LOG.error(
                     _("Failed to update snapshot name or description: %s"),
@@ -469,18 +509,14 @@ class ShowVolumeSnapshot(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        snapshot = utils.find_resource(
-            volume_client.volume_snapshots, parsed_args.snapshot
-        )
-        snapshot._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    snapshot._info.pop('metadata')
-                )
-            }
+        volume_client = self.app.client_manager.sdk_connection.volume
+
+        snapshot = volume_client.find_snapshot(
+            parsed_args.snapshot, ignore_missing=False
         )
-        return zip(*sorted(snapshot._info.items()))
+
+        data = _format_snapshot(snapshot)
+        return zip(*sorted(data.items()))
 
 
 class UnsetVolumeSnapshot(command.Command):
@@ -498,6 +534,7 @@ class UnsetVolumeSnapshot(command.Command):
             metavar='<key>',
             action='append',
             default=[],
+            dest='properties',
             help=_(
                 'Property to remove from snapshot '
                 '(repeat option to remove multiple properties)'
@@ -506,13 +543,13 @@ class UnsetVolumeSnapshot(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        snapshot = utils.find_resource(
-            volume_client.volume_snapshots, parsed_args.snapshot
+        volume_client = self.app.client_manager.sdk_connection.volume
+
+        snapshot = volume_client.find_snapshot(
+            parsed_args.snapshot, ignore_missing=False
         )
 
-        if parsed_args.property:
-            volume_client.volume_snapshots.delete_metadata(
-                snapshot.id,
-                parsed_args.property,
+        if parsed_args.properties:
+            volume_client.delete_snapshot_metadata(
+                snapshot.id, keys=parsed_args.properties
             )

openstackclient/volume/v3/block_storage_log_level.py

@@ -14,10 +14,9 @@
 
 """Block Storage Service action implementations"""
 
-from cinderclient import api_versions
+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.i18n import _
 
@@ -33,7 +32,7 @@ class BlockStorageLogLevelList(command.Lister):
         parser.add_argument(
             "--host",
             metavar="<host>",
-            default="",
+            default=None,
             help=_(
                 "List block storage service log level of specified host "
                 "(name only)"
@@ -42,9 +41,9 @@ class BlockStorageLogLevelList(command.Lister):
         parser.add_argument(
             "--service",
             metavar="<service>",
-            default="",
+            default=None,
             choices=(
-                '',
+                None,
                 '*',
                 'cinder-api',
                 'cinder-volume',
@@ -59,13 +58,13 @@ class BlockStorageLogLevelList(command.Lister):
         parser.add_argument(
             "--log-prefix",
             metavar="<log-prefix>",
-            default="",
+            default=None,
             help="Prefix for the log, e.g. 'sqlalchemy'",
         )
         return parser
 
     def take_action(self, parsed_args):
-        service_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
         columns = [
             "Binary",
             "Host",
@@ -73,29 +72,24 @@ class BlockStorageLogLevelList(command.Lister):
             "Level",
         ]
 
-        if service_client.api_version < api_versions.APIVersion('3.32'):
+        if not sdk_utils.supports_microversion(volume_client, '3.32'):
             msg = _(
                 "--os-volume-api-version 3.32 or greater is required to "
                 "support the 'block storage log level list' command"
             )
             raise exceptions.CommandError(msg)
 
-        data = service_client.services.get_log_levels(
+        data = []
+        for entry in volume_client.get_service_log_levels(
             binary=parsed_args.service,
             server=parsed_args.host,
             prefix=parsed_args.log_prefix,
-        )
+        ):
+            entry_levels = sorted(entry.levels.items(), key=lambda x: x[0])
+            for prefix, level in entry_levels:
+                data.append((entry.binary, entry.host, prefix, level))
 
-        return (
-            columns,
-            (
-                utils.get_item_properties(
-                    s,
-                    columns,
-                )
-                for s in data
-            ),
-        )
+        return (columns, data)
 
 
 class BlockStorageLogLevelSet(command.Command):
@@ -111,12 +105,12 @@ class BlockStorageLogLevelSet(command.Command):
             metavar="<log-level>",
             choices=('INFO', 'WARNING', 'ERROR', 'DEBUG'),
             type=str.upper,
-            help=_("Desired log level."),
+            help=_("Desired log level"),
         )
         parser.add_argument(
             "--host",
             metavar="<host>",
-            default="",
+            default=None,
             help=_(
                 "Set block storage service log level of specified host "
                 "(name only)"
@@ -125,9 +119,9 @@ class BlockStorageLogLevelSet(command.Command):
         parser.add_argument(
             "--service",
             metavar="<service>",
-            default="",
+            default=None,
             choices=(
-                '',
+                None,
                 '*',
                 'cinder-api',
                 'cinder-volume',
@@ -142,22 +136,22 @@ class BlockStorageLogLevelSet(command.Command):
         parser.add_argument(
             "--log-prefix",
             metavar="<log-prefix>",
-            default="",
+            default=None,
             help="Prefix for the log, e.g. 'sqlalchemy'",
         )
         return parser
 
     def take_action(self, parsed_args):
-        service_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
 
-        if service_client.api_version < api_versions.APIVersion('3.32'):
+        if not sdk_utils.supports_microversion(volume_client, '3.32'):
             msg = _(
                 "--os-volume-api-version 3.32 or greater is required to "
                 "support the 'block storage log level set' command"
             )
             raise exceptions.CommandError(msg)
 
-        service_client.services.set_log_levels(
+        volume_client.set_service_log_levels(
             level=parsed_args.level,
             binary=parsed_args.service,
             server=parsed_args.host,

openstackclient/volume/v3/service.py

@@ -14,37 +14,72 @@
 
 """Service action implementations"""
 
-from cinderclient import api_versions
+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.volume.v2 import service as service_v2
+from openstackclient.i18n import _
 
 
-class ListService(service_v2.ListService):
+class ListService(command.Lister):
+    _description = _("List service command")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--host",
+            metavar="<host>",
+            help=_("List services on specified host (name only)"),
+        )
+        parser.add_argument(
+            "--service",
+            metavar="<service>",
+            help=_("List only specified service (name only)"),
+        )
+        parser.add_argument(
+            "--long",
+            action="store_true",
+            default=False,
+            help=_("List additional fields in output"),
+        )
+        return parser
+
     def take_action(self, parsed_args):
-        service_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
 
-        columns = [
+        columns: tuple[str, ...] = (
+            "binary",
+            "host",
+            "availability_zone",
+            "status",
+            "state",
+            "updated_at",
+        )
+        column_names: tuple[str, ...] = (
             "Binary",
             "Host",
             "Zone",
             "Status",
             "State",
             "Updated At",
-        ]
+        )
 
-        if service_client.api_version >= api_versions.APIVersion('3.7'):
-            columns.append("Cluster")
-        if service_client.api_version >= api_versions.APIVersion('3.49'):
-            columns.append("Backend State")
+        if sdk_utils.supports_microversion(volume_client, '3.7'):
+            columns += ("cluster",)
+            column_names += ("Cluster",)
+        if sdk_utils.supports_microversion(volume_client, '3.49'):
+            columns += ("backend_state",)
+            column_names += ("Backend State",)
         if parsed_args.long:
-            columns.append("Disabled Reason")
+            columns += ("disabled_reason",)
+            column_names += ("Disabled Reason",)
 
-        data = service_client.services.list(
-            parsed_args.host, parsed_args.service
+        data = volume_client.services(
+            host=parsed_args.host, binary=parsed_args.service
         )
         return (
-            columns,
+            column_names,
             (
                 utils.get_item_properties(
                     s,
@@ -53,3 +88,59 @@ class ListService(service_v2.ListService):
                 for s in data
             ),
         )
+
+
+class SetService(command.Command):
+    _description = _("Set volume service properties")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "host",
+            metavar="<host>",
+            help=_("Name of host"),
+        )
+        parser.add_argument(
+            "service",
+            metavar="<service>",
+            help=_("Name of service (Binary name)"),
+        )
+        enabled_group = parser.add_mutually_exclusive_group()
+        enabled_group.add_argument(
+            "--enable", action="store_true", help=_("Enable volume service")
+        )
+        enabled_group.add_argument(
+            "--disable", action="store_true", help=_("Disable volume service")
+        )
+        parser.add_argument(
+            "--disable-reason",
+            metavar="<reason>",
+            help=_(
+                "Reason for disabling the service "
+                "(should be used with --disable option)"
+            ),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        if parsed_args.disable_reason and not parsed_args.disable:
+            msg = _(
+                "Cannot specify option --disable-reason without "
+                "--disable specified."
+            )
+            raise exceptions.CommandError(msg)
+
+        volume_client = self.app.client_manager.sdk_connection.volume
+
+        service = volume_client.find_service(
+            host=parsed_args.host, service=parsed_args.service
+        )
+
+        if parsed_args.enable:
+            service.enable(volume_client)
+
+        if parsed_args.disable:
+            service.disable(
+                volume_client,
+                reason=parsed_args.disable_reason,
+            )