NEWS: cli: manual page for notmuch configuration options
[notmuch] / test / maildir-sync
1 #!/usr/bin/env bash
2
3 test_description="maildir synchronization"
4
5 . ./test-lib.sh
6
7 # Much easier to examine differences if the "notmuch show
8 # --format=json" output includes some newlines. Also, need to avoid
9 # including the local value of MAIL_DIR in the result.
10 filter_show_json() {
11     sed -e 's/, /,\n/g'  | sed -e "s|${MAIL_DIR}/|MAIL_DIR/|"
12     echo
13 }
14
15 # Create the expected maildir structure
16 mkdir $MAIL_DIR/cur
17 mkdir $MAIL_DIR/new
18 mkdir $MAIL_DIR/tmp
19
20 test_begin_subtest "Adding 'S' flag to existing filename removes 'unread' tag"
21 add_message [subject]='"Adding S flag"' [filename]='adding-s-flag:2,' [dir]=cur
22 output=$(notmuch search subject:"Adding S flag" | notmuch_search_sanitize)
23 output+="
24 "
25 mv "${gen_msg_filename}" "${gen_msg_filename}S"
26 output+=$(NOTMUCH_NEW)
27 output+="
28 "
29 output+=$(notmuch search subject:"Adding S flag" | notmuch_search_sanitize)
30 test_expect_equal "$output" "thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Adding S flag (inbox unread)
31 No new mail. Detected 1 file rename.
32 thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Adding S flag (inbox)"
33
34 test_begin_subtest "Adding message with 'S' flag prevents 'unread' tag"
35 add_message [subject]='"Adding message with S"' [filename]='adding-with-s-flag:2,S' [dir]=cur
36 output=$(notmuch search subject:"Adding message with S" | notmuch_search_sanitize)
37 test_expect_equal "$output" "thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Adding message with S (inbox)"
38
39 test_begin_subtest "Adding 'replied' tag adds 'R' flag to filename"
40 add_message [subject]='"Adding replied tag"' [filename]='adding-replied-tag:2,S' [dir]=cur
41 notmuch tag +replied subject:"Adding replied tag"
42 output=$(cd ${MAIL_DIR}/cur; ls -1 adding-replied*)
43 test_expect_equal "$output" "adding-replied-tag:2,RS"
44
45 test_begin_subtest "notmuch show works with renamed file (without notmuch new)"
46 output=$(notmuch show --format=json id:${gen_msg_id} | filter_show_json)
47 test_expect_equal "$output" '[[[{"id": "adding-replied-tag@notmuch-test-suite",
48 "match": true,
49 "filename": "MAIL_DIR/cur/adding-replied-tag:2,RS",
50 "timestamp": 978709437,
51 "date_relative": "2001-01-05",
52 "tags": ["inbox","replied"],
53 "headers": {"Subject": "Adding replied tag",
54 "From": "Notmuch Test Suite <test_suite@notmuchmail.org>",
55 "To": "Notmuch Test Suite <test_suite@notmuchmail.org>",
56 "Cc": "",
57 "Bcc": "",
58 "Date": "Fri,
59 05 Jan 2001 15:43:57 +0000"},
60 "body": [{"id": 1,
61 "content-type": "text/plain",
62 "content": "This is just a test message (#3)\n"}]},
63 []]]]'
64
65 test_expect_success 'notmuch reply works with renamed file (without notmuch new)' 'notmuch reply id:${gen_msg_id}'
66
67 test_begin_subtest "notmuch new detects no file rename after tag->flag synchronization"
68 output=$(NOTMUCH_NEW)
69 test_expect_equal "$output" "No new mail."
70
71 test_begin_subtest "When read, message moved from new to cur"
72 add_message [subject]='"Message to move to cur"' [date]='"Sat, 01 Jan 2000 12:00:00 -0000"' [filename]='message-to-move-to-cur' [dir]=new
73 notmuch tag -unread subject:"Message to move to cur"
74 output=$(cd "$MAIL_DIR/cur"; ls message-to-move*)
75 test_expect_equal "$output" "message-to-move-to-cur:2,S"
76
77 test_begin_subtest "No rename should be detected by notmuch new"
78 output=$(NOTMUCH_NEW)
79 test_expect_equal "$output" "No new mail."
80 # (*) If notmuch new was not run we've got "Processed 1 file in almost
81 # no time" here. The reason is that removing unread tag in a previous
82 # test created directory document in the database but this document
83 # was not linked as subdirectory of $MAIL_DIR. Therefore notmuch new
84 # could not reach the cur/ directory and its files in it during
85 # recursive traversal.
86 #
87 # XXX: The above sounds like a bug that should be fixed. If notmuch is
88 # creating new directories in the mail store, then it should be
89 # creating all necessary database state for those directories.
90
91 test_begin_subtest "Removing 'S' flag from existing filename adds 'unread' tag"
92 add_message [subject]='"Removing S flag"' [filename]='removing-s-flag:2,S' [dir]=cur
93 output=$(notmuch search subject:"Removing S flag" | notmuch_search_sanitize)
94 output+="
95 "
96 mv "${gen_msg_filename}" "${gen_msg_filename%S}"
97 output+=$(NOTMUCH_NEW)
98 output+="
99 "
100 output+=$(notmuch search subject:"Removing S flag" | notmuch_search_sanitize)
101 test_expect_equal "$output" "thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Removing S flag (inbox)
102 No new mail. Detected 1 file rename.
103 thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Removing S flag (inbox unread)"
104
105 test_begin_subtest "Removing info from filename leaves tags unchanged"
106 add_message [subject]='"Message to lose maildir info"' [filename]='message-to-lose-maildir-info' [dir]=cur
107 notmuch tag -unread subject:"Message to lose maildir info"
108 mv "$MAIL_DIR/cur/message-to-lose-maildir-info:2,S" "$MAIL_DIR/cur/message-without-maildir-info"
109 output=$(NOTMUCH_NEW)
110 output+="
111 "
112 output+=$(notmuch search subject:"Message to lose maildir info" | notmuch_search_sanitize)
113 test_expect_equal "$output" "No new mail. Detected 1 file rename.
114 thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Message to lose maildir info (inbox)"
115
116 add_message [subject]='"Non-maildir message"' [dir]=notmaildir [filename]='non-maildir-message'
117 expected=$(notmuch search --output=files subject:"Non-maildir message")
118 test_expect_success "Can remove unread tag from message in non-maildir directory" 'notmuch tag -unread subject:"Non-maildir message"'
119
120 test_begin_subtest "Message in non-maildir directory does not get renamed"
121 output=$(notmuch search --output=files subject:"Non-maildir message")
122 test_expect_equal "$output" "$expected"
123
124 test_begin_subtest "notmuch dump/restore re-synchronizes maildir tags with flags"
125 # Capture current filename state
126 expected=$(ls $MAIL_DIR/cur)
127 # Add/remove some flags from filenames
128 mv $MAIL_DIR/cur/adding-replied-tag:2,RS $MAIL_DIR/cur/adding-replied-tag:2,S
129 mv $MAIL_DIR/cur/adding-s-flag:2,S $MAIL_DIR/cur/adding-s-flag:2,
130 mv $MAIL_DIR/cur/adding-with-s-flag:2,S $MAIL_DIR/cur/adding-with-s-flag:2,RS
131 mv $MAIL_DIR/cur/message-to-move-to-cur:2,S $MAIL_DIR/cur/message-to-move-to-cur:2,DS
132 notmuch dump dump.txt
133 NOTMUCH_NEW >/dev/null
134 notmuch restore dump.txt
135 output=$(ls $MAIL_DIR/cur)
136 test_expect_equal "$output" "$expected"
137
138 test_begin_subtest 'Adding flags to duplicate message tags the mail'
139 add_message [subject]='"Duplicated message"' [dir]=cur [filename]='duplicated-message:2,'
140 cp "$MAIL_DIR/cur/duplicated-message:2," "$MAIL_DIR/cur/duplicated-message-copy:2,RS"
141 NOTMUCH_NEW > output
142 notmuch search subject:"Duplicated message" | notmuch_search_sanitize >> output
143 test_expect_equal "$(< output)" "No new mail.
144 thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Duplicated message (inbox replied)"
145
146 test_begin_subtest "Adding duplicate message without flags does not remove tags"
147 cp "$MAIL_DIR/cur/duplicated-message-copy:2,RS" "$MAIL_DIR/cur/duplicated-message-another-copy:2,"
148 NOTMUCH_NEW > output
149 notmuch search subject:"Duplicated message" | notmuch_search_sanitize >> output
150 test_expect_equal "$(< output)" "No new mail.
151 thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Duplicated message (inbox replied)"
152
153 test_begin_subtest "Tag changes modify flags of multiple files"
154 notmuch tag -replied subject:"Duplicated message"
155 (cd $MAIL_DIR/cur/; ls duplicated*) > actual
156 test_expect_equal "$(< actual)"  "duplicated-message-another-copy:2,S
157 duplicated-message-copy:2,S
158 duplicated-message:2,S"
159
160 test_begin_subtest "Synchronizing tag changes preserves unsupported maildir flags"
161 add_message [subject]='"Unsupported maildir flags"' [dir]=cur [filename]='unsupported-maildir-flags:2,FSZxyz'
162 notmuch tag +unread +draft -flagged subject:"Unsupported maildir flags"
163 test_expect_equal "$(cd $MAIL_DIR/cur/; ls unsupported*)" "unsupported-maildir-flags:2,DZxyz"
164
165 test_begin_subtest "A file with non-compliant maildir info will not be renamed"
166 add_message [subject]='"Non-compliant maildir info"' [dir]=cur [filename]='non-compliant-maildir-info:2,These-are-not-flags-in-ASCII-order-donottouch'
167 notmuch tag +unread +draft -flagged subject:"Non-compliant maildir info"
168 test_expect_equal "$(cd $MAIL_DIR/cur/; ls non-compliant*)" "non-compliant-maildir-info:2,These-are-not-flags-in-ASCII-order-donottouch"
169
170 test_done