python-openstackclient 6.1.0__py3-none-any.whl → 6.2.1__py3-none-any.whl

openstackclient/common/project_cleanup.py

@@ -28,16 +28,15 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-def ask_user_yesno(msg, default=True):
+def ask_user_yesno(msg):
     """Ask user Y/N question
 
     :param str msg: question text
-    :param bool default: default value
     :return bool: User choice
     """
     while True:
         answer = getpass._raw_input(
-            '{} [{}]: '.format(msg, 'y/N' if not default else 'Y/n'))
+            '{} [{}]: '.format(msg, 'y/n'))
         if answer in ('y', 'Y', 'yes'):
             return True
         elif answer in ('n', 'N', 'no'):
@@ -129,8 +128,7 @@ class ProjectCleanup(command.Command):
                 return
 
             confirm = ask_user_yesno(
-                _("These resources will be deleted. Are you sure"),
-                default=False)
+                _("These resources will be deleted. Are you sure"))
 
             if confirm:
                 self.log.warning(_('Deleting resources'))

openstackclient/common/quota.py

@@ -749,12 +749,10 @@ class SetQuota(common.NetDetectionMixin, command.Command):
 
 
 class ShowQuota(command.Lister):
-    _description = _(
-        "Show quotas for project or class. "
-        "Specify ``--os-compute-api-version 2.50`` or higher to see "
-        "``server-groups`` and ``server-group-members`` output for a given "
-        "quota class."
-    )
+    _description = _("""Show quotas for project or class.
+
+Specify ``--os-compute-api-version 2.50`` or higher to see ``server-groups``
+and ``server-group-members`` output for a given quota class.""")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)

openstackclient/compute/v2/host.py

@@ -22,10 +22,10 @@ from openstackclient.i18n import _
 
 
 class ListHost(command.Lister):
-    _description = _("List hosts")
+    _description = _("DEPRECATED: List hosts")
 
     def get_parser(self, prog_name):
-        parser = super(ListHost, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "--zone",
             metavar="<zone>",
@@ -34,17 +34,33 @@ class ListHost(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
         columns = (
             "Host Name",
             "Service",
             "Zone"
         )
-        data = compute_client.api.host_list(parsed_args.zone)
-        return (columns,
-                (utils.get_dict_properties(
-                    s, columns,
-                ) for s in data))
+
+        self.log.warning(
+            "API has been deprecated. "
+            "Please consider using 'hypervisor list' instead."
+        )
+
+        # doing this since openstacksdk has decided not to support this
+        # deprecated command
+        hosts = compute_client.get(
+            '/os-hosts', microversion='2.1'
+        ).json().get('hosts')
+
+        if parsed_args.zone is not None:
+            filtered_hosts = []
+            for host in hosts:
+                if host['zone'] == parsed_args.zone:
+                    filtered_hosts.append(host)
+
+            hosts = filtered_hosts
+
+        return columns, (utils.get_dict_properties(s, columns) for s in hosts)
 
 
 class SetHost(command.Command):
@@ -102,10 +118,10 @@ class SetHost(command.Command):
 
 
 class ShowHost(command.Lister):
-    _description = _("Display host details")
+    _description = _("DEPRECATED: Display host details")
 
     def get_parser(self, prog_name):
-        parser = super(ShowHost, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "host",
             metavar="<host>",
@@ -114,7 +130,7 @@ class ShowHost(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
         columns = (
             "Host",
             "Project",
@@ -123,9 +139,21 @@ class ShowHost(command.Lister):
             "Disk GB"
         )
 
-        data = compute_client.api.host_show(parsed_args.host)
+        self.log.warning(
+            "API has been deprecated. "
+            "Please consider using 'hypervisor show' instead."
+        )
+
+        # doing this since openstacksdk has decided not to support this
+        # deprecated command
+        resources = compute_client.get(
+            '/os-hosts/' + parsed_args.host,
+            microversion='2.1'
+        ).json().get('host')
+
+        data = []
+        if resources is not None:
+            for resource in resources:
+                data.append(resource['resource'])
 
-        return (columns,
-                (utils.get_dict_properties(
-                    s, columns,
-                ) for s in data))
+        return columns, (utils.get_dict_properties(s, columns) for s in data)

openstackclient/compute/v2/server.py

@@ -608,10 +608,10 @@ class AddServerSecurityGroup(command.Command):
 
 
 class AddServerVolume(command.ShowOne):
-    _description = _(
-        "Add volume to server. "
-        "Specify ``--os-compute-api-version 2.20`` or higher to add a volume "
-        "to a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``.")
+    _description = _("""Add volume to server.
+
+Specify ``--os-compute-api-version 2.20`` or higher to add a volume to a server
+with status ``SHELVED`` or ``SHELVED_OFFLOADED``.""")
 
     def get_parser(self, prog_name):
         parser = super(AddServerVolume, self).get_parser(prog_name)
@@ -3757,11 +3757,10 @@ class RemoveServerSecurityGroup(command.Command):
 
 
 class RemoveServerVolume(command.Command):
-    _description = _(
-        "Remove volume from server. "
-        "Specify ``--os-compute-api-version 2.20`` or higher to remove a "
-        "volume from a server with status ``SHELVED`` or "
-        "``SHELVED_OFFLOADED``.")
+    _description = _("""Remove volume from server.
+
+Specify ``--os-compute-api-version 2.20`` or higher to remove a
+volume from a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``.""")
 
     def get_parser(self, prog_name):
         parser = super(RemoveServerVolume, self).get_parser(prog_name)
@@ -3798,11 +3797,10 @@ class RemoveServerVolume(command.Command):
 
 
 class RescueServer(command.Command):
-    _description = _(
-        "Put server in rescue mode. "
-        "Specify ``--os-compute-api-version 2.87`` or higher to rescue a "
-        "server booted from a volume."
-    )
+    _description = _("""Put server in rescue mode.
+
+Specify ``--os-compute-api-version 2.87`` or higher to rescue a
+server booted from a volume.""")
 
     def get_parser(self, prog_name):
         parser = super(RescueServer, self).get_parser(prog_name)
@@ -3958,9 +3956,7 @@ Confirm (verify) success of resize operation and release the old server.""")
 
 # TODO(stephenfin): Remove in OSC 7.0
 class MigrateConfirm(ResizeConfirm):
-    _description = _("""DEPRECATED: Confirm server migration.
-
-Use 'server migration confirm' instead.""")
+    _description = _("DEPRECATED: Use 'server migration confirm' instead.")
 
     def take_action(self, parsed_args):
         msg = _(
@@ -4006,9 +4002,7 @@ one.""")
 
 # TODO(stephenfin): Remove in OSC 7.0
 class MigrateRevert(ResizeRevert):
-    _description = _("""Revert server migration.
-
-Use 'server migration revert' instead.""")
+    _description = _("DEPRECATED: Use 'server migration revert' instead.")
 
     def take_action(self, parsed_args):
         msg = _(
@@ -4346,10 +4340,10 @@ class ShelveServer(command.Command):
 
 
 class ShowServer(command.ShowOne):
-    _description = _(
-        "Show server details. Specify ``--os-compute-api-version 2.47`` "
-        "or higher to see the embedded flavor information for the server."
-    )
+    _description = _("""Show server details.
+
+Specify ``--os-compute-api-version 2.47`` or higher to see the embedded flavor
+information for the server.""")
 
     def get_parser(self, prog_name):
         parser = super(ShowServer, self).get_parser(prog_name)

openstackclient/compute/v2/server_migration.py

@@ -14,7 +14,6 @@
 
 import uuid
 
-from novaclient import api_versions
 from openstack import utils as sdk_utils
 from osc_lib.command import command
 from osc_lib import exceptions
@@ -256,7 +255,7 @@ class ListMigration(command.Lister):
 
 
 def _get_migration_by_uuid(compute_client, server_id, migration_uuid):
-    for migration in compute_client.server_migrations.list(server_id):
+    for migration in compute_client.server_migrations(server_id):
         if migration.uuid == migration_uuid:
             return migration
             break
@@ -290,9 +289,9 @@ class ShowMigration(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
 
-        if compute_client.api_version < api_versions.APIVersion('2.24'):
+        if not sdk_utils.supports_microversion(compute_client, '2.24'):
             msg = _(
                 '--os-compute-api-version 2.24 or greater is required to '
                 'support the server migration show command'
@@ -308,16 +307,16 @@ class ShowMigration(command.ShowOne):
                 )
                 raise exceptions.CommandError(msg)
 
-            if compute_client.api_version < api_versions.APIVersion('2.59'):
+            if not sdk_utils.supports_microversion(compute_client, '2.59'):
                 msg = _(
                     '--os-compute-api-version 2.59 or greater is required to '
                     'retrieve server migrations by UUID'
                 )
                 raise exceptions.CommandError(msg)
 
-        server = utils.find_resource(
-            compute_client.servers,
+        server = compute_client.find_server(
             parsed_args.server,
+            ignore_missing=False,
         )
 
         # the nova API doesn't currently allow retrieval by UUID but it's a
@@ -328,11 +327,13 @@ class ShowMigration(command.ShowOne):
                 compute_client, server.id, parsed_args.migration,
             )
         else:
-            server_migration = compute_client.server_migrations.get(
-                server.id, parsed_args.migration,
+            server_migration = compute_client.get_server_migration(
+                server.id,
+                parsed_args.migration,
+                ignore_missing=False,
             )
 
-        columns = (
+        column_headers = (
             'ID',
             'Server UUID',
             'Status',
@@ -351,14 +352,35 @@ class ShowMigration(command.ShowOne):
             'Updated At',
         )
 
-        if compute_client.api_version >= api_versions.APIVersion('2.59'):
-            columns += ('UUID',)
+        columns = (
+            'id',
+            'server_id',
+            'status',
+            'source_compute',
+            'source_node',
+            'dest_compute',
+            'dest_host',
+            'dest_node',
+            'memory_total_bytes',
+            'memory_processed_bytes',
+            'memory_remaining_bytes',
+            'disk_total_bytes',
+            'disk_processed_bytes',
+            'disk_remaining_bytes',
+            'created_at',
+            'updated_at',
+        )
 
-        if compute_client.api_version >= api_versions.APIVersion('2.80'):
-            columns += ('User ID', 'Project ID')
+        if sdk_utils.supports_microversion(compute_client, '2.59'):
+            column_headers += ('UUID',)
+            columns += ('uuid',)
+
+        if sdk_utils.supports_microversion(compute_client, '2.80'):
+            column_headers += ('User ID', 'Project ID')
+            columns += ('user_id', 'project_id')
 
         data = utils.get_item_properties(server_migration, columns)
-        return columns, data
+        return column_headers, data
 
 
 class AbortMigration(command.Command):
@@ -382,9 +404,9 @@ class AbortMigration(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
 
-        if compute_client.api_version < api_versions.APIVersion('2.24'):
+        if not sdk_utils.supports_microversion(compute_client, '2.24'):
             msg = _(
                 '--os-compute-api-version 2.24 or greater is required to '
                 'support the server migration abort command'
@@ -400,16 +422,16 @@ class AbortMigration(command.Command):
                 )
                 raise exceptions.CommandError(msg)
 
-            if compute_client.api_version < api_versions.APIVersion('2.59'):
+            if not sdk_utils.supports_microversion(compute_client, '2.59'):
                 msg = _(
                     '--os-compute-api-version 2.59 or greater is required to '
                     'abort server migrations by UUID'
                 )
                 raise exceptions.CommandError(msg)
 
-        server = utils.find_resource(
-            compute_client.servers,
+        server = compute_client.find_server(
             parsed_args.server,
+            ignore_missing=False,
         )
 
         # the nova API doesn't currently allow retrieval by UUID but it's a
@@ -421,8 +443,10 @@ class AbortMigration(command.Command):
                 compute_client, server.id, parsed_args.migration,
             ).id
 
-        compute_client.server_migrations.live_migration_abort(
-            server.id, migration_id,
+        compute_client.abort_server_migration(
+            migration_id,
+            server.id,
+            ignore_missing=False,
         )
 
 
@@ -447,9 +471,9 @@ class ForceCompleteMigration(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
 
-        if compute_client.api_version < api_versions.APIVersion('2.22'):
+        if not sdk_utils.supports_microversion(compute_client, '2.22'):
             msg = _(
                 '--os-compute-api-version 2.22 or greater is required to '
                 'support the server migration force complete command'
@@ -465,16 +489,16 @@ class ForceCompleteMigration(command.Command):
                 )
                 raise exceptions.CommandError(msg)
 
-            if compute_client.api_version < api_versions.APIVersion('2.59'):
+            if not sdk_utils.supports_microversion(compute_client, '2.59'):
                 msg = _(
                     '--os-compute-api-version 2.59 or greater is required to '
                     'abort server migrations by UUID'
                 )
                 raise exceptions.CommandError(msg)
 
-        server = utils.find_resource(
-            compute_client.servers,
+        server = compute_client.find_server(
             parsed_args.server,
+            ignore_missing=False,
         )
 
         # the nova API doesn't currently allow retrieval by UUID but it's a
@@ -486,6 +510,6 @@ class ForceCompleteMigration(command.Command):
                 compute_client, server.id, parsed_args.migration,
             ).id
 
-        compute_client.server_migrations.live_migrate_force_complete(
-            server.id, migration_id,
+        compute_client.force_complete_server_migration(
+            migration_id, server.id
         )

openstackclient/compute/v2/server_volume.py

@@ -14,7 +14,7 @@
 
 """Compute v2 Server action implementations"""
 
-from novaclient 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
@@ -34,27 +34,25 @@ class ListServerVolume(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
+        compute_client = self.app.client_manager.sdk_connection.compute
 
-        compute_client = self.app.client_manager.compute
-
-        server = utils.find_resource(
-            compute_client.servers,
+        server = compute_client.find_server(
             parsed_args.server,
+            ignore_missing=False,
         )
-
-        volumes = compute_client.volumes.get_server_volumes(server.id)
+        volumes = compute_client.volume_attachments(server)
 
         columns = ()
         column_headers = ()
 
-        if compute_client.api_version < api_versions.APIVersion('2.89'):
+        if not sdk_utils.supports_microversion(compute_client, '2.89'):
             columns += ('id',)
             column_headers += ('ID',)
 
         columns += (
             'device',
-            'serverId',
-            'volumeId',
+            'server_id',
+            'volume_id',
         )
         column_headers += (
             'Device',
@@ -62,40 +60,36 @@ class ListServerVolume(command.Lister):
             'Volume ID',
         )
 
-        if compute_client.api_version >= api_versions.APIVersion('2.70'):
+        if sdk_utils.supports_microversion(compute_client, '2.70'):
             columns += ('tag',)
             column_headers += ('Tag',)
 
-        if compute_client.api_version >= api_versions.APIVersion('2.79'):
+        if sdk_utils.supports_microversion(compute_client, '2.79'):
             columns += ('delete_on_termination',)
             column_headers += ('Delete On Termination?',)
 
-        if compute_client.api_version >= api_versions.APIVersion('2.89'):
-            columns += ('attachment_id', 'bdm_uuid')
+        if sdk_utils.supports_microversion(compute_client, '2.89'):
+            columns += ('attachment_id', 'bdm_id')
             column_headers += ('Attachment ID', 'BlockDeviceMapping UUID')
 
         return (
             column_headers,
-            (
-                utils.get_item_properties(
-                    s, columns, mixed_case_fields=('serverId', 'volumeId')
-                ) for s in volumes
-            ),
+            (utils.get_item_properties(s, columns) for s in volumes),
         )
 
 
-class UpdateServerVolume(command.Command):
+class SetServerVolume(command.Command):
     """Update a volume attachment on the server."""
 
     def get_parser(self, prog_name):
-        parser = super(UpdateServerVolume, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
             help=_('Server to update volume for (name or ID)'),
         )
         parser.add_argument(
             'volume',
-            help=_('Volume (ID)'),
+            help=_('Volume to update attachment for (name or ID)'),
         )
         termination_group = parser.add_mutually_exclusive_group()
         termination_group.add_argument(
@@ -120,31 +114,34 @@ class UpdateServerVolume(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
+        volume_client = self.app.client_manager.sdk_connection.volume
 
         if parsed_args.delete_on_termination is not None:
-            if compute_client.api_version < api_versions.APIVersion('2.85'):
+            if not sdk_utils.supports_microversion(compute_client, '2.85'):
                 msg = _(
                     '--os-compute-api-version 2.85 or greater is required to '
-                    'support the --(no-)delete-on-termination option'
+                    'support the -delete-on-termination or '
+                    '--preserve-on-termination option'
                 )
                 raise exceptions.CommandError(msg)
 
-            server = utils.find_resource(
-                compute_client.servers,
+            server = compute_client.find_server(
                 parsed_args.server,
+                ignore_missing=False,
             )
-
-            # NOTE(stephenfin): This may look silly, and that's because it is.
-            # This API was originally used only for the swapping volumes, which
-            # is an internal operation that should only be done by
-            # orchestration software rather than a human. We're not going to
-            # expose that, but we are going to expose the ability to change the
-            # delete on termination behavior.
-            compute_client.volumes.update_server_volume(
-                server.id,
-                parsed_args.volume,
+            volume = volume_client.find_volume(
                 parsed_args.volume,
+                ignore_missing=False,
+            )
+
+            compute_client.update_volume_attachment(
+                server,
+                volume,
                 delete_on_termination=parsed_args.delete_on_termination,
             )
+
+
+# Legacy alias
+class UpdateServerVolume(SetServerVolume):
+    """DEPRECATED: Use 'server volume set' instead."""

openstackclient/compute/v2/service.py

@@ -71,11 +71,11 @@ class DeleteService(command.Command):
 
 
 class ListService(command.Lister):
-    _description = _("List compute services. Using "
-                     "``--os-compute-api-version`` 2.53 or greater will "
-                     "return the ID as a UUID value which can be used to "
-                     "uniquely identify the service in a multi-cell "
-                     "deployment.")
+    _description = _("""List compute services.
+
+Using ``--os-compute-api-version`` 2.53 or greater will return the ID as a UUID
+value which can be used to uniquely identify the service in a multi-cell
+deployment.""")
 
     def get_parser(self, prog_name):
         parser = super(ListService, self).get_parser(prog_name)

openstackclient/identity/common.py

@@ -87,6 +87,18 @@ def get_resource(manager, name_type_or_id):
         raise exceptions.CommandError(msg % name_type_or_id)
 
 
+def get_resource_by_id(manager, resource_id):
+    """Get resource by ID
+
+    Raises CommandError if the resource is not found
+    """
+    try:
+        return manager.get(resource_id)
+    except identity_exc.NotFound:
+        msg = _("Resource with id {} not found")
+        raise exceptions.CommandError(msg.format(resource_id))
+
+
 def _get_token_resource(client, resource, parsed_name, parsed_domain=None):
     """Peek into the user's auth token to get resource IDs
 

openstackclient/identity/v3/access_rule.py

@@ -37,7 +37,7 @@ class DeleteAccessRule(command.Command):
             'access_rule',
             metavar='<access-rule>',
             nargs="+",
-            help=_('Access rule(s) to delete (name or ID)'),
+            help=_('Access rule ID(s) to delete'),
         )
         return parser
 
@@ -47,8 +47,9 @@ class DeleteAccessRule(command.Command):
         errors = 0
         for ac in parsed_args.access_rule:
             try:
-                access_rule = utils.find_resource(
-                    identity_client.access_rules, ac)
+                access_rule = common.get_resource_by_id(
+                    identity_client.access_rules, ac
+                )
                 identity_client.access_rules.delete(access_rule.id)
             except Exception as e:
                 errors += 1
@@ -103,14 +104,15 @@ class ShowAccessRule(command.ShowOne):
         parser.add_argument(
             'access_rule',
             metavar='<access-rule>',
-            help=_('Access rule to display (name or ID)'),
+            help=_('Access rule ID to display'),
         )
         return parser
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.identity
-        access_rule = utils.find_resource(identity_client.access_rules,
-                                          parsed_args.access_rule)
+        access_rule = common.get_resource_by_id(
+            identity_client.access_rules, parsed_args.access_rule
+        )
 
         access_rule._info.pop('links', None)
 

openstackclient/image/v2/image.py

@@ -1206,7 +1206,10 @@ class SetImage(command.Command):
             const="accepted",
             dest="membership",
             default=None,
-            help=_("Accept the image membership"),
+            help=_(
+                "Accept the image membership for either the project indicated "
+                "by '--project', if provided, or the current user's project"
+            ),
         )
         membership_group.add_argument(
             "--reject",
@@ -1214,7 +1217,10 @@ class SetImage(command.Command):
             const="rejected",
             dest="membership",
             default=None,
-            help=_("Reject the image membership"),
+            help=_(
+                "Reject the image membership for either the project indicated "
+                "by '--project', if provided, or the current user's project"
+            ),
         )
         membership_group.add_argument(
             "--pending",