Merge lp:~dan-prince/glance/purge_props into lp:~glance-coresec/glance/cactus-trunk

[Dan Prince]

  Updates to the Registry API such that only external requests to
  update image properties purge existing properties. The update_image
  call now contains an extra flag to purge_props which is set to
  True for external requests but False internally.

  This resolves with revision 99 where Glance API incidentally deleted
  image metadata when uploading new images.

[Jay Pipes (jaypipes)]

merging this as a hotfix. we can discuss a long-term solution later.

review: Approve

=== modified file 'glance/registry/__init__.py'
--- glance/registry/__init__.py	2011-03-06 17:26:34 +0000
+++ glance/registry/__init__.py	2011-03-29 14:42:55 +0000
@@ -63,13 +63,13 @@
     return new_image_meta
 
 
-def update_image_metadata(options, image_id, image_meta):
+def update_image_metadata(options, image_id, image_meta, purge_props=False):
     if options['debug']:
         logger.debug("Updating image metadata for image %s...", image_id)
         _debug_print_metadata(image_meta)
 
     c = get_registry_client(options)
-    new_image_meta = c.update_image(image_id, image_meta)
+    new_image_meta = c.update_image(image_id, image_meta, purge_props)
 
     if options['debug']:
         logger.debug("Returned image metadata from call to "

=== modified file 'glance/registry/client.py'
--- glance/registry/client.py	2011-01-26 20:44:36 +0000
+++ glance/registry/client.py	2011-03-29 14:42:55 +0000
@@ -87,7 +87,7 @@
         data = json.loads(res.read())
         return data['image']
 
-    def update_image(self, image_id, image_metadata):
+    def update_image(self, image_id, image_metadata, purge_props=False):
         """
         Updates Registry's information about an image
         """
@@ -96,7 +96,10 @@
 
         body = json.dumps(image_metadata)
 
-        res = self.do_request("PUT", "/images/%s" % image_id, body)
+        headers = {}
+        if purge_props:
+            headers["X-Glance-Registry-Purge-Props"] = "true"
+        res = self.do_request("PUT", "/images/%s" % image_id, body, headers)
         data = json.loads(res.read())
         image = data['image']
         return image

=== modified file 'glance/registry/db/api.py'
--- glance/registry/db/api.py	2011-03-28 18:02:21 +0000
+++ glance/registry/db/api.py	2011-03-29 14:42:55 +0000
@@ -97,16 +97,16 @@
 
 def image_create(context, values):
     """Create an image from the values dictionary."""
-    return _image_update(context, values, None)
-
-
-def image_update(context, image_id, values):
+    return _image_update(context, values, None, False)
+
+
+def image_update(context, image_id, values, purge_props=False):
     """Set the given properties on an image and update it.
 
     Raises NotFound if image does not exist.
 
     """
-    return _image_update(context, values, image_id)
+    return _image_update(context, values, image_id, purge_props)
 
 
 def image_destroy(context, image_id):
@@ -188,7 +188,7 @@
             raise exception.Invalid(msg)
 
 
-def _image_update(context, values, image_id):
+def _image_update(context, values, image_id, purge_props=False):
     """Used internally by image_create and image_update
 
     :param context: Request context
@@ -227,12 +227,14 @@
 
         image_ref.save(session=session)
 
-        _set_properties_for_image(context, image_ref, properties, session)
+        _set_properties_for_image(context, image_ref, properties, purge_props,
+                                  session)
 
     return image_get(context, image_ref.id)
 
 
-def _set_properties_for_image(context, image_ref, properties, session=None):
+def _set_properties_for_image(context, image_ref, properties,
+                              purge_props=False, session=None):
     """
     Create or update a set of image_properties for a given image
 
@@ -256,10 +258,11 @@
         else:
             image_property_create(context, prop_values, session=session)
 
-    for key in orig_properties.keys():
-        if not key in properties:
-            prop_ref = orig_properties[key]
-            image_property_delete(context, prop_ref, session=session)
+    if purge_props:
+        for key in orig_properties.keys():
+            if not key in properties:
+                prop_ref = orig_properties[key]
+                image_property_delete(context, prop_ref, session=session)
 
 
 def image_property_create(context, values, session=None):

=== modified file 'glance/registry/server.py'
--- glance/registry/server.py	2011-03-23 14:16:10 +0000
+++ glance/registry/server.py	2011-03-29 14:42:55 +0000
@@ -157,11 +157,16 @@
         """
         image_data = json.loads(req.body)['image']
 
+        purge_props = req.headers.get("X-Glance-Registry-Purge-Props", "false")
         context = None
         try:
             logger.debug("Updating image %(id)s with metadata: %(image_data)r"
                          % locals())
-            updated_image = db_api.image_update(context, id, image_data)
+            if purge_props == "true":
+                updated_image = db_api.image_update(context, id, image_data,
+                                                        True)
+            else:
+                updated_image = db_api.image_update(context, id, image_data)
             return dict(image=make_image_dict(updated_image))
         except exception.Invalid, e:
             msg = ("Failed to update image metadata. "

=== modified file 'glance/server.py'
--- glance/server.py	2011-03-25 18:33:54 +0000
+++ glance/server.py	2011-03-29 14:42:55 +0000
@@ -418,7 +418,8 @@
         try:
             image_meta = registry.update_image_metadata(self.options,
                                                         id,
-                                                        new_image_meta)
+                                                        new_image_meta,
+                                                        True)
             if has_body:
                 image_meta = self._upload_and_activate(req, image_meta)
 

=== modified file 'tests/stubs.py'
--- tests/stubs.py	2011-03-23 14:16:10 +0000
+++ tests/stubs.py	2011-03-29 14:42:55 +0000
@@ -344,7 +344,7 @@
             self.images.append(values)
             return values
 
-        def image_update(self, _context, image_id, values):
+        def image_update(self, _context, image_id, values, purge_props=False):
 
             image = self.image_get(_context, image_id)
             copy_image = image.copy()
@@ -353,16 +353,17 @@
             props = []
             orig_properties = image['properties']
 
-            if 'properties' in values.keys():
-                for k, v in values['properties'].items():
-                    p = {}
-                    p['key'] = k
-                    p['value'] = v
-                    p['deleted'] = False
-                    p['created_at'] = datetime.datetime.utcnow()
-                    p['updated_at'] = datetime.datetime.utcnow()
-                    p['deleted_at'] = None
-                    props.append(p)
+            if purge_props == False:
+                if 'properties' in values.keys():
+                    for k, v in values['properties'].items():
+                        p = {}
+                        p['key'] = k
+                        p['value'] = v
+                        p['deleted'] = False
+                        p['created_at'] = datetime.datetime.utcnow()
+                        p['updated_at'] = datetime.datetime.utcnow()
+                        p['deleted_at'] = None
+                        props.append(p)
 
             orig_properties = orig_properties + props
             values['properties'] = orig_properties