python-openstackclient 6.3.0__py3-none-any.whl → 6.5.0__py3-none-any.whl

openstackclient/compute/v2/server.py

@@ -32,13 +32,12 @@ from osc_lib.cli import parseractions
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
-from oslo_utils import strutils
 
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common as network_common
 
-
 LOG = logging.getLogger(__name__)
 
 IMAGE_STRING_FOR_BFV = 'N/A (booted from volume)'
@@ -150,16 +149,13 @@ def _prep_server_detail(compute_client, image_client, server, refresh=True):
     # Some commands using this routine were originally implemented with the
     # nova python wrappers, and were later migrated to use the SDK. Map the
     # SDK's property names to the original property names to maintain backward
-    # compatibility for existing users. Data is duplicated under both the old
-    # and new name so users can consume the data by either name.
+    # compatibility for existing users.
     column_map = {
         'access_ipv4': 'accessIPv4',
         'access_ipv6': 'accessIPv6',
         'admin_password': 'adminPass',
-        'admin_password': 'adminPass',
-        'volumes': 'os-extended-volumes:volumes_attached',
+        'attached_volumes': 'volumes_attached',
         'availability_zone': 'OS-EXT-AZ:availability_zone',
-        'block_device_mapping': 'block_device_mapping_v2',
         'compute_host': 'OS-EXT-SRV-ATTR:host',
         'created_at': 'created',
         'disk_config': 'OS-DCF:diskConfig',
@@ -169,7 +165,6 @@ def _prep_server_detail(compute_client, image_client, server, refresh=True):
         'fault': 'fault',
         'hostname': 'OS-EXT-SRV-ATTR:hostname',
         'hypervisor_hostname': 'OS-EXT-SRV-ATTR:hypervisor_hostname',
-        'image_id': 'imageRef',
         'instance_name': 'OS-EXT-SRV-ATTR:instance_name',
         'is_locked': 'locked',
         'kernel_id': 'OS-EXT-SRV-ATTR:kernel_id',
@@ -180,21 +175,56 @@ def _prep_server_detail(compute_client, image_client, server, refresh=True):
         'ramdisk_id': 'OS-EXT-SRV-ATTR:ramdisk_id',
         'reservation_id': 'OS-EXT-SRV-ATTR:reservation_id',
         'root_device_name': 'OS-EXT-SRV-ATTR:root_device_name',
-        'scheduler_hints': 'OS-SCH-HNT:scheduler_hints',
         'task_state': 'OS-EXT-STS:task_state',
         'terminated_at': 'OS-SRV-USG:terminated_at',
         'updated_at': 'updated',
         'user_data': 'OS-EXT-SRV-ATTR:user_data',
         'vm_state': 'OS-EXT-STS:vm_state',
     }
+    # Some columns returned by openstacksdk should not be shown because they're
+    # either irrelevant or duplicates
+    ignored_columns = {
+        # computed columns
+        'interface_ip',
+        'location',
+        'private_v4',
+        'private_v6',
+        'public_v4',
+        'public_v6',
+        # create-only columns
+        'block_device_mapping',
+        'image_id',
+        'max_count',
+        'min_count',
+        'scheduler_hints',
+        # aliases
+        'volumes',
+        # unnecessary
+        'links',
+    }
+    # Some columns are only present in certain responses and should not be
+    # shown otherwise.
+    optional_columns = {
+        'admin_password',  # removed in 2.14
+        'fault',  # only present in errored servers
+        'flavor_id',  # removed in 2.47
+        'networks',  # only present in create responses
+        'security_groups',  # only present in create, detail responses
+    }
 
-    info.update(
-        {
-            column_map[column]: data
-            for column, data in info.items()
-            if column in column_map
-        }
-    )
+    data = {}
+    for key, value in info.items():
+        if key in ignored_columns:
+            continue
+
+        if key in optional_columns:
+            if info[key] is None:
+                continue
+
+        alias = column_map.get(key)
+        data[alias or key] = value
+
+    info = data
 
     # Convert the image blob to a name
     image_info = info.get('image', {})
@@ -215,46 +245,57 @@ def _prep_server_detail(compute_client, image_client, server, refresh=True):
     # Convert the flavor blob to a name
     flavor_info = info.get('flavor', {})
     # Microversion 2.47 puts the embedded flavor into the server response
-    # body but omits the id, so if not present we just expose the flavor
-    # dict in the server output.
-    if 'id' in flavor_info:
+    # body. The presence of the 'original_name' attribute indicates this.
+    if flavor_info.get('original_name') is None:  # microversion < 2.47
         flavor_id = flavor_info.get('id', '')
         try:
             flavor = utils.find_resource(compute_client.flavors, flavor_id)
             info['flavor'] = "%s (%s)" % (flavor.name, flavor_id)
         except Exception:
             info['flavor'] = flavor_id
-    else:
+    else:  # microversion >= 2.47
         info['flavor'] = format_columns.DictColumn(flavor_info)
 
-    if 'os-extended-volumes:volumes_attached' in info:
+    # there's a lot of redundant information in BDMs - strip it
+    if 'volumes_attached' in info:
         info.update(
             {
                 'volumes_attached': format_columns.ListDictColumn(
-                    info.pop('os-extended-volumes:volumes_attached')
+                    [
+                        {
+                            k: v
+                            for k, v in volume.items()
+                            if v is not None and k != 'location'
+                        }
+                        for volume in info.pop('volumes_attached') or []
+                    ]
                 )
             }
         )
+
     if 'security_groups' in info:
         info.update(
             {
                 'security_groups': format_columns.ListDictColumn(
-                    info.pop('security_groups')
+                    info.pop('security_groups'),
                 )
             }
         )
+
     if 'tags' in info:
         info.update({'tags': format_columns.ListColumn(info.pop('tags'))})
 
-    # NOTE(dtroyer): novaclient splits these into separate entries...
-    # Format addresses in a useful way
-    info['addresses'] = (
-        AddressesColumn(info['addresses'])
-        if 'addresses' in info
-        else format_columns.DictListColumn(info.get('networks'))
-    )
+    # Map 'networks' to 'addresses', if present. Note that the 'networks' key
+    # is used for create responses, otherwise it's 'addresses'. We know it'll
+    # be set because this is one of our optional columns.
+    if 'networks' in info:
+        info['addresses'] = format_columns.DictListColumn(
+            info.pop('networks', {}),
+        )
+    else:
+        info['addresses'] = AddressesColumn(info.get('addresses', {}))
 
-    # Map 'metadata' field to 'properties'
+    # Map 'metadata' field to 'properties' and format
     info['properties'] = format_columns.DictColumn(info.pop('metadata'))
 
     # Migrate tenant_id to project_id naming
@@ -267,12 +308,33 @@ def _prep_server_detail(compute_client, image_client, server, refresh=True):
             info['OS-EXT-STS:power_state']
         )
 
-    # Remove values that are long and not too useful
-    info.pop('links', None)
-
     return info
 
 
+def bool_from_str(value, strict=False):
+    true_strings = ('1', 't', 'true', 'on', 'y', 'yes')
+    false_strings = ('0', 'f', 'false', 'off', 'n', 'no')
+
+    if isinstance(value, bool):
+        return value
+
+    lowered = value.strip().lower()
+    if lowered in true_strings:
+        return True
+    elif lowered in false_strings or not strict:
+        return False
+
+    msg = _(
+        "Unrecognized value '%(value)s'; acceptable values are: %(valid)s"
+    ) % {
+        'value': value,
+        'valid': ', '.join(
+            f"'{s}'" for s in sorted(true_strings + false_strings)
+        ),
+    }
+    raise ValueError(msg)
+
+
 def boolenv(*vars, default=False):
     """Search for the first defined of possibly many bool-like env vars.
 
@@ -287,7 +349,7 @@ def boolenv(*vars, default=False):
     for v in vars:
         value = os.environ.get(v, None)
         if value:
-            return strutils.bool_from_string(value)
+            return bool_from_str(value)
     return default
 
 
@@ -818,7 +880,7 @@ class NICAction(argparse.Action):
                     "Invalid argument %s; characters ',' and '=' are not "
                     "allowed"
                 )
-                raise argparse.ArgumentTypeError(msg % values)
+                raise argparse.ArgumentError(self, msg % values)
 
             values = '='.join([self.key, values])
         else:
@@ -846,7 +908,7 @@ class NICAction(argparse.Action):
                     "'net-id=net-uuid,port-id=port-uuid,v4-fixed-ip=ip-addr,"
                     "v6-fixed-ip=ip-addr,tag=tag'"
                 )
-                raise argparse.ArgumentTypeError(msg % values)
+                raise argparse.ArgumentError(self, msg % values)
 
             info[k] = v
 
@@ -855,7 +917,7 @@ class NICAction(argparse.Action):
                 'Invalid argument %s; either network or port should be '
                 'specified but not both'
             )
-            raise argparse.ArgumentTypeError(msg % values)
+            raise argparse.ArgumenteError(self, msg % values)
 
         getattr(namespace, self.dest).append(info)
 
@@ -873,7 +935,7 @@ class BDMLegacyAction(argparse.Action):
                 "Invalid argument %s; argument must be of form "
                 "'dev-name=id[:type[:size[:delete-on-terminate]]]'"
             )
-            raise argparse.ArgumentTypeError(msg % values)
+            raise argparse.ArgumentError(self, msg % values)
 
         mapping = {
             'device_name': dev_name,
@@ -890,7 +952,7 @@ class BDMLegacyAction(argparse.Action):
                     "Invalid argument %s; 'type' must be one of: volume, "
                     "snapshot, image"
                 )
-                raise argparse.ArgumentTypeError(msg % values)
+                raise argparse.ArgumentError(self, msg % values)
 
             mapping['source_type'] = dev_map[1]
 
@@ -943,12 +1005,13 @@ class BDMAction(parseractions.MultiKeyValueAction):
                 "Invalid keys %(invalid_keys)s specified.\n"
                 "Valid keys are: %(valid_keys)s"
             )
-            raise argparse.ArgumentTypeError(
+            raise argparse.ArgumentError(
+                self,
                 msg
                 % {
                     'invalid_keys': ', '.join(invalid_keys),
                     'valid_keys': ', '.join(valid_keys),
-                }
+                },
             )
 
         missing_keys = [k for k in self.required_keys if k not in keys]
@@ -957,12 +1020,13 @@ class BDMAction(parseractions.MultiKeyValueAction):
                 "Missing required keys %(missing_keys)s.\n"
                 "Required keys are: %(required_keys)s"
             )
-            raise argparse.ArgumentTypeError(
+            raise argparse.ArgumentError(
+                self,
                 msg
                 % {
                     'missing_keys': ', '.join(missing_keys),
                     'required_keys': ', '.join(self.required_keys),
-                }
+                },
             )
 
     def __call__(self, parser, namespace, values, option_string=None):
@@ -1313,10 +1377,19 @@ class CreateServer(command.ShowOne):
                 '(supported by --os-compute-api-version 2.74 or above)'
             ),
         )
+        parser.add_argument(
+            '--server-group',
+            metavar='<server-group>',
+            help=_(
+                "Server group to create the server within "
+                "(this is an alias for '--hint group=<server-group-id>')"
+            ),
+        )
         parser.add_argument(
             '--hint',
             metavar='<key=value>',
             action=parseractions.KeyValueAppendAction,
+            dest='hints',
             default={},
             help=_('Hints for the scheduler'),
         )
@@ -1553,8 +1626,8 @@ class CreateServer(command.ShowOne):
         if parsed_args.description:
             if compute_client.api_version < api_versions.APIVersion("2.19"):
                 msg = _(
-                    "Description is not supported for "
-                    "--os-compute-api-version less than 2.19"
+                    '--os-compute-api-version 2.19 or greater is '
+                    'required to support the --description option'
                 )
                 raise exceptions.CommandError(msg)
 
@@ -1580,6 +1653,12 @@ class CreateServer(command.ShowOne):
             ]
         elif parsed_args.boot_from_volume:
             # Tell nova to create a root volume from the image provided.
+            if not image:
+                msg = _(
+                    "An image (--image or --image-property) is required "
+                    "to support --boot-from-volume option"
+                )
+                raise exceptions.CommandError(msg)
             block_device_mapping_v2 = [
                 {
                     'uuid': image.id,
@@ -1713,8 +1792,9 @@ class CreateServer(command.ShowOne):
 
             if 'delete_on_termination' in mapping:
                 try:
-                    value = strutils.bool_from_string(
-                        mapping['delete_on_termination'], strict=True
+                    value = bool_from_str(
+                        mapping['delete_on_termination'],
+                        strict=True,
                     )
                 except ValueError:
                     msg = _(
@@ -1828,13 +1908,20 @@ class CreateServer(command.ShowOne):
                 security_group_names.append(sg['name'])
 
         hints = {}
-        for key, values in parsed_args.hint.items():
+        for key, values in parsed_args.hints.items():
             # only items with multiple values will result in a list
             if len(values) == 1:
                 hints[key] = values[0]
             else:
                 hints[key] = values
 
+        if parsed_args.server_group:
+            server_group_obj = utils.find_resource(
+                compute_client.server_groups,
+                parsed_args.server_group,
+            )
+            hints['group'] = server_group_obj.id
+
         if isinstance(parsed_args.config_drive, bool):
             # NOTE(stephenfin): The API doesn't accept False as a value :'(
             config_drive = parsed_args.config_drive or None
@@ -1957,9 +2044,8 @@ class CreateServer(command.ShowOne):
             ):
                 self.app.stdout.write('\n')
             else:
-                LOG.error('Error creating server: %s', parsed_args.server_name)
-                self.app.stdout.write(_('Error creating server\n'))
-                raise SystemExit
+                msg = _('Error creating server: %s') % parsed_args.server_name
+                raise exceptions.CommandError(msg)
 
         details = _prep_server_detail(compute_client, image_client, server)
         return zip(*sorted(details.items()))
@@ -2051,17 +2137,52 @@ class DeleteServer(command.Command):
                     server_obj.id,
                     callback=_show_progress,
                 ):
-                    msg = _('Error deleting server: %s')
-                    LOG.error(msg, server_obj.id)
-                    self.app.stdout.write(_('Error deleting server\n'))
-                    raise SystemExit
+                    msg = _('Error deleting server: %s') % server_obj.id
+                    raise exceptions.CommandError(msg)
+
+
+class PercentAction(argparse.Action):
+    def __init__(
+        self,
+        option_strings,
+        dest,
+        nargs=None,
+        const=None,
+        default=None,
+        type=None,
+        choices=None,
+        required=False,
+        help=None,
+        metavar=None,
+    ):
+        if nargs == 0:
+            raise ValueError(
+                'nargs for store actions must be != 0; if you '
+                'have nothing to store, actions such as store '
+                'true or store const may be more appropriate'
+            )
+
+        if const is not None:
+            raise ValueError('const does not make sense for PercentAction')
 
+        super().__init__(
+            option_strings=option_strings,
+            dest=dest,
+            nargs=nargs,
+            const=const,
+            default=default,
+            type=type,
+            choices=choices,
+            required=required,
+            help=help,
+            metavar=metavar,
+        )
 
-def percent_type(x):
-    x = int(x)
-    if not 0 < x <= 100:
-        raise argparse.ArgumentTypeError("Must be between 0 and 100")
-    return x
+    def __call__(self, parser, namespace, values, option_string=None):
+        x = int(values)
+        if not 0 < x <= 100:
+            raise argparse.ArgumentError(self, "Must be between 0 and 100")
+        setattr(namespace, self.dest, x)
 
 
 class ListServer(command.Lister):
@@ -2214,7 +2335,7 @@ class ListServer(command.Lister):
         )
         parser.add_argument(
             '--progress',
-            type=percent_type,
+            action=PercentAction,
             default=None,
             help=_(
                 'Search by progress value (%%) '
@@ -2341,29 +2462,7 @@ class ListServer(command.Lister):
                 'Mutually exclusive with "--no-name-lookup|-n" option.'
             ),
         )
-        parser.add_argument(
-            '--marker',
-            metavar='<server>',
-            default=None,
-            help=_(
-                'The last server of the previous page. Display '
-                'list of servers after marker. Display all servers if not '
-                'specified. When used with ``--deleted``, the marker must '
-                'be an ID, otherwise a name or ID can be used.'
-            ),
-        )
-        parser.add_argument(
-            '--limit',
-            metavar='<num-servers>',
-            type=int,
-            default=None,
-            help=_(
-                "Maximum number of servers to display. If limit equals -1, "
-                "all servers will be displayed. If limit is greater than "
-                "'osapi_max_limit' option of Nova API, "
-                "'osapi_max_limit' will be used instead."
-            ),
-        )
+        pagination.add_marker_pagination_option_to_parser(parser)
         parser.add_argument(
             '--changes-before',
             metavar='<changes-before>',
@@ -2743,7 +2842,7 @@ class ListServer(command.Lister):
                 try:
                     # some deployments can have *loads* of images so we only
                     # want to list the ones we care about. It would be better
-                    # to only retrun the *fields* we care about (name) but
+                    # to only return the *fields* we care about (name) but
                     # glance doesn't support that
                     # NOTE(stephenfin): This could result in super long URLs
                     # but it seems unlikely to cause issues. Apache supports
@@ -3102,9 +3201,8 @@ revert to release the new server and restart the old one."""
             ):
                 self.app.stdout.write(_('Complete\n'))
             else:
-                LOG.error(_('Error migrating server: %s'), server.id)
-                self.app.stdout.write(_('Error migrating server\n'))
-                raise SystemExit
+                msg = _('Error migrating server: %s') % server.id
+                raise exceptions.CommandError(msg)
 
 
 class PauseServer(command.Command):
@@ -3186,9 +3284,8 @@ class RebootServer(command.Command):
             ):
                 self.app.stdout.write(_('Complete\n'))
             else:
-                LOG.error(_('Error rebooting server: %s'), server_id)
-                self.app.stdout.write(_('Error rebooting server\n'))
-                raise SystemExit
+                msg = _('Error rebooting server: %s') % server_id
+                raise exceptions.CommandError(msg)
 
 
 class RebuildServer(command.ShowOne):
@@ -3558,9 +3655,8 @@ class RebuildServer(command.ShowOne):
             ):
                 self.app.stdout.write(_('Complete\n'))
             else:
-                LOG.error(_('Error rebuilding server: %s'), server.id)
-                self.app.stdout.write(_('Error rebuilding server\n'))
-                raise SystemExit
+                msg = _('Error rebuilding server: %s') % server.id
+                raise exceptions.CommandError(msg)
 
         details = _prep_server_detail(
             compute_client, image_client, server, refresh=False
@@ -3681,9 +3777,8 @@ host."""
             ):
                 self.app.stdout.write(_('Complete\n'))
             else:
-                LOG.error(_('Error evacuating server: %s'), server.id)
-                self.app.stdout.write(_('Error evacuating server\n'))
-                raise SystemExit
+                msg = _('Error evacuating server: %s') % server.id
+                raise exceptions.CommandError(msg)
 
         details = _prep_server_detail(
             compute_client, image_client, server, refresh=True
@@ -4017,6 +4112,13 @@ release the new server and restart the old one."""
                 compute_client.flavors,
                 parsed_args.flavor,
             )
+            if not server.image:
+                self.log.warning(
+                    _(
+                        "The root disk size in flavor will not be applied "
+                        "while booting from a persistent volume."
+                    )
+                )
             compute_client.servers.resize(server, flavor)
             if parsed_args.wait:
                 if utils.wait_for_status(
@@ -4027,9 +4129,8 @@ release the new server and restart the old one."""
                 ):
                     self.app.stdout.write(_('Complete\n'))
                 else:
-                    LOG.error(_('Error resizing server: %s'), server.id)
-                    self.app.stdout.write(_('Error resizing server\n'))
-                    raise SystemExit
+                    msg = _('Error resizing server: %s') % server.id
+                    raise exceptions.CommandError(msg)
         elif parsed_args.confirm:
             self.log.warning(
                 _(
@@ -4401,6 +4502,7 @@ class ShelveServer(command.Command):
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute
+        server_ids = []
 
         for server in parsed_args.servers:
             server_obj = compute_client.find_server(
@@ -4410,6 +4512,8 @@ class ShelveServer(command.Command):
             if server_obj.status.lower() in ('shelved', 'shelved_offloaded'):
                 continue
 
+            server_ids.append(server_obj.id)
+
             compute_client.shelve_server(server_obj.id)
 
         # if we don't have to wait, either because it was requested explicitly
@@ -4417,56 +4521,44 @@ class ShelveServer(command.Command):
         if not parsed_args.wait and not parsed_args.offload:
             return
 
-        for server in parsed_args.servers:
+        for server_id in server_ids:
             # We use osc-lib's wait_for_status since that allows for a callback
             # TODO(stephenfin): We should wait for these in parallel using e.g.
             # https://review.opendev.org/c/openstack/osc-lib/+/762503/
             if not utils.wait_for_status(
                 compute_client.get_server,
-                server_obj.id,
+                server_id,
                 success_status=('shelved', 'shelved_offloaded'),
                 callback=_show_progress,
             ):
-                LOG.error(_('Error shelving server: %s'), server_obj.id)
-                self.app.stdout.write(
-                    _('Error shelving server: %s\n') % server_obj.id
-                )
-                raise SystemExit
+                msg = _('Error shelving server: %s') % server_id
+                raise exceptions.CommandError(msg)
 
         if not parsed_args.offload:
             return
 
-        for server in parsed_args.servers:
-            server_obj = compute_client.find_server(
-                server,
-                ignore_missing=False,
-            )
+        for server_id in server_ids:
+            server_obj = compute_client.get_server(server_id)
             if server_obj.status.lower() == 'shelved_offloaded':
                 continue
 
-            compute_client.shelve_offload_server(server_obj.id)
+            compute_client.shelve_offload_server(server_id)
 
         if not parsed_args.wait:
             return
 
-        for server in parsed_args.servers:
+        for server_id in server_ids:
             # We use osc-lib's wait_for_status since that allows for a callback
             # TODO(stephenfin): We should wait for these in parallel using e.g.
             # https://review.opendev.org/c/openstack/osc-lib/+/762503/
             if not utils.wait_for_status(
                 compute_client.get_server,
-                server_obj.id,
+                server_id,
                 success_status=('shelved_offloaded',),
                 callback=_show_progress,
             ):
-                LOG.error(
-                    _('Error offloading shelved server %s'),
-                    server_obj.id,
-                )
-                self.app.stdout.write(
-                    _('Error offloading shelved server: %s\n') % server_obj.id
-                )
-                raise SystemExit
+                msg = _('Error offloading shelved server: %s') % server_id
+                raise exceptions.CommandError(msg)
 
 
 class ShowServer(command.ShowOne):
@@ -4928,8 +5020,8 @@ class UnsetServer(command.Command):
         if parsed_args.description:
             if compute_client.api_version < api_versions.APIVersion("2.19"):
                 msg = _(
-                    "Description is not supported for "
-                    "--os-compute-api-version less than 2.19"
+                    '--os-compute-api-version 2.19 or greater is '
+                    'required to support the --description option'
                 )
                 raise exceptions.CommandError(msg)
             compute_client.servers.update(
@@ -5058,8 +5150,5 @@ class UnshelveServer(command.Command):
                     success_status=('active', 'shutoff'),
                     callback=_show_progress,
                 ):
-                    LOG.error(_('Error unshelving server %s'), server_obj.id)
-                    self.app.stdout.write(
-                        _('Error unshelving server: %s\n') % server_obj.id
-                    )
-                    raise SystemExit
+                    msg = _('Error unshelving server: %s') % server_obj.id
+                    raise exceptions.CommandError(msg)