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

openstackclient/image/v2/image.py

@@ -17,14 +17,16 @@
 
 import argparse
 from base64 import b64encode
+import copy
 import logging
 import os
 import sys
 import typing as ty
+import urllib.parse
 
-from cinderclient import api_versions
 from openstack import exceptions as sdk_exceptions
 from openstack.image import image_signer
+from openstack import utils as sdk_utils
 from osc_lib.api import utils as api_utils
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -53,6 +55,19 @@ DISK_CHOICES = [
     "iso",
     "ploop",
 ]
+# A list of openstacksdk Image object attributes (values) that named
+# differently from actual properties stored by Glance (keys).
+IMAGE_ATTRIBUTES_CUSTOM_NAMES = {
+    'os_hidden': 'is_hidden',
+    'protected': 'is_protected',
+    'os_hash_algo': 'hash_algo',
+    'os_hash_value': 'hash_value',
+    'img_config_drive': 'needs_config_drive',
+    'os_secure_boot': 'needs_secure_boot',
+    'hw_vif_multiqueue_enabled': 'is_hw_vif_multiqueue_enabled',
+    'hw_boot_menu': 'is_hw_boot_menu_enabled',
+    'auto_disk_config': 'has_auto_disk_config',
+}
 MEMBER_STATUS_CHOICES = ["accepted", "pending", "rejected", "all"]
 
 LOG = logging.getLogger(__name__)
@@ -83,6 +98,9 @@ def _format_image(image, human_readable=False):
         'virtual_size',
         'min_ram',
         'schema',
+        'is_hidden',
+        'hash_algo',
+        'hash_value',
     ]
 
     # TODO(gtema/anybody): actually it should be possible to drop this method,
@@ -576,7 +594,7 @@ class CreateImage(command.ShowOne):
         return _format_image(image)
 
     def _take_action_volume(self, parsed_args):
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
 
         unsupported_opts = {
             # 'name',  # 'name' is a positional argument and will always exist
@@ -607,15 +625,14 @@ class CreateImage(command.ShowOne):
                 # version
                 LOG.warning(msg % opt_name)
 
-        source_volume = utils.find_resource(
-            volume_client.volumes,
-            parsed_args.volume,
+        source_volume = volume_client.find_volume(
+            parsed_args.volume, ignore_missing=False
         )
         kwargs: dict[str, ty.Any] = {
             'visibility': None,
             'protected': None,
         }
-        if volume_client.api_version < api_versions.APIVersion('3.1'):
+        if not sdk_utils.supports_microversion(volume_client, '3.1'):
             if parsed_args.visibility or parsed_args.is_protected is not None:
                 msg = _(
                     '--os-volume-api-version 3.1 or greater is required '
@@ -627,15 +644,15 @@ class CreateImage(command.ShowOne):
             kwargs['visibility'] = parsed_args.visibility or 'private'
             kwargs['protected'] = parsed_args.is_protected or False
 
-        response, body = volume_client.volumes.upload_to_image(
+        response = volume_client.upload_volume_to_image(
             source_volume.id,
-            parsed_args.force,
             parsed_args.name,
-            parsed_args.container_format,
-            parsed_args.disk_format,
+            force=parsed_args.force,
+            disk_format=parsed_args.disk_format,
+            container_format=parsed_args.container_format,
             **kwargs,
         )
-        info = body['os-volume_upload_image']
+        info = copy.deepcopy(response)
         try:
             info['volume_type'] = info['volume_type']['name']
         except TypeError:
@@ -889,6 +906,8 @@ class ListImage(command.Lister):
                 'visibility',
                 'is_protected',
                 'owner_id',
+                'hash_algo',
+                'hash_value',
                 'tags',
             )
             column_headers: tuple[str, ...] = (
@@ -902,6 +921,8 @@ class ListImage(command.Lister):
                 'Visibility',
                 'Protected',
                 'Project',
+                'Hash Algorithm',
+                'Hash Value',
                 'Tags',
             )
         else:
@@ -1052,6 +1073,16 @@ class SaveImage(command.Command):
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--chunk-size",
+            type=int,
+            default=1024,
+            metavar="<chunk-size>",
+            help=_(
+                "Size in bytes to read from the wire and buffer at one "
+                "time (default: 1024)"
+            ),
+        )
         parser.add_argument(
             "--file",
             metavar="<filename>",
@@ -1076,7 +1107,12 @@ class SaveImage(command.Command):
         if output_file is None:
             output_file = getattr(sys.stdout, "buffer", sys.stdout)
 
-        image_client.download_image(image.id, stream=True, output=output_file)
+        image_client.download_image(
+            image.id,
+            stream=True,
+            output=output_file,
+            chunk_size=parsed_args.chunk_size,
+        )
 
 
 class SetImage(command.Command):
@@ -1477,6 +1513,11 @@ class UnsetImage(command.Command):
                     )
                     new_props.pop(k, None)
                     kwargs['properties'] = new_props
+                elif (
+                    k in IMAGE_ATTRIBUTES_CUSTOM_NAMES
+                    and IMAGE_ATTRIBUTES_CUSTOM_NAMES[k] in image
+                ):
+                    delattr(image, IMAGE_ATTRIBUTES_CUSTOM_NAMES[k])
                 else:
                     LOG.error(
                         _(
@@ -1744,6 +1785,12 @@ class ImportImage(command.ShowOne):
                     "'--method=web-download'"
                 )
                 raise exceptions.CommandError(msg)
+            _parsed = urllib.parse.urlparse(parsed_args.uri)
+            if not all({_parsed.scheme, _parsed.netloc}):
+                msg = _("'%(uri)s' is not a valid url")
+                raise exceptions.CommandError(
+                    msg % {'uri': parsed_args.uri},
+                )
         else:
             if parsed_args.uri:
                 msg = _(

openstackclient/image/v2/metadef_objects.py

@@ -123,8 +123,11 @@ class DeleteMetadefObject(command.Command):
         parser.add_argument(
             "objects",
             metavar="<object>",
-            nargs="+",
-            help=_("Metadef object(s) to delete (name)"),
+            nargs="*",
+            help=_(
+                "Metadef object(s) to delete (name) "
+                "(omit this argument to delete all objects in the namespace)"
+            ),
         )
         return parser
 
@@ -133,6 +136,9 @@ class DeleteMetadefObject(command.Command):
 
         namespace = parsed_args.namespace
 
+        if not parsed_args.objects:
+            return image_client.delete_all_metadef_objects(namespace)
+
         result = 0
         for obj in parsed_args.objects:
             try:

openstackclient/image/v2/metadef_properties.py

@@ -124,14 +124,21 @@ class DeleteMetadefProperty(command.Command):
         parser.add_argument(
             "properties",
             metavar="<property>",
-            nargs="+",
-            help=_("Metadef propert(ies) to delete (name)"),
+            nargs="*",
+            help=_(
+                "Metadef properties to delete (name) "
+                "(omit this argument to delete all properties in the namespace)"
+            ),
         )
         return parser
 
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
 
+        if not parsed_args.properties:
+            image_client.delete_all_metadef_properties(parsed_args.namespace)
+            return
+
         result = 0
         for prop in parsed_args.properties:
             try:

openstackclient/network/client.py

@@ -27,12 +27,6 @@ API_VERSIONS = ('2.0', '2')
 
 def make_client(instance):
     """Returns a network proxy"""
-    # NOTE(dtroyer): As of osc-lib 1.8.0 and OpenStackSDK 0.10.0 the
-    #                old Profile interface and separate client creation
-    #                for each API that uses the SDK is unnecessary.  This
-    #                callback remains as a remnant of the original plugin
-    #                interface and to avoid the code churn of changing all
-    #                of the existing references.
     LOG.debug(
         'Network client initialized using OpenStack SDK: %s',
         instance.sdk_connection.network,

openstackclient/network/v2/floating_ip.py

@@ -243,18 +243,26 @@ class ListFloatingIP(common.NetworkAndComputeLister):
         parser.add_argument(
             '--network',
             metavar='<network>',
+            dest='networks',
+            action='append',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to "
-                    "given network (name or ID)"
+                    "List floating IP(s) according to given network "
+                    "(name or ID) "
+                    "(repeat option to fiter on multiple networks)"
                 )
             ),
         )
         parser.add_argument(
             '--port',
             metavar='<port>',
+            dest='ports',
+            action='append',
             help=self.enhance_help_neutron(
-                _("List floating IP(s) according to given port (name or ID)")
+                _(
+                    "List floating IP(s) according to given port (name or ID) "
+                    "(repeat option to fiter on multiple ports)"
+                )
             ),
         )
         parser.add_argument(
@@ -271,14 +279,6 @@ class ListFloatingIP(common.NetworkAndComputeLister):
                 _("List floating IP(s) according to given floating IP address")
             ),
         )
-        parser.add_argument(
-            '--long',
-            action='store_true',
-            default=False,
-            help=self.enhance_help_neutron(
-                _("List additional fields in output")
-            ),
-        )
         parser.add_argument(
             '--status',
             metavar='<status>',
@@ -295,8 +295,8 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             metavar='<project>',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given project (name or "
-                    "ID)"
+                    "List floating IP(s) according to given project "
+                    "(name or ID) "
                 )
             ),
         )
@@ -304,13 +304,27 @@ class ListFloatingIP(common.NetworkAndComputeLister):
         parser.add_argument(
             '--router',
             metavar='<router>',
+            dest='routers',
+            action='append',
             help=self.enhance_help_neutron(
-                _("List floating IP(s) according to given router (name or ID)")
+                _(
+                    "List floating IP(s) according to given router "
+                    "(name or ID) "
+                    "(repeat option to fiter on multiple routers)"
+                )
             ),
         )
         _tag.add_tag_filtering_option_to_parser(
             parser, _('floating IP'), enhance_help=self.enhance_help_neutron
         )
+        parser.add_argument(
+            '--long',
+            action='store_true',
+            default=False,
+            help=self.enhance_help_neutron(
+                _("List additional fields in output")
+            ),
+        )
 
         return parser
 
@@ -354,22 +368,33 @@ class ListFloatingIP(common.NetworkAndComputeLister):
 
         query = {}
 
-        if parsed_args.network is not None:
-            network = network_client.find_network(
-                parsed_args.network, ignore_missing=False
-            )
-            query['floating_network_id'] = network.id
-        if parsed_args.port is not None:
-            port = network_client.find_port(
-                parsed_args.port, ignore_missing=False
-            )
-            query['port_id'] = port.id
+        if parsed_args.networks is not None:
+            network_ids = []
+            for network in parsed_args.networks:
+                network_id = network_client.find_network(
+                    network, ignore_missing=False
+                ).id
+                network_ids.append(network_id)
+            query['floating_network_id'] = network_ids
+
+        if parsed_args.ports is not None:
+            port_ids = []
+            for port in parsed_args.ports:
+                port_id = network_client.find_port(
+                    port, ignore_missing=False
+                ).id
+                port_ids.append(port_id)
+            query['port_id'] = port_ids
+
         if parsed_args.fixed_ip_address is not None:
             query['fixed_ip_address'] = parsed_args.fixed_ip_address
+
         if parsed_args.floating_ip_address is not None:
             query['floating_ip_address'] = parsed_args.floating_ip_address
+
         if parsed_args.status:
             query['status'] = parsed_args.status
+
         if parsed_args.project is not None:
             project = identity_common.find_project(
                 identity_client,
@@ -377,11 +402,15 @@ class ListFloatingIP(common.NetworkAndComputeLister):
                 parsed_args.project_domain,
             )
             query['project_id'] = project.id
-        if parsed_args.router is not None:
-            router = network_client.find_router(
-                parsed_args.router, ignore_missing=False
-            )
-            query['router_id'] = router.id
+
+        if parsed_args.routers is not None:
+            router_ids = []
+            for router in parsed_args.routers:
+                router_id = network_client.find_router(
+                    router, ignore_missing=False
+                ).id
+                router_ids.append(router_id)
+            query['router_id'] = router_ids
 
         _tag.get_tag_filtering_args(parsed_args, query)
 

openstackclient/network/v2/network_qos_rule.py

@@ -73,7 +73,7 @@ ACTION_SHOW = 'get'
 
 
 def _get_columns(item):
-    hidden_columns = ['location', 'tenant_id']
+    hidden_columns = ['location', 'name', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
@@ -148,14 +148,6 @@ def _get_attrs(network_client, parsed_args, is_create=False):
     return attrs
 
 
-def _get_item_properties(item, fields):
-    """Return a tuple containing the item properties."""
-    row = []
-    for field in fields:
-        row.append(item.get(field, ''))
-    return tuple(row)
-
-
 def _rule_action_call(client, action, rule_type):
     rule_type = rule_type.replace('-', '_')
     func_name = f'{action}_qos_{rule_type}_rule'
@@ -357,10 +349,10 @@ class ListNetworkQosRule(command.Lister):
         qos = client.find_qos_policy(
             parsed_args.qos_policy, ignore_missing=False
         )
-        data = qos.rules
+
         return (
             column_headers,
-            (_get_item_properties(s, columns) for s in data),
+            (utils.get_dict_properties(s, columns) for s in qos.rules),
         )
 
 

openstackclient/network/v2/port.py

@@ -1316,6 +1316,18 @@ class UnsetPort(common.NeutronUnsetCommandWithExtraArgs):
             default=False,
             help=_("Clear hints for the port"),
         )
+        parser.add_argument(
+            '--device',
+            action='store_true',
+            default=False,
+            help=_("Clear device ID for the port."),
+        )
+        parser.add_argument(
+            '--device-owner',
+            action='store_true',
+            default=False,
+            help=_("Clear device owner for the port."),
+        )
         _tag.add_tag_option_to_parser_for_unset(parser, _('port'))
         parser.add_argument(
             'port',
@@ -1382,6 +1394,10 @@ class UnsetPort(common.NeutronUnsetCommandWithExtraArgs):
             attrs['binding:host_id'] = None
         if parsed_args.hints:
             attrs['hints'] = None
+        if parsed_args.device:
+            attrs['device_id'] = ''
+        if parsed_args.device_owner:
+            attrs['device_owner'] = ''
 
         attrs.update(
             self._parse_extra_properties(parsed_args.extra_properties)

openstackclient/network/v2/router.py

@@ -76,7 +76,7 @@ def _get_columns(item):
     }
     if hasattr(item, 'interfaces_info'):
         column_map['interfaces_info'] = 'interfaces_info'
-    invisible_columns = ['location']
+    invisible_columns = ['location', 'tenant_id']
     if item.is_ha is None:
         invisible_columns.append('is_ha')
         column_map.pop('is_ha')

openstackclient/network/v2/security_group.py

@@ -89,9 +89,8 @@ def _get_columns(item):
     # We still support Nova managed security groups, where we have tenant_id.
     column_map = {
         'security_group_rules': 'rules',
-        'tenant_id': 'project_id',
     }
-    hidden_columns = ['location']
+    hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, column_map, hidden_columns
     )
@@ -186,7 +185,8 @@ class CreateSecurityGroup(
             parsed_args.name,
             description,
         )
-        display_columns, property_columns = _get_columns(obj)
+        display_columns = ('description', 'id', 'name', 'project_id', 'rules')
+        property_columns = ('description', 'id', 'name', 'tenant_id', 'rules')
         data = utils.get_dict_properties(
             obj, property_columns, formatters=_formatters_compute
         )
@@ -222,7 +222,14 @@ class DeleteSecurityGroup(common.NetworkAndComputeDelete):
 # the OSC minimum requirements include SDK 1.0.
 class ListSecurityGroup(common.NetworkAndComputeLister):
     _description = _("List security groups")
-    FIELDS_TO_RETRIEVE = ['id', 'name', 'description', 'project_id', 'tags']
+    FIELDS_TO_RETRIEVE = [
+        'id',
+        'name',
+        'description',
+        'project_id',
+        'tags',
+        'shared',
+    ]
 
     def update_parser_network(self, parser):
         if not self.is_docs_build:
@@ -245,6 +252,23 @@ class ListSecurityGroup(common.NetworkAndComputeLister):
         identity_common.add_project_domain_option_to_parser(
             parser, enhance_help=self.enhance_help_neutron
         )
+
+        shared_group = parser.add_mutually_exclusive_group()
+        shared_group.add_argument(
+            '--share',
+            action='store_true',
+            dest='shared',
+            default=None,
+            help=_("List security groups shared between projects"),
+        )
+        shared_group.add_argument(
+            '--no-share',
+            action='store_false',
+            dest='shared',
+            default=None,
+            help=_("List security groups not shared between projects"),
+        )
+
         _tag.add_tag_filtering_option_to_parser(
             parser, _('security group'), enhance_help=self.enhance_help_neutron
         )
@@ -272,13 +296,30 @@ class ListSecurityGroup(common.NetworkAndComputeLister):
             ).id
             filters['project_id'] = project_id
 
+        if parsed_args.shared is not None:
+            filters['shared'] = parsed_args.shared
+
         _tag.get_tag_filtering_args(parsed_args, filters)
         data = client.security_groups(
             fields=self.FIELDS_TO_RETRIEVE, **filters
         )
 
-        columns = ("id", "name", "description", "project_id", "tags")
-        column_headers = ("ID", "Name", "Description", "Project", "Tags")
+        columns = (
+            "id",
+            "name",
+            "description",
+            "project_id",
+            "tags",
+            "is_shared",
+        )
+        column_headers = (
+            "ID",
+            "Name",
+            "Description",
+            "Project",
+            "Tags",
+            "Shared",
+        )
         return (
             column_headers,
             (
@@ -420,7 +461,8 @@ class ShowSecurityGroup(common.NetworkAndComputeShowOne):
 
     def take_action_compute(self, client, parsed_args):
         obj = compute_v2.find_security_group(client, parsed_args.group)
-        display_columns, property_columns = _get_columns(obj)
+        display_columns = ('description', 'id', 'name', 'project_id', 'rules')
+        property_columns = ('description', 'id', 'name', 'tenant_id', 'rules')
         data = utils.get_dict_properties(
             obj, property_columns, formatters=_formatters_compute
         )

openstackclient/network/v2/security_group_rule.py

@@ -30,7 +30,7 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    hidden_columns = ['location', 'tenant_id']
+    hidden_columns = ['location', 'name', 'tenant_id', 'tags']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
@@ -427,6 +427,14 @@ class ListSecurityGroupRule(common.NetworkAndComputeLister):
                 _("**Deprecated** This argument is no longer needed")
             ),
         )
+        parser.add_argument(
+            '--project',
+            metavar='<project>',
+            help=self.enhance_help_neutron(_("Owner's project (name or ID)")),
+        )
+        identity_common.add_project_domain_option_to_parser(
+            parser, enhance_help=self.enhance_help_neutron
+        )
         return parser
 
     def update_parser_compute(self, parser):
@@ -503,6 +511,15 @@ class ListSecurityGroupRule(common.NetworkAndComputeLister):
             query['direction'] = 'egress'
         if parsed_args.protocol is not None:
             query['protocol'] = parsed_args.protocol
+        if parsed_args.project is not None:
+            identity_client = self.app.client_manager.identity
+            project_id = identity_common.find_project(
+                identity_client,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+            query['tenant_id'] = project_id
+            query['project_id'] = project_id
 
         rules = [
             self._format_network_security_group_rule(r)

openstackclient/shell.py

@@ -94,7 +94,7 @@ class OpenStackShell(shell.OpenStackShell):
                 # instead.
                 mod_versions = getattr(mod, 'API_VERSIONS', None)
                 if mod_versions is not None and not isinstance(
-                    mod_versions, (dict, tuple)
+                    mod_versions, dict | tuple
                 ):
                     raise TypeError(
                         f'Plugin {mod} has incompatible API_VERSIONS. '

openstackclient/tests/functional/base.py

@@ -97,7 +97,11 @@ class TestCase(testtools.TestCase):
         )
 
         if parse_output:
-            return json.loads(output)
+            try:
+                return json.loads(output)
+            except json.JSONDecodeError:
+                print(f'failed to decode: {output}')
+                raise
         else:
             return output