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 test_require_external_prereq gdb
   6
   7 # Create directories and database before inserting.
   8 mkdir -p "$MAIL_DIR"/{cur,new,tmp}
   9 mkdir -p "$MAIL_DIR"/Drafts/{cur,new,tmp}
  10 notmuch new > /dev/null
  11
  12 # We use generate_message to create the temporary message files.
  13 # They happen to be in the mail directory already but that is okay
  14 # since we do not call notmuch new hereafter.
  15
  16 gen_insert_msg() {
  17     generate_message \
  18         "[subject]=\"insert-subject\"" \
  19         "[date]=\"Sat, 01 Jan 2000 12:00:00 -0000\"" \
  20         "[body]=\"insert-message\""
  21 }
  22
  23 test_begin_subtest "Insert zero-length file"
  24 test_expect_code 1 "notmuch insert < /dev/null"
  25
  26 # This test is a proxy for other errors that may occur while trying to
  27 # add a message to the notmuch database, e.g. database locked.
  28 test_begin_subtest "Insert non-message"
  29 test_expect_code 1 "echo bad_message | notmuch insert"
  30
  31 test_begin_subtest "Database empty so far"
  32 test_expect_equal "0" "`notmuch count --output=messages '*'`"
  33
  34 test_begin_subtest "Insert message"
  35 gen_insert_msg
  36 notmuch insert < "$gen_msg_filename"
  37 cur_msg_filename=$(notmuch search --output=files "subject:insert-subject")
  38 test_expect_equal_file "$cur_msg_filename" "$gen_msg_filename"
  39
  40 test_begin_subtest "Insert message adds default tags"
  41 output=$(notmuch show --format=json "subject:insert-subject")
  42 expected='[[[{
  43  "id": "'"${gen_msg_id}"'",
  44  "match": true,
  45  "excluded": false,
  46  "filename": ["'"${cur_msg_filename}"'"],
  47  "timestamp": 946728000,
  48  "date_relative": "2000-01-01",
  49  "tags": ["inbox","unread"],
  50  "headers": {
  51   "Subject": "insert-subject",
  52   "From": "Notmuch Test Suite <test_suite@notmuchmail.org>",
  53   "To": "Notmuch Test Suite <test_suite@notmuchmail.org>",
  54   "Date": "Sat, 01 Jan 2000 12:00:00 +0000"},
  55  "body": [{"id": 1,
  56   "content-type": "text/plain",
  57   "content": "insert-message\n"}]},
  58  []]]]'
  59 test_expect_equal_json "$output" "$expected"
  60
  61 test_begin_subtest "Insert duplicate message"
  62 notmuch insert +duptag -unread < "$gen_msg_filename"
  63 output=$((`notmuch search --output=files "subject:insert-subject" | wc -l`))
  64 test_expect_equal "$output" 2
  65
  66 test_begin_subtest "Duplicate message does not change tags"
  67 output=$(notmuch search --format=json --output=tags "subject:insert-subject")
  68 test_expect_equal_json "$output" '["inbox", "unread"]'
  69
  70 test_begin_subtest "Insert message, add tag"
  71 gen_insert_msg
  72 notmuch insert +custom < "$gen_msg_filename"
  73 output=$(notmuch search --output=messages tag:custom)
  74 test_expect_equal "$output" "id:$gen_msg_id"
  75
  76 test_begin_subtest "Insert message, add/remove tags"
  77 gen_insert_msg
  78 notmuch insert +custom -unread < "$gen_msg_filename"
  79 output=$(notmuch search --output=messages tag:custom NOT tag:unread)
  80 test_expect_equal "$output" "id:$gen_msg_id"
  81
  82 test_begin_subtest "Insert message with default tags stays in new/"
  83 gen_insert_msg
  84 notmuch insert < "$gen_msg_filename"
  85 output=$(notmuch search --output=files id:$gen_msg_id)
  86 dirname=$(dirname "$output")
  87 test_expect_equal "$dirname" "$MAIL_DIR/new"
  88
  89 test_begin_subtest "Insert message with non-maildir synced tags stays in new/"
  90 gen_insert_msg
  91 notmuch insert +custom -inbox < "$gen_msg_filename"
  92 output=$(notmuch search --output=files id:$gen_msg_id)
  93 dirname=$(dirname "$output")
  94 test_expect_equal "$dirname" "$MAIL_DIR/new"
  95
  96 test_begin_subtest "Insert message with custom new.tags goes to cur/"
  97 OLDCONFIG=$(notmuch config get new.tags)
  98 notmuch config set new.tags test
  99 gen_insert_msg
 100 notmuch insert < "$gen_msg_filename"
 101 output=$(notmuch search --output=files id:$gen_msg_id)
 102 dirname=$(dirname "$output")
 103 notmuch config set new.tags $OLDCONFIG
 104 test_expect_equal "$dirname" "$MAIL_DIR/cur"
 105
 106 # additional check on the previous message
 107 test_begin_subtest "Insert message with custom new.tags actually gets the tags"
 108 output=$(notmuch search --output=tags id:$gen_msg_id)
 109 test_expect_equal "$output" "test"
 110
 111 test_begin_subtest "Insert message with maildir synced tags goes to cur/"
 112 gen_insert_msg
 113 notmuch insert +flagged < "$gen_msg_filename"
 114 output=$(notmuch search --output=files id:$gen_msg_id)
 115 dirname=$(dirname "$output")
 116 test_expect_equal "$dirname" "$MAIL_DIR/cur"
 117
 118 test_begin_subtest "Insert message with maildir sync off goes to new/"
 119 OLDCONFIG=$(notmuch config get maildir.synchronize_flags)
 120 notmuch config set maildir.synchronize_flags false
 121 gen_insert_msg
 122 notmuch insert +flagged < "$gen_msg_filename"
 123 output=$(notmuch search --output=files id:$gen_msg_id)
 124 dirname=$(dirname "$output")
 125 notmuch config set maildir.synchronize_flags $OLDCONFIG
 126 test_expect_equal "$dirname" "$MAIL_DIR/new"
 127
 128 test_begin_subtest "Insert message into folder"
 129 gen_insert_msg
 130 notmuch insert --folder=Drafts < "$gen_msg_filename"
 131 output=$(notmuch search --output=files path:Drafts/new)
 132 dirname=$(dirname "$output")
 133 test_expect_equal "$dirname" "$MAIL_DIR/Drafts/new"
 134
 135 test_begin_subtest "Insert message into top level folder"
 136 gen_insert_msg
 137 notmuch insert --folder="" < "$gen_msg_filename"
 138 output=$(notmuch search --output=files id:${gen_msg_id})
 139 dirname=$(dirname "$output")
 140 test_expect_equal "$dirname" "$MAIL_DIR/new"
 141
 142 test_begin_subtest "Insert message into folder with trailing /"
 143 gen_insert_msg
 144 notmuch insert --folder=Drafts/ < "$gen_msg_filename"
 145 output=$(notmuch search --output=files id:${gen_msg_id})
 146 dirname=$(dirname "$output")
 147 test_expect_equal "$dirname" "$MAIL_DIR/Drafts/new"
 148
 149 test_begin_subtest "Insert message into folder, add/remove tags"
 150 gen_insert_msg
 151 notmuch insert --folder=Drafts +draft -unread < "$gen_msg_filename"
 152 output=$(notmuch search --output=messages path:Drafts/cur tag:draft NOT tag:unread)
 153 test_expect_equal "$output" "id:$gen_msg_id"
 154
 155 test_begin_subtest "Insert message into non-existent folder"
 156 gen_insert_msg
 157 test_expect_code 1 "notmuch insert --folder=nonesuch < $gen_msg_filename"
 158
 159 test_begin_subtest "Insert message, create folder"
 160 gen_insert_msg
 161 notmuch insert --folder=F --create-folder +folder < "$gen_msg_filename"
 162 output=$(notmuch search --output=files path:F/new tag:folder)
 163 basename=$(basename "$output")
 164 test_expect_equal_file "$gen_msg_filename" "$MAIL_DIR/F/new/${basename}"
 165
 166 test_begin_subtest "Insert message, create subfolder"
 167 gen_insert_msg
 168 notmuch insert --folder=F/G/H/I/J --create-folder +folder < "$gen_msg_filename"
 169 output=$(notmuch search --output=files path:F/G/H/I/J/new tag:folder)
 170 basename=$(basename "$output")
 171 test_expect_equal_file "$gen_msg_filename" "${MAIL_DIR}/F/G/H/I/J/new/${basename}"
 172
 173 test_begin_subtest "Insert message, create existing subfolder"
 174 gen_insert_msg
 175 notmuch insert --folder=F/G/H/I/J --create-folder +folder < "$gen_msg_filename"
 176 output=$(notmuch count path:F/G/H/I/J/new tag:folder)
 177 test_expect_equal "$output" "2"
 178
 179 test_begin_subtest "Insert message, create invalid subfolder"
 180 gen_insert_msg
 181 test_expect_code 1 "notmuch insert --folder=../G --create-folder $gen_msg_filename"
 182
 183 OLDCONFIG=$(notmuch config get new.tags)
 184
 185 test_begin_subtest "Empty tags in new.tags are forbidden"
 186 notmuch config set new.tags "foo;;bar"
 187 gen_insert_msg
 188 output=$(notmuch insert $gen_msg_filename 2>&1)
 189 test_expect_equal "$output" "Error: tag '' in new.tags: empty tag forbidden"
 190
 191 test_begin_subtest "Tags starting with '-' in new.tags are forbidden"
 192 notmuch config set new.tags "-foo;bar"
 193 gen_insert_msg
 194 output=$(notmuch insert $gen_msg_filename 2>&1)
 195 test_expect_equal "$output" "Error: tag '-foo' in new.tags: tag starting with '-' forbidden"
 196
 197 test_begin_subtest "Invalid tags set exit code"
 198 test_expect_code 1 "notmuch insert $gen_msg_filename 2>&1"
 199
 200 notmuch config set new.tags $OLDCONFIG
 201
 202 # DUPLICATE_MESSAGE_ID is not tested here, because it should actually pass.
 203
 204 for code in OUT_OF_MEMORY XAPIAN_EXCEPTION FILE_NOT_EMAIL \
 205     READ_ONLY_DATABASE UPGRADE_REQUIRED PATH_ERROR; do
 206 cat <<EOF > index-file-$code.gdb
 207 set breakpoint pending on
 208 set logging file index-file-$code.log
 209 set logging on
 210 break notmuch_database_index_file
 211 commands
 212 return NOTMUCH_STATUS_$code
 213 continue
 214 end
 215 run
 216 EOF
 217 done
 218
 219 gen_insert_msg
 220
 221 for code in  FILE_NOT_EMAIL READ_ONLY_DATABASE UPGRADE_REQUIRED PATH_ERROR; do
 222     test_begin_subtest "EXIT_FAILURE when index_file returns $code"
 223     test_expect_code 1 \
 224          "${TEST_GDB} --batch-silent --return-child-result \
 225              -ex 'set args insert < $gen_msg_filename' \
 226              -x index-file-$code.gdb notmuch"
 227
 228     test_begin_subtest "success exit with --keep when index_file returns $code"
 229     test_expect_code 0 \
 230          "${TEST_GDB} --batch-silent --return-child-result \
 231              -ex 'set args insert --keep < $gen_msg_filename' \
 232              -x index-file-$code.gdb notmuch"
 233 done
 234
 235 for code in OUT_OF_MEMORY XAPIAN_EXCEPTION ; do
 236     test_begin_subtest "EX_TEMPFAIL when index_file returns $code"
 237     test_expect_code 75 \
 238          "${TEST_GDB} --batch-silent --return-child-result \
 239              -ex 'set args insert < $gen_msg_filename' \
 240              -x index-file-$code.gdb notmuch"
 241
 242     test_begin_subtest "success exit with --keep when index_file returns $code"
 243     test_expect_code 0 \
 244          "${TEST_GDB} --batch-silent --return-child-result \
 245              -ex 'set args insert --keep < $gen_msg_filename' \
 246              -x index-file-$code.gdb notmuch"
 247 done
 248
 249 test_done