debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-21 18:38:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/test/dump-restore

239 lines
8.5 KiB
Text
Raw Normal View History

test: change "#!/bin/bash" to "#!/usr/bin/env bash" enhances portability Change #!/bin/bash at start of tests to "#!/usr/bin/env bash". That way systems running on bash < 4 can prepend bash >= 4 to path before running the tests.
2010-12-01 21:27:52 +01:00
#!/usr/bin/env bash
Convert the actual tests to the new framework The changes are: - The notmuch-test was split into several files (t000?-*.sh). - Removed helper functions which were moved to test-lib.sh - Replaced every printf with test_expect_success. - Test commands chained with && (test-lib.sh doesn't use "set -e" in order to complete the test suite even if something fails) - Many variables such as ${MAIL_DIR} were properly quoted as they contain spaces. - Changed quoting patterns in add_message and generate_message (single quotes are already used by the test framework). - ${TEST_DIR} replaced by ${PWD} QUICK HOWTO: To run the whole test suite make To run only a single test ./t0001-new.sh To stop on the first error ./t0001-new.sh -i then mail store and database can be inspected in "trash directory.t0001-new" To see the output of tests ./t0001-new.sh -v To not remove trash directory at the end: ./t0001-new.sh -d To run all tests verbosely: make GIT_TEST_OPTS="-v" Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>
2010-06-10 08:48:03 +02:00
test_description="\"notmuch dump\" and \"notmuch restore\""
. ./test-lib.sh
test: Fix the search and dump-restore tests to operator on non-empty mail store. We do this with a new add_email_corpus function that establishes a mail store with 50 messages from the notmuch mailing list.
2010-09-21 01:40:35 +02:00
add_email_corpus
test/dump-restore: expand test suite for dump-restore, make more robust Several new tests are added, and existing use of test_begin_subtest is replaced by test_expect_success to catch failing commands in cases where we execute more than one command. Based on changes in id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-19 23:03:12 +02:00
test_expect_success 'Dumping all tags' \
'generate_message &&
notmuch new &&
notmuch dump > dump.expected'
test/dump-restore: add tests for restore --accumulate Flesh out what ``notmuch restore --accumulate'' is supposed to do. Its tests are currently XFAILed; the functionality will be added in future patch(es). Based on a patch by Thomas Schwinge: id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-21 18:04:46 +02:00
# 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/dump-restore: expand test suite for dump-restore, make more robust Several new tests are added, and existing use of test_begin_subtest is replaced by test_expect_success to catch failing commands in cases where we execute more than one command. Based on changes in id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-19 23:03:12 +02:00
test_expect_success 'Clearing all tags' \
'sed -e "s/(\([^(]*\))$/()/" < dump.expected > clear.expected &&
notmuch-restore: replace positional argument for input with option Since notmuch dump doesn't use positional arguments anymore, it seems better to be consistent.
2012-08-04 14:55:45 +02:00
notmuch restore --input=clear.expected &&
test/dump-restore: expand test suite for dump-restore, make more robust Several new tests are added, and existing use of test_begin_subtest is replaced by test_expect_success to catch failing commands in cases where we execute more than one command. Based on changes in id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-19 23:03:12 +02:00
notmuch dump > clear.actual &&
test_cmp clear.expected clear.actual'
test/dump-restore: add tests for restore --accumulate Flesh out what ``notmuch restore --accumulate'' is supposed to do. Its tests are currently XFAILed; the functionality will be added in future patch(es). Based on a patch by Thomas Schwinge: id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-21 18:04:46 +02:00
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/dump-restore: expand test suite for dump-restore, make more robust Several new tests are added, and existing use of test_begin_subtest is replaced by test_expect_success to catch failing commands in cases where we execute more than one command. Based on changes in id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-19 23:03:12 +02:00
test_expect_success 'Restoring original tags' \
notmuch-restore: replace positional argument for input with option Since notmuch dump doesn't use positional arguments anymore, it seems better to be consistent.
2012-08-04 14:55:45 +02:00
'notmuch restore --input=dump.expected &&
test/dump-restore: expand test suite for dump-restore, make more robust Several new tests are added, and existing use of test_begin_subtest is replaced by test_expect_success to catch failing commands in cases where we execute more than one command. Based on changes in id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-19 23:03:12 +02:00
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: add more informative titles to restore --accumulate tests Thanks to Ethan for the suggestion.
2012-11-17 15:18:00 +01:00
test_expect_success 'Accumulate with existing tags' \
notmuch-restore: replace positional argument for input with option Since notmuch dump doesn't use positional arguments anymore, it seems better to be consistent.
2012-08-04 14:55:45 +02:00
'notmuch restore --accumulate --input=dump.expected &&
test/dump-restore: add tests for restore --accumulate Flesh out what ``notmuch restore --accumulate'' is supposed to do. Its tests are currently XFAILed; the functionality will be added in future patch(es). Based on a patch by Thomas Schwinge: id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-21 18:04:46 +02:00
notmuch dump > dump.actual &&
test_cmp dump.expected dump.actual'
test: add more informative titles to restore --accumulate tests Thanks to Ethan for the suggestion.
2012-11-17 15:18:00 +01:00
test_expect_success 'Accumulate with no tags' \
test/dump-restore: add tests for restore --accumulate Flesh out what ``notmuch restore --accumulate'' is supposed to do. Its tests are currently XFAILed; the functionality will be added in future patch(es). Based on a patch by Thomas Schwinge: id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-21 18:04:46 +02:00
'notmuch restore --accumulate < clear.expected &&
notmuch dump > dump.actual &&
test_cmp dump.expected dump.actual'
test: add nontrivial test for restore --accumulate. It seems we have never tested the case that restore --accumulate actually adds tags. I noticed this when I started optimizing and no tests failed. The bracketing with "restore --input=dump.expected" are to make sure we start in a known state, and we leave the database in a known state for the next test.
2012-11-16 13:31:19 +01:00
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'
test/dump-restore: expand test suite for dump-restore, make more robust Several new tests are added, and existing use of test_begin_subtest is replaced by test_expect_success to catch failing commands in cases where we execute more than one command. Based on changes in id:"1317317811-29540-1-git-send-email-thomas@schwinge.name"
2011-10-19 23:03:12 +02:00
# notmuch restore currently only considers the first argument.
test_expect_success 'Invalid restore invocation' \
notmuch-restore: replace positional argument for input with option Since notmuch dump doesn't use positional arguments anymore, it seems better to be consistent.
2012-08-04 14:55:45 +02:00
'test_must_fail notmuch restore --input=dump.expected another_one'
test: Rework test-suite input to avoid ulti-command strings The original git test suite works by concatenating many commands into a very long string (each separated by &&). This is painful to work with since it prevents the editor from helping by parsing the shell script, indenting, colorizing, etc. Instead, we switch this back to something like the original notmuch test suite, and add two new functions to test-lib.sh (test_begin_subtest and test_expect_equal) to support these. This also fixes the test suite to once again display the diff when a test fails to generate the expected input.
2010-09-18 00:25:39 +02:00
notmuch-dump: remove deprecated positional argument for output file The syntax --output=filename is a smaller change than deleting the output argument completely, and conceivably useful e.g. when running notmuch under a debugger.
2012-08-04 04:23:11 +02:00
test_begin_subtest "dump --output=outfile"
notmuch dump --output=dump-outfile.actual
test: add tests for command line arguments to notmuch-dump The plan is to add the possibility of search terms after the file name, and the use of -- to stop looking for an output file name.
2011-10-10 14:27:20 +02:00
test_expect_equal_file dump.expected dump-outfile.actual
notmuch-dump: remove deprecated positional argument for output file The syntax --output=filename is a smaller change than deleting the output argument completely, and conceivably useful e.g. when running notmuch under a debugger.
2012-08-04 04:23:11 +02:00
test_begin_subtest "dump --output=outfile --"
notmuch dump --output=dump-1-arg-dash.actual --
test: add tests for command line arguments to notmuch-dump The plan is to add the possibility of search terms after the file name, and the use of -- to stop looking for an output file name.
2011-10-10 14:27:20 +02:00
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
test/dump-restore: Fix quoting on grep Thanks to Thomas Schwinge for noticing yet another place where quoting matters. Since the shell translates \. to ., the regex passed to grep is too generous without the quotes. The use of [.] is the suggestion of Tomi Ollila.
2011-10-21 02:14:30 +02:00
grep 'cworth[.]org' dump.expected > dump-cworth.expected
test: add tests for command line arguments to notmuch-dump The plan is to add the possibility of search terms after the file name, and the use of -- to stop looking for an output file name.
2011-10-10 14:27:20 +02:00
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
notmuch-dump: remove deprecated positional argument for output file The syntax --output=filename is a smaller change than deleting the output argument completely, and conceivably useful e.g. when running notmuch under a debugger.
2012-08-04 04:23:11 +02:00
test_begin_subtest "dump --output=outfile from:cworth"
notmuch dump --output=dump-outfile-cworth.actual from:cworth
test: add tests for command line arguments to notmuch-dump The plan is to add the possibility of search terms after the file name, and the use of -- to stop looking for an output file name.
2011-10-10 14:27:20 +02:00
test_expect_equal_file dump-cworth.expected dump-outfile-cworth.actual
notmuch-dump: remove deprecated positional argument for output file The syntax --output=filename is a smaller change than deleting the output argument completely, and conceivably useful e.g. when running notmuch under a debugger.
2012-08-04 04:23:11 +02:00
test_begin_subtest "dump --output=outfile -- from:cworth"
notmuch dump --output=dump-outfile-dash-inbox.actual -- from:cworth
test: add tests for command line arguments to notmuch-dump The plan is to add the possibility of search terms after the file name, and the use of -- to stop looking for an output file name.
2011-10-10 14:27:20 +02:00
test_expect_equal_file dump-cworth.expected dump-outfile-dash-inbox.actual
test: add sanity check for dump --format=batch-tag. It's important this does not rely on restore, since it hasn't been written yet.
2012-12-05 03:48:37 +01:00
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: second set of dump/restore --format=batch-tag tests These one need the completed functionality in notmuch-restore. Fairly exotic tags are tested, but no weird message id's. We test each possible input to autodetection, both explicit (with --format=auto) and implicit (without --format).
2012-11-24 22:20:15 +01:00
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 "*"
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/dump-restore: add test for warning/error messages We want to test both that error/warning messages are generated when they should be, and not generated when they should not be. This varies between restore and batch tagging.
2012-12-08 13:34:00 +01:00
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:%yy
# 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
# highlight the sketchy id parsing; this should be last
+g -- id:foo and bar
EOF
cat <<EOF > EXPECTED
Warning: unsupported query: a
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: hex decoding of query id:%yy failed [+e +f id:%yy]
Warning: cannot apply tags to missing message: foo and bar
EOF
test_expect_equal_file EXPECTED OUTPUT
test: add broken roundtrip test We demonstrate the current notmuch restore parser being confused by message-id's and tags containing non alpha numeric characters (particularly space and parentheses are problematic because they are not escaped by notmuch dump). We save the files as hex escaped on disk so that terminal emulators will not get confused if the test fails (as we mostly expect it to do).
2012-08-05 20:13:13 +02:00
test_begin_subtest 'roundtripping random message-ids and tags'
test: update dump-restore roundtripping test for batch-tag format Now we can actually round trip these crazy tags and and message ids. hex-xcode is no longer needed as it's built in.
2011-12-13 04:22:53 +01:00
test: add broken roundtrip test We demonstrate the current notmuch restore parser being confused by message-id's and tags containing non alpha numeric characters (particularly space and parentheses are problematic because they are not escaped by notmuch dump). We save the files as hex escaped on disk so that terminal emulators will not get confused if the test fails (as we mostly expect it to do).
2012-08-05 20:13:13 +02:00
${TEST_DIRECTORY}/random-corpus --config-path=${NOTMUCH_CONFIG} \
test: update dump-restore roundtripping test for batch-tag format Now we can actually round trip these crazy tags and and message ids. hex-xcode is no longer needed as it's built in.
2011-12-13 04:22:53 +01:00
--num-messages=100
test: add broken roundtrip test We demonstrate the current notmuch restore parser being confused by message-id's and tags containing non alpha numeric characters (particularly space and parentheses are problematic because they are not escaped by notmuch dump). We save the files as hex escaped on disk so that terminal emulators will not get confused if the test fails (as we mostly expect it to do).
2012-08-05 20:13:13 +02:00
test: update dump-restore roundtripping test for batch-tag format Now we can actually round trip these crazy tags and and message ids. hex-xcode is no longer needed as it's built in.
2011-12-13 04:22:53 +01:00
notmuch dump --format=batch-tag| \
test: add broken roundtrip test We demonstrate the current notmuch restore parser being confused by message-id's and tags containing non alpha numeric characters (particularly space and parentheses are problematic because they are not escaped by notmuch dump). We save the files as hex escaped on disk so that terminal emulators will not get confused if the test fails (as we mostly expect it to do).
2012-08-05 20:13:13 +02:00
sort > EXPECTED.$test_count
notmuch tag +this_tag_is_very_unlikely_to_be_random '*'
test: update dump-restore roundtripping test for batch-tag format Now we can actually round trip these crazy tags and and message ids. hex-xcode is no longer needed as it's built in.
2011-12-13 04:22:53 +01:00
notmuch restore --format=batch-tag < EXPECTED.$test_count
test: add broken roundtrip test We demonstrate the current notmuch restore parser being confused by message-id's and tags containing non alpha numeric characters (particularly space and parentheses are problematic because they are not escaped by notmuch dump). We save the files as hex escaped on disk so that terminal emulators will not get confused if the test fails (as we mostly expect it to do).
2012-08-05 20:13:13 +02:00
test: update dump-restore roundtripping test for batch-tag format Now we can actually round trip these crazy tags and and message ids. hex-xcode is no longer needed as it's built in.
2011-12-13 04:22:53 +01:00
notmuch dump --format=batch-tag| \
test: add broken roundtrip test We demonstrate the current notmuch restore parser being confused by message-id's and tags containing non alpha numeric characters (particularly space and parentheses are problematic because they are not escaped by notmuch dump). We save the files as hex escaped on disk so that terminal emulators will not get confused if the test fails (as we mostly expect it to do).
2012-08-05 20:13:13 +02:00
sort > OUTPUT.$test_count
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count
Convert the actual tests to the new framework The changes are: - The notmuch-test was split into several files (t000?-*.sh). - Removed helper functions which were moved to test-lib.sh - Replaced every printf with test_expect_success. - Test commands chained with && (test-lib.sh doesn't use "set -e" in order to complete the test suite even if something fails) - Many variables such as ${MAIL_DIR} were properly quoted as they contain spaces. - Changed quoting patterns in add_message and generate_message (single quotes are already used by the test framework). - ${TEST_DIR} replaced by ${PWD} QUICK HOWTO: To run the whole test suite make To run only a single test ./t0001-new.sh To stop on the first error ./t0001-new.sh -i then mail store and database can be inspected in "trash directory.t0001-new" To see the output of tests ./t0001-new.sh -v To not remove trash directory at the end: ./t0001-new.sh -d To run all tests verbosely: make GIT_TEST_OPTS="-v" Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>
2010-06-10 08:48:03 +02:00
test_done
test: update dump-restore roundtripping test for batch-tag format Now we can actually round trip these crazy tags and and message ids. hex-xcode is no longer needed as it's built in.
2011-12-13 04:22:53 +01:00
# Note the database is "poisoned" for sup format at this point.
Reference in a new issue Copy permalink