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