mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-12-27 03:41:41 +01:00
425e2bc812
This switches the new batch-tag format away from using a home-grown hex-encoding scheme for message IDs in the dump to simply using Xapian queries with Xapian quoting syntax. This has a variety of advantages beyond presenting a cleaner and more consistent interface. Foremost is that it will dramatically simplify the quoting for batch tagging, which shares the same input format. While the hex-encoding is no better or worse for the simple ID queries used by dump/restore, it becomes onerous for general-purpose queries used in batch tagging. It also better handles strange cases like "id:foo and bar", since this is no longer syntactically valid.
293 lines
10 KiB
Bash
Executable file
293 lines
10 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
test_description="\"notmuch dump\" and \"notmuch restore\""
|
|
. ./test-lib.sh
|
|
|
|
add_email_corpus
|
|
|
|
test_expect_success 'Dumping all tags' \
|
|
'generate_message &&
|
|
notmuch new &&
|
|
notmuch dump > dump.expected'
|
|
|
|
# The use of from:cworth is rather arbitrary: it matches some of the
|
|
# email corpus' messages, but not all of them.
|
|
|
|
test_expect_success 'Dumping all tags II' \
|
|
'notmuch tag +ABC +DEF -- from:cworth &&
|
|
notmuch dump > dump-ABC_DEF.expected &&
|
|
! cmp dump.expected dump-ABC_DEF.expected'
|
|
|
|
test_expect_success 'Clearing all tags' \
|
|
'sed -e "s/(\([^(]*\))$/()/" < dump.expected > clear.expected &&
|
|
notmuch restore --input=clear.expected &&
|
|
notmuch dump > clear.actual &&
|
|
test_cmp clear.expected clear.actual'
|
|
|
|
test_expect_success 'Accumulate original tags' \
|
|
'notmuch tag +ABC +DEF -- from:cworth &&
|
|
notmuch restore --accumulate < dump.expected &&
|
|
notmuch dump > dump.actual &&
|
|
test_cmp dump-ABC_DEF.expected dump.actual'
|
|
|
|
test_expect_success 'Restoring original tags' \
|
|
'notmuch restore --input=dump.expected &&
|
|
notmuch dump > dump.actual &&
|
|
test_cmp dump.expected dump.actual'
|
|
|
|
test_expect_success 'Restore with nothing to do' \
|
|
'notmuch restore < dump.expected &&
|
|
notmuch dump > dump.actual &&
|
|
test_cmp dump.expected dump.actual'
|
|
|
|
test_expect_success 'Accumulate with existing tags' \
|
|
'notmuch restore --accumulate --input=dump.expected &&
|
|
notmuch dump > dump.actual &&
|
|
test_cmp dump.expected dump.actual'
|
|
|
|
test_expect_success 'Accumulate with no tags' \
|
|
'notmuch restore --accumulate < clear.expected &&
|
|
notmuch dump > dump.actual &&
|
|
test_cmp dump.expected dump.actual'
|
|
|
|
test_expect_success 'Accumulate with new tags' \
|
|
'notmuch restore --input=dump.expected &&
|
|
notmuch restore --accumulate --input=dump-ABC_DEF.expected &&
|
|
notmuch dump > OUTPUT.$test_count &&
|
|
notmuch restore --input=dump.expected &&
|
|
test_cmp dump-ABC_DEF.expected OUTPUT.$test_count'
|
|
|
|
# notmuch restore currently only considers the first argument.
|
|
test_expect_success 'Invalid restore invocation' \
|
|
'test_must_fail notmuch restore --input=dump.expected another_one'
|
|
|
|
test_begin_subtest "dump --output=outfile"
|
|
notmuch dump --output=dump-outfile.actual
|
|
test_expect_equal_file dump.expected dump-outfile.actual
|
|
|
|
test_begin_subtest "dump --output=outfile --"
|
|
notmuch dump --output=dump-1-arg-dash.actual --
|
|
test_expect_equal_file dump.expected dump-1-arg-dash.actual
|
|
|
|
# Note, we assume all messages from cworth have a message-id
|
|
# containing cworth.org
|
|
|
|
grep 'cworth[.]org' dump.expected > dump-cworth.expected
|
|
|
|
test_begin_subtest "dump -- from:cworth"
|
|
notmuch dump -- from:cworth > dump-dash-cworth.actual
|
|
test_expect_equal_file dump-cworth.expected dump-dash-cworth.actual
|
|
|
|
test_begin_subtest "dump --output=outfile from:cworth"
|
|
notmuch dump --output=dump-outfile-cworth.actual from:cworth
|
|
test_expect_equal_file dump-cworth.expected dump-outfile-cworth.actual
|
|
|
|
test_begin_subtest "dump --output=outfile -- from:cworth"
|
|
notmuch dump --output=dump-outfile-dash-inbox.actual -- from:cworth
|
|
test_expect_equal_file dump-cworth.expected dump-outfile-dash-inbox.actual
|
|
|
|
test_begin_subtest "Check for a safe set of message-ids"
|
|
notmuch search --output=messages from:cworth | sed s/^id:// > EXPECTED
|
|
notmuch search --output=messages from:cworth | sed s/^id:// |\
|
|
$TEST_DIRECTORY/hex-xcode --direction=encode > OUTPUT
|
|
test_expect_equal_file OUTPUT EXPECTED
|
|
|
|
test_begin_subtest "format=batch-tag, dump sanity check."
|
|
notmuch dump --format=sup from:cworth | cut -f1 -d' ' | \
|
|
sort > EXPECTED.$test_count
|
|
notmuch dump --format=batch-tag from:cworth | sed 's/^.*-- id://' | \
|
|
sort > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_begin_subtest "format=batch-tag, # round-trip"
|
|
notmuch dump --format=sup | sort > EXPECTED.$test_count
|
|
notmuch dump --format=batch-tag | notmuch restore --format=batch-tag
|
|
notmuch dump --format=sup | sort > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_begin_subtest "format=batch-tag, # blank lines and comments"
|
|
notmuch dump --format=batch-tag| sort > EXPECTED.$test_count
|
|
notmuch restore <<EOF
|
|
# this line is a comment; the next has only white space
|
|
|
|
|
|
# the previous line is empty
|
|
EOF
|
|
notmuch dump --format=batch-tag | sort > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_begin_subtest "format=batch-tag, # reverse-round-trip empty tag"
|
|
cat <<EOF >EXPECTED.$test_count
|
|
+ -- id:20091117232137.GA7669@griffis1.net
|
|
EOF
|
|
notmuch restore --format=batch-tag < EXPECTED.$test_count
|
|
notmuch dump --format=batch-tag id:20091117232137.GA7669@griffis1.net > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
tag1='comic_swear=$&^%$^%\\//-+$^%$'
|
|
enc1=$($TEST_DIRECTORY/hex-xcode --direction=encode "$tag1")
|
|
|
|
tag2=$(printf 'this\n tag\t has\n spaces')
|
|
enc2=$($TEST_DIRECTORY/hex-xcode --direction=encode "$tag2")
|
|
|
|
enc3='%c3%91%c3%a5%c3%b0%c3%a3%c3%a5%c3%a9-%c3%8f%c3%8a'
|
|
tag3=$($TEST_DIRECTORY/hex-xcode --direction=decode $enc3)
|
|
|
|
notmuch dump --format=batch-tag > BACKUP
|
|
|
|
notmuch tag +"$tag1" +"$tag2" +"$tag3" -inbox -unread "*"
|
|
|
|
# initial segment of file used for several tests below.
|
|
cat <<EOF > comments-and-blanks
|
|
# this is a comment
|
|
|
|
# next line has leading whitespace
|
|
|
|
|
|
EOF
|
|
|
|
test_begin_subtest 'restoring empty file is not an error'
|
|
notmuch restore < /dev/null 2>OUTPUT.$test_count
|
|
cp /dev/null EXPECTED
|
|
test_expect_equal_file EXPECTED OUTPUT.$test_count
|
|
|
|
test_begin_subtest 'file of comments and blank lines is not an error'
|
|
notmuch restore --input=comments-and-blanks
|
|
ret_val=$?
|
|
test_expect_equal "$ret_val" "0"
|
|
|
|
cp comments-and-blanks leading-comments-blanks-batch-tag
|
|
echo "+some_tag -- id:yun1vjwegii.fsf@aiko.keithp.com" \
|
|
>> leading-comments-blanks-batch-tag
|
|
|
|
test_begin_subtest 'detect format=batch-tag with leading comments and blanks'
|
|
notmuch restore --input=leading-comments-blanks-batch-tag
|
|
notmuch search --output=tags id:yun1vjwegii.fsf@aiko.keithp.com > OUTPUT.$test_count
|
|
echo "some_tag" > EXPECTED
|
|
test_expect_equal_file EXPECTED OUTPUT.$test_count
|
|
|
|
cp comments-and-blanks leading-comments-blanks-sup
|
|
echo "yun1vjwegii.fsf@aiko.keithp.com (another_tag)" \
|
|
>> leading-comments-blanks-sup
|
|
|
|
test_begin_subtest 'detect format=sup with leading comments and blanks'
|
|
notmuch restore --input=leading-comments-blanks-sup
|
|
notmuch search --output=tags id:yun1vjwegii.fsf@aiko.keithp.com > OUTPUT.$test_count
|
|
echo "another_tag" > EXPECTED
|
|
test_expect_equal_file EXPECTED OUTPUT.$test_count
|
|
|
|
test_begin_subtest 'format=batch-tag, round trip with strange tags'
|
|
notmuch dump --format=batch-tag > EXPECTED.$test_count
|
|
notmuch dump --format=batch-tag | notmuch restore --format=batch-tag
|
|
notmuch dump --format=batch-tag > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_begin_subtest 'format=batch-tag, checking encoded output'
|
|
notmuch dump --format=batch-tag -- from:cworth |\
|
|
awk "{ print \"+$enc1 +$enc2 +$enc3 -- \" \$5 }" > EXPECTED.$test_count
|
|
notmuch dump --format=batch-tag -- from:cworth > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_begin_subtest 'restoring sane tags'
|
|
notmuch restore --format=batch-tag < BACKUP
|
|
notmuch dump --format=batch-tag > OUTPUT.$test_count
|
|
test_expect_equal_file BACKUP OUTPUT.$test_count
|
|
|
|
test_begin_subtest 'format=batch-tag, restore=auto'
|
|
notmuch dump --format=batch-tag > EXPECTED.$test_count
|
|
notmuch tag -inbox -unread "*"
|
|
notmuch restore --format=auto < EXPECTED.$test_count
|
|
notmuch dump --format=batch-tag > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_begin_subtest 'format=sup, restore=auto'
|
|
notmuch dump --format=sup > EXPECTED.$test_count
|
|
notmuch tag -inbox -unread "*"
|
|
notmuch restore --format=auto < EXPECTED.$test_count
|
|
notmuch dump --format=sup > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_begin_subtest 'format=batch-tag, restore=default'
|
|
notmuch dump --format=batch-tag > EXPECTED.$test_count
|
|
notmuch tag -inbox -unread "*"
|
|
notmuch restore < EXPECTED.$test_count
|
|
notmuch dump --format=batch-tag > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_begin_subtest 'format=sup, restore=default'
|
|
notmuch dump --format=sup > EXPECTED.$test_count
|
|
notmuch tag -inbox -unread "*"
|
|
notmuch restore < EXPECTED.$test_count
|
|
notmuch dump --format=sup > OUTPUT.$test_count
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_begin_subtest 'restore: checking error messages'
|
|
notmuch restore <<EOF 2>OUTPUT
|
|
# the next line has a space
|
|
|
|
a
|
|
+0
|
|
+a +b
|
|
# trailing whitespace
|
|
+a +b
|
|
+c +d --
|
|
# this is a harmless comment, do not yell about it.
|
|
|
|
# the previous line was blank; also no yelling please
|
|
+%zz -- id:whatever
|
|
+e +f id:"
|
|
+e +f tag:abc
|
|
# the next non-comment line should report an an empty tag error for
|
|
# batch tagging, but not for restore
|
|
+ +e -- id:20091117232137.GA7669@griffis1.net
|
|
# valid id, but warning about missing message
|
|
+e id:missing_message_id
|
|
# exercise parser
|
|
+e -- id:some)stuff
|
|
+e -- id:some stuff
|
|
+e -- id:some"stuff
|
|
+e -- id:"a_message_id_with""_a_quote"
|
|
+e -- id:"a message id with spaces"
|
|
+e -- id:an_id_with_leading_and_trailing_ws \
|
|
|
|
EOF
|
|
|
|
cat <<EOF > EXPECTED
|
|
Warning: cannot parse query: a (skipping)
|
|
Warning: no query string [+0]
|
|
Warning: no query string [+a +b]
|
|
Warning: missing query string [+a +b ]
|
|
Warning: no query string after -- [+c +d --]
|
|
Warning: hex decoding of tag %zz failed [+%zz -- id:whatever]
|
|
Warning: cannot parse query: id:" (skipping)
|
|
Warning: not an id query: tag:abc (skipping)
|
|
Warning: cannot apply tags to missing message: missing_message_id
|
|
Warning: cannot parse query: id:some)stuff (skipping)
|
|
Warning: cannot parse query: id:some stuff (skipping)
|
|
Warning: cannot apply tags to missing message: some"stuff
|
|
Warning: cannot apply tags to missing message: a_message_id_with"_a_quote
|
|
Warning: cannot apply tags to missing message: a message id with spaces
|
|
Warning: cannot apply tags to missing message: an_id_with_leading_and_trailing_ws
|
|
EOF
|
|
|
|
test_expect_equal_file EXPECTED OUTPUT
|
|
|
|
test_begin_subtest 'roundtripping random message-ids and tags'
|
|
|
|
${TEST_DIRECTORY}/random-corpus --config-path=${NOTMUCH_CONFIG} \
|
|
--num-messages=100
|
|
|
|
notmuch dump --format=batch-tag| \
|
|
sort > EXPECTED.$test_count
|
|
|
|
notmuch tag +this_tag_is_very_unlikely_to_be_random '*'
|
|
|
|
notmuch restore --format=batch-tag < EXPECTED.$test_count
|
|
|
|
notmuch dump --format=batch-tag| \
|
|
sort > OUTPUT.$test_count
|
|
|
|
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
|
|
|
|
test_done
|
|
|
|
# Note the database is "poisoned" for sup format at this point.
|