src/test/test-conf-parser.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /***
   3   This file is part of systemd.
   4
   5   Copyright 2015 Ronny Chevalier
   6 ***/
   7
   8 #include "conf-parser.h"
   9 #include "fd-util.h"
  10 #include "fileio.h"
  11 //#include "fs-util.h"
  12 #include "log.h"
  13 #include "macro.h"
  14 #include "string-util.h"
  15 #include "strv.h"
  16 #include "util.h"
  17
  18 /// Additional includes needed by elogind
  19 #include "fd-util.h"
  20 #include "fileio.h"
  21
  22 static void test_config_parse_path_one(const char *rvalue, const char *expected) {
  23         _cleanup_free_ char *path = NULL;
  24
  25         assert_se(config_parse_path("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &path, NULL) >= 0);
  26         assert_se(streq_ptr(expected, path));
  27 }
  28
  29 static void test_config_parse_log_level_one(const char *rvalue, int expected) {
  30         int log_level = 0;
  31
  32         assert_se(config_parse_log_level("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &log_level, NULL) >= 0);
  33         assert_se(expected == log_level);
  34 }
  35
  36 #if 0 /// UNNEEDED by elogind
  37 static void test_config_parse_log_facility_one(const char *rvalue, int expected) {
  38         int log_facility = 0;
  39
  40         assert_se(config_parse_log_facility("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &log_facility, NULL) >= 0);
  41         assert_se(expected == log_facility);
  42 }
  43 #endif // 0
  44
  45 static void test_config_parse_iec_size_one(const char *rvalue, size_t expected) {
  46         size_t iec_size = 0;
  47
  48         assert_se(config_parse_iec_size("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &iec_size, NULL) >= 0);
  49         assert_se(expected == iec_size);
  50 }
  51
  52 #if 0 /// UNNEEDED by elogind
  53 static void test_config_parse_si_size_one(const char *rvalue, size_t expected) {
  54         size_t si_size = 0;
  55
  56         assert_se(config_parse_si_size("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &si_size, NULL) >= 0);
  57         assert_se(expected == si_size);
  58 }
  59 #endif // 0
  60
  61 static void test_config_parse_int_one(const char *rvalue, int expected) {
  62         int v = -1;
  63
  64         assert_se(config_parse_int("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &v, NULL) >= 0);
  65         assert_se(expected == v);
  66 }
  67
  68 static void test_config_parse_unsigned_one(const char *rvalue, unsigned expected) {
  69         unsigned v = 0;
  70
  71         assert_se(config_parse_unsigned("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &v, NULL) >= 0);
  72         assert_se(expected == v);
  73 }
  74
  75 static void test_config_parse_strv_one(const char *rvalue, char **expected) {
  76         _cleanup_strv_free_ char **strv = NULL;
  77
  78         assert_se(config_parse_strv("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &strv, NULL) >= 0);
  79         assert_se(strv_equal(expected, strv));
  80 }
  81
  82 static void test_config_parse_mode_one(const char *rvalue, mode_t expected) {
  83         mode_t v = 0;
  84
  85         assert_se(config_parse_mode("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &v, NULL) >= 0);
  86         assert_se(expected == v);
  87 }
  88
  89 static void test_config_parse_sec_one(const char *rvalue, usec_t expected) {
  90         usec_t v = 0;
  91
  92         assert_se(config_parse_sec("unit", "filename", 1, "section", 1, "lvalue", 0, rvalue, &v, NULL) >= 0);
  93         assert_se(expected == v);
  94 }
  95
  96 #if 0 /// UNNEEDED by elogind
  97 static void test_config_parse_nsec_one(const char *rvalue, nsec_t expected) {
  98         nsec_t v = 0;
  99
 100         assert_se(config_parse_nsec("unit", "filename", 1, "nsection", 1, "lvalue", 0, rvalue, &v, NULL) >= 0);
 101         assert_se(expected == v);
 102 }
 103 #endif // 0
 104
 105 static void test_config_parse_path(void) {
 106         test_config_parse_path_one("/path", "/path");
 107         test_config_parse_path_one("/path//////////", "/path");
 108         test_config_parse_path_one("///path/foo///bar////bar//", "/path/foo/bar/bar");
 109         test_config_parse_path_one("/path/\xc3\x80", "/path/\xc3\x80");
 110
 111         test_config_parse_path_one("not_absolute/path", NULL);
 112         test_config_parse_path_one("/path/\xc3\x7f", NULL);
 113 }
 114
 115 static void test_config_parse_log_level(void) {
 116         test_config_parse_log_level_one("debug", LOG_DEBUG);
 117         test_config_parse_log_level_one("info", LOG_INFO);
 118
 119         test_config_parse_log_level_one("garbage", 0);
 120 }
 121
 122 #if 0 /// UNNEEDED by elogind
 123 static void test_config_parse_log_facility(void) {
 124         test_config_parse_log_facility_one("mail", LOG_MAIL);
 125         test_config_parse_log_facility_one("user", LOG_USER);
 126
 127         test_config_parse_log_facility_one("garbage", 0);
 128 }
 129 #endif // 0
 130
 131 static void test_config_parse_iec_size(void) {
 132         test_config_parse_iec_size_one("1024", 1024);
 133         test_config_parse_iec_size_one("2K", 2048);
 134         test_config_parse_iec_size_one("10M", 10 * 1024 * 1024);
 135         test_config_parse_iec_size_one("1G", 1 * 1024 * 1024 * 1024);
 136         test_config_parse_iec_size_one("0G", 0);
 137         test_config_parse_iec_size_one("0", 0);
 138
 139         test_config_parse_iec_size_one("-982", 0);
 140         test_config_parse_iec_size_one("49874444198739873000000G", 0);
 141         test_config_parse_iec_size_one("garbage", 0);
 142 }
 143
 144 #if 0 /// UNNEEDED by elogind
 145 static void test_config_parse_si_size(void) {
 146         test_config_parse_si_size_one("1024", 1024);
 147         test_config_parse_si_size_one("2K", 2000);
 148         test_config_parse_si_size_one("10M", 10 * 1000 * 1000);
 149         test_config_parse_si_size_one("1G", 1 * 1000 * 1000 * 1000);
 150         test_config_parse_si_size_one("0G", 0);
 151         test_config_parse_si_size_one("0", 0);
 152
 153         test_config_parse_si_size_one("-982", 0);
 154         test_config_parse_si_size_one("49874444198739873000000G", 0);
 155         test_config_parse_si_size_one("garbage", 0);
 156 }
 157 #endif // 0
 158
 159 static void test_config_parse_int(void) {
 160         test_config_parse_int_one("1024", 1024);
 161         test_config_parse_int_one("-1024", -1024);
 162         test_config_parse_int_one("0", 0);
 163
 164         test_config_parse_int_one("99999999999999999999999999999999999999999999999999999999", -1);
 165         test_config_parse_int_one("-99999999999999999999999999999999999999999999999999999999", -1);
 166         test_config_parse_int_one("1G", -1);
 167         test_config_parse_int_one("garbage", -1);
 168 }
 169
 170 static void test_config_parse_unsigned(void) {
 171         test_config_parse_unsigned_one("10241024", 10241024);
 172         test_config_parse_unsigned_one("1024", 1024);
 173         test_config_parse_unsigned_one("0", 0);
 174
 175         test_config_parse_unsigned_one("99999999999999999999999999999999999999999999999999999999", 0);
 176         test_config_parse_unsigned_one("1G", 0);
 177         test_config_parse_unsigned_one("garbage", 0);
 178         test_config_parse_unsigned_one("1000garbage", 0);
 179 }
 180
 181 static void test_config_parse_strv(void) {
 182         test_config_parse_strv_one("", STRV_MAKE_EMPTY);
 183         test_config_parse_strv_one("foo", STRV_MAKE("foo"));
 184         test_config_parse_strv_one("foo bar foo", STRV_MAKE("foo", "bar", "foo"));
 185         test_config_parse_strv_one("\"foo bar\" foo", STRV_MAKE("foo bar", "foo"));
 186         test_config_parse_strv_one("\xc3\x80", STRV_MAKE("\xc3\x80"));
 187         test_config_parse_strv_one("\xc3\x7f", STRV_MAKE_EMPTY);
 188 }
 189
 190 static void test_config_parse_mode(void) {
 191         test_config_parse_mode_one("777", 0777);
 192         test_config_parse_mode_one("644", 0644);
 193
 194         test_config_parse_mode_one("-777", 0);
 195         test_config_parse_mode_one("999", 0);
 196         test_config_parse_mode_one("garbage", 0);
 197         test_config_parse_mode_one("777garbage", 0);
 198         test_config_parse_mode_one("777 garbage", 0);
 199 }
 200
 201 static void test_config_parse_sec(void) {
 202         test_config_parse_sec_one("1", 1 * USEC_PER_SEC);
 203         test_config_parse_sec_one("1s", 1 * USEC_PER_SEC);
 204         test_config_parse_sec_one("100ms", 100 * USEC_PER_MSEC);
 205         test_config_parse_sec_one("5min 20s", 5 * 60 * USEC_PER_SEC + 20 * USEC_PER_SEC);
 206
 207         test_config_parse_sec_one("-1", 0);
 208         test_config_parse_sec_one("10foo", 0);
 209         test_config_parse_sec_one("garbage", 0);
 210 }
 211
 212 #if 0 /// UNNEEDED by elogind
 213 static void test_config_parse_nsec(void) {
 214         test_config_parse_nsec_one("1", 1);
 215         test_config_parse_nsec_one("1s", 1 * NSEC_PER_SEC);
 216         test_config_parse_nsec_one("100ms", 100 * NSEC_PER_MSEC);
 217         test_config_parse_nsec_one("5min 20s", 5 * 60 * NSEC_PER_SEC + 20 * NSEC_PER_SEC);
 218
 219         test_config_parse_nsec_one("-1", 0);
 220         test_config_parse_nsec_one("10foo", 0);
 221         test_config_parse_nsec_one("garbage", 0);
 222 }
 223
 224 static void test_config_parse_iec_uint64(void) {
 225         uint64_t offset = 0;
 226         assert_se(config_parse_iec_uint64(NULL, "/this/file", 11, "Section", 22, "Size", 0, "4M", &offset, NULL) == 0);
 227         assert_se(offset == 4 * 1024 * 1024);
 228
 229         assert_se(config_parse_iec_uint64(NULL, "/this/file", 11, "Section", 22, "Size", 0, "4.5M", &offset, NULL) == 0);
 230 }
 231
 232 static void test_config_parse_join_controllers(void) {
 233         int r;
 234         _cleanup_(strv_free_freep) char ***c = NULL;
 235         char ***c2;
 236
 237         /* Test normal operation */
 238         r = config_parse_join_controllers(NULL, "example.conf", 11, "Section", 10, "JoinControllers", 0, "cpu,cpuacct net_cls,netprio", &c, NULL);
 239         assert_se(r == 0);
 240         assert_se(c);
 241         assert_se(strv_length(c[0]) == 2);
 242         assert_se(strv_equal(c[0], STRV_MAKE("cpu", "cpuacct")));
 243         assert_se(strv_length(c[1]) == 2);
 244         assert_se(strv_equal(c[1], STRV_MAKE("net_cls", "netprio")));
 245         assert_se(c[2] == NULL);
 246
 247         /* Test special case of no mounted controllers */
 248         r = config_parse_join_controllers(NULL, "example.conf", 12, "Section", 10, "JoinControllers", 0, "", &c, NULL);
 249         assert_se(r == 0);
 250         assert_se(c);
 251         assert_se(strv_equal(c[0], STRV_MAKE_EMPTY));
 252         assert_se(c[1] == NULL);
 253
 254         /* Test merging of overlapping lists */
 255         r = config_parse_join_controllers(NULL, "example.conf", 13, "Section", 10, "JoinControllers", 0, "a,b b,c", &c, NULL);
 256         assert_se(r == 0);
 257         assert_se(c);
 258         assert_se(strv_length(c[0]) == 3);
 259         assert_se(strv_contains(c[0], "a"));
 260         assert_se(strv_contains(c[0], "b"));
 261         assert_se(strv_contains(c[0], "c"));
 262         assert_se(c[1] == NULL);
 263
 264         /* Test ignoring of bad lines */
 265         c2 = c;
 266         r = config_parse_join_controllers(NULL, "example.conf", 14, "Section", 10, "JoinControllers", 0, "a,\"b ", &c, NULL);
 267         assert_se(r < 0);
 268         assert_se(c == c2);
 269 }
 270 #endif // 0
 271
 272 #define x10(x) x x x x x x x x x x
 273 #define x100(x) x10(x10(x))
 274 #define x1000(x) x10(x100(x))
 275
 276 static const char* const config_file[] = {
 277         "[Section]\n"
 278         "setting1=1\n",
 279
 280         "[Section]\n"
 281         "setting1=1",        /* no terminating newline */
 282
 283         "\n\n\n\n[Section]\n\n\n"
 284         "setting1=1",        /* some whitespace, no terminating newline */
 285
 286         "[Section]\n"
 287         "[Section]\n"
 288         "setting1=1\n"
 289         "setting1=2\n"
 290         "setting1=1\n",      /* repeated settings */
 291
 292         "[Section]\n"
 293         "setting1=1\\\n"     /* normal continuation */
 294         "2\\\n"
 295         "3\n",
 296
 297         "[Section]\n"
 298         "setting1=1\\\n"     /* continuation with extra trailing backslash at the end */
 299         "2\\\n"
 300         "3\\\n",
 301
 302         "[Section]\n"
 303         "setting1=1\\\\\\\n" /* continuation with trailing escape symbols */
 304         "\\\\2\n",           /* note that C requires one level of escaping, so the
 305                               * parser gets "…1 BS BS BS NL BS BS 2 NL", which
 306                               * it translates into "…1 BS BS SP BS BS 2" */
 307
 308         "\n[Section]\n\n"
 309         "setting1="          /* a line above LINE_MAX length */
 310         x1000("ABCD")
 311         "\n",
 312
 313         "[Section]\n"
 314         "setting1="          /* a line above LINE_MAX length, with continuation */
 315         x1000("ABCD") "\\\n"
 316         "foobar",
 317
 318         "[Section]\n"
 319         "setting1="          /* a line above LINE_MAX length, with continuation */
 320         x1000("ABCD") "\\\n" /* and an extra trailing backslash */
 321         "foobar\\\n",
 322
 323         "[Section]\n"
 324         "setting1="          /* a line above the allowed limit: 9 + 1050000 + 1 */
 325         x1000(x1000("x") x10("abcde")) "\n",
 326
 327         "[Section]\n"
 328         "setting1="          /* many continuation lines, together above the limit */
 329         x1000(x1000("x") x10("abcde") "\\\n") "xxx",
 330 };
 331
 332 static void test_config_parse(unsigned i, const char *s) {
 333         _cleanup_(unlink_tempfilep) char name[] = "/tmp/test-conf-parser.XXXXXX";
 334         int fd, r;
 335         _cleanup_fclose_ FILE *f = NULL;
 336         _cleanup_free_ char *setting1 = NULL;
 337
 338         const ConfigTableItem items[] = {
 339                 { "Section", "setting1",  config_parse_string,   0, &setting1},
 340                 {}
 341         };
 342
 343         log_info("== %s[%i] ==", __func__, i);
 344
 345         fd = mkostemp_safe(name);
 346         assert_se(fd >= 0);
 347         assert_se((size_t) write(fd, s, strlen(s)) == strlen(s));
 348
 349         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 350         assert_se(f = fdopen(fd, "r"));
 351
 352         /*
 353         int config_parse(const char *unit,
 354                          const char *filename,
 355                          FILE *f,
 356                          const char *sections,
 357                          ConfigItemLookup lookup,
 358                          const void *table,
 359                          bool relaxed,
 360                          bool allow_include,
 361                          bool warn,
 362                          void *userdata)
 363         */
 364
 365         r = config_parse(NULL, name, f,
 366                          "Section\0",
 367                          config_item_table_lookup, items,
 368                          CONFIG_PARSE_WARN, NULL);
 369
 370         switch (i) {
 371         case 0 ... 3:
 372                 assert_se(r == 0);
 373                 assert_se(streq(setting1, "1"));
 374                 break;
 375
 376         case 4 ... 5:
 377                 assert_se(r == 0);
 378                 assert_se(streq(setting1, "1 2 3"));
 379                 break;
 380
 381         case 6:
 382                 assert_se(r == 0);
 383                 assert_se(streq(setting1, "1\\\\ \\\\2"));
 384                 break;
 385
 386         case 7:
 387                 assert_se(r == 0);
 388                 assert_se(streq(setting1, x1000("ABCD")));
 389                 break;
 390
 391         case 8 ... 9:
 392                 assert_se(r == 0);
 393                 assert_se(streq(setting1, x1000("ABCD") " foobar"));
 394                 break;
 395
 396         case 10 ... 11:
 397                 assert_se(r == -ENOBUFS);
 398                 assert_se(setting1 == NULL);
 399                 break;
 400         }
 401 }
 402
 403 int main(int argc, char **argv) {
 404         unsigned i;
 405
 406         log_parse_environment();
 407         log_open();
 408
 409         test_config_parse_path();
 410         test_config_parse_log_level();
 411 #if 0 /// UNNEEDED by elogind
 412         test_config_parse_log_facility();
 413 #endif // 0
 414         test_config_parse_iec_size();
 415 #if 0 /// UNNEEDED by elogind
 416         test_config_parse_si_size();
 417 #endif // 0
 418         test_config_parse_int();
 419         test_config_parse_unsigned();
 420         test_config_parse_strv();
 421         test_config_parse_mode();
 422         test_config_parse_sec();
 423 #if 0 /// UNNEEDED by elogind
 424         test_config_parse_nsec();
 425         test_config_parse_iec_uint64();
 426         test_config_parse_join_controllers();
 427 #endif // 0
 428
 429         for (i = 0; i < ELEMENTSOF(config_file); i++)
 430                 test_config_parse(i, config_file[i]);
 431
 432         return 0;
 433 }