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
379 test_expect_equal_file EXPECTED OUTPUT
382 test_begin_subtest "override config from \${NOTMUCH_CONFIG}"
383 notmuch config set test.key1 overridden
384 # second argument omitted to make argv[2] == NULL
385 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
387 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
388 printf("test.key1 = %s\n", val);
389 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
390 printf("test.key2 = %s\n", val);
393 notmuch config set test.key1
394 cat <<'EOF' >EXPECTED
396 test.key1 = overridden
397 test.key2 = testvalue2
400 test_expect_equal_file EXPECTED OUTPUT
404 test_begin_subtest "override config from \${HOME}/.notmuch-config"
405 ovconfig=${HOME}/.notmuch-config
406 cp ${NOTMUCH_CONFIG} ${ovconfig}
407 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
409 notmuch --config=${ovconfig} config set test.key1 overridden-home
410 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
412 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
413 printf("test.key1 = %s\n", val);
414 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
415 printf("test.key2 = %s\n", val);
419 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
420 cat <<'EOF' >EXPECTED
422 test.key1 = overridden-home
423 test.key2 = testvalue2
426 test_expect_equal_file EXPECTED OUTPUT
430 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch"
431 ovconfig=${HOME}/.config/notmuch/default/config
432 mkdir -p $(dirname ${ovconfig})
433 cp ${NOTMUCH_CONFIG} ${ovconfig}
434 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
436 notmuch --config=${ovconfig} config set test.key1 overridden-xdg
437 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
439 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
440 printf("test.key1 = %s\n", val);
441 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
442 printf("test.key2 = %s\n", val);
446 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
447 cat <<'EOF' >EXPECTED
449 test.key1 = overridden-xdg
450 test.key2 = testvalue2
453 test_expect_equal_file EXPECTED OUTPUT
457 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch with profile"
458 ovconfig=${HOME}/.config/notmuch/work/config
459 mkdir -p $(dirname ${ovconfig})
460 cp ${NOTMUCH_CONFIG} ${ovconfig}
461 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
463 notmuch --config=${ovconfig} config set test.key1 overridden-xdg-profile
464 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
466 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
467 printf("test.key1 = %s\n", val);
468 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
469 printf("test.key2 = %s\n", val);
473 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
474 cat <<'EOF' >EXPECTED
476 test.key1 = overridden-xdg-profile
477 test.key2 = testvalue2
480 test_expect_equal_file EXPECTED OUTPUT
484 test_begin_subtest "override config from \${HOME}/.notmuch-config.work (via args)"
485 ovconfig=${HOME}/.notmuch-config.work
486 cp ${NOTMUCH_CONFIG} ${ovconfig}
487 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
489 notmuch --config=${ovconfig} config set test.key1 overridden-profile
490 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
492 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
493 printf("test.key1 = %s\n", val);
494 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
495 printf("test.key2 = %s\n", val);
499 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
500 cat <<'EOF' >EXPECTED
502 test.key1 = overridden-profile
503 test.key2 = testvalue2
506 test_expect_equal_file EXPECTED OUTPUT
509 test_begin_subtest "no config, fail to open database"
510 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
512 cat c_head - c_tail <<'EOF' | test_C %NULL% '' %NULL%
517 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
518 cat <<'EOF' >EXPECTED
521 error opening database
522 Erroneous NULL pointer
523 Error: Cannot open a database for a NULL path.
526 test_expect_equal_file EXPECTED OUTPUT
528 test_begin_subtest "open database from NOTMUCH_DATABASE"
529 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
531 export NOTMUCH_DATABASE=${MAIL_DIR}
532 cat c_head - c_tail <<'EOF' | test_C %NULL% '' %NULL%
534 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
535 printf("test.key1 = %s\n", val);
536 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
537 printf("test.key2 = %s\n", val);
540 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
541 unset NOTMUCH_DATABASE
542 cat <<'EOF' >EXPECTED
544 test.key1 = testvalue1
545 test.key2 = testvalue2
548 test_expect_equal_file EXPECTED OUTPUT
550 test_begin_subtest "NOTMUCH_DATABASE overrides config"
551 old_path=$(notmuch config get database.path)
552 notmuch config set database.path /nonexistent
553 export NOTMUCH_DATABASE=${MAIL_DIR}
554 cat c_head - c_tail <<'EOF' | test_C %NULL% '' %NULL%
556 EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
557 printf("test.key1 = %s\n", val);
558 EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
559 printf("test.key2 = %s\n", val);
562 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
563 unset NOTMUCH_DATABASE
564 cat <<'EOF' >EXPECTED
566 test.key1 = testvalue1
567 test.key2 = testvalue2
570 notmuch config set database.path "${old_path}"
571 test_expect_equal_file EXPECTED OUTPUT