trivial: Use plural for appended parameters

Multiple compute commands take a '--property' parameter or variant
thereof. These should be stored in a 'properties' (plural) dest for
sanity's sake. Correct this.

Change-Id: If393836925fa736404527d9abd212b8ac9931027
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>

Author: stephenfin

openstackclient/compute/v2/aggregate.py

@@ -101,6 +101,7 @@ def get_parser(self, prog_name):
             "--property",
             metavar="<key=value>",
             action=parseractions.KeyValueAction,
+            dest="properties",
             help=_("Property to add to this aggregate "
                    "(repeat option to set multiple properties)")
         )
@@ -116,10 +117,10 @@ def take_action(self, parsed_args):
 
         aggregate = compute_client.create_aggregate(**attrs)
 
-        if parsed_args.property:
+        if parsed_args.properties:
             aggregate = compute_client.set_aggregate_metadata(
                 aggregate.id,
-                parsed_args.property,
+                parsed_args.properties,
             )
 
         display_columns, columns = _get_aggregate_columns(aggregate)
@@ -269,12 +270,12 @@ def get_parser(self, prog_name):
             "--property",
             metavar="<key=value>",
             action=parseractions.KeyValueAction,
+            dest="properties",
             help=_("Property to set on <aggregate> "
                    "(repeat option to set multiple properties)")
         )
         parser.add_argument(
             "--no-property",
-            dest="no_property",
             action="store_true",
             help=_("Remove all properties from <aggregate> "
                    "(specify both --property and --no-property to "
@@ -296,21 +297,20 @@ def take_action(self, parsed_args):
         if kwargs:
             compute_client.update_aggregate(aggregate.id, **kwargs)
 
-        set_property = {}
+        properties = {}
         if parsed_args.no_property:
             # NOTE(RuiChen): "availability_zone" can not be unset from
             # properties. It is already excluded from show and create output.
-            set_property.update({key: None
-                                 for key in aggregate.metadata.keys()
-                                 if key != 'availability_zone'})
-        if parsed_args.property:
-            set_property.update(parsed_args.property)
-
-        if set_property:
-            compute_client.set_aggregate_metadata(
-                aggregate.id,
-                set_property
-            )
+            properties.update({
+                key: None for key in aggregate.metadata.keys()
+                if key != 'availability_zone'
+            })
+
+        if parsed_args.properties:
+            properties.update(parsed_args.properties)
+
+        if properties:
+            compute_client.set_aggregate_metadata(aggregate.id, properties)
 
 
 class ShowAggregate(command.ShowOne):
@@ -354,7 +354,9 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "--property",
             metavar="<key>",
-            action='append',
+            action="append",
+            default=[],
+            dest="properties",
             help=_("Property to remove from aggregate "
                    "(repeat option to remove multiple properties)")
         )
@@ -365,12 +367,10 @@ def take_action(self, parsed_args):
         aggregate = compute_client.find_aggregate(
             parsed_args.aggregate, ignore_missing=False)
 
-        unset_property = {}
-        if parsed_args.property:
-            unset_property.update({key: None for key in parsed_args.property})
-        if unset_property:
-            compute_client.set_aggregate_metadata(
-                aggregate, unset_property)
+        properties = {key: None for key in parsed_args.properties}
+
+        if properties:
+            compute_client.set_aggregate_metadata(aggregate.id, properties)
 
 
 class CacheImageForAggregate(command.Command):

openstackclient/compute/v2/flavor.py

@@ -128,6 +128,7 @@ def get_parser(self, prog_name):
             "--property",
             metavar="<key=value>",
             action=parseractions.KeyValueAction,
+            dest="properties",
             help=_("Property to add for this flavor "
                    "(repeat option to set multiple properties)")
         )
@@ -191,12 +192,12 @@ def take_action(self, parsed_args):
                 msg = _("Failed to add project %(project)s access to "
                         "flavor: %(e)s")
                 LOG.error(msg, {'project': parsed_args.project, 'e': e})
-        if parsed_args.property:
+        if parsed_args.properties:
             try:
                 flavor = compute_client.create_flavor_extra_specs(
-                    flavor, parsed_args.property)
+                    flavor, parsed_args.properties)
             except Exception as e:
-                LOG.error(_("Failed to set flavor property: %s"), e)
+                LOG.error(_("Failed to set flavor properties: %s"), e)
 
         display_columns, columns = _get_flavor_columns(flavor)
         data = utils.get_dict_properties(flavor, columns,
@@ -398,6 +399,7 @@ def get_parser(self, prog_name):
             "--property",
             metavar="<key=value>",
             action=parseractions.KeyValueAction,
+            dest="properties",
             help=_("Property to add or modify for this flavor "
                    "(repeat option to set multiple properties)")
         )
@@ -447,15 +449,15 @@ def take_action(self, parsed_args):
                     compute_client.delete_flavor_extra_specs_property(
                         flavor.id, key)
             except Exception as e:
-                LOG.error(_("Failed to clear flavor property: %s"), e)
+                LOG.error(_("Failed to clear flavor properties: %s"), e)
                 result += 1
 
-        if parsed_args.property:
+        if parsed_args.properties:
             try:
                 compute_client.create_flavor_extra_specs(
-                    flavor.id, parsed_args.property)
+                    flavor.id, parsed_args.properties)
             except Exception as e:
-                LOG.error(_("Failed to set flavor property: %s"), e)
+                LOG.error(_("Failed to set flavor properties: %s"), e)
                 result += 1
 
         if parsed_args.project:
@@ -537,6 +539,7 @@ def get_parser(self, prog_name):
             "--property",
             metavar="<key>",
             action='append',
+            dest="properties",
             help=_("Property to remove from flavor "
                    "(repeat option to unset multiple properties)")
         )
@@ -563,8 +566,8 @@ def take_action(self, parsed_args):
             raise exceptions.CommandError(_(e.message))
 
         result = 0
-        if parsed_args.property:
-            for key in parsed_args.property:
+        if parsed_args.properties:
+            for key in parsed_args.properties:
                 try:
                     compute_client.delete_flavor_extra_specs_property(
                         flavor.id, key)

openstackclient/compute/v2/server.py

@@ -614,6 +614,7 @@ def get_parser(self, prog_name):
             '--image-property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='image_properties',
             help=_("Image property to be matched"),
         )
         disk_group.add_argument(
@@ -659,6 +660,7 @@ def get_parser(self, prog_name):
             '--property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='properties',
             help=_(
                 'Set a property on this server '
                 '(repeat option to set multiple values)'
@@ -886,8 +888,8 @@ def _show_progress(progress):
             image = image_client.find_image(
                 parsed_args.image, ignore_missing=False)
 
-        if not image and parsed_args.image_property:
-            def emit_duplicated_warning(img, image_property):
+        if not image and parsed_args.image_properties:
+            def emit_duplicated_warning(img):
                 img_uuid_list = [str(image.id) for image in img]
                 LOG.warning(
                     'Multiple matching images: %(img_uuid_list)s\n'
@@ -930,9 +932,9 @@ def _match_image(image_api, wanted_properties):
 
                 return images_matched
 
-            images = _match_image(image_client, parsed_args.image_property)
+            images = _match_image(image_client, parsed_args.image_properties)
             if len(images) > 1:
-                emit_duplicated_warning(images, parsed_args.image_property)
+                emit_duplicated_warning(images, parsed_args.image_properties)
             if images:
                 image = images[0]
             else:
@@ -1195,7 +1197,7 @@ def _match_image(image_api, wanted_properties):
                 config_drive = parsed_args.config_drive
 
         boot_kwargs = dict(
-            meta=parsed_args.property,
+            meta=parsed_args.properties,
             files=files,
             reservation_id=None,
             min_count=parsed_args.min,
@@ -2473,6 +2475,7 @@ def get_parser(self, prog_name):
             '--property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='properties',
             help=_(
                 'Set a new property on the rebuilt server '
                 '(repeat option to set multiple values)'
@@ -2614,8 +2617,8 @@ def _show_progress(progress):
         if parsed_args.preserve_ephemeral is not None:
             kwargs['preserve_ephemeral'] = parsed_args.preserve_ephemeral
 
-        if parsed_args.property:
-            kwargs['meta'] = parsed_args.property
+        if parsed_args.properties:
+            kwargs['meta'] = parsed_args.properties
 
         if parsed_args.description:
             if compute_client.api_version < api_versions.APIVersion('2.19'):
@@ -3278,9 +3281,10 @@ def get_parser(self, prog_name):
             help=_('Set new root password (interactive only)'),
         )
         parser.add_argument(
-            "--property",
-            metavar="<key=value>",
+            '--property',
+            metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='properties',
             help=_('Property to add/change for this server '
                    '(repeat option to set multiple properties)'),
         )
@@ -3321,11 +3325,8 @@ def take_action(self, parsed_args):
         if parsed_args.name:
             server.update(name=parsed_args.name)
 
-        if parsed_args.property:
-            compute_client.servers.set_meta(
-                server,
-                parsed_args.property,
-            )
+        if parsed_args.properties:
+            compute_client.servers.set_meta(server, parsed_args.properties)
 
         if parsed_args.state:
             server.reset_state(state=parsed_args.state)
@@ -3740,6 +3741,7 @@ def get_parser(self, prog_name):
             metavar='<key>',
             action='append',
             default=[],
+            dest='properties',
             help=_('Property key to remove from server '
                    '(repeat option to remove multiple values)'),
         )
@@ -3771,11 +3773,8 @@ def take_action(self, parsed_args):
             parsed_args.server,
         )
 
-        if parsed_args.property:
-            compute_client.servers.delete_meta(
-                server,
-                parsed_args.property,
-            )
+        if parsed_args.properties:
+            compute_client.servers.delete_meta(server, parsed_args.properties)
 
         if parsed_args.description:
             if compute_client.api_version < api_versions.APIVersion("2.19"):

openstackclient/tests/unit/compute/v2/test_aggregate.py

@@ -138,15 +138,15 @@ def test_aggregate_create_with_property(self):
             'ag1',
         ]
         verifylist = [
-            ('property', {'key1': 'value1', 'key2': 'value2'}),
+            ('properties', {'key1': 'value1', 'key2': 'value2'}),
             ('name', 'ag1'),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         columns, data = self.cmd.take_action(parsed_args)
         self.sdk_client.create_aggregate.assert_called_once_with(
             name=parsed_args.name)
         self.sdk_client.set_aggregate_metadata.assert_called_once_with(
-            self.fake_ag.id, parsed_args.property)
+            self.fake_ag.id, parsed_args.properties)
         self.assertEqual(self.columns, columns)
         self.assertItemsEqual(self.data, data)
 
@@ -378,7 +378,7 @@ def test_aggregate_set_with_property(self):
             'ag1',
         ]
         verifylist = [
-            ('property', {'key1': 'value1', 'key2': 'value2'}),
+            ('properties', {'key1': 'value1', 'key2': 'value2'}),
             ('aggregate', 'ag1'),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -388,7 +388,7 @@ def test_aggregate_set_with_property(self):
             parsed_args.aggregate, ignore_missing=False)
         self.assertNotCalled(self.sdk_client.update_aggregate)
         self.sdk_client.set_aggregate_metadata.assert_called_once_with(
-            self.fake_ag.id, parsed_args.property)
+            self.fake_ag.id, parsed_args.properties)
         self.assertIsNone(result)
 
     def test_aggregate_set_with_no_property_and_property(self):
@@ -399,7 +399,7 @@ def test_aggregate_set_with_no_property_and_property(self):
         ]
         verifylist = [
             ('no_property', True),
-            ('property', {'key2': 'value2'}),
+            ('properties', {'key2': 'value2'}),
             ('aggregate', 'ag1'),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -509,14 +509,14 @@ def test_aggregate_unset(self):
             'ag1',
         ]
         verifylist = [
-            ('property', ['unset_key']),
+            ('properties', ['unset_key']),
             ('aggregate', 'ag1'),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         result = self.cmd.take_action(parsed_args)
         self.sdk_client.set_aggregate_metadata.assert_called_once_with(
-            self.fake_ag, {'unset_key': None})
+            self.fake_ag.id, {'unset_key': None})
         self.assertIsNone(result)
 
     def test_aggregate_unset_multiple_properties(self):
@@ -526,22 +526,22 @@ def test_aggregate_unset_multiple_properties(self):
             'ag1',
         ]
         verifylist = [
-            ('property', ['unset_key1', 'unset_key2']),
+            ('properties', ['unset_key1', 'unset_key2']),
             ('aggregate', 'ag1'),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         result = self.cmd.take_action(parsed_args)
         self.sdk_client.set_aggregate_metadata.assert_called_once_with(
-            self.fake_ag, {'unset_key1': None, 'unset_key2': None})
+            self.fake_ag.id, {'unset_key1': None, 'unset_key2': None})
         self.assertIsNone(result)
 
     def test_aggregate_unset_no_option(self):
         arglist = [
             'ag1',
         ]
         verifylist = [
-            ('property', None),
+            ('properties', []),
             ('aggregate', 'ag1'),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)