tests/test-bootconfig-parser-internals.c - main - githubmirror/ostree

tests/test-bootconfig-parser-internals.c
273 строки10 KB
Joseph Marrero Corchado
bootconfig: Preserve extension BLS keys across staged deployments
02 апр 2026, 03:52
02 апр 2026, 03:524affc1b
/*
 * SPDX-License-Identifier: LGPL-2.0+
 */

#include "config.h"
#define _OSTREE_PUBLIC
#include "../src/libostree/ostree-bootconfig-parser.c"

static void
test_parse_tries_valid (void)
{
  guint64 left, done;
  parse_bootloader_tries ("foo", &left, &done);
  g_assert_cmpuint (left, ==, 0);
  g_assert_cmpuint (done, ==, 0);

  parse_bootloader_tries ("foo+1", &left, &done);
  g_assert_cmpuint (left, ==, 1);
  g_assert_cmpuint (done, ==, 0);

  parse_bootloader_tries ("foo+1-2", &left, &done);
  g_assert_cmpuint (left, ==, 1);
  g_assert_cmpuint (done, ==, 2);

  parse_bootloader_tries ("foo+1-2.conf", &left, &done);
  g_assert_cmpuint (left, ==, 1);
  g_assert_cmpuint (done, ==, 2);
}

static void
test_parse_tries_invalid (void)
{
  guint64 left, done;

  parse_bootloader_tries ("foo+1-", &left, &done);
  g_assert_cmpuint (left, ==, 0);
  g_assert_cmpuint (done, ==, 0);

  parse_bootloader_tries ("foo+-1", &left, &done);
  g_assert_cmpuint (left, ==, 0);
  g_assert_cmpuint (done, ==, 0);

  parse_bootloader_tries ("foo+1-a", &left, &done);
  g_assert_cmpuint (left, ==, 0);
  g_assert_cmpuint (done, ==, 0);

  parse_bootloader_tries ("foo+a-1", &left, &done);
  g_assert_cmpuint (left, ==, 0);
  g_assert_cmpuint (done, ==, 0);
}

static void
test_extra_keys_variant_empty (void)
{
  /* A bootconfig with no x-prefixed keys should return NULL */
  OstreeBootconfigParser *parser = ostree_bootconfig_parser_new ();
  ostree_bootconfig_parser_set (parser, "title", "Fedora Linux 43");
  ostree_bootconfig_parser_set (parser, "version", "1");
  ostree_bootconfig_parser_set (parser, "options", "root=UUID=abc rw quiet");
  ostree_bootconfig_parser_set (parser, "linux", "/vmlinuz-6.8.0");
  ostree_bootconfig_parser_set (parser, "initrd", "/initramfs-6.8.0.img");

  GVariant *extra = _ostree_bootconfig_parser_get_extra_keys_variant (parser);
  g_assert_null (extra);

  g_object_unref (parser);
}

static void
test_extra_keys_variant_with_extension_keys (void)
{
  /* Standard keys should be excluded, only extension keys returned */
  OstreeBootconfigParser *parser = ostree_bootconfig_parser_new ();
  ostree_bootconfig_parser_set (parser, "title", "Fedora Linux 43");
  ostree_bootconfig_parser_set (parser, "options", "root=UUID=abc rw");
  ostree_bootconfig_parser_set (parser, "linux", "/vmlinuz-6.8.0");
  ostree_bootconfig_parser_set (parser, "x-options-source-tuned", "nohz=full isolcpus=1-3");
  ostree_bootconfig_parser_set (parser, "x-options-source-dracut", "rd.driver.pre=vfio-pci");

  GVariant *extra = _ostree_bootconfig_parser_get_extra_keys_variant (parser);
  g_assert_nonnull (extra);

  GVariant *extra_owned = g_variant_ref_sink (extra);

  /* Should be a{ss} with exactly 2 entries */
  g_assert_true (g_variant_is_of_type (extra_owned, G_VARIANT_TYPE ("a{ss}")));
  g_assert_cmpuint (g_variant_n_children (extra_owned), ==, 2);

  /* Verify the contents */
  GVariantIter iter;
  const char *key, *val;
  gboolean found_tuned = FALSE, found_dracut = FALSE;
  g_variant_iter_init (&iter, extra_owned);
  while (g_variant_iter_next (&iter, "{&s&s}", &key, &val))
    {
      if (g_str_equal (key, "x-options-source-tuned"))
        {
          g_assert_cmpstr (val, ==, "nohz=full isolcpus=1-3");
          found_tuned = TRUE;
        }
      else if (g_str_equal (key, "x-options-source-dracut"))
        {
          g_assert_cmpstr (val, ==, "rd.driver.pre=vfio-pci");
          found_dracut = TRUE;
        }
      else
        {
          g_assert_not_reached ();
        }
    }
  g_assert_true (found_tuned);
  g_assert_true (found_dracut);

  g_variant_unref (extra_owned);
  g_object_unref (parser);
}

static void
test_extra_keys_variant_standard_excluded (void)
{
  /* Standard BLS keys (title, version, options, linux, initrd, devicetree)
   * should be excluded. All other keys should be preserved.
   */
  OstreeBootconfigParser *parser = ostree_bootconfig_parser_new ();
  ostree_bootconfig_parser_set (parser, "title", "Test");
  ostree_bootconfig_parser_set (parser, "version", "1.0");
  ostree_bootconfig_parser_set (parser, "options", "root=UUID=abc");
  ostree_bootconfig_parser_set (parser, "linux", "/vmlinuz");
  ostree_bootconfig_parser_set (parser, "initrd", "/initramfs.img");
  ostree_bootconfig_parser_set (parser, "devicetree", "/dtb");

  /* Only standard keys -- should return NULL */
  GVariant *extra = _ostree_bootconfig_parser_get_extra_keys_variant (parser);
  g_assert_null (extra);

  /* Add non-standard keys -- all should be preserved */
  ostree_bootconfig_parser_set (parser, "my-custom-key", "some-value");
  ostree_bootconfig_parser_set (parser, "x-options-source-tuned", "nohz=full");

  extra = _ostree_bootconfig_parser_get_extra_keys_variant (parser);
  g_assert_nonnull (extra);
  GVariant *extra_owned = g_variant_ref_sink (extra);

  g_assert_cmpuint (g_variant_n_children (extra_owned), ==, 2);

  GVariantIter iter;
  const char *key, *val;
  gboolean found_custom = FALSE, found_tuned = FALSE;
  g_variant_iter_init (&iter, extra_owned);
  while (g_variant_iter_next (&iter, "{&s&s}", &key, &val))
    {
      if (g_str_equal (key, "my-custom-key"))
        {
          g_assert_cmpstr (val, ==, "some-value");
          found_custom = TRUE;
        }
      else if (g_str_equal (key, "x-options-source-tuned"))
        {
          g_assert_cmpstr (val, ==, "nohz=full");
          found_tuned = TRUE;
        }
      else
        g_assert_not_reached ();
    }
  g_assert_true (found_custom);
  g_assert_true (found_tuned);

  g_variant_unref (extra_owned);
  g_object_unref (parser);
}

static void
test_extra_keys_roundtrip (void)
{
  /* Test that extra keys can be serialized to a variant and restored */
  OstreeBootconfigParser *original = ostree_bootconfig_parser_new ();
  ostree_bootconfig_parser_set (original, "options", "root=UUID=abc rw");
  ostree_bootconfig_parser_set (original, "linux", "/vmlinuz");
  ostree_bootconfig_parser_set (original, "x-options-source-tuned", "nohz=full isolcpus=1-3");

  /* Serialize */
  GVariant *extra = _ostree_bootconfig_parser_get_extra_keys_variant (original);
  g_assert_nonnull (extra);
  GVariant *extra_owned = g_variant_ref_sink (extra);

  /* Create a new parser (simulating deserialization) with only standard keys */
  OstreeBootconfigParser *restored = ostree_bootconfig_parser_new ();
  ostree_bootconfig_parser_set (restored, "options", "root=UUID=abc rw nohz=full isolcpus=1-3");

  /* Restore extra keys from variant */
  GVariantIter iter;
  const char *key, *value;
  g_variant_iter_init (&iter, extra_owned);
  while (g_variant_iter_next (&iter, "{&s&s}", &key, &value))
    ostree_bootconfig_parser_set (restored, key, value);

  /* Verify the extension key survived the roundtrip */
  g_assert_cmpstr (ostree_bootconfig_parser_get (restored, "x-options-source-tuned"), ==,
                   "nohz=full isolcpus=1-3");
  /* Standard keys should also be present */
  g_assert_cmpstr (ostree_bootconfig_parser_get (restored, "options"), ==,
                   "root=UUID=abc rw nohz=full isolcpus=1-3");

  g_variant_unref (extra_owned);
  g_object_unref (original);
  g_object_unref (restored);
}

static void
test_extra_keys_parse_write_roundtrip (void)
{
  /* Test that x-prefixed keys survive a parse -> write -> parse roundtrip
   * via the BLS file format.
   */
  const char *bls_content = "title Fedora Linux 43\n"
                            "version 6.8.0-300.fc40.x86_64\n"
                            "linux /vmlinuz-6.8.0\n"
                            "initrd /initramfs-6.8.0.img\n"
                            "options root=UUID=abc rw nohz=full\n"
                            "x-options-source-tuned nohz=full\n";

  /* Write the BLS content to a temp file */
  g_autofree char *tmpdir = g_dir_make_tmp ("ostree-test-XXXXXX", NULL);
  g_assert_nonnull (tmpdir);
  g_autofree char *tmpfile = g_build_filename (tmpdir, "ostree-test.conf", NULL);
  g_assert_true (g_file_set_contents (tmpfile, bls_content, -1, NULL));

  /* Parse */
  OstreeBootconfigParser *parser = ostree_bootconfig_parser_new ();
  g_assert_true (ostree_bootconfig_parser_parse_at (parser, AT_FDCWD, tmpfile, NULL, NULL));

  /* The x-prefixed key should have been parsed */
  g_assert_cmpstr (ostree_bootconfig_parser_get (parser, "x-options-source-tuned"), ==,
                   "nohz=full");
  g_assert_cmpstr (ostree_bootconfig_parser_get (parser, "options"), ==,
                   "root=UUID=abc rw nohz=full");

  /* Write it back out */
  g_autofree char *outfile = g_build_filename (tmpdir, "ostree-test-out.conf", NULL);
  g_assert_true (ostree_bootconfig_parser_write_at (parser, AT_FDCWD, outfile, NULL, NULL));

  /* Parse the output and verify the key survived */
  OstreeBootconfigParser *parser2 = ostree_bootconfig_parser_new ();
  g_assert_true (ostree_bootconfig_parser_parse_at (parser2, AT_FDCWD, outfile, NULL, NULL));
  g_assert_cmpstr (ostree_bootconfig_parser_get (parser2, "x-options-source-tuned"), ==,
                   "nohz=full");
  g_assert_cmpstr (ostree_bootconfig_parser_get (parser2, "options"), ==,
                   "root=UUID=abc rw nohz=full");

  g_object_unref (parser);
  g_object_unref (parser2);
  (void)unlink (tmpfile);
  (void)unlink (outfile);
  (void)rmdir (tmpdir);
}

int
main (int argc, char *argv[])
{
  g_test_init (&argc, &argv, NULL);

  g_test_add_func ("/bootconfig-parser/tries/valid", test_parse_tries_valid);
  g_test_add_func ("/bootconfig-parser/tries/invalid", test_parse_tries_invalid);
  g_test_add_func ("/bootconfig-parser/extra-keys/empty", test_extra_keys_variant_empty);
  g_test_add_func ("/bootconfig-parser/extra-keys/with-extension-keys",
                   test_extra_keys_variant_with_extension_keys);
  g_test_add_func ("/bootconfig-parser/extra-keys/standard-excluded",
                   test_extra_keys_variant_standard_excluded);
  g_test_add_func ("/bootconfig-parser/extra-keys/roundtrip", test_extra_keys_roundtrip);
  g_test_add_func ("/bootconfig-parser/extra-keys/parse-write-roundtrip",
                   test_extra_keys_parse_write_roundtrip);
  return g_test_run ();
}