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: %d %s\n", 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_get_values"
205 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
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))
213 puts (notmuch_config_values_get (values));
217 cat <<'EOF' >EXPECTED
224 test_expect_equal_file EXPECTED OUTPUT
227 test_begin_subtest "notmuch_config_get_values (restart)"
228 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
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))
236 puts (notmuch_config_values_get (values));
238 for (notmuch_config_values_start (values);
239 notmuch_config_values_valid (values);
240 notmuch_config_values_move_to_next (values))
242 puts (notmuch_config_values_get (values));
246 cat <<'EOF' >EXPECTED
256 test_expect_equal_file EXPECTED OUTPUT
260 test_begin_subtest "notmuch_config_get_values, trailing ;"
261 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG} %NULL%
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))
269 puts (notmuch_config_values_get (values));
273 cat <<'EOF' >EXPECTED
280 test_expect_equal_file EXPECTED OUTPUT
284 test_begin_subtest "get config by key"
285 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
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));
292 cat <<'EOF' >EXPECTED
298 test_expect_equal_file EXPECTED OUTPUT
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}
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));
311 cat <<'EOF' >EXPECTED
317 test_expect_equal_file EXPECTED OUTPUT
320 test_begin_subtest "load default values"
321 export MAILDIR=${MAIL_DIR}
322 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} '' %NULL%
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" );
333 cat <<'EOF' >EXPECTED
346 test_expect_equal_file EXPECTED OUTPUT
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}
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);
360 notmuch config set test.key1
361 cat <<'EOF' >EXPECTED
363 test.key1 = overridden
364 test.key2 = testvalue2
367 test_expect_equal_file EXPECTED OUTPUT
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}
376 notmuch --config=${ovconfig} config set test.key1 overridden-home
377 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
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);
386 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
387 cat <<'EOF' >EXPECTED
389 test.key1 = overridden-home
390 test.key2 = testvalue2
393 test_expect_equal_file EXPECTED OUTPUT
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}
403 notmuch --config=${ovconfig} config set test.key1 overridden-xdg
404 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
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);
413 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
414 cat <<'EOF' >EXPECTED
416 test.key1 = overridden-xdg
417 test.key2 = testvalue2
420 test_expect_equal_file EXPECTED OUTPUT
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}
430 notmuch --config=${ovconfig} config set test.key1 overridden-xdg-profile
431 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
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);
440 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
441 cat <<'EOF' >EXPECTED
443 test.key1 = overridden-xdg-profile
444 test.key2 = testvalue2
447 test_expect_equal_file EXPECTED OUTPUT
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}
456 notmuch --config=${ovconfig} config set test.key1 overridden-profile
457 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
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);
466 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
467 cat <<'EOF' >EXPECTED
469 test.key1 = overridden-profile
470 test.key2 = testvalue2
473 test_expect_equal_file EXPECTED OUTPUT