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