git.notmuchmail.org Git - notmuch/blob - test/T070-insert.sh

   1 #!/usr/bin/env bash
   2 test_description='"notmuch insert"'
   3 . $(dirname "$0")/test-lib.sh || exit 1
   4
   5 # subtests about file permissions assume that we're working with umask
   6 # 022 by default.
   7 umask 022
   8
   9 # Create directories and database before inserting.
  10 mkdir -p "$MAIL_DIR"/{cur,new,tmp}
  11 mkdir -p "$MAIL_DIR"/Drafts/{cur,new,tmp}
  12 notmuch new > /dev/null
  13
  14 # We use generate_message to create the temporary message files.
  15 # They happen to be in the mail directory already but that is okay
  16 # since we do not call notmuch new hereafter.
  17
  18 gen_insert_msg () {
  19     generate_message \
  20         "[subject]=\"insert-subject\"" \
  21         "[date]=\"Sat, 01 Jan 2000 12:00:00 -0000\"" \
  22         "[body]=\"insert-message\""
  23 }
  24
  25 test_begin_subtest "Insert zero-length file"
  26 test_expect_code 1 "notmuch insert < /dev/null"
  27
  28 # This test is a proxy for other errors that may occur while trying to
  29 # add a message to the notmuch database, e.g. database locked.
  30 test_begin_subtest "Insert non-message"
  31 test_expect_code 1 "echo bad_message | notmuch insert"
  32
  33 test_begin_subtest "Database empty so far"
  34 test_expect_equal "0" "`notmuch count --output=messages '*'`"
  35
  36 test_begin_subtest "Insert message"
  37 gen_insert_msg
  38 notmuch insert < "$gen_msg_filename"
  39 cur_msg_filename=$(notmuch search --output=files "subject:insert-subject")
  40 test_expect_equal_file "$cur_msg_filename" "$gen_msg_filename"
  41
  42 test_begin_subtest "Permissions on inserted message should be 0600"
  43 test_expect_equal "600" "$(stat -c %a "$cur_msg_filename")"
  44
  45 test_begin_subtest "Insert message adds default tags"
  46 output=$(notmuch show --format=json "subject:insert-subject")
  47 expected='[[[{
  48  "id": "'"${gen_msg_id}"'",
  49  "crypto": {},
  50  "match": true,
  51  "excluded": false,
  52  "filename": ["'"${cur_msg_filename}"'"],
  53  "timestamp": 946728000,
  54  "date_relative": "2000-01-01",
  55  "tags": ["inbox","unread"],
  56  "headers": {
  57   "Subject": "insert-subject",
  58   "From": "Notmuch Test Suite <test_suite@notmuchmail.org>",
  59   "To": "Notmuch Test Suite <test_suite@notmuchmail.org>",
  60   "Date": "Sat, 01 Jan 2000 12:00:00 +0000"},
  61  "body": [{"id": 1,
  62   "content-type": "text/plain",
  63   "content": "insert-message\n"}]},
  64  []]]]'
  65 test_expect_equal_json "$output" "$expected"
  66
  67 test_begin_subtest "Insert duplicate message"
  68 notmuch insert +duptag -unread < "$gen_msg_filename"
  69 output=$((`notmuch search --output=files "subject:insert-subject" | wc -l`))
  70 test_expect_equal "$output" 2
  71
  72 test_begin_subtest "Duplicate message does not change tags"
  73 output=$(notmuch search --format=json --output=tags "subject:insert-subject")
  74 test_expect_equal_json "$output" '["inbox", "unread"]'
  75
  76 test_begin_subtest "Insert message, add tag"
  77 gen_insert_msg
  78 notmuch insert +custom < "$gen_msg_filename"
  79 output=$(notmuch search --output=messages tag:custom)
  80 test_expect_equal "$output" "id:$gen_msg_id"
  81
  82 test_begin_subtest "Insert tagged world-readable message"
  83 gen_insert_msg
  84 notmuch insert --world-readable +world-readable-test < "$gen_msg_filename"
  85 cur_msg_filename=$(notmuch search --output=files "tag:world-readable-test")
  86 test_expect_equal_file "$cur_msg_filename" "$gen_msg_filename"
  87
  88 test_begin_subtest "Permissions on inserted world-readable message should be 0644"
  89 test_expect_equal "644" "$(stat -c %a "$cur_msg_filename")"
  90
  91 test_begin_subtest "Insert tagged world-readable message with group-only umask"
  92 oldumask=$(umask)
  93 umask 027
  94 gen_insert_msg
  95 notmuch insert --world-readable +world-readable-umask-test < "$gen_msg_filename"
  96 cur_msg_filename=$(notmuch search --output=files "tag:world-readable-umask-test")
  97 umask "$oldumask"
  98 test_expect_equal_file "$cur_msg_filename" "$gen_msg_filename"
  99
 100 test_begin_subtest "Permissions on inserted world-readable message with funny umask should be 0640"
 101 test_expect_equal "640" "$(stat -c %a "$cur_msg_filename")"
 102
 103 test_begin_subtest "Insert message, add/remove tags"
 104 gen_insert_msg
 105 notmuch insert +custom -unread < "$gen_msg_filename"
 106 output=$(notmuch search --output=messages tag:custom NOT tag:unread)
 107 test_expect_equal "$output" "id:$gen_msg_id"
 108
 109 test_begin_subtest "Insert message with default tags stays in new/"
 110 gen_insert_msg
 111 notmuch insert < "$gen_msg_filename"
 112 output=$(notmuch search --output=files id:$gen_msg_id)
 113 dirname=$(dirname "$output")
 114 test_expect_equal "$dirname" "$MAIL_DIR/new"
 115
 116 test_begin_subtest "Insert message with non-maildir synced tags stays in new/"
 117 gen_insert_msg
 118 notmuch insert +custom -inbox < "$gen_msg_filename"
 119 output=$(notmuch search --output=files id:$gen_msg_id)
 120 dirname=$(dirname "$output")
 121 test_expect_equal "$dirname" "$MAIL_DIR/new"
 122
 123 test_begin_subtest "Insert message with custom new.tags goes to cur/"
 124 OLDCONFIG=$(notmuch config get new.tags)
 125 notmuch config set new.tags test
 126 gen_insert_msg
 127 notmuch insert < "$gen_msg_filename"
 128 output=$(notmuch search --output=files id:$gen_msg_id)
 129 dirname=$(dirname "$output")
 130 notmuch config set new.tags $OLDCONFIG
 131 test_expect_equal "$dirname" "$MAIL_DIR/cur"
 132
 133 # additional check on the previous message
 134 test_begin_subtest "Insert message with custom new.tags actually gets the tags"
 135 output=$(notmuch search --output=tags id:$gen_msg_id)
 136 test_expect_equal "$output" "test"
 137
 138 test_begin_subtest "Insert message with maildir synced tags goes to cur/"
 139 gen_insert_msg
 140 notmuch insert +flagged < "$gen_msg_filename"
 141 output=$(notmuch search --output=files id:$gen_msg_id)
 142 dirname=$(dirname "$output")
 143 test_expect_equal "$dirname" "$MAIL_DIR/cur"
 144
 145 test_begin_subtest "Insert message with maildir sync off goes to new/"
 146 OLDCONFIG=$(notmuch config get maildir.synchronize_flags)
 147 notmuch config set maildir.synchronize_flags false
 148 gen_insert_msg
 149 notmuch insert +flagged < "$gen_msg_filename"
 150 output=$(notmuch search --output=files id:$gen_msg_id)
 151 dirname=$(dirname "$output")
 152 notmuch config set maildir.synchronize_flags $OLDCONFIG
 153 test_expect_equal "$dirname" "$MAIL_DIR/new"
 154
 155 test_begin_subtest "Insert message into folder"
 156 gen_insert_msg
 157 notmuch insert --folder=Drafts < "$gen_msg_filename"
 158 output=$(notmuch search --output=files path:Drafts/new)
 159 dirname=$(dirname "$output")
 160 test_expect_equal "$dirname" "$MAIL_DIR/Drafts/new"
 161
 162 test_begin_subtest "Insert message into top level folder"
 163 gen_insert_msg
 164 notmuch insert --folder="" < "$gen_msg_filename"
 165 output=$(notmuch search --output=files id:${gen_msg_id})
 166 dirname=$(dirname "$output")
 167 test_expect_equal "$dirname" "$MAIL_DIR/new"
 168
 169 test_begin_subtest "Insert message into folder with trailing /"
 170 gen_insert_msg
 171 notmuch insert --folder=Drafts/ < "$gen_msg_filename"
 172 output=$(notmuch search --output=files id:${gen_msg_id})
 173 dirname=$(dirname "$output")
 174 test_expect_equal "$dirname" "$MAIL_DIR/Drafts/new"
 175
 176 test_begin_subtest "Insert message into folder, add/remove tags"
 177 gen_insert_msg
 178 notmuch insert --folder=Drafts +draft -unread < "$gen_msg_filename"
 179 output=$(notmuch search --output=messages path:Drafts/cur tag:draft NOT tag:unread)
 180 test_expect_equal "$output" "id:$gen_msg_id"
 181
 182 test_begin_subtest "Insert message into non-existent folder"
 183 gen_insert_msg
 184 test_expect_code 1 "notmuch insert --folder=nonesuch < $gen_msg_filename"
 185
 186 test_begin_subtest "Insert message, create folder"
 187 gen_insert_msg
 188 notmuch insert --folder=F --create-folder +folder < "$gen_msg_filename"
 189 output=$(notmuch search --output=files path:F/new tag:folder)
 190 basename=$(basename "$output")
 191 test_expect_equal_file "$gen_msg_filename" "$MAIL_DIR/F/new/${basename}"
 192
 193 test_begin_subtest "Insert message, create subfolder"
 194 gen_insert_msg
 195 notmuch insert --folder=F/G/H/I/J --create-folder +folder < "$gen_msg_filename"
 196 output=$(notmuch search --output=files path:F/G/H/I/J/new tag:folder)
 197 basename=$(basename "$output")
 198 test_expect_equal_file "$gen_msg_filename" "${MAIL_DIR}/F/G/H/I/J/new/${basename}"
 199
 200 test_begin_subtest "Created subfolder should have permissions 0700"
 201 test_expect_equal "700" "$(stat -c %a "${MAIL_DIR}/F/G/H/I/J")"
 202 test_begin_subtest "Created subfolder new/ should also have permissions 0700"
 203 test_expect_equal "700" "$(stat -c %a "${MAIL_DIR}/F/G/H/I/J/new")"
 204
 205 test_begin_subtest "Insert message, create world-readable subfolder"
 206 gen_insert_msg
 207 notmuch insert --folder=F/G/H/I/J/K --create-folder --world-readable +folder-world-readable < "$gen_msg_filename"
 208 output=$(notmuch search --output=files path:F/G/H/I/J/K/new tag:folder-world-readable)
 209 basename=$(basename "$output")
 210 test_expect_equal_file "$gen_msg_filename" "${MAIL_DIR}/F/G/H/I/J/K/new/${basename}"
 211
 212 test_begin_subtest "Created world-readable subfolder should have permissions 0755"
 213 test_expect_equal "755" "$(stat -c %a "${MAIL_DIR}/F/G/H/I/J/K")"
 214 test_begin_subtest "Created world-readable subfolder new/ should also have permissions 0755"
 215 test_expect_equal "755" "$(stat -c %a "${MAIL_DIR}/F/G/H/I/J/K/new")"
 216
 217 test_begin_subtest "Insert message, create existing subfolder"
 218 gen_insert_msg
 219 notmuch insert --folder=F/G/H/I/J --create-folder +folder < "$gen_msg_filename"
 220 output=$(notmuch count path:F/G/H/I/J/new tag:folder)
 221 test_expect_equal "$output" "2"
 222
 223 test_begin_subtest "Insert message, create invalid subfolder"
 224 gen_insert_msg
 225 test_expect_code 1 "notmuch insert --folder=../G --create-folder < $gen_msg_filename"
 226
 227 OLDCONFIG=$(notmuch config get new.tags)
 228
 229 test_begin_subtest "Empty tags in new.tags are ignored"
 230 notmuch config set new.tags "foo;;bar"
 231 gen_insert_msg
 232 notmuch insert < $gen_msg_filename
 233 output=$(notmuch show --format=json id:$gen_msg_id)
 234 test_json_nodes <<<"$output" \
 235                 'new_tags:[0][0][0]["tags"] = ["bar", "foo"]'
 236
 237 test_begin_subtest "leading/trailing whitespace in new.tags is ignored"
 238 # avoid complications with leading spaces and "notmuch config"
 239 sed -i 's/^tags=.*$/tags= fu bar ; ; bar /' notmuch-config
 240 gen_insert_msg
 241 notmuch insert < $gen_msg_filename
 242 notmuch dump id:$gen_msg_id | sed 's/ --.*$//' > OUTPUT
 243 cat <<EOF >EXPECTED
 244 #notmuch-dump batch-tag:3 config,properties,tags
 245 +bar +fu%20bar
 246 EOF
 247 test_expect_equal_file EXPECTED OUTPUT
 248
 249 test_begin_subtest "Tags starting with '-' in new.tags are forbidden"
 250 notmuch config set new.tags "-foo;bar"
 251 gen_insert_msg
 252 output=$(notmuch insert < $gen_msg_filename 2>&1)
 253 test_expect_equal "$output" "Error: tag '-foo' in new.tags: tag starting with '-' forbidden"
 254
 255 test_begin_subtest "Invalid tags set exit code"
 256 test_expect_code 1 "notmuch insert < $gen_msg_filename 2>&1"
 257
 258 notmuch config set new.tags $OLDCONFIG
 259
 260 # DUPLICATE_MESSAGE_ID is not tested here, because it should actually pass.
 261 # pregenerate all of the test shims
 262 for code in FILE_NOT_EMAIL READ_ONLY_DATABASE UPGRADE_REQUIRED PATH_ERROR OUT_OF_MEMORY XAPIAN_EXCEPTION; do
 263     make_shim shim-$code <<EOF
 264 #include <notmuch.h>
 265 #include <stdio.h>
 266 notmuch_status_t
 267 notmuch_database_index_file (notmuch_database_t *notmuch,
 268                              const char *filename,
 269                              notmuch_indexopts_t *indexopts,
 270                              notmuch_message_t **message_ret)
 271 {
 272   return NOTMUCH_STATUS_$code;
 273 }
 274 EOF
 275 done
 276
 277 gen_insert_msg
 278
 279 for code in FILE_NOT_EMAIL READ_ONLY_DATABASE UPGRADE_REQUIRED PATH_ERROR; do
 280     test_begin_subtest "EXIT_FAILURE when index_file returns $code"
 281     test_expect_code 1 "notmuch_with_shim shim-$code insert < \"$gen_msg_filename\""
 282
 283     test_begin_subtest "success exit with --keep when index_file returns $code"
 284     test_expect_code 0 "notmuch_with_shim shim-$code insert --keep < \"$gen_msg_filename\""
 285 done
 286
 287 for code in OUT_OF_MEMORY XAPIAN_EXCEPTION ; do
 288     test_begin_subtest "EX_TEMPFAIL when index_file returns $code"
 289     test_expect_code 75 "notmuch_with_shim shim-$code insert < \"$gen_msg_filename\""
 290
 291     test_begin_subtest "success exit with --keep when index_file returns $code"
 292     test_expect_code 0 "notmuch_with_shim shim-$code insert --keep < \"$gen_msg_filename\""
 293 done
 294
 295 test_begin_subtest "insert converts mboxes on delivery"
 296 notmuch insert +unmboxed < "${TEST_DIRECTORY}"/corpora/indexing/mbox-attachment.eml
 297 output=$(notmuch count tag:unmboxed)
 298 test_expect_equal "${output}" 1
 299
 300 test_done