Implement public API PackagerV3.convert_to_index()

mmathesius · sgallagher · commit da1eaeebeffe · 2020-12-09T21:05:09.000-05:00
Signed-off-by: Merlin Mathesius &lt;mmathesi@redhat.com&gt;
diff --git a/modulemd/include/modulemd-2.0/modulemd-packager-v3.h b/modulemd/include/modulemd-2.0/modulemd-packager-v3.h
@@ -16,6 +16,7 @@
 #include "modulemd-build-config.h"
 #include "modulemd-component-module.h"
 #include "modulemd-component-rpm.h"
+#include "modulemd-module-index.h"
 #include "modulemd-profile.h"
 #include "modulemd-subdocument-info.h"
 #include <glib-object.h>
@@ -722,4 +723,23 @@ ModulemdComponentRpm *
 modulemd_packager_v3_get_rpm_component (ModulemdPackagerV3 *self,
                                         const gchar *component_name);
 
+
+/**
+ * modulemd_packager_v3_convert_to_index:
+ * @self: (in): This #ModulemdPackagerV3 object.
+ * @error: (out): A #GError that will return the reason for a conversion error.
+ *
+ * Returns: (transfer full): A newly-allocated #ModulemdModuleIndex object
+ * containing a set of one or more #ModulemdModuleStreamV2 objects and possibly
+ * a #ModulemdDefaults object corresponding to the #ModulemdPackagerV3 object
+ * @self. NULL if there was an error doing the mapping and sets @error
+ * appropriately.
+ *
+ * Since: 2.11
+ */
+ModulemdModuleIndex *
+modulemd_packager_v3_convert_to_index (ModulemdPackagerV3 *self,
+                                       GError **error);
+
+
 G_END_DECLS
diff --git a/modulemd/modulemd-packager-v3.c b/modulemd/modulemd-packager-v3.c
@@ -983,6 +983,198 @@ modulemd_packager_v3_to_stream_v2_ext (ModulemdPackagerV3 *self,
 }
 
 
+ModulemdModuleIndex *
+modulemd_packager_v3_convert_to_index (ModulemdPackagerV3 *self,
+                                       GError **error)
+{
+  g_auto (GStrv) contexts = NULL;
+  g_autoptr (ModulemdModuleIndex) index = NULL;
+  g_autoptr (ModulemdModuleStreamV2) v2_stream = NULL;
+  g_autoptr (ModulemdProfile) profile = NULL;
+  g_autoptr (ModulemdDependencies) deps = NULL;
+  g_autoptr (ModulemdDefaults) defaults = NULL;
+  g_auto (GStrv) modules = NULL;
+  g_autoptr (GError) nested_error = NULL;
+  ModulemdBuildConfig *bc;
+  GHashTableIter iter;
+  gpointer value;
+
+  g_return_val_if_fail (error == NULL || *error == NULL, NULL);
+  g_return_val_if_fail (MODULEMD_IS_PACKAGER_V3 (self), NULL);
+
+  /* get the list of packager build configuration contexts */
+  contexts = modulemd_packager_v3_get_build_config_contexts_as_strv (self);
+
+  if (g_strv_length (contexts) == 0)
+    {
+      g_set_error_literal (error,
+                           MODULEMD_ERROR,
+                           MMD_ERROR_VALIDATE,
+                           "Packager document with no build configurations "
+                           "cannot be converted to stream");
+      return NULL;
+    }
+
+  /* create a ModuleIndex to contain the results */
+  index = modulemd_module_index_new ();
+
+  /* create a StreamV2 object for each BuildConfig object */
+  for (guint i = 0; i < g_strv_length (contexts); i++)
+    {
+      bc = modulemd_packager_v3_get_build_config (self, contexts[i]);
+
+      v2_stream = modulemd_module_stream_v2_new (
+        modulemd_packager_v3_get_module_name (self),
+        modulemd_packager_v3_get_stream_name (self));
+
+      modulemd_module_stream_set_context (MODULEMD_MODULE_STREAM (v2_stream),
+                                          contexts[i]);
+
+      /* set attributes that are the same for all streams */
+
+      modulemd_module_stream_v2_set_summary (
+        v2_stream, modulemd_packager_v3_get_summary (self));
+
+      modulemd_module_stream_v2_set_description (
+        v2_stream, modulemd_packager_v3_get_description (self));
+
+      /* Packager v3 "license" is optional. Stream v2 "license" is required
+       * Fill in the default Packager v3 license if none has been specified.
+       */
+      if (g_hash_table_size (self->module_licenses) == 0)
+        {
+          modulemd_module_stream_v2_add_module_license (
+            v2_stream, MMD_PACKAGER_DEFAULT_MODULE_LICENSE);
+        }
+      else
+        {
+          MODULEMD_REPLACE_SET (v2_stream->module_licenses,
+                                self->module_licenses);
+        }
+
+      modulemd_module_stream_v2_set_xmd (v2_stream,
+                                         modulemd_packager_v3_get_xmd (self));
+
+      modulemd_module_stream_v2_set_community (
+        v2_stream, modulemd_packager_v3_get_community (self));
+
+      modulemd_module_stream_v2_set_documentation (
+        v2_stream, modulemd_packager_v3_get_documentation (self));
+
+      modulemd_module_stream_v2_set_tracker (
+        v2_stream, modulemd_packager_v3_get_tracker (self));
+
+      g_hash_table_iter_init (&iter, self->profiles);
+      while (g_hash_table_iter_next (&iter, NULL, &value))
+        {
+          profile = modulemd_profile_copy (MODULEMD_PROFILE (value));
+          modulemd_profile_unset_default (profile);
+          modulemd_module_stream_v2_add_profile (v2_stream, profile);
+          g_clear_object (&profile);
+        }
+
+      modulemd_module_stream_v2_replace_rpm_api (v2_stream, self->rpm_api);
+
+      modulemd_module_stream_v2_replace_rpm_filters (v2_stream,
+                                                     self->rpm_filters);
+
+      COPY_HASHTABLE_BY_VALUE_ADDER (v2_stream,
+                                     self,
+                                     rpm_components,
+                                     modulemd_module_stream_v2_add_component);
+
+      COPY_HASHTABLE_BY_VALUE_ADDER (v2_stream,
+                                     self,
+                                     module_components,
+                                     modulemd_module_stream_v2_add_component);
+
+
+      /* set attributes that are the unique per build configuration */
+
+      if (modulemd_build_config_get_buildopts (bc))
+        {
+          modulemd_module_stream_v2_set_buildopts (
+            v2_stream, modulemd_build_config_get_buildopts (bc));
+        }
+
+      deps = modulemd_dependencies_new ();
+
+      modulemd_dependencies_add_buildtime_stream (
+        deps, "platform", modulemd_build_config_get_platform (bc));
+      modulemd_dependencies_add_runtime_stream (
+        deps, "platform", modulemd_build_config_get_platform (bc));
+
+      modules = modulemd_build_config_get_buildtime_modules_as_strv (bc);
+      for (guint j = 0; j < g_strv_length (modules); j++)
+        {
+          modulemd_dependencies_add_buildtime_stream (
+            deps,
+            modules[j],
+            modulemd_build_config_get_buildtime_requirement_stream (
+              bc, modules[j]));
+        }
+      g_clear_pointer (&modules, g_strfreev);
+
+      modules = modulemd_build_config_get_runtime_modules_as_strv (bc);
+      for (guint j = 0; j < g_strv_length (modules); j++)
+        {
+          modulemd_dependencies_add_runtime_stream (
+            deps,
+            modules[j],
+            modulemd_build_config_get_runtime_requirement_stream (bc,
+                                                                  modules[j]));
+        }
+      g_clear_pointer (&modules, g_strfreev);
+
+      modulemd_module_stream_v2_add_dependencies (v2_stream, deps);
+      g_clear_object (&deps);
+
+      if (!modulemd_module_stream_validate (MODULEMD_MODULE_STREAM (v2_stream),
+                                            &nested_error))
+        {
+          g_propagate_error (error, g_steal_pointer (&nested_error));
+          return NULL;
+        }
+
+      /* autogen module/stream names if necessary for adding to index */
+
+      modulemd_module_stream_set_autogen_module_name (
+        MODULEMD_MODULE_STREAM (v2_stream), 0);
+      modulemd_module_stream_set_autogen_stream_name (
+        MODULEMD_MODULE_STREAM (v2_stream), 0);
+
+      if (!modulemd_module_index_add_module_stream (
+            index, MODULEMD_MODULE_STREAM (v2_stream), &nested_error))
+        {
+          g_propagate_error (error, g_steal_pointer (&nested_error));
+          return NULL;
+        }
+
+      g_clear_object (&v2_stream);
+    }
+  g_clear_pointer (&contexts, g_strfreev);
+
+  if (!modulemd_packager_v3_to_defaults (self, &defaults, &nested_error))
+    {
+      g_propagate_error (error, g_steal_pointer (&nested_error));
+      return NULL;
+    }
+
+  if (defaults)
+    {
+      if (!modulemd_module_index_add_defaults (index, defaults, &nested_error))
+        {
+          g_propagate_error (error, g_steal_pointer (&nested_error));
+          return NULL;
+        }
+
+      g_clear_object (&defaults);
+    }
+
+  return g_steal_pointer (&index);
+}
+
+
 static gboolean
 modulemd_packager_v3_parse_build_configs (yaml_parser_t *parser,
                                           ModulemdPackagerV3 *packager,
diff --git a/modulemd/tests/test-modulemd-packager-v3.c b/modulemd/tests/test-modulemd-packager-v3.c
@@ -470,6 +470,48 @@ packager_test_map_to_stream_v2 (void)
   g_clear_pointer (&expected_str, g_free);
 }
 
+
+static void
+packager_test_convert_to_index (void)
+{
+  g_autoptr (ModulemdPackagerV3) packager = NULL;
+  g_autoptr (ModulemdModuleIndex) index = NULL;
+  g_autoptr (GError) error = NULL;
+  g_autofree gchar *yaml_str = NULL;
+  g_autofree gchar *expected_path = NULL;
+  g_autofree gchar *expected_str = NULL;
+
+  packager = read_spec ();
+
+  index = modulemd_packager_v3_convert_to_index (packager, &error);
+  g_assert_no_error (error);
+  g_assert_nonnull (index);
+  g_assert_true (MODULEMD_IS_MODULE_INDEX (index));
+
+  yaml_str = modulemd_module_index_dump_to_string (index, &error);
+  g_assert_no_error (error);
+  g_assert_nonnull (yaml_str);
+
+  g_debug ("YAML dump of index from PackageV3 to Index mapping:\n%s",
+           yaml_str);
+
+  expected_path = g_strdup_printf ("%s/upgrades/packager_v3_to_index.yaml",
+                                   g_getenv ("TEST_DATA_PATH"));
+  g_assert_nonnull (expected_path);
+  g_assert_true (
+    g_file_get_contents (expected_path, &expected_str, NULL, &error));
+  g_assert_no_error (error);
+  g_assert_nonnull (expected_str);
+
+  g_assert_cmpstr (expected_str, ==, yaml_str);
+
+  g_clear_object (&index);
+  g_clear_pointer (&yaml_str, g_free);
+  g_clear_pointer (&expected_path, g_free);
+  g_clear_pointer (&expected_str, g_free);
+}
+
+
 static void
 packager_test_map_to_stream_v2_autoname (void)
 {
@@ -633,5 +675,8 @@ main (int argc, char *argv[])
   g_test_add_func ("/modulemd/v2/packager/index/read",
                    packager_test_read_to_index);
 
+  g_test_add_func ("/modulemd/v2/packager/to_index",
+                   packager_test_convert_to_index);
+
   return g_test_run ();
 }
diff --git a/modulemd/tests/test_data/upgrades/packager_v3_to_index.yaml b/modulemd/tests/test_data/upgrades/packager_v3_to_index.yaml
