#!/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 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 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 'Restore with nothing to do, II' \
  'notmuch restore --accumulate dump.expected &&
  notmuch dump > dump.actual &&
  test_cmp dump.expected dump.actual'

test_expect_success 'Restore with nothing to do, III' \
  'notmuch restore --accumulate < clear.expected &&
  notmuch dump > dump.actual &&
  test_cmp dump.expected dump.actual'

# notmuch restore currently only considers the first argument.
test_expect_success 'Invalid restore invocation' \
  'test_must_fail notmuch restore dump.expected another_one'

test_begin_subtest "dump outfile"
notmuch dump dump-outfile.actual
test_expect_equal_file dump.expected dump-outfile.actual

test_begin_subtest "dump outfile # deprecated"
test_expect_equal "Warning: the output file argument of dump is deprecated."\
  "$(notmuch dump /dev/null 2>&1)"

test_begin_subtest "dump outfile --"
notmuch dump 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 outfile from:cworth"
notmuch dump dump-outfile-cworth.actual from:cworth
test_expect_equal_file dump-cworth.expected dump-outfile-cworth.actual

test_begin_subtest "dump outfile -- from:cworth"
notmuch dump 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 > EXPECTED.$test_count
notmuch search --output=messages from:cworth |\
	$TEST_DIRECTORY/hex-xcode --direction=encode > OUTPUT.$test_count
test_expect_equal_file OUTPUT.$test_count EXPECTED.$test_count

# we have observed that cworth has sane message-ids, and hopefully sane tags.
test_begin_subtest "dump --format=notmuch -- from:cworth"
notmuch dump --format=sup -- from:cworth | tr -d \(\) > EXPECTED.$test_count
notmuch dump --format=notmuch -- from:cworth > OUTPUT.$test_count
test_expect_equal_file OUTPUT.$test_count EXPECTED.$test_count

test_begin_subtest "format=notmuch, # round-trip"
notmuch dump --format=sup | sort > EXPECTED.$test_count
notmuch dump --format=notmuch | notmuch restore --format=notmuch
notmuch dump --format=sup | sort > 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=notmuch > BACKUP

notmuch tag +"$tag1" +"$tag2" +"$tag3" -inbox -unread "*"

test_begin_subtest 'format=notmuch, round trip with strange tags'
    notmuch dump --format=notmuch > EXPECTED.$test_count
    notmuch dump --format=notmuch | notmuch restore --format=notmuch
    notmuch dump --format=notmuch > OUTPUT.$test_count
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count

test_begin_subtest 'format=notmuch, checking encoded output'
    cp /dev/null EXPECTED.$test_count
    notmuch dump --format=notmuch -- from:cworth |\
	 awk "{ print \$1 \" $enc1 $enc2 $enc3\" }" > EXPECTED.$test_count

    notmuch dump --format=notmuch -- from:cworth  > OUTPUT.$test_count
test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count

test_begin_subtest 'restoring sane tags'
    notmuch restore --format=notmuch < BACKUP
    notmuch dump --format=notmuch > OUTPUT.$test_count
test_expect_equal_file BACKUP OUTPUT.$test_count

test_begin_subtest 'format=notmuch, restore=auto'
    notmuch dump --format=notmuch > EXPECTED.$test_count
    notmuch tag -inbox -unread "*"
    notmuch restore --format=auto < EXPECTED.$test_count
    notmuch dump --format=notmuch > 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=notmuch, restore=default'
    notmuch dump --format=notmuch > EXPECTED.$test_count
    notmuch tag -inbox -unread "*"
    notmuch restore < EXPECTED.$test_count
    notmuch dump --format=notmuch > 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 'random message-ids and tags'

     count=0

    ${TEST_DIRECTORY}/random-dump sort > EXPECTED.$test_count

    while read id tags ; do
	file=${MAIL_DIR}/cur/dump-$count:2,
	count=$((count + 1))
	printf 'From: dump-test@example.com\n' > ${file}
	printf 'To: example@example.net\n' > ${file}
	printf 'Subject: StrangeMessageIDsAndTags\n' > ${file}
	# the missing angle-braces are intentional, since they trigger
	# gmime to pass the message-id through unparsed.
	printf 'Message-Id: ' >> $file
	${TEST_DIRECTORY}/hex-xcode --direction=decode $id >> $file
    done < EXPECTED.$test_count

    notmuch new
    notmuch restore < EXPECTED.$test_count
    notmuch dump --format=notmuch -- subject:StrangeMessageIDsAndTags | \
	sed 's/ *$//' | sort > OUTPUT.$test_count

test_expect_equal_file EXPECTED.$test_count OUTPUT.$test_count

test_done