Add support for stripping XMD from an Index

By specification, the XMD contents are not meant to be used by
consumers. This will provide a simple method of stripping that content
out from the metadata of all streams.

This could be used to sanitize the module metadata prior to including it
in a composed RPM repository.

Signed-off-by: Stephen Gallagher <[email protected]>

Author: sgallagher

modulemd/include/modulemd-2.0/modulemd-module-index.h

@@ -667,4 +667,19 @@ modulemd_module_index_upgrade_defaults (ModulemdModuleIndex *self,
                                         GError **error);
 
 
+/**
+ * modulemd_module_index_clear_xmds:
+ * @self: This #ModulemdModuleIndex object.
+ *
+ * Iterates through all #ModulemdModuleStream entries in this
+ * #ModulemdModuleIndex and removes any XMD sections that are present. This is
+ * generally done to trim down the metadata to only the portions that are
+ * useful to the package manager.
+ *
+ * Since: 2.14.0
+ */
+void
+modulemd_module_index_clear_xmds (ModulemdModuleIndex *self);
+
+
 G_END_DECLS

modulemd/include/modulemd-2.0/modulemd-module-stream-v2.h

@@ -959,6 +959,16 @@ GVariant *
 modulemd_module_stream_v2_get_xmd (ModulemdModuleStreamV2 *self);
 
 
+/**
+ * modulemd_module_stream_v2_clear_xmd:
+ * @self: (in): This #ModulemdModuleStreamV2 object.
+ *
+ * Removes all XMD data from this #ModulemdModuleStreamV2
+ */
+void
+modulemd_module_stream_v2_clear_xmd (ModulemdModuleStreamV2 *self);
+
+
 /**
  * modulemd_module_stream_v2_set_static_context:
  * @self: (in): This #ModulemdModuleStreamV2 object.

modulemd/include/modulemd-2.0/modulemd-module.h

@@ -336,4 +336,20 @@ modulemd_module_get_newest_active_obsoletes (ModulemdModule *self,
                                              const gchar *stream,
                                              const gchar *context);
 
+
+/**
+ * modulemd_module_clear_xmds:
+ * @self: (in): This #ModulemdModule object.
+ *
+ * Iterates through all #ModulemdModuleStream entries in this
+ * #ModulemdModule and removes any XMD sections that are present. This is
+ * generally done to trim down the metadata to only the portions that are
+ * useful to the package manager.
+ *
+ * Since: 2.14.0
+ */
+void
+modulemd_module_clear_xmds (ModulemdModule *self);
+
+
 G_END_DECLS

modulemd/modulemd-module-index.c

@@ -1439,6 +1439,26 @@ modulemd_module_index_add_translation (ModulemdModuleIndex *self,
 }
 
 
+static void
+clear_xmds (gpointer key, gpointer value, gpointer user_data)
+{
+  MODULEMD_INIT_TRACE ();
+
+  g_return_if_fail (MODULEMD_IS_MODULE (value));
+
+  modulemd_module_clear_xmds (MODULEMD_MODULE (value));
+}
+
+
+void
+modulemd_module_index_clear_xmds (ModulemdModuleIndex *self)
+{
+  MODULEMD_INIT_TRACE ();
+
+  g_hash_table_foreach (self->modules, clear_xmds, NULL);
+}
+
+
 gboolean
 modulemd_module_index_merge (ModulemdModuleIndex *from,
                              ModulemdModuleIndex *into,

modulemd/modulemd-module-stream-v2.c

@@ -1263,6 +1263,15 @@ modulemd_module_stream_v2_get_xmd (ModulemdModuleStreamV2 *self)
 }
 
 
+void
+modulemd_module_stream_v2_clear_xmd (ModulemdModuleStreamV2 *self)
+{
+  g_return_if_fail (MODULEMD_IS_MODULE_STREAM_V2 (self));
+
+  g_clear_pointer (&self->xmd, g_variant_unref);
+}
+
+
 gboolean
 modulemd_module_stream_v2_includes_nevra (ModulemdModuleStreamV2 *self,
                                           const gchar *nevra_pattern)

modulemd/modulemd-module.c

@@ -1088,3 +1088,23 @@ modulemd_module_get_newest_active_obsoletes (ModulemdModule *self,
 
   return newestActiveObsoletes;
 }
+
+
+static void
+clear_xmds (gpointer data, gpointer user_data)
+{
+  g_return_if_fail (MODULEMD_IS_MODULE_STREAM_V2 (data));
+
+  modulemd_module_stream_v2_clear_xmd (MODULEMD_MODULE_STREAM_V2 (data));
+}
+
+
+void
+modulemd_module_clear_xmds (ModulemdModule *self)
+{
+  MODULEMD_INIT_TRACE ();
+
+  g_return_if_fail (MODULEMD_IS_MODULE (self));
+
+  g_ptr_array_foreach (self->streams, clear_xmds, NULL);
+}

modulemd/tests/ModulemdTests/moduleindex.py

@@ -224,6 +224,86 @@ def test_update_from_defaults_directory(self):
             )
             self.assertFalse(ret)
 
+    def test_clear_xmds(self):
+        if "_overrides_module" in dir(Modulemd) and hasattr(
+            gi.overrides.Modulemd, "ModuleStreamV2"
+        ):
+            idx = Modulemd.ModuleIndex.new()
+            self.assertIsNotNone(idx)
+
+            ret, failures = idx.update_from_string(
+                """
+---
+document: modulemd
+version: 2
+data:
+    name: foo
+    stream: latest
+    version: 1
+    static_context: true
+    context: c0ffee43
+    arch: s390x
+    summary: An example module
+    description: A longer description
+    license:
+        module: MIT
+    xmd:
+        a_key: a_value
+        another_key: another_value
+        an_array:
+          - a
+          - b
+...
+---
+document: modulemd
+version: 2
+data:
+    name: foo
+    stream: latest
+    version: 2
+    static_context: true
+    context: c0ffee43
+    arch: s390x
+    summary: An example module
+    description: A longer description
+    license:
+        module: MIT
+    xmd:
+        a_key: a_value
+        another_key: another_value
+        an_array:
+          - a
+          - b
+...
+""",
+                strict=True,
+            )
+            self.assertEqual(len(failures), 0)
+
+            module_names = idx.get_module_names()
+            self.assertEqual(len(module_names), 1)
+            self.assertEqual(module_names[0], "foo")
+
+            module = idx.get_module(module_names[0])
+            self.assertEqual(len(module.get_all_streams()), 2)
+
+            ref_xmd = {
+                "a_key": "a_value",
+                "another_key": "another_value",
+                "an_array": ["a", "b"],
+            }
+
+            for stream in module.get_all_streams():
+                # Verify that the XMD data is present.
+                xmd = stream.get_xmd()
+                self.assertEqual(xmd, ref_xmd)
+
+            idx.clear_xmds()
+
+            for stream in module.get_all_streams():
+                # Verify that the XMD data is gone now.
+                self.assertEqual(stream.get_xmd(), {})
+
 
 if __name__ == "__main__":
     unittest.main()