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