#!/bin/bash
set -e

# Messages contain time/date values with time zone and notmuch
# displays them converted to the local time zone. We need to set fixed
# timezone here so that the output of the tests is always the same
# without regard to the time zone of where the test suite is run.
export TZ=UTC+8

TEST_COLLECTION_DIR="$(dirname $(readlink -f $0))/tests"

TEST_COLLECTIONS="notmuch-new
notmuch-search
json
thread-naming
notmuch-reply
uuencoded
notmuch-dump-restore
out-of-order-threading
author-reordering
from-guessing-multiple
from-guessing-single"

find_notmuch_binary ()
{
    dir=$1

    while [ -n "$dir" ]; do
	bin=$dir/notmuch
	if [ -x $bin ]; then
	    echo $bin
	    return
	fi
	dir=$(dirname $dir)
	if [ "$dir" = "/" ]; then
	    break
	fi
    done

    echo notmuch
}

increment_mtime_amount=0
increment_mtime ()
{
    dir=$1

    increment_mtime_amount=$((increment_mtime_amount + 1))
    touch -d "+${increment_mtime_amount} seconds" $dir
}

# Generate a new message in the mail directory, with a unique message
# ID and subject. The message is not added to the index.
#
# After this function returns, the filename of the generated message
# is available as $gen_msg_filename and the message ID is available as
# $gen_msg_id .
#
# This function supports named parameters with the bash syntax for
# assigning a value to an associative array ([name]=value). The
# supported parameters are:
#
#  [dir]=directory/of/choice
#
#	Generate the message in directory 'directory/of/choice' within
#	the mail store. The directory will be created if necessary.
#
#  [body]=text
#
#	Text to use as the body of the email message
#
#  '[from]="Some User <user@example.com>"'
#  '[to]="Some User <user@example.com>"'
#  '[subject]="Subject of email message"'
#  '[date]="RFC 822 Date"'
#
#	Values for email headers. If not provided, default values will
#	be generated instead.
#
#  '[cc]="Some User <user@example.com>"'
#  [reply-to]=some-address
#  [in-reply-to]=<message-id>
#  '[header]=full header line, including keyword'
#
#	Additional values for email headers. If these are not provided
#	then the relevant headers will simply not appear in the
#	message.
#
#  '[id]=<message-id>'
#
#	Controls the message-id of the created message.
gen_msg_cnt=0
gen_msg_filename=""
gen_msg_id=""
generate_message ()
{
    # This is our (bash-specific) magic for doing named parameters
    local -A template="($@)"
    local additional_headers

    if [ -z "${template[id]}" ]; then
	gen_msg_cnt=$((gen_msg_cnt + 1))
	gen_msg_name=msg-$(printf "%03d" $gen_msg_cnt)
	gen_msg_id="${gen_msg_name}@notmuch-test-suite"
    else
	gen_msg_name="msg-${template[id]}"
	gen_msg_id="${template[id]}"
    fi

    if [ -z "${template[dir]}" ]; then
	gen_msg_filename="${MAIL_DIR}/$gen_msg_name"
    else
	gen_msg_filename="${MAIL_DIR}/${template[dir]}/$gen_msg_name"
	mkdir -p $(dirname $gen_msg_filename)
    fi

    if [ -z "${template[body]}" ]; then
	template[body]="This is just a test message (#${gen_msg_cnt})"
    fi

    if [ -z "${template[from]}" ]; then
	template[from]="Notmuch Test Suite <test_suite@notmuchmail.org>"
    fi

    if [ -z "${template[to]}" ]; then
	template[to]="Notmuch Test Suite <test_suite@notmuchmail.org>"
    fi

    if [ -z "${template[subject]}" ]; then
	template[subject]="Test message #${gen_msg_cnt}"
    fi

    if [ -z "${template[date]}" ]; then
	template[date]="Tue, 05 Jan 2001 15:43:57 -0800"
    fi

    additional_headers=""
    if [ ! -z "${template[header]}" ]; then
	additional_headers="${template[header]}
${additional_headers}"
    fi

    if [ ! -z "${template[reply-to]}" ]; then
	additional_headers="Reply-To: ${template[reply-to]}
${additional_headers}"
    fi

    if [ ! -z "${template[in-reply-to]}" ]; then
	additional_headers="In-Reply-To: ${template[in-reply-to]}
${additional_headers}"
    fi

    if [ ! -z "${template[cc]}" ]; then
	additional_headers="Cc: ${template[cc]}
${additional_headers}"
    fi


cat <<EOF >$gen_msg_filename
From: ${template[from]}
To: ${template[to]}
Message-Id: <${gen_msg_id}>
Subject: ${template[subject]}
Date: ${template[date]}
${additional_headers}
${template[body]}
EOF

    # Ensure that the mtime of the containing directory is updated
    increment_mtime $(dirname ${gen_msg_filename})
}

# Generate a new message and add it to the index.
#
# All of the arguments and return values supported by generate_message
# are also supported here, so see that function for details.
add_message ()
{
    generate_message "$@"

    $NOTMUCH new > /dev/null
}

tests=0
test_failures=0

pass_if_equal ()
{
    output=$1
    expected=$2

    tests=$((tests + 1))

    if [ "$output" = "$expected" ]; then
	echo "	PASS"
    else
	echo "	FAIL"
	testname=test-$(printf "%03d" $tests)
	echo "$expected" > $testname.expected
	echo "$output" > $testname.output
	diff -u $testname.expected $testname.output || true
	test_failures=$((test_failures + 1))
    fi
}

TEST_DIR=$(pwd)/test.$$
MAIL_DIR=${TEST_DIR}/mail
export NOTMUCH_CONFIG=${TEST_DIR}/notmuch-config
NOTMUCH=$(find_notmuch_binary $(pwd))

NOTMUCH_NEW ()
{
    $NOTMUCH new | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
}

notmuch_search_sanitize ()
{
    sed -r -e 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
}

NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
notmuch_show_sanitize ()
{
    sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
}

initialize_notmuch_test ()
{
    rm -rf ${TEST_DIR}
    mkdir ${TEST_DIR}
    cd ${TEST_DIR}

    mkdir ${MAIL_DIR}

    cat <<EOF > ${NOTMUCH_CONFIG}
[database]
path=${MAIL_DIR}

[user]
name=Notmuch Test Suite
primary_email=test_suite@notmuchmail.org
other_email=test_suite_other@notmuchmail.org;test_suite@otherdomain.org
EOF
}

run_collection_setup_and_tests ()
{
    for testfile in $(find ${TEST_COLLECTION_DIR}/$1 \
	-name "*.test" -o -name "*.setup" |
	sort -n);
    do
	source $testfile
    done
}

run_test_suite ()
{
    initialize_notmuch_test;

    if [ "$#" = "0" -o "$1" = "all" ]; then
	for dir in $(echo ${TEST_COLLECTIONS}); do
	    run_collection_setup_and_tests "$(basename ${dir})";
	done;
    elif [ ! -d "${TEST_COLLECTION_DIR}/$1" ]; then
	echo "${TEST_COLLECTION_DIR}/$1 is not a directory"
	exit
    else
	run_collection_setup_and_tests "$1";
    fi
}

run_test_suite $1

echo ""
echo "Notmuch test suite complete."

if [ "$test_failures" = "0" ]; then
    echo "All $tests tests passed."
    rm -rf ${TEST_DIR}
else
    echo "$test_failures/$tests tests failed. The failures can be investigated in:"
    echo "${TEST_DIR}"
fi

echo ""

exit $test_failures