Fix --image-property option in 'create server'

There was a problem that the '-image-property' option, which can be used
to create an instance, did not work as intended.

I found that there were two problems with this option.

First, I cannot select an image as its metadata.

The second is that when there are multiple images available, the desired
image may not be selected depending on the situation.

This patch solves these two problems.

I wrote the test case with these two problems considered together.

Change-Id: Ib2745d7e067056ff4ca8bfaf6cff492d0dacb73a
story: #2007860

Author: cocahack

openstackclient/compute/v2/server.py

@@ -751,19 +751,27 @@ def _match_image(image_api, wanted_properties):
                 images_matched = []
                 for img in image_list:
                     img_dict = {}
+
                     # exclude any unhashable entries
-                    for key, value in img.items():
+                    img_dict_items = list(img.items())
+                    if img.properties:
+                        img_dict_items.extend(list(img.properties.items()))
+                    for key, value in img_dict_items:
                         try:
                             set([key, value])
                         except TypeError:
+                            if key != 'properties':
+                                LOG.debug('Skipped the \'%s\' attribute. '
+                                          'That cannot be compared. '
+                                          '(image: %s, value: %s)',
+                                          key, img.id, value)
                             pass
                         else:
                             img_dict[key] = value
+
                     if all(k in img_dict and img_dict[k] == v
                            for k, v in wanted_properties.items()):
                         images_matched.append(img)
-                    else:
-                        return []
                 return images_matched
 
             images = _match_image(image_client, parsed_args.image_property)

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

@@ -2048,6 +2048,65 @@ def test_server_create_image_property_missed(self):
                           self.cmd.take_action,
                           parsed_args)
 
+    def test_server_create_image_property_with_image_list(self):
+        arglist = [
+            '--image-property',
+            'owner_specified.openstack.object=image/cirros',
+            '--flavor', 'flavor1',
+            '--nic', 'none',
+            self.new_server.name,
+        ]
+
+        verifylist = [
+            ('image_property',
+                {'owner_specified.openstack.object': 'image/cirros'}),
+            ('flavor', 'flavor1'),
+            ('nic', ['none']),
+            ('server_name', self.new_server.name),
+        ]
+        # create a image_info as the side_effect of the fake image_list()
+        image_info = {
+            'properties': {
+                'owner_specified.openstack.object': 'image/cirros'
+            }
+        }
+
+        target_image = image_fakes.FakeImage.create_one_image(image_info)
+        another_image = image_fakes.FakeImage.create_one_image({})
+        self.images_mock.return_value = [target_image, another_image]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Set expected values
+        kwargs = dict(
+            files={},
+            reservation_id=None,
+            min_count=1,
+            max_count=1,
+            security_groups=[],
+            userdata=None,
+            key_name=None,
+            availability_zone=None,
+            block_device_mapping_v2=[],
+            nics='none',
+            meta=None,
+            scheduler_hints={},
+            config_drive=None,
+        )
+
+        # ServerManager.create(name, image, flavor, **kwargs)
+        self.servers_mock.create.assert_called_with(
+            self.new_server.name,
+            target_image,
+            self.flavor,
+            **kwargs
+        )
+
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.datalist(), data)
+
     def test_server_create_invalid_hint(self):
         # Not a key-value pair
         arglist = [

releasenotes/notes/properties-with-image-property-field.yaml-c51bf37c3106d6ff.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - Support for image search via properties of image. Currently
+    "openstack server create --image-property" only takes image property.
+    Now it can also search image via properties (user defined) too.
+    Story https://storyboard.openstack.org/#!/story/2007860.