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_get_values"
 205 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 206 {
 207     notmuch_config_values_t *values;
 208     EXPECT0(notmuch_config_set (db, NOTMUCH_CONFIG_NEW_TAGS, "a;b;c"));
 209     for (values = notmuch_config_get_values (db, NOTMUCH_CONFIG_NEW_TAGS);
 210          notmuch_config_values_valid (values);
 211          notmuch_config_values_move_to_next (values))
 212     {
 213           puts (notmuch_config_values_get (values));
 214     }
 215 }
 216 EOF
 217 cat <<'EOF' >EXPECTED
 218 == stdout ==
 219 a
 220 b
 221 c
 222 == stderr ==
 223 EOF
 224 test_expect_equal_file EXPECTED OUTPUT
 225 restore_database
 226
 227 test_begin_subtest "notmuch_config_get_values (restart)"
 228 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 229 {
 230     notmuch_config_values_t *values;
 231     EXPECT0(notmuch_config_set (db, NOTMUCH_CONFIG_NEW_TAGS, "a;b;c"));
 232     for (values = notmuch_config_get_values (db, NOTMUCH_CONFIG_NEW_TAGS);
 233          notmuch_config_values_valid (values);
 234          notmuch_config_values_move_to_next (values))
 235     {
 236           puts (notmuch_config_values_get (values));
 237     }
 238     for (notmuch_config_values_start (values);
 239          notmuch_config_values_valid (values);
 240          notmuch_config_values_move_to_next (values))
 241     {
 242           puts (notmuch_config_values_get (values));
 243     }
 244 }
 245 EOF
 246 cat <<'EOF' >EXPECTED
 247 == stdout ==
 248 a
 249 b
 250 c
 251 a
 252 b
 253 c
 254 == stderr ==
 255 EOF
 256 test_expect_equal_file EXPECTED OUTPUT
 257 restore_database
 258
 259 backup_database
 260 test_begin_subtest "notmuch_config_get_values, trailing ;"
 261 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
 262 {
 263     notmuch_config_values_t *values;
 264     EXPECT0(notmuch_config_set (db, NOTMUCH_CONFIG_NEW_TAGS, "a;b;c"));
 265     for (values = notmuch_config_get_values (db, NOTMUCH_CONFIG_NEW_TAGS);
 266          notmuch_config_values_valid (values);
 267          notmuch_config_values_move_to_next (values))
 268     {
 269           puts (notmuch_config_values_get (values));
 270     }
 271 }
 272 EOF
 273 cat <<'EOF' >EXPECTED
 274 == stdout ==
 275 a
 276 b
 277 c
 278 == stderr ==
 279 EOF
 280 test_expect_equal_file EXPECTED OUTPUT
 281 restore_database
 282
 283 backup_database
 284 test_begin_subtest "get config by key"
 285 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
 286 {
 287    printf("before = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 288    EXPECT0(notmuch_database_set_config (db, "maildir.synchronize_flags", "false"));
 289    printf("after = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 290 }
 291 EOF
 292 cat <<'EOF' >EXPECTED
 293 == stdout ==
 294 before = true
 295 after = false
 296 == stderr ==
 297 EOF
 298 test_expect_equal_file EXPECTED OUTPUT
 299 restore_database
 300
 301 backup_database
 302 test_begin_subtest "set config by key"
 303 notmuch config set test.key1 overridden
 304 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
 305 {
 306    printf("before = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 307    EXPECT0(notmuch_config_set (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS, "false"));
 308    printf("after = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 309 }
 310 EOF
 311 cat <<'EOF' >EXPECTED
 312 == stdout ==
 313 before = true
 314 after = false
 315 == stderr ==
 316 EOF
 317 test_expect_equal_file EXPECTED OUTPUT
 318 restore_database
 319
 320 test_begin_subtest "load default values"
 321 export MAILDIR=${MAIL_DIR}
 322 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} '' %NULL%
 323 {
 324     notmuch_config_key_t key;
 325     for (key = NOTMUCH_CONFIG_FIRST;
 326          key < NOTMUCH_CONFIG_LAST;
 327          key = (notmuch_config_key_t)(key + 1)) {
 328         const char *val = notmuch_config_get (db, key);
 329         printf("%s\n", val ? val : "NULL" );
 330     }
 331 }
 332 EOF
 333 cat <<'EOF' >EXPECTED
 334 == stdout ==
 335 MAIL_DIR
 336
 337 inbox;unread
 338 NULL
 339 true
 340 NULL
 341 NULL
 342 NULL
 343 == stderr ==
 344 EOF
 345 unset MAILDIR
 346 test_expect_equal_file EXPECTED OUTPUT
 347
 348 backup_database
 349 test_begin_subtest "override config from \${NOTMUCH_CONFIG}"
 350 notmuch config set test.key1 overridden
 351 # second argument omitted to make argv[2] == NULL
 352 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 353 {
 354    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 355    printf("test.key1 = %s\n", val);
 356    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 357    printf("test.key2 = %s\n", val);
 358 }
 359 EOF
 360 notmuch config set test.key1
 361 cat <<'EOF' >EXPECTED
 362 == stdout ==
 363 test.key1 = overridden
 364 test.key2 = testvalue2
 365 == stderr ==
 366 EOF
 367 test_expect_equal_file EXPECTED OUTPUT
 368 restore_database
 369
 370 backup_database
 371 test_begin_subtest "override config from \${HOME}/.notmuch-config"
 372 ovconfig=${HOME}/.notmuch-config
 373 cp ${NOTMUCH_CONFIG} ${ovconfig}
 374 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 375 unset NOTMUCH_CONFIG
 376 notmuch --config=${ovconfig} config set test.key1 overridden-home
 377 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
 378 {
 379    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 380    printf("test.key1 = %s\n", val);
 381    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 382    printf("test.key2 = %s\n", val);
 383 }
 384 EOF
 385 rm -f ${ovconfig}
 386 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 387 cat <<'EOF' >EXPECTED
 388 == stdout ==
 389 test.key1 = overridden-home
 390 test.key2 = testvalue2
 391 == stderr ==
 392 EOF
 393 test_expect_equal_file EXPECTED OUTPUT
 394 restore_database
 395
 396 backup_database
 397 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch"
 398 ovconfig=${HOME}/.config/notmuch/default/config
 399 mkdir -p $(dirname ${ovconfig})
 400 cp ${NOTMUCH_CONFIG} ${ovconfig}
 401 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 402 unset NOTMUCH_CONFIG
 403 notmuch --config=${ovconfig} config set test.key1 overridden-xdg
 404 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
 405 {
 406    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 407    printf("test.key1 = %s\n", val);
 408    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 409    printf("test.key2 = %s\n", val);
 410 }
 411 EOF
 412 rm -f ${ovconfig}
 413 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 414 cat <<'EOF' >EXPECTED
 415 == stdout ==
 416 test.key1 = overridden-xdg
 417 test.key2 = testvalue2
 418 == stderr ==
 419 EOF
 420 test_expect_equal_file EXPECTED OUTPUT
 421 restore_database
 422
 423 backup_database
 424 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch with profile"
 425 ovconfig=${HOME}/.config/notmuch/work/config
 426 mkdir -p $(dirname ${ovconfig})
 427 cp ${NOTMUCH_CONFIG} ${ovconfig}
 428 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 429 unset NOTMUCH_CONFIG
 430 notmuch --config=${ovconfig} config set test.key1 overridden-xdg-profile
 431 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
 432 {
 433    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 434    printf("test.key1 = %s\n", val);
 435    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 436    printf("test.key2 = %s\n", val);
 437 }
 438 EOF
 439 rm -f ${ovconfig}
 440 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 441 cat <<'EOF' >EXPECTED
 442 == stdout ==
 443 test.key1 = overridden-xdg-profile
 444 test.key2 = testvalue2
 445 == stderr ==
 446 EOF
 447 test_expect_equal_file EXPECTED OUTPUT
 448 restore_database
 449
 450 backup_database
 451 test_begin_subtest "override config from \${HOME}/.notmuch-config.work (via args)"
 452 ovconfig=${HOME}/.notmuch-config.work
 453 cp ${NOTMUCH_CONFIG} ${ovconfig}
 454 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 455 unset NOTMUCH_CONFIG
 456 notmuch --config=${ovconfig} config set test.key1 overridden-profile
 457 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
 458 {
 459    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 460    printf("test.key1 = %s\n", val);
 461    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 462    printf("test.key2 = %s\n", val);
 463 }
 464 EOF
 465 #rm -f ${ovconfig}
 466 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 467 cat <<'EOF' >EXPECTED
 468 == stdout ==
 469 test.key1 = overridden-profile
 470 test.key2 = testvalue2
 471 == stderr ==
 472 EOF
 473 test_expect_equal_file EXPECTED OUTPUT
 474 restore_database
 475
 476 test_done