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

openstackclient/image/v2/image.py

@@ -22,6 +22,7 @@ import logging
 import os
 import sys
 import typing as ty
+import urllib.parse
 
 from openstack import exceptions as sdk_exceptions
 from openstack.image import image_signer
@@ -54,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__)
@@ -84,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,
@@ -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/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/security_group.py

@@ -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,
             (

openstackclient/network/v2/security_group_rule.py

@@ -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/tests/functional/identity/v3/test_access_rule.py

@@ -62,7 +62,7 @@ class AccessRuleTests(common.IdentityTests):
 
         items = self.parse_show_as_object(raw_output)
         self.access_rule_ids = [
-            x['id'] for x in ast.literal_eval(items['access_rules'])
+            x['id'] for x in ast.literal_eval(items['Access Rules'])
         ]
         self.addCleanup(
             self.openstack,

openstackclient/tests/functional/identity/v3/test_application_credential.py

@@ -21,13 +21,13 @@ from openstackclient.tests.functional.identity.v3 import common
 
 class ApplicationCredentialTests(common.IdentityTests):
     APPLICATION_CREDENTIAL_FIELDS = [
-        'id',
-        'name',
-        'project_id',
-        'description',
-        'roles',
-        'expires_at',
-        'unrestricted',
+        'ID',
+        'Name',
+        'Project ID',
+        'Description',
+        'Roles',
+        'Expires At',
+        'Unrestricted',
     ]
     APPLICATION_CREDENTIAL_LIST_HEADERS = [
         'ID',

openstackclient/tests/functional/image/v2/test_image.py

@@ -218,17 +218,39 @@ class ImageTests(base.BaseImageTests):
                 'image remove project ' + self.name + ' ' + my_project_id
             )
 
-        # else:
-        #     # Test not shared
-        #     self.assertRaises(
-        #         image_exceptions.HTTPForbidden,
-        #         self.openstack,
-        #         'image add project ' +
-        #         self.name + ' ' +
-        #         my_project_id
-        #     )
-        #     self.openstack(
-        #         'image set ' +
-        #         '--share ' +
-        #         self.name
-        #     )
+    def test_image_hidden(self):
+        # Test image is shown in list
+        output = self.openstack(
+            'image list',
+            parse_output=True,
+        )
+        self.assertIn(
+            self.name,
+            [img['Name'] for img in output],
+        )
+
+        # Hide the image and test image not show in the list
+        self.openstack('image set ' + '--hidden ' + self.name)
+        output = self.openstack(
+            'image list',
+            parse_output=True,
+        )
+        self.assertNotIn(self.name, [img['Name'] for img in output])
+
+        # Test image show in the list with flag
+        output = self.openstack(
+            'image list',
+            parse_output=True,
+        )
+        self.assertNotIn(self.name, [img['Name'] for img in output])
+
+        # Unhide the image and test image is again visible in regular list
+        self.openstack('image set ' + '--unhidden ' + self.name)
+        output = self.openstack(
+            'image list',
+            parse_output=True,
+        )
+        self.assertIn(
+            self.name,
+            [img['Name'] for img in output],
+        )

openstackclient/tests/functional/volume/v2/test_volume.py

@@ -171,7 +171,7 @@ class VolumeTests(common.BaseVolumeTests):
             cmd_output["volume_image_metadata"],
         )
         self.assertEqual(
-            'true',
+            True,
             cmd_output["bootable"],
         )
 

openstackclient/tests/functional/volume/v3/test_volume.py

@@ -124,7 +124,7 @@ class VolumeTests(common.BaseVolumeTests):
             cmd_output["properties"],
         )
         self.assertEqual(
-            'false',
+            False,
             cmd_output["bootable"],
         )
         self.wait_for_status("volume", name, "available")
@@ -172,7 +172,7 @@ class VolumeTests(common.BaseVolumeTests):
             cmd_output["volume_image_metadata"],
         )
         self.assertEqual(
-            'true',
+            True,
             cmd_output["bootable"],
         )
 

openstackclient/tests/unit/api/test_volume_v2.py

@@ -0,0 +1,124 @@
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+#
+
+"""Volume v2 API Library Tests"""
+
+import http
+from unittest import mock
+import uuid
+
+from openstack.block_storage.v2 import _proxy
+from osc_lib import exceptions as osc_lib_exceptions
+
+from openstackclient.api import volume_v2 as volume
+from openstackclient.tests.unit import fakes
+from openstackclient.tests.unit import utils
+
+
+class TestConsistencyGroup(utils.TestCase):
+    def setUp(self):
+        super().setUp()
+
+        self.volume_sdk_client = mock.Mock(_proxy.Proxy)
+
+    def test_find_consistency_group_by_id(self):
+        cg_id = uuid.uuid4().hex
+        cg_name = 'name-' + uuid.uuid4().hex
+        data = {
+            'consistencygroup': {
+                'id': cg_id,
+                'name': cg_name,
+                'status': 'available',
+                'availability_zone': 'az1',
+                'created_at': '2015-09-16T09:28:52.000000',
+                'description': 'description-' + uuid.uuid4().hex,
+                'volume_types': ['123456'],
+            }
+        }
+        self.volume_sdk_client.get.side_effect = [
+            fakes.FakeResponse(data=data),
+        ]
+
+        result = volume.find_consistency_group(self.volume_sdk_client, cg_id)
+
+        self.volume_sdk_client.get.assert_has_calls(
+            [
+                mock.call(f'/consistencygroups/{cg_id}'),
+            ]
+        )
+        self.assertEqual(data['consistencygroup'], result)
+
+    def test_find_consistency_group_by_name(self):
+        cg_id = uuid.uuid4().hex
+        cg_name = 'name-' + uuid.uuid4().hex
+        data = {
+            'consistencygroups': [
+                {
+                    'id': cg_id,
+                    'name': cg_name,
+                }
+            ],
+        }
+        self.volume_sdk_client.get.side_effect = [
+            fakes.FakeResponse(status_code=http.HTTPStatus.NOT_FOUND),
+            fakes.FakeResponse(data=data),
+        ]
+
+        result = volume.find_consistency_group(self.volume_sdk_client, cg_name)
+
+        self.volume_sdk_client.get.assert_has_calls(
+            [
+                mock.call(f'/consistencygroups/{cg_name}'),
+                mock.call('/consistencygroups'),
+            ]
+        )
+        self.assertEqual(data['consistencygroups'][0], result)
+
+    def test_find_consistency_group_not_found(self):
+        data = {'consistencygroups': []}
+        self.volume_sdk_client.get.side_effect = [
+            fakes.FakeResponse(status_code=http.HTTPStatus.NOT_FOUND),
+            fakes.FakeResponse(data=data),
+        ]
+        self.assertRaises(
+            osc_lib_exceptions.NotFound,
+            volume.find_consistency_group,
+            self.volume_sdk_client,
+            'invalid-cg',
+        )
+
+    def test_find_consistency_group_by_name_duplicate(self):
+        cg_name = 'name-' + uuid.uuid4().hex
+        data = {
+            'consistencygroups': [
+                {
+                    'id': uuid.uuid4().hex,
+                    'name': cg_name,
+                },
+                {
+                    'id': uuid.uuid4().hex,
+                    'name': cg_name,
+                },
+            ],
+        }
+        self.volume_sdk_client.get.side_effect = [
+            fakes.FakeResponse(status_code=http.HTTPStatus.NOT_FOUND),
+            fakes.FakeResponse(data=data),
+        ]
+
+        self.assertRaises(
+            osc_lib_exceptions.NotFound,
+            volume.find_consistency_group,
+            self.volume_sdk_client,
+            cg_name,
+        )

openstackclient/tests/unit/api/test_volume_v3.py

@@ -0,0 +1,124 @@
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+#
+
+"""Volume v3 API Library Tests"""
+
+import http
+from unittest import mock
+import uuid
+
+from openstack.block_storage.v3 import _proxy
+from osc_lib import exceptions as osc_lib_exceptions
+
+from openstackclient.api import volume_v3 as volume
+from openstackclient.tests.unit import fakes
+from openstackclient.tests.unit import utils
+
+
+class TestConsistencyGroup(utils.TestCase):
+    def setUp(self):
+        super().setUp()
+
+        self.volume_sdk_client = mock.Mock(_proxy.Proxy)
+
+    def test_find_consistency_group_by_id(self):
+        cg_id = uuid.uuid4().hex
+        cg_name = 'name-' + uuid.uuid4().hex
+        data = {
+            'consistencygroup': {
+                'id': cg_id,
+                'name': cg_name,
+                'status': 'available',
+                'availability_zone': 'az1',
+                'created_at': '2015-09-16T09:28:52.000000',
+                'description': 'description-' + uuid.uuid4().hex,
+                'volume_types': ['123456'],
+            }
+        }
+        self.volume_sdk_client.get.side_effect = [
+            fakes.FakeResponse(data=data),
+        ]
+
+        result = volume.find_consistency_group(self.volume_sdk_client, cg_id)
+
+        self.volume_sdk_client.get.assert_has_calls(
+            [
+                mock.call(f'/consistencygroups/{cg_id}'),
+            ]
+        )
+        self.assertEqual(data['consistencygroup'], result)
+
+    def test_find_consistency_group_by_name(self):
+        cg_id = uuid.uuid4().hex
+        cg_name = 'name-' + uuid.uuid4().hex
+        data = {
+            'consistencygroups': [
+                {
+                    'id': cg_id,
+                    'name': cg_name,
+                }
+            ],
+        }
+        self.volume_sdk_client.get.side_effect = [
+            fakes.FakeResponse(status_code=http.HTTPStatus.NOT_FOUND),
+            fakes.FakeResponse(data=data),
+        ]
+
+        result = volume.find_consistency_group(self.volume_sdk_client, cg_name)
+
+        self.volume_sdk_client.get.assert_has_calls(
+            [
+                mock.call(f'/consistencygroups/{cg_name}'),
+                mock.call('/consistencygroups'),
+            ]
+        )
+        self.assertEqual(data['consistencygroups'][0], result)
+
+    def test_find_consistency_group_not_found(self):
+        data = {'consistencygroups': []}
+        self.volume_sdk_client.get.side_effect = [
+            fakes.FakeResponse(status_code=http.HTTPStatus.NOT_FOUND),
+            fakes.FakeResponse(data=data),
+        ]
+        self.assertRaises(
+            osc_lib_exceptions.NotFound,
+            volume.find_consistency_group,
+            self.volume_sdk_client,
+            'invalid-cg',
+        )
+
+    def test_find_consistency_group_by_name_duplicate(self):
+        cg_name = 'name-' + uuid.uuid4().hex
+        data = {
+            'consistencygroups': [
+                {
+                    'id': uuid.uuid4().hex,
+                    'name': cg_name,
+                },
+                {
+                    'id': uuid.uuid4().hex,
+                    'name': cg_name,
+                },
+            ],
+        }
+        self.volume_sdk_client.get.side_effect = [
+            fakes.FakeResponse(status_code=http.HTTPStatus.NOT_FOUND),
+            fakes.FakeResponse(data=data),
+        ]
+
+        self.assertRaises(
+            osc_lib_exceptions.NotFound,
+            volume.find_consistency_group,
+            self.volume_sdk_client,
+            cg_name,
+        )