2 test_description="library config API"
4 . $(dirname "$0")/test-lib.sh || exit 1
11 #include <notmuch-test.h>
13 int main (int argc, char** argv)
15 notmuch_database_t *db;
17 notmuch_status_t stat;
20 for (int i = 1; i < argc; i++)
21 if (strcmp (argv[i], "%NULL%") == 0) argv[i] = NULL;
23 stat = notmuch_database_open_with_config (argv[1],
24 NOTMUCH_DATABASE_MODE_READ_WRITE,
29 if (stat != NOTMUCH_STATUS_SUCCESS) {
30 fprintf (stderr, "error opening database\n%s\n%s\n", notmuch_status_to_string (stat), msg ? msg : "");
36 EXPECT0(notmuch_database_destroy(db));
40 test_begin_subtest "notmuch_database_{set,get}_config"
41 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
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);
53 test.key1 = testvalue1
54 test.key2 = testvalue2
57 test_expect_equal_file EXPECTED OUTPUT
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%
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);
74 test_expect_equal_file EXPECTED OUTPUT
76 test_begin_subtest "notmuch_database_get_config_list: closed db"
77 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
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);
90 test_expect_equal_file EXPECTED OUTPUT
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%
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));
102 notmuch_config_list_destroy (list);
105 cat <<'EOF' >EXPECTED
113 test_expect_equal_file EXPECTED OUTPUT
115 test_begin_subtest "notmuch_database_get_config_list: all pairs (closed db)"
116 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
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));
124 notmuch_config_list_destroy (list);
127 cat <<'EOF' >EXPECTED
135 test_expect_equal_file EXPECTED OUTPUT
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%
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));
145 notmuch_config_list_destroy (list);
148 cat <<'EOF' >EXPECTED
154 test_expect_equal_file EXPECTED OUTPUT
156 test_begin_subtest "dump config"
157 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
159 EXPECT0(notmuch_database_set_config (db, "key with spaces", "value, with, spaces!"));
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
171 test_expect_equal_file EXPECTED OUTPUT
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%
177 EXPECT0(notmuch_database_set_config (db, "test.key1", "mutatedvalue"));
180 notmuch restore --include=config <EXPECTED
181 notmuch dump --include=config >OUTPUT
182 test_expect_equal_file EXPECTED OUTPUT
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}
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);
195 cat <<'EOF' >EXPECTED
197 test.key1 = overridden
198 test.key2 = testvalue2
201 test_expect_equal_file EXPECTED OUTPUT
204 test_begin_subtest "NOTMUCH_CONFIG_HOOK_DIR: traditional"
205 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
207 const char *val = notmuch_config_get (db, NOTMUCH_CONFIG_HOOK_DIR);
208 printf("database.hook_dir = %s\n", val);
211 cat <<'EOF' >EXPECTED
213 database.hook_dir = MAIL_DIR/.notmuch/hooks
216 test_expect_equal_file EXPECTED OUTPUT
218 test_begin_subtest "NOTMUCH_CONFIG_HOOK_DIR: xdg"
219 dir="${HOME}/.config/notmuch/default/hooks"
221 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
223 const char *val = notmuch_config_get (db, NOTMUCH_CONFIG_HOOK_DIR);
224 printf("database.hook_dir = %s\n", val);
227 cat <<'EOF' >EXPECTED
229 database.hook_dir = CWD/home/.config/notmuch/default/hooks
233 test_expect_equal_file EXPECTED OUTPUT
235 test_begin_subtest "notmuch_config_get_values"
236 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
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))
244 puts (notmuch_config_values_get (values));
248 cat <<'EOF' >EXPECTED
255 test_expect_equal_file EXPECTED OUTPUT
258 test_begin_subtest "notmuch_config_get_values (restart)"
259 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
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))
267 puts (notmuch_config_values_get (values));
269 for (notmuch_config_values_start (values);
270 notmuch_config_values_valid (values);
271 notmuch_config_values_move_to_next (values))
273 puts (notmuch_config_values_get (values));
277 cat <<'EOF' >EXPECTED
287 test_expect_equal_file EXPECTED OUTPUT
291 test_begin_subtest "notmuch_config_get_values, trailing ;"
292 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
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))
300 puts (notmuch_config_values_get (values));
304 cat <<'EOF' >EXPECTED
311 test_expect_equal_file EXPECTED OUTPUT
315 test_begin_subtest "get config by key"
316 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
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));
323 cat <<'EOF' >EXPECTED
329 test_expect_equal_file EXPECTED OUTPUT
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}
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));
342 cat <<'EOF' >EXPECTED
348 test_expect_equal_file EXPECTED OUTPUT
351 test_begin_subtest "load default values"
352 export MAILDIR=${MAIL_DIR}
353 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} '' %NULL%
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" );
364 cat <<'EOF' >EXPECTED
368 MAIL_DIR/.notmuch/hooks
369 MAIL_DIR/.notmuch/backups
380 test_expect_equal_file EXPECTED OUTPUT
383 test_begin_subtest "override config from \${NOTMUCH_CONFIG}"
384 notmuch config set test.key1 overridden
385 # second argument omitted to make argv[2] == NULL
386 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
388 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
389 printf("test.key1 = %s\n", val);
390 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
391 printf("test.key2 = %s\n", val);
394 notmuch config set test.key1
395 cat <<'EOF' >EXPECTED
397 test.key1 = overridden
398 test.key2 = testvalue2
401 test_expect_equal_file EXPECTED OUTPUT
405 test_begin_subtest "override config from \${HOME}/.notmuch-config"
406 ovconfig=${HOME}/.notmuch-config
407 cp ${NOTMUCH_CONFIG} ${ovconfig}
408 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
410 notmuch --config=${ovconfig} config set test.key1 overridden-home
411 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
413 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
414 printf("test.key1 = %s\n", val);
415 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
416 printf("test.key2 = %s\n", val);
420 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
421 cat <<'EOF' >EXPECTED
423 test.key1 = overridden-home
424 test.key2 = testvalue2
427 test_expect_equal_file EXPECTED OUTPUT
431 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch"
432 ovconfig=${HOME}/.config/notmuch/default/config
433 mkdir -p $(dirname ${ovconfig})
434 cp ${NOTMUCH_CONFIG} ${ovconfig}
435 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
437 notmuch --config=${ovconfig} config set test.key1 overridden-xdg
438 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
440 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
441 printf("test.key1 = %s\n", val);
442 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
443 printf("test.key2 = %s\n", val);
447 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
448 cat <<'EOF' >EXPECTED
450 test.key1 = overridden-xdg
451 test.key2 = testvalue2
454 test_expect_equal_file EXPECTED OUTPUT
458 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch with profile"
459 ovconfig=${HOME}/.config/notmuch/work/config
460 mkdir -p $(dirname ${ovconfig})
461 cp ${NOTMUCH_CONFIG} ${ovconfig}
462 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
464 notmuch --config=${ovconfig} config set test.key1 overridden-xdg-profile
465 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
467 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
468 printf("test.key1 = %s\n", val);
469 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
470 printf("test.key2 = %s\n", val);
474 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
475 cat <<'EOF' >EXPECTED
477 test.key1 = overridden-xdg-profile
478 test.key2 = testvalue2
481 test_expect_equal_file EXPECTED OUTPUT
485 test_begin_subtest "override config from \${HOME}/.notmuch-config.work (via args)"
486 ovconfig=${HOME}/.notmuch-config.work
487 cp ${NOTMUCH_CONFIG} ${ovconfig}
488 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
490 notmuch --config=${ovconfig} config set test.key1 overridden-profile
491 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
493 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
494 printf("test.key1 = %s\n", val);
495 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
496 printf("test.key2 = %s\n", val);
500 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
501 cat <<'EOF' >EXPECTED
503 test.key1 = overridden-profile
504 test.key2 = testvalue2
507 test_expect_equal_file EXPECTED OUTPUT
510 test_begin_subtest "no config, fail to open database"
511 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
513 cat c_head - c_tail <<'EOF' | test_C %NULL% '' %NULL%
518 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
519 cat <<'EOF' >EXPECTED
522 error opening database
523 Something went wrong trying to read or write a file
524 Error: Cannot open database at CWD/home/.local/share/notmuch/default: No such file or directory.
527 test_expect_equal_file EXPECTED OUTPUT
529 test_begin_subtest "open database from NOTMUCH_DATABASE"
530 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
532 export NOTMUCH_DATABASE=${MAIL_DIR}
533 cat c_head - c_tail <<'EOF' | test_C %NULL% '' %NULL%
535 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
536 printf("test.key1 = %s\n", val);
537 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
538 printf("test.key2 = %s\n", val);
541 export NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
542 unset NOTMUCH_DATABASE
543 cat <<'EOF' >EXPECTED
545 test.key1 = testvalue1
546 test.key2 = testvalue2
549 test_expect_equal_file EXPECTED OUTPUT
551 test_begin_subtest "NOTMUCH_DATABASE overrides config"
552 cp notmuch-config notmuch-config.bak
553 notmuch config set database.path /nonexistent
554 export NOTMUCH_DATABASE=${MAIL_DIR}
555 cat c_head - c_tail <<'EOF' | test_C %NULL% '' %NULL%
557 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
558 printf("test.key1 = %s\n", val);
559 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
560 printf("test.key2 = %s\n", val);
563 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
564 unset NOTMUCH_DATABASE
565 cat <<'EOF' >EXPECTED
567 test.key1 = testvalue1
568 test.key2 = testvalue2
571 cp notmuch-config.bak notmuch-config
572 test_expect_equal_file EXPECTED OUTPUT
577 #include <notmuch-test.h>
579 int main (int argc, char** argv)
581 notmuch_database_t *db;
583 notmuch_status_t stat;
586 for (int i = 1; i < argc; i++)
587 if (strcmp (argv[i], "%NULL%") == 0) argv[i] = NULL;
589 stat = notmuch_database_load_config (argv[1],
594 if (stat != NOTMUCH_STATUS_SUCCESS && stat != NOTMUCH_STATUS_NO_CONFIG) {
595 fprintf (stderr, "error opening database\n%d: %s\n%s\n", stat,
596 notmuch_status_to_string (stat), msg ? msg : "");
602 test_begin_subtest "notmuch_database_get_config (ndlc)"
603 echo NOTMUCH_CONFIG=$NOTMUCH_CONFIG
604 echo NOTMUCH_PROFILE=$NOTMUCH_PROFILE
606 cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
608 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
609 printf("test.key1 = %s\n", val);
610 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
611 printf("test.key2 = %s\n", val);
614 cat <<'EOF' >EXPECTED
616 test.key1 = testvalue1
617 test.key2 = testvalue2
620 test_expect_equal_file EXPECTED OUTPUT
623 test_begin_subtest "notmuch_database_get_config_list: all pairs (ndlc)"
624 cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
626 notmuch_config_list_t *list;
627 EXPECT0(notmuch_database_get_config_list (db, "", &list));
628 for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) {
629 printf("%s %s\n", notmuch_config_list_key (list), notmuch_config_list_value(list));
631 notmuch_config_list_destroy (list);
634 cat <<'EOF' >EXPECTED
637 key with spaces value, with, spaces!
643 test_expect_equal_file EXPECTED OUTPUT
645 test_begin_subtest "notmuch_database_get_config_list: one prefix (ndlc)"
646 cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
648 notmuch_config_list_t *list;
649 EXPECT0(notmuch_database_get_config_list (db, "test.key", &list));
650 for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) {
651 printf("%s %s\n", notmuch_config_list_key (list), notmuch_config_list_value(list));
653 notmuch_config_list_destroy (list);
656 cat <<'EOF' >EXPECTED
662 test_expect_equal_file EXPECTED OUTPUT
664 test_begin_subtest "list by keys (ndlc)"
665 notmuch config set search.exclude_tags "foo;bar;fub"
666 notmuch config set new.ignore "sekrit_junk"
667 cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
669 notmuch_config_key_t key;
670 for (key = NOTMUCH_CONFIG_FIRST;
671 key < NOTMUCH_CONFIG_LAST;
672 key = (notmuch_config_key_t)(key + 1)) {
673 const char *val = notmuch_config_get (db, key);
674 printf("%s\n", val ? val : "NULL" );
678 cat <<'EOF' >EXPECTED
682 MAIL_DIR/.notmuch/hooks
683 MAIL_DIR/.notmuch/backups
688 test_suite@notmuchmail.org
689 test_suite_other@notmuchmail.org;test_suite@otherdomain.org
693 test_expect_equal_file EXPECTED OUTPUT
695 test_begin_subtest "load default values (ndlc, nonexistent config)"
696 cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} /nonexistent %NULL%
698 notmuch_config_key_t key;
699 for (key = NOTMUCH_CONFIG_FIRST;
700 key < NOTMUCH_CONFIG_LAST;
701 key = (notmuch_config_key_t)(key + 1)) {
702 const char *val = notmuch_config_get (db, key);
703 printf("%s\n", val ? val : "NULL" );
707 cat <<'EOF' >EXPECTED
711 MAIL_DIR/.notmuch/hooks
712 MAIL_DIR/.notmuch/backups
722 test_expect_equal_file EXPECTED OUTPUT
725 test_begin_subtest "override config from \${HOME}/.notmuch-config (ndlc)"
726 ovconfig=${HOME}/.notmuch-config
727 cp ${NOTMUCH_CONFIG} ${ovconfig}
728 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
730 notmuch --config=${ovconfig} config set test.key1 overridden-home
731 cat c_head2 - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
733 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
734 printf("test.key1 = %s\n", val);
735 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
736 printf("test.key2 = %s\n", val);
740 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
741 cat <<'EOF' >EXPECTED
743 test.key1 = overridden-home
744 test.key2 = testvalue2
747 test_expect_equal_file EXPECTED OUTPUT