git.notmuchmail.org Git - notmuch/blob - test/T590-libconfig.sh

   1 #!/usr/bin/env bash
   2 test_description="library config API"
   3
   4 . $(dirname "$0")/test-lib.sh || exit 1
   5
   6 add_email_corpus
   7
   8 cat <<EOF > c_head
   9 #include <string.h>
  10 #include <stdlib.h>
  11 #include <notmuch-test.h>
  12
  13 int main (int argc, char** argv)
  14 {
  15    notmuch_database_t *db;
  16    char *val;
  17    notmuch_status_t stat;
  18    char *msg = NULL;
  19
  20    for (int i = 1; i < argc; i++)
  21       if (strcmp (argv[i], "%NULL%") == 0) argv[i] = NULL;
  22
  23    stat = notmuch_database_open_with_config (argv[1],
  24                                               NOTMUCH_DATABASE_MODE_READ_WRITE,
  25                                               argv[2],
  26                                               argv[3],
  27                                               &db,
  28                                               &msg);
  29    if (stat != NOTMUCH_STATUS_SUCCESS) {
  30      fprintf (stderr, "error opening database: %d %s\n", stat, msg ? msg : "");
  31      exit (1);
  32    }
  33 EOF
  34
  35 cat <<EOF > c_tail
  36    EXPECT0(notmuch_database_destroy(db));
  37 }
  38 EOF
  39
  40 test_begin_subtest "notmuch_database_{set,get}_config"
  41 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
  42 {
  43    EXPECT0(notmuch_database_set_config (db, "test.key1", "testvalue1"));
  44    EXPECT0(notmuch_database_set_config (db, "test.key2", "testvalue2"));
  45    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
  46    printf("test.key1 = %s\n", val);
  47    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
  48    printf("test.key2 = %s\n", val);
  49 }
  50 EOF
  51 cat <<'EOF' >EXPECTED
  52 == stdout ==
  53 test.key1 = testvalue1
  54 test.key2 = testvalue2
  55 == stderr ==
  56 EOF
  57 test_expect_equal_file EXPECTED OUTPUT
  58
  59
  60 test_begin_subtest "notmuch_database_get_config_list: empty list"
  61 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
  62 {
  63    notmuch_config_list_t *list;
  64    EXPECT0(notmuch_database_get_config_list (db, "nonexistent", &list));
  65    printf("valid = %d\n", notmuch_config_list_valid (list));
  66    notmuch_config_list_destroy (list);
  67 }
  68 EOF
  69 cat <<'EOF' >EXPECTED
  70 == stdout ==
  71 valid = 0
  72 == stderr ==
  73 EOF
  74 test_expect_equal_file EXPECTED OUTPUT
  75
  76 test_begin_subtest "notmuch_database_get_config_list: closed db"
  77 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
  78 {
  79    notmuch_config_list_t *list;
  80    EXPECT0(notmuch_database_close (db));
  81    stat = notmuch_database_get_config_list (db, "nonexistent", &list);
  82    printf("%d\n", stat == NOTMUCH_STATUS_XAPIAN_EXCEPTION);
  83 }
  84 EOF
  85 cat <<'EOF' >EXPECTED
  86 == stdout ==
  87 1
  88 == stderr ==
  89 EOF
  90 test_expect_equal_file EXPECTED OUTPUT
  91
  92 test_begin_subtest "notmuch_database_get_config_list: all pairs"
  93 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
  94 {
  95    notmuch_config_list_t *list;
  96    EXPECT0(notmuch_database_set_config (db, "zzzafter", "afterval"));
  97    EXPECT0(notmuch_database_set_config (db, "aaabefore", "beforeval"));
  98    EXPECT0(notmuch_database_get_config_list (db, "", &list));
  99    for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) {
 100       printf("%s %s\n", notmuch_config_list_key (list), notmuch_config_list_value(list));
 101    }
 102    notmuch_config_list_destroy (list);
 103 }
 104 EOF
 105 cat <<'EOF' >EXPECTED
 106 == stdout ==
 107 aaabefore beforeval
 108 test.key1 testvalue1
 109 test.key2 testvalue2
 110 zzzafter afterval
 111 == stderr ==
 112 EOF
 113 test_expect_equal_file EXPECTED OUTPUT
 114
 115 test_begin_subtest "notmuch_database_get_config_list: all pairs (closed db)"
 116 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 117 {
 118    notmuch_config_list_t *list;
 119    EXPECT0(notmuch_database_get_config_list (db, "", &list));
 120    EXPECT0(notmuch_database_close (db));
 121    for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) {
 122       printf("%s %d\n", notmuch_config_list_key (list), NULL == notmuch_config_list_value(list));
 123    }
 124    notmuch_config_list_destroy (list);
 125 }
 126 EOF
 127 cat <<'EOF' >EXPECTED
 128 == stdout ==
 129 aaabefore 1
 130 test.key1 1
 131 test.key2 1
 132 zzzafter 1
 133 == stderr ==
 134 EOF
 135 test_expect_equal_file EXPECTED OUTPUT
 136
 137 test_begin_subtest "notmuch_database_get_config_list: one prefix"
 138 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 139 {
 140    notmuch_config_list_t *list;
 141    EXPECT0(notmuch_database_get_config_list (db, "test.key", &list));
 142    for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) {
 143       printf("%s %s\n", notmuch_config_list_key (list), notmuch_config_list_value(list));
 144    }
 145    notmuch_config_list_destroy (list);
 146 }
 147 EOF
 148 cat <<'EOF' >EXPECTED
 149 == stdout ==
 150 test.key1 testvalue1
 151 test.key2 testvalue2
 152 == stderr ==
 153 EOF
 154 test_expect_equal_file EXPECTED OUTPUT
 155
 156 test_begin_subtest "dump config"
 157 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 158 {
 159     EXPECT0(notmuch_database_set_config (db, "key with spaces", "value, with, spaces!"));
 160 }
 161 EOF
 162 notmuch dump --include=config >OUTPUT
 163 cat <<'EOF' >EXPECTED
 164 #notmuch-dump batch-tag:3 config
 165 #@ aaabefore beforeval
 166 #@ key%20with%20spaces value,%20with,%20spaces%21
 167 #@ test.key1 testvalue1
 168 #@ test.key2 testvalue2
 169 #@ zzzafter afterval
 170 EOF
 171 test_expect_equal_file EXPECTED OUTPUT
 172
 173 test_begin_subtest "restore config"
 174 notmuch dump --include=config >EXPECTED
 175 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 176 {
 177     EXPECT0(notmuch_database_set_config (db, "test.key1", "mutatedvalue"));
 178 }
 179 EOF
 180 notmuch restore --include=config <EXPECTED
 181 notmuch dump --include=config >OUTPUT
 182 test_expect_equal_file EXPECTED OUTPUT
 183
 184 backup_database
 185 test_begin_subtest "override config from file"
 186 notmuch config set test.key1 overridden
 187 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
 188 {
 189    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 190    printf("test.key1 = %s\n", val);
 191    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 192    printf("test.key2 = %s\n", val);
 193 }
 194 EOF
 195 cat <<'EOF' >EXPECTED
 196 == stdout ==
 197 test.key1 = overridden
 198 test.key2 = testvalue2
 199 == stderr ==
 200 EOF
 201 test_expect_equal_file EXPECTED OUTPUT
 202 restore_database
 203
 204 test_begin_subtest "NOTMUCH_CONFIG_HOOK_DIR: traditional"
 205 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 206 {
 207    const char *val = notmuch_config_get (db, NOTMUCH_CONFIG_HOOK_DIR);
 208    printf("database.hook_dir = %s\n", val);
 209 }
 210 EOF
 211 cat <<'EOF' >EXPECTED
 212 == stdout ==
 213 database.hook_dir = MAIL_DIR/.notmuch/hooks
 214 == stderr ==
 215 EOF
 216 test_expect_equal_file EXPECTED OUTPUT
 217
 218 test_begin_subtest "NOTMUCH_CONFIG_HOOK_DIR: xdg"
 219 dir="${HOME}/.config/notmuch/default/hooks"
 220 mkdir -p $dir
 221 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 222 {
 223    const char *val = notmuch_config_get (db, NOTMUCH_CONFIG_HOOK_DIR);
 224    printf("database.hook_dir = %s\n", val);
 225 }
 226 EOF
 227 cat <<'EOF' >EXPECTED
 228 == stdout ==
 229 database.hook_dir = CWD/home/.config/notmuch/default/hooks
 230 == stderr ==
 231 EOF
 232 rmdir $dir
 233 test_expect_equal_file EXPECTED OUTPUT
 234
 235 test_begin_subtest "notmuch_config_get_values"
 236 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 237 {
 238     notmuch_config_values_t *values;
 239     EXPECT0(notmuch_config_set (db, NOTMUCH_CONFIG_NEW_TAGS, "a;b;c"));
 240     for (values = notmuch_config_get_values (db, NOTMUCH_CONFIG_NEW_TAGS);
 241          notmuch_config_values_valid (values);
 242          notmuch_config_values_move_to_next (values))
 243     {
 244           puts (notmuch_config_values_get (values));
 245     }
 246 }
 247 EOF
 248 cat <<'EOF' >EXPECTED
 249 == stdout ==
 250 a
 251 b
 252 c
 253 == stderr ==
 254 EOF
 255 test_expect_equal_file EXPECTED OUTPUT
 256 restore_database
 257
 258 test_begin_subtest "notmuch_config_get_values (restart)"
 259 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 260 {
 261     notmuch_config_values_t *values;
 262     EXPECT0(notmuch_config_set (db, NOTMUCH_CONFIG_NEW_TAGS, "a;b;c"));
 263     for (values = notmuch_config_get_values (db, NOTMUCH_CONFIG_NEW_TAGS);
 264          notmuch_config_values_valid (values);
 265          notmuch_config_values_move_to_next (values))
 266     {
 267           puts (notmuch_config_values_get (values));
 268     }
 269     for (notmuch_config_values_start (values);
 270          notmuch_config_values_valid (values);
 271          notmuch_config_values_move_to_next (values))
 272     {
 273           puts (notmuch_config_values_get (values));
 274     }
 275 }
 276 EOF
 277 cat <<'EOF' >EXPECTED
 278 == stdout ==
 279 a
 280 b
 281 c
 282 a
 283 b
 284 c
 285 == stderr ==
 286 EOF
 287 test_expect_equal_file EXPECTED OUTPUT
 288 restore_database
 289
 290 backup_database
 291 test_begin_subtest "notmuch_config_get_values, trailing ;"
 292 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 293 {
 294     notmuch_config_values_t *values;
 295     EXPECT0(notmuch_config_set (db, NOTMUCH_CONFIG_NEW_TAGS, "a;b;c"));
 296     for (values = notmuch_config_get_values (db, NOTMUCH_CONFIG_NEW_TAGS);
 297          notmuch_config_values_valid (values);
 298          notmuch_config_values_move_to_next (values))
 299     {
 300           puts (notmuch_config_values_get (values));
 301     }
 302 }
 303 EOF
 304 cat <<'EOF' >EXPECTED
 305 == stdout ==
 306 a
 307 b
 308 c
 309 == stderr ==
 310 EOF
 311 test_expect_equal_file EXPECTED OUTPUT
 312 restore_database
 313
 314 backup_database
 315 test_begin_subtest "get config by key"
 316 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
 317 {
 318    printf("before = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 319    EXPECT0(notmuch_database_set_config (db, "maildir.synchronize_flags", "false"));
 320    printf("after = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 321 }
 322 EOF
 323 cat <<'EOF' >EXPECTED
 324 == stdout ==
 325 before = true
 326 after = false
 327 == stderr ==
 328 EOF
 329 test_expect_equal_file EXPECTED OUTPUT
 330 restore_database
 331
 332 backup_database
 333 test_begin_subtest "set config by key"
 334 notmuch config set test.key1 overridden
 335 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
 336 {
 337    printf("before = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 338    EXPECT0(notmuch_config_set (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS, "false"));
 339    printf("after = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 340 }
 341 EOF
 342 cat <<'EOF' >EXPECTED
 343 == stdout ==
 344 before = true
 345 after = false
 346 == stderr ==
 347 EOF
 348 test_expect_equal_file EXPECTED OUTPUT
 349 restore_database
 350
 351 test_begin_subtest "load default values"
 352 export MAILDIR=${MAIL_DIR}
 353 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} '' %NULL%
 354 {
 355     notmuch_config_key_t key;
 356     for (key = NOTMUCH_CONFIG_FIRST;
 357          key < NOTMUCH_CONFIG_LAST;
 358          key = (notmuch_config_key_t)(key + 1)) {
 359         const char *val = notmuch_config_get (db, key);
 360         printf("%s\n", val ? val : "NULL" );
 361     }
 362 }
 363 EOF
 364 cat <<'EOF' >EXPECTED
 365 == stdout ==
 366 MAIL_DIR
 367 MAIL_DIR/.notmuch/hooks
 368
 369 inbox;unread
 370 NULL
 371 true
 372 NULL
 373 NULL
 374 NULL
 375 == stderr ==
 376 EOF
 377 unset MAILDIR
 378 test_expect_equal_file EXPECTED OUTPUT
 379
 380 backup_database
 381 test_begin_subtest "override config from \${NOTMUCH_CONFIG}"
 382 notmuch config set test.key1 overridden
 383 # second argument omitted to make argv[2] == NULL
 384 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 385 {
 386    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 387    printf("test.key1 = %s\n", val);
 388    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 389    printf("test.key2 = %s\n", val);
 390 }
 391 EOF
 392 notmuch config set test.key1
 393 cat <<'EOF' >EXPECTED
 394 == stdout ==
 395 test.key1 = overridden
 396 test.key2 = testvalue2
 397 == stderr ==
 398 EOF
 399 test_expect_equal_file EXPECTED OUTPUT
 400 restore_database
 401
 402 backup_database
 403 test_begin_subtest "override config from \${HOME}/.notmuch-config"
 404 ovconfig=${HOME}/.notmuch-config
 405 cp ${NOTMUCH_CONFIG} ${ovconfig}
 406 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 407 unset NOTMUCH_CONFIG
 408 notmuch --config=${ovconfig} config set test.key1 overridden-home
 409 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
 410 {
 411    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 412    printf("test.key1 = %s\n", val);
 413    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 414    printf("test.key2 = %s\n", val);
 415 }
 416 EOF
 417 rm -f ${ovconfig}
 418 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 419 cat <<'EOF' >EXPECTED
 420 == stdout ==
 421 test.key1 = overridden-home
 422 test.key2 = testvalue2
 423 == stderr ==
 424 EOF
 425 test_expect_equal_file EXPECTED OUTPUT
 426 restore_database
 427
 428 backup_database
 429 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch"
 430 ovconfig=${HOME}/.config/notmuch/default/config
 431 mkdir -p $(dirname ${ovconfig})
 432 cp ${NOTMUCH_CONFIG} ${ovconfig}
 433 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 434 unset NOTMUCH_CONFIG
 435 notmuch --config=${ovconfig} config set test.key1 overridden-xdg
 436 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
 437 {
 438    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 439    printf("test.key1 = %s\n", val);
 440    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 441    printf("test.key2 = %s\n", val);
 442 }
 443 EOF
 444 rm -f ${ovconfig}
 445 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 446 cat <<'EOF' >EXPECTED
 447 == stdout ==
 448 test.key1 = overridden-xdg
 449 test.key2 = testvalue2
 450 == stderr ==
 451 EOF
 452 test_expect_equal_file EXPECTED OUTPUT
 453 restore_database
 454
 455 backup_database
 456 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch with profile"
 457 ovconfig=${HOME}/.config/notmuch/work/config
 458 mkdir -p $(dirname ${ovconfig})
 459 cp ${NOTMUCH_CONFIG} ${ovconfig}
 460 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 461 unset NOTMUCH_CONFIG
 462 notmuch --config=${ovconfig} config set test.key1 overridden-xdg-profile
 463 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
 464 {
 465    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 466    printf("test.key1 = %s\n", val);
 467    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 468    printf("test.key2 = %s\n", val);
 469 }
 470 EOF
 471 rm -f ${ovconfig}
 472 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 473 cat <<'EOF' >EXPECTED
 474 == stdout ==
 475 test.key1 = overridden-xdg-profile
 476 test.key2 = testvalue2
 477 == stderr ==
 478 EOF
 479 test_expect_equal_file EXPECTED OUTPUT
 480 restore_database
 481
 482 backup_database
 483 test_begin_subtest "override config from \${HOME}/.notmuch-config.work (via args)"
 484 ovconfig=${HOME}/.notmuch-config.work
 485 cp ${NOTMUCH_CONFIG} ${ovconfig}
 486 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 487 unset NOTMUCH_CONFIG
 488 notmuch --config=${ovconfig} config set test.key1 overridden-profile
 489 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
 490 {
 491    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 492    printf("test.key1 = %s\n", val);
 493    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 494    printf("test.key2 = %s\n", val);
 495 }
 496 EOF
 497 #rm -f ${ovconfig}
 498 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 499 cat <<'EOF' >EXPECTED
 500 == stdout ==
 501 test.key1 = overridden-profile
 502 test.key2 = testvalue2
 503 == stderr ==
 504 EOF
 505 test_expect_equal_file EXPECTED OUTPUT
 506 restore_database
 507
 508 test_done