Auto-quote all values in modulemd-defaults-v1 documents

ppisar · ppisar · commit cb8d47e560f5 · 2023-04-18T18:19:42.000+02:00
This patch enhances serialization of modulemd-defaults-v1 with respect
to number-like values. Now these fields are quoted when necessary:
module name, profile name, intent name. That means all fileds of
modulemd-defaults-v1 are guarded if necessary.

Default stream name was left always quoted not to disturb previous
serializations. We can turn it into autoquoting when requested.
diff --git a/modulemd/modulemd-defaults-v1.c b/modulemd/modulemd-defaults-v1.c
@@ -1015,10 +1015,9 @@ modulemd_defaults_v1_emit_yaml (ModulemdDefaultsV1 *self,
       return FALSE;
     }
 
-  if (!mmd_emitter_scalar (
+  if (!mmd_emitter_scalar_string (
         emitter,
         modulemd_defaults_get_module_name (MODULEMD_DEFAULTS (self)),
-        YAML_PLAIN_SCALAR_STYLE,
         error))
     {
       return FALSE;
@@ -1092,7 +1091,7 @@ modulemd_defaults_v1_emit_profiles (GHashTable *profile_table,
                                     GError **error)
 {
   g_autoptr (GPtrArray) stream_names = NULL;
-  g_auto (GStrv) streams = NULL;
+  g_auto (GStrv) profiles = NULL;
   gchar *stream_name = NULL;
   GHashTable *profile_set = NULL;
 
@@ -1129,13 +1128,13 @@ modulemd_defaults_v1_emit_profiles (GHashTable *profile_table,
           return FALSE;
         }
 
-      streams = modulemd_ordered_str_keys_as_strv (profile_set);
+      profiles = modulemd_ordered_str_keys_as_strv (profile_set);
       if (!mmd_emitter_strv (
-            emitter, YAML_FLOW_SEQUENCE_STYLE, streams, error))
+            emitter, YAML_FLOW_SEQUENCE_STYLE, profiles, error))
         {
           return FALSE;
         }
-      g_clear_pointer (&streams, g_strfreev);
+      g_clear_pointer (&profiles, g_strfreev);
     }
 
   /* End the mapping for "profiles:" */
@@ -1200,8 +1199,7 @@ modulemd_defaults_v1_emit_intents (ModulemdDefaultsV1 *self,
       intent = g_ptr_array_index (intents, i);
 
       /* Emit the intent name */
-      if (!mmd_emitter_scalar (
-            emitter, intent, YAML_PLAIN_SCALAR_STYLE, error))
+      if (!mmd_emitter_scalar_string (emitter, intent, error))
         {
           return FALSE;
         }
diff --git a/modulemd/modulemd-yaml-util.c b/modulemd/modulemd-yaml-util.c
@@ -369,8 +369,12 @@ mmd_emitter_strv (yaml_emitter_t *emitter,
 
   for (int i = 0; i < numentries; i++)
     {
-      ret = mmd_emitter_scalar (
-        emitter, list[i], YAML_PLAIN_SCALAR_STYLE, &nested_error);
+      ret = mmd_emitter_scalar (emitter,
+                                list[i],
+                                string_is_empty_or_a_number (list[i]) ?
+                                  YAML_DOUBLE_QUOTED_SCALAR_STYLE :
+                                  YAML_PLAIN_SCALAR_STYLE,
+                                &nested_error);
       if (!ret)
         {
           g_propagate_prefixed_error (
diff --git a/modulemd/tests/test-modulemd-defaults-v1.c b/modulemd/tests/test-modulemd-defaults-v1.c
@@ -733,6 +733,82 @@ defaults_test_emit_yaml (void)
 }
 
 
+static void
+defaults_test_quoting (void)
+{
+  MMD_INIT_YAML_EMITTER (emitter);
+  MMD_INIT_YAML_EVENT (event);
+  MMD_INIT_YAML_STRING (&emitter, yaml_string);
+  g_autoptr (GError) error = NULL;
+  g_autoptr (ModulemdDefaultsV1) defaults = NULL;
+
+  /* Module name which does not need quoting. */
+  defaults = modulemd_defaults_v1_new ("unquoted");
+  modulemd_defaults_v1_set_default_stream (defaults, "alwaysquoted", NULL);
+
+  g_assert_true (mmd_emitter_start_stream (&emitter, &error));
+  g_assert_true (modulemd_defaults_v1_emit_yaml (defaults, &emitter, &error));
+  g_assert_true (mmd_emitter_end_stream (&emitter, &error));
+  g_assert_nonnull (yaml_string->str);
+  g_assert_cmpstr (yaml_string->str,
+                   ==,
+                   "---\n"
+                   "document: modulemd-defaults\n"
+                   "version: 1\n"
+                   "data:\n"
+                   "  module: unquoted\n"
+                   "  stream: \"alwaysquoted\"\n"
+                   "...\n");
+
+  g_clear_object (&defaults);
+
+  /* A module name which needs quoting. */
+  defaults = modulemd_defaults_v1_new ("1.0");
+  modulemd_defaults_v1_set_default_stream (defaults, "alwaysquoted", NULL);
+  modulemd_defaults_v1_set_empty_default_profiles_for_stream (
+    defaults, "unquoted", NULL);
+  modulemd_defaults_v1_add_default_profile_for_stream (
+    defaults, "2.0", "unquoted", NULL);
+  modulemd_defaults_v1_add_default_profile_for_stream (
+    defaults, "2.0", "3.0", NULL);
+  modulemd_defaults_v1_set_default_stream (
+    defaults, "alwaysquoted", "unquoted");
+  modulemd_defaults_v1_set_empty_default_profiles_for_stream (
+    defaults, "unquoted", "unquoted");
+  modulemd_defaults_v1_add_default_profile_for_stream (
+    defaults, "2.0", "unquoted", "unquoted");
+  modulemd_defaults_v1_add_default_profile_for_stream (
+    defaults, "2.0", "3.0", "unquoted");
+  modulemd_defaults_v1_set_default_stream (defaults, "alwaysquoted", "4.0");
+
+  MMD_REINIT_YAML_STRING (&emitter, yaml_string);
+  g_assert_true (mmd_emitter_start_stream (&emitter, &error));
+  g_assert_true (modulemd_defaults_v1_emit_yaml (defaults, &emitter, &error));
+  g_assert_true (mmd_emitter_end_stream (&emitter, &error));
+  g_assert_nonnull (yaml_string->str);
+  g_assert_cmpstr (yaml_string->str,
+                   ==,
+                   "---\n"
+                   "document: modulemd-defaults\n"
+                   "version: 1\n"
+                   "data:\n"
+                   "  module: \"1.0\"\n"
+                   "  stream: \"alwaysquoted\"\n"
+                   "  profiles:\n"
+                   "    \"2.0\": [\"3.0\", unquoted]\n"
+                   "    unquoted: []\n"
+                   "  intents:\n"
+                   "    \"4.0\":\n"
+                   "      stream: \"alwaysquoted\"\n"
+                   "    unquoted:\n"
+                   "      stream: \"alwaysquoted\"\n"
+                   "      profiles:\n"
+                   "        \"2.0\": [\"3.0\", unquoted]\n"
+                   "        unquoted: []\n"
+                   "...\n");
+}
+
+
 int
 main (int argc, char *argv[])
 {
@@ -764,5 +840,8 @@ main (int argc, char *argv[])
   g_test_add_func ("/modulemd/v2/defaults/v1/yaml/emit",
                    defaults_test_emit_yaml);
 
+  g_test_add_func ("/modulemd/v2/defaults/v1/yaml/quoting",
+                   defaults_test_quoting);
+
   return g_test_run ();
 }

Original file line number	Diff line number	Diff line change
`@@ -1015,10 +1015,9 @@ modulemd_defaults_v1_emit_yaml (ModulemdDefaultsV1 *self,`
`1015`	`1015`	`return FALSE;`
`1016`	`1016`	`}`
`1017`	`1017`
`1018`		`- if (!mmd_emitter_scalar (`
	`1018`	`+ if (!mmd_emitter_scalar_string (`
`1019`	`1019`	`emitter,`
`1020`	`1020`	`modulemd_defaults_get_module_name (MODULEMD_DEFAULTS (self)),`
`1021`		`- YAML_PLAIN_SCALAR_STYLE,`
`1022`	`1021`	`error))`
`1023`	`1022`	`{`
`1024`	`1023`	`return FALSE;`
`@@ -1092,7 +1091,7 @@ modulemd_defaults_v1_emit_profiles (GHashTable *profile_table,`
`1092`	`1091`	`GError **error)`
`1093`	`1092`	`{`
`1094`	`1093`	`g_autoptr (GPtrArray) stream_names = NULL;`
`1095`		`- g_auto (GStrv) streams = NULL;`
	`1094`	`+ g_auto (GStrv) profiles = NULL;`
`1096`	`1095`	`gchar *stream_name = NULL;`
`1097`	`1096`	`GHashTable *profile_set = NULL;`
`1098`	`1097`
`@@ -1129,13 +1128,13 @@ modulemd_defaults_v1_emit_profiles (GHashTable *profile_table,`
`1129`	`1128`	`return FALSE;`
`1130`	`1129`	`}`
`1131`	`1130`
`1132`		`- streams = modulemd_ordered_str_keys_as_strv (profile_set);`
	`1131`	`+ profiles = modulemd_ordered_str_keys_as_strv (profile_set);`
`1133`	`1132`	`if (!mmd_emitter_strv (`
`1134`		`- emitter, YAML_FLOW_SEQUENCE_STYLE, streams, error))`
	`1133`	`+ emitter, YAML_FLOW_SEQUENCE_STYLE, profiles, error))`
`1135`	`1134`	`{`
`1136`	`1135`	`return FALSE;`
`1137`	`1136`	`}`
`1138`		`- g_clear_pointer (&streams, g_strfreev);`
	`1137`	`+ g_clear_pointer (&profiles, g_strfreev);`
`1139`	`1138`	`}`
`1140`	`1139`
`1141`	`1140`	`/* End the mapping for "profiles:" */`
`@@ -1200,8 +1199,7 @@ modulemd_defaults_v1_emit_intents (ModulemdDefaultsV1 *self,`
`1200`	`1199`	`intent = g_ptr_array_index (intents, i);`
`1201`	`1200`
`1202`	`1201`	`/* Emit the intent name */`
`1203`		`- if (!mmd_emitter_scalar (`
`1204`		`- emitter, intent, YAML_PLAIN_SCALAR_STYLE, error))`
	`1202`	`+ if (!mmd_emitter_scalar_string (emitter, intent, error))`
`1205`	`1203`	`{`
`1206`	`1204`	`return FALSE;`
`1207`	`1205`	`}`
Original file line number	Diff line number	Diff line change
`@@ -369,8 +369,12 @@ mmd_emitter_strv (yaml_emitter_t *emitter,`
`369`	`369`
`370`	`370`	`for (int i = 0; i < numentries; i++)`
`371`	`371`	`{`
`372`		`- ret = mmd_emitter_scalar (`
`373`		`- emitter, list[i], YAML_PLAIN_SCALAR_STYLE, &nested_error);`
	`372`	`+ ret = mmd_emitter_scalar (emitter,`
	`373`	`+ list[i],`
	`374`	`+ string_is_empty_or_a_number (list[i]) ?`
	`375`	`+ YAML_DOUBLE_QUOTED_SCALAR_STYLE :`
	`376`	`+ YAML_PLAIN_SCALAR_STYLE,`
	`377`	`+ &nested_error);`
`374`	`378`	`if (!ret)`
`375`	`379`	`{`
`376`	`380`	`g_propagate_prefixed_error (`