fix glance metadata layout

The code here builds a dictionary from a glance v2 image object that
roughly resembles the glance v2 image object. The current behavior
nests the 'properties' set on the image under it's own 'properties' key
resulting in the image properties never being seen by the Ironic code.
The breakage results from the change from glanceclient to the SDK which
changed the shape of the returned object. The glanceclient object shape
was that of FakeImage while the SDK returns a Resource based object
which includes attributes for all possible fields which are defined at
the top-level of the object. Since the tests run against a different
value they did not cature the failure. Just changing to the SDK object
results in us copying all these new values to the properties dict which
is definitely not the intention. For maximum compatibility to backport
this filters any value not set from being set into properties and sets
the rest. The broken path is any user of get_image_properties()
(both copies from common/images and deploy_utils) checking for user
supplied properties.

Closes-Bug: 2099953
Change-Id: I1842e2651fd2bd8455646db9a3a80c3b9ece5c97
Signed-off-by: Doug Goldstein <cardoe@cardoe.com>

ironic/common/glance_service/service_utils.py

@@ -38,14 +38,26 @@ LOG = log.getLogger(__name__)
 
 def _extract_attributes(image):
     output = {}
+    # copies attributes from the openstacksdk Image object
+    # to a dictionary
     for attr in _IMAGE_ATTRIBUTES:
         output[attr] = getattr(image, attr, None)
 
-    output['properties'] = {}
+    # copy the properties over to start so that image properties
+    # are not nested in another properties key
+    output['properties'] = getattr(image, 'properties', {})
     output['schema'] = image.schema
 
-    for image_property in set(image) - set(_IMAGE_ATTRIBUTES):
-        output['properties'][image_property] = image[image_property]
+    # attributes already copied so we copy the rest into properties
+    copied = set(_IMAGE_ATTRIBUTES)
+    copied.add('properties')
+
+    for image_property in set(image) - copied:
+        # previously with glanceclient only set things
+        # were on the object that came back but the SDK
+        # defines every possible attribute so we need to filter
+        if image[image_property]:
+            output['properties'][image_property] = image[image_property]
 
     return output
 

ironic/tests/unit/common/test_glance_service.py

@@ -100,9 +100,11 @@ class TestGlanceImageService(base.TestCase):
     @staticmethod
     def _make_fixture(**kwargs):
         fixture = {'name': None,
+                   'owner': None,
+                   'properties': {},
                    'status': "active"}
         fixture.update(kwargs)
-        return stubs.FakeImage(fixture)
+        return openstack.image.v2.image.Image.new(**fixture)
 
     @property
     def endpoint(self):
@@ -142,7 +144,7 @@ class TestGlanceImageService(base.TestCase):
             'schema': None,
             'size': None,
             'status': "active",
-            'tags': None,
+            'tags': [],
             'updated_at': None,
             'visibility': None,
             'os_hash_algo': None,

ironic/tests/unit/stubs.py

@@ -51,33 +51,6 @@ class FakeImageDownload(object):
         self.content = content
 
 
-class FakeImage(dict):
-    def __init__(self, metadata):
-        IMAGE_ATTRIBUTES = ['size', 'disk_format', 'owner',
-                            'container_format', 'checksum', 'id',
-                            'name', 'deleted', 'status',
-                            'min_disk', 'min_ram', 'tags', 'visibility',
-                            'protected', 'file', 'schema', 'os_hash_algo',
-                            'os_hash_value']
-        raw = dict.fromkeys(IMAGE_ATTRIBUTES)
-        raw.update(metadata)
-        # raw['created_at'] = NOW_GLANCE_FORMAT
-        # raw['updated_at'] = NOW_GLANCE_FORMAT
-        super(FakeImage, self).__init__(raw)
-
-    def __getattr__(self, key):
-        try:
-            return self[key]
-        except KeyError:
-            raise AttributeError(key)
-
-    def __setattr__(self, key, value):
-        if key in self:
-            self[key] = value
-        else:
-            raise AttributeError(key)
-
-
 class FakeNeutronPort(dict):
     def __init__(self, **attrs):
         PORT_ATTRS = ['admin_state_up',

releasenotes/notes/bug-2099275-glance-image-properties-check-2a11337c9e517a5c.yaml

@@ -0,0 +1,10 @@
+---
+fixes:
+  - |
+    When changing from glanceclient to OpenStack SDK to communicate with
+    Glance, a bug was introduced reading image properties causing the
+    Anaconda deploy interface to be unable to use Glance images. Other
+    deploy interfaces continued to function but could have resulted in
+    some properties not taking affect.
+    See `bug 2099275 <https://bugs.launchpad.net/ironic/+bug/2099953>`_ for
+    more details.