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 backup_database
 205 test_begin_subtest "get config by key"
 206 notmuch config set test.key1 overridden
 207 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
 208 {
 209    printf("before = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 210    EXPECT0(notmuch_database_set_config (db, "maildir.synchronize_flags", "false"));
 211    printf("after = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 212 }
 213 EOF
 214 cat <<'EOF' >EXPECTED
 215 == stdout ==
 216 before = true
 217 after = false
 218 == stderr ==
 219 EOF
 220 test_expect_equal_file EXPECTED OUTPUT
 221 restore_database
 222
 223 backup_database
 224 test_begin_subtest "set config by key"
 225 notmuch config set test.key1 overridden
 226 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} ${NOTMUCH_CONFIG}
 227 {
 228    printf("before = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 229    EXPECT0(notmuch_config_set (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS, "false"));
 230    printf("after = %s\n", notmuch_config_get (db, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS));
 231 }
 232 EOF
 233 cat <<'EOF' >EXPECTED
 234 == stdout ==
 235 before = true
 236 after = false
 237 == stderr ==
 238 EOF
 239 test_expect_equal_file EXPECTED OUTPUT
 240 restore_database
 241
 242 test_begin_subtest "load default values"
 243 export MAILDIR=${MAIL_DIR}
 244 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} '' %NULL%
 245 {
 246     notmuch_config_key_t key;
 247     for (key = NOTMUCH_CONFIG_FIRST;
 248          key < NOTMUCH_CONFIG_LAST;
 249          key = (notmuch_config_key_t)(key + 1)) {
 250         const char *val = notmuch_config_get (db, key);
 251         printf("%s\n", val ? val : "NULL" );
 252     }
 253 }
 254 EOF
 255 cat <<'EOF' >EXPECTED
 256 == stdout ==
 257 MAIL_DIR
 258
 259 inbox;unread
 260 true
 261 NULL
 262 NULL
 263 NULL
 264 == stderr ==
 265 EOF
 266 unset MAILDIR
 267 test_expect_equal_file EXPECTED OUTPUT
 268
 269 backup_database
 270 test_begin_subtest "override config from \${NOTMUCH_CONFIG}"
 271 notmuch config set test.key1 overridden
 272 # second argument omitted to make argv[2] == NULL
 273 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 274 {
 275    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 276    printf("test.key1 = %s\n", val);
 277    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 278    printf("test.key2 = %s\n", val);
 279 }
 280 EOF
 281 notmuch config set test.key1
 282 cat <<'EOF' >EXPECTED
 283 == stdout ==
 284 test.key1 = overridden
 285 test.key2 = testvalue2
 286 == stderr ==
 287 EOF
 288 test_expect_equal_file EXPECTED OUTPUT
 289 restore_database
 290
 291 backup_database
 292 test_begin_subtest "override config from \${HOME}/.notmuch-config"
 293 ovconfig=${HOME}/.notmuch-config
 294 cp ${NOTMUCH_CONFIG} ${ovconfig}
 295 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 296 unset NOTMUCH_CONFIG
 297 notmuch --config=${ovconfig} config set test.key1 overridden-home
 298 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
 299 {
 300    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 301    printf("test.key1 = %s\n", val);
 302    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 303    printf("test.key2 = %s\n", val);
 304 }
 305 EOF
 306 rm -f ${ovconfig}
 307 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 308 cat <<'EOF' >EXPECTED
 309 == stdout ==
 310 test.key1 = overridden-home
 311 test.key2 = testvalue2
 312 == stderr ==
 313 EOF
 314 test_expect_equal_file EXPECTED OUTPUT
 315 restore_database
 316
 317 backup_database
 318 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch"
 319 ovconfig=${HOME}/.config/notmuch/default/config
 320 mkdir -p $(dirname ${ovconfig})
 321 cp ${NOTMUCH_CONFIG} ${ovconfig}
 322 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 323 unset NOTMUCH_CONFIG
 324 notmuch --config=${ovconfig} config set test.key1 overridden-xdg
 325 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% %NULL%
 326 {
 327    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 328    printf("test.key1 = %s\n", val);
 329    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 330    printf("test.key2 = %s\n", val);
 331 }
 332 EOF
 333 rm -f ${ovconfig}
 334 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 335 cat <<'EOF' >EXPECTED
 336 == stdout ==
 337 test.key1 = overridden-xdg
 338 test.key2 = testvalue2
 339 == stderr ==
 340 EOF
 341 test_expect_equal_file EXPECTED OUTPUT
 342 restore_database
 343
 344 backup_database
 345 test_begin_subtest "override config from \${XDG_CONFIG_HOME}/notmuch with profile"
 346 ovconfig=${HOME}/.config/notmuch/work/config
 347 mkdir -p $(dirname ${ovconfig})
 348 cp ${NOTMUCH_CONFIG} ${ovconfig}
 349 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 350 unset NOTMUCH_CONFIG
 351 notmuch --config=${ovconfig} config set test.key1 overridden-xdg-profile
 352 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
 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 rm -f ${ovconfig}
 361 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 362 cat <<'EOF' >EXPECTED
 363 == stdout ==
 364 test.key1 = overridden-xdg-profile
 365 test.key2 = testvalue2
 366 == stderr ==
 367 EOF
 368 test_expect_equal_file EXPECTED OUTPUT
 369 restore_database
 370
 371 backup_database
 372 test_begin_subtest "override config from \${HOME}/.notmuch-config.work (via args)"
 373 ovconfig=${HOME}/.notmuch-config.work
 374 cp ${NOTMUCH_CONFIG} ${ovconfig}
 375 old_NOTMUCH_CONFIG=${NOTMUCH_CONFIG}
 376 unset NOTMUCH_CONFIG
 377 notmuch --config=${ovconfig} config set test.key1 overridden-profile
 378 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} %NULL% work
 379 {
 380    EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
 381    printf("test.key1 = %s\n", val);
 382    EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
 383    printf("test.key2 = %s\n", val);
 384 }
 385 EOF
 386 #rm -f ${ovconfig}
 387 NOTMUCH_CONFIG=${old_NOTMUCH_CONFIG}
 388 cat <<'EOF' >EXPECTED
 389 == stdout ==
 390 test.key1 = overridden-profile
 391 test.key2 = testvalue2
 392 == stderr ==
 393 EOF
 394 test_expect_equal_file EXPECTED OUTPUT
 395 restore_database
 396
 397 test_done