git.notmuchmail.org Git - notmuch/blob - test/T610-message-property.sh

   1 #!/usr/bin/env bash
   2 test_description="message property API"
   3
   4 . $(dirname "$0")/test-lib.sh || exit 1
   5
   6 add_email_corpus
   7
   8 cat <<EOF > c_head
   9 #include <stdio.h>
  10 #include <string.h>
  11 #include <stdlib.h>
  12 #include <talloc.h>
  13 #include <notmuch-test.h>
  14
  15 void print_properties (notmuch_message_t *message, const char *prefix, notmuch_bool_t exact) {
  16     notmuch_message_properties_t *list;
  17     for (list = notmuch_message_get_properties (message, prefix, exact);
  18          notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
  19        printf("%s\n", notmuch_message_properties_value(list));
  20     }
  21     notmuch_message_properties_destroy (list);
  22 }
  23
  24 int main (int argc, char** argv)
  25 {
  26    notmuch_database_t *db;
  27    notmuch_message_t *message = NULL;
  28    const char *val;
  29    notmuch_status_t stat;
  30
  31    EXPECT0(notmuch_database_open (argv[1], NOTMUCH_DATABASE_MODE_READ_WRITE, &db));
  32    EXPECT0(notmuch_database_find_message(db, "4EFC743A.3060609@april.org", &message));
  33    if (message == NULL) {
  34         fprintf (stderr, "unable to find message");
  35         exit (1);
  36    }
  37 EOF
  38
  39 cat <<EOF > c_tail
  40    EXPECT0(notmuch_database_destroy(db));
  41 }
  42 EOF
  43
  44 test_begin_subtest "notmuch_message_{add,get,remove}_property"
  45 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
  46 {
  47    EXPECT0(notmuch_message_add_property (message, "testkey1", "testvalue1"));
  48    EXPECT0(notmuch_message_get_property (message, "testkey1", &val));
  49    printf("testkey1[1] = %s\n", val);
  50    EXPECT0(notmuch_message_add_property (message, "testkey2", "this value has spaces and = sign"));
  51    EXPECT0(notmuch_message_get_property (message, "testkey1", &val));
  52    printf("testkey1[2] = %s\n", val);
  53    EXPECT0(notmuch_message_get_property (message, "testkey1", &val));
  54
  55    EXPECT0(notmuch_message_get_property (message, "testkey2", &val));
  56    printf("testkey2 = %s\n", val);
  57
  58    /* Add second value for key */
  59    EXPECT0(notmuch_message_add_property (message, "testkey2", "zztestvalue3"));
  60    EXPECT0(notmuch_message_get_property (message, "testkey2", &val));
  61    printf("testkey2 = %s\n", val);
  62
  63    /* remove first value for key */
  64    EXPECT0(notmuch_message_remove_property (message, "testkey2", "this value has spaces and = sign"));
  65    EXPECT0(notmuch_message_get_property (message, "testkey2", &val));
  66    printf("testkey2 = %s\n", val);
  67
  68    /* remove non-existant value for key */
  69    EXPECT0(notmuch_message_remove_property (message, "testkey2", "this value has spaces and = sign"));
  70    EXPECT0(notmuch_message_get_property (message, "testkey2", &val));
  71    printf("testkey2 = %s\n", val);
  72
  73    /* remove only value for key */
  74    EXPECT0(notmuch_message_remove_property (message, "testkey2", "zztestvalue3"));
  75    EXPECT0(notmuch_message_get_property (message, "testkey2", &val));
  76    printf("testkey2 = %s\n", val == NULL ? "NULL" : val);
  77 }
  78 EOF
  79 cat <<'EOF' >EXPECTED
  80 == stdout ==
  81 testkey1[1] = testvalue1
  82 testkey1[2] = testvalue1
  83 testkey2 = this value has spaces and = sign
  84 testkey2 = this value has spaces and = sign
  85 testkey2 = zztestvalue3
  86 testkey2 = zztestvalue3
  87 testkey2 = NULL
  88 == stderr ==
  89 EOF
  90 test_expect_equal_file EXPECTED OUTPUT
  91
  92 test_begin_subtest "notmuch_message_remove_all_properties"
  93 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
  94 EXPECT0(notmuch_message_remove_all_properties (message, NULL));
  95 print_properties (message, "", FALSE);
  96 EOF
  97 cat <<'EOF' >EXPECTED
  98 == stdout ==
  99 == stderr ==
 100 EOF
 101 test_expect_equal_file EXPECTED OUTPUT
 102
 103 test_begin_subtest "testing string map binary search (via message properties)"
 104 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 105 {
 106    char *keys[] = {"a", "b", "c", "d", "e", NULL};
 107    for (int i=0; keys[i]; i++)
 108        EXPECT0(notmuch_message_add_property (message, keys[i], keys[i]));
 109
 110    for (int i=0; keys[i]; i++) {
 111       EXPECT0(notmuch_message_get_property (message, keys[i], &val));
 112       printf("%s = %s\n", keys[i], val);
 113    }
 114
 115    for (int i=0; keys[i]; i++) {
 116       EXPECT0(notmuch_message_remove_property (message, keys[i], keys[i]));
 117       EXPECT0(notmuch_message_get_property (message, keys[i], &val));
 118       printf("%s = %s\n", keys[i], val == NULL ? "NULL" : val);
 119    }
 120 }
 121 EOF
 122 cat <<EOF > EXPECTED
 123 == stdout ==
 124 a = a
 125 b = b
 126 c = c
 127 d = d
 128 e = e
 129 a = NULL
 130 b = NULL
 131 c = NULL
 132 d = NULL
 133 e = NULL
 134 == stderr ==
 135 EOF
 136 test_expect_equal_file EXPECTED OUTPUT
 137
 138 test_begin_subtest "notmuch_message_get_properties: empty list"
 139 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 140 {
 141    notmuch_message_properties_t *list;
 142    list = notmuch_message_get_properties (message, "nonexistent", TRUE);
 143    printf("valid = %d\n", notmuch_message_properties_valid (list));
 144    notmuch_message_properties_destroy (list);
 145 }
 146 EOF
 147 cat <<'EOF' >EXPECTED
 148 == stdout ==
 149 valid = 0
 150 == stderr ==
 151 EOF
 152 test_expect_equal_file EXPECTED OUTPUT
 153
 154 test_begin_subtest "notmuch_message_properties: one value"
 155 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 156 print_properties (message, "testkey1", TRUE);
 157 EOF
 158 cat <<'EOF' >EXPECTED
 159 == stdout ==
 160 testvalue1
 161 == stderr ==
 162 EOF
 163 test_expect_equal_file EXPECTED OUTPUT
 164
 165 test_begin_subtest "notmuch_message_properties: multiple values"
 166 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 167 EXPECT0(notmuch_message_add_property (message, "testkey1", "bob"));
 168 EXPECT0(notmuch_message_add_property (message, "testkey1", "testvalue2"));
 169 EXPECT0(notmuch_message_add_property (message, "testkey1", "alice"));
 170 print_properties (message, "testkey1", TRUE);
 171 EOF
 172 cat <<'EOF' >EXPECTED
 173 == stdout ==
 174 alice
 175 bob
 176 testvalue1
 177 testvalue2
 178 == stderr ==
 179 EOF
 180 test_expect_equal_file EXPECTED OUTPUT
 181
 182 test_begin_subtest "notmuch_message_properties: prefix"
 183 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 184 EXPECT0(notmuch_message_add_property (message, "testkey3", "bob3"));
 185 EXPECT0(notmuch_message_add_property (message, "testkey3", "testvalue3"));
 186 EXPECT0(notmuch_message_add_property (message, "testkey3", "alice3"));
 187 print_properties (message, "testkey", FALSE);
 188 EOF
 189 cat <<'EOF' >EXPECTED
 190 == stdout ==
 191 alice
 192 bob
 193 testvalue1
 194 testvalue2
 195 alice3
 196 bob3
 197 testvalue3
 198 == stderr ==
 199 EOF
 200 test_expect_equal_file EXPECTED OUTPUT
 201
 202 test_begin_subtest "notmuch_message_properties: modify during iteration"
 203 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 204 {
 205     const char *keys[1000] = {NULL};
 206     const char *vals[1000] = {NULL};
 207     notmuch_message_properties_t *properties;
 208     int i;
 209
 210     for (properties = notmuch_message_get_properties (message, "", FALSE), i=0;
 211          notmuch_message_properties_valid (properties);
 212          notmuch_message_properties_move_to_next (properties), i++)
 213     {
 214         const char *key, *value;
 215
 216         keys[i]=talloc_strdup(message,
 217                     notmuch_message_properties_key (properties));
 218         vals[i]=talloc_strdup(message,
 219                     notmuch_message_properties_value (properties));
 220
 221         EXPECT0(notmuch_message_remove_property (message, keys[i], vals[i]));
 222     }
 223
 224     print_properties (message, "", FALSE);
 225
 226     for (i = 0; keys[i] && vals[i]; i++) {
 227         EXPECT0(notmuch_message_add_property (message, keys[i], vals[i]));
 228     }
 229 }
 230 EOF
 231 cat <<'EOF' >EXPECTED
 232 == stdout ==
 233 == stderr ==
 234 EOF
 235 test_expect_equal_file EXPECTED OUTPUT
 236
 237 test_begin_subtest "dump message properties"
 238 cat <<EOF > PROPERTIES
 239 #= 4EFC743A.3060609@april.org fancy%20key%20with%20%c3%a1cc%c3%a8nts=import%20value%20with%20= testkey1=alice testkey1=bob testkey1=testvalue1 testkey1=testvalue2 testkey3=alice3 testkey3=bob3 testkey3=testvalue3
 240 EOF
 241 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 242 EXPECT0(notmuch_message_add_property (message, "fancy key with áccènts", "import value with ="));
 243 EOF
 244 notmuch dump | grep '^#=' > OUTPUT
 245 test_expect_equal_file PROPERTIES OUTPUT
 246
 247 test_begin_subtest "dump _only_ message properties"
 248 cat <<EOF > EXPECTED
 249 #notmuch-dump batch-tag:3 properties
 250 #= 4EFC743A.3060609@april.org fancy%20key%20with%20%c3%a1cc%c3%a8nts=import%20value%20with%20= testkey1=alice testkey1=bob testkey1=testvalue1 testkey1=testvalue2 testkey3=alice3 testkey3=bob3 testkey3=testvalue3
 251 EOF
 252 notmuch dump --include=properties > OUTPUT
 253 test_expect_equal_file EXPECTED OUTPUT
 254
 255
 256 test_begin_subtest "restore missing message property (single line)"
 257 notmuch dump | grep '^#=' > BEFORE1
 258 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 259 EXPECT0(notmuch_message_remove_property (message, "testkey1", "bob"));
 260 EOF
 261 notmuch restore < BEFORE1
 262 notmuch dump | grep '^#=' > OUTPUT
 263 test_expect_equal_file PROPERTIES OUTPUT
 264
 265
 266 test_begin_subtest "restore missing message property (full dump)"
 267 notmuch dump > BEFORE2
 268 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 269 EXPECT0(notmuch_message_remove_property (message, "testkey1", "bob"));
 270 EOF
 271 notmuch restore < BEFORE2
 272 notmuch dump | grep '^#=' > OUTPUT
 273 test_expect_equal_file PROPERTIES OUTPUT
 274
 275 test_begin_subtest "restore clear extra message property"
 276 cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
 277 EXPECT0(notmuch_message_add_property (message, "testkey1", "charles"));
 278 EOF
 279 notmuch restore < BEFORE2
 280 notmuch dump | grep '^#=' > OUTPUT
 281 test_expect_equal_file PROPERTIES OUTPUT
 282
 283 test_begin_subtest "test 'property:' queries: empty"
 284 notmuch search property:testkey1=charles > OUTPUT
 285 test_expect_equal_file /dev/null OUTPUT
 286
 287 test_begin_subtest "test 'property:' queries: single message"
 288 notmuch search --output=messages property:testkey1=alice > OUTPUT
 289 cat <<EOF >EXPECTED
 290 id:4EFC743A.3060609@april.org
 291 EOF
 292 test_expect_equal_file EXPECTED OUTPUT
 293
 294 test_begin_subtest "msg.get_property (python)"
 295 test_python <<'EOF'
 296 import notmuch
 297 db = notmuch.Database(mode=notmuch.Database.MODE.READ_WRITE)
 298 msg = db.find_message("4EFC743A.3060609@april.org")
 299 print("testkey1 = {0}".format(msg.get_property("testkey1")))
 300 print("testkey3 = {0}".format(msg.get_property("testkey3")))
 301 EOF
 302 cat <<'EOF' > EXPECTED
 303 testkey1 = alice
 304 testkey3 = alice3
 305 EOF
 306 test_expect_equal_file EXPECTED OUTPUT
 307
 308 test_begin_subtest "msg.get_properties (python)"
 309 test_python <<'EOF'
 310 import notmuch
 311 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
 312 msg = db.find_message("4EFC743A.3060609@april.org")
 313 for (key,val) in msg.get_properties("testkey1"):
 314         print("{0} = {1}".format(key,val))
 315 EOF
 316 cat <<'EOF' > EXPECTED
 317 testkey1 = alice
 318 testkey1 = bob
 319 testkey1 = testvalue1
 320 testkey1 = testvalue2
 321 EOF
 322 test_expect_equal_file EXPECTED OUTPUT
 323
 324 test_begin_subtest "msg.get_properties (python, prefix)"
 325 test_python <<'EOF'
 326 import notmuch
 327 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
 328 msg = db.find_message("4EFC743A.3060609@april.org")
 329 for (key,val) in msg.get_properties("testkey"):
 330         print("{0} = {1}".format(key,val))
 331 EOF
 332 cat <<'EOF' > EXPECTED
 333 testkey1 = alice
 334 testkey1 = bob
 335 testkey1 = testvalue1
 336 testkey1 = testvalue2
 337 testkey3 = alice3
 338 testkey3 = bob3
 339 testkey3 = testvalue3
 340 EOF
 341 test_expect_equal_file EXPECTED OUTPUT
 342
 343 test_begin_subtest "msg.get_properties (python, exact)"
 344 test_python <<'EOF'
 345 import notmuch
 346 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
 347 msg = db.find_message("4EFC743A.3060609@april.org")
 348 for (key,val) in msg.get_properties("testkey",True):
 349         print("{0} = {1}".format(key,val))
 350 EOF
 351 test_expect_equal_file /dev/null OUTPUT
 352
 353 test_done