notmuch/test/notmuch-test

#!/bin/sh
set -e

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
}

# Generate a new message in the mail directory, with
# a unique message ID and subject.
#
# The filename of the message generated is available as
# $gen_msg_filename
gen_msg_cnt=0
gen_msg_filename=""
generate_message ()
{
    gen_msg_cnt=$((gen_msg_cnt + 1))
    gen_msg_name=msg-$(printf "%03d" $gen_msg_cnt)

    if [ "$#" = "0" ]; then
	gen_msg_filename="${MAIL_DIR}/$gen_msg_name"
    else
	gen_msg_filename="${MAIL_DIR}/$1/$gen_msg_name"
	mkdir -p $(dirname $gen_msg_filename)
    fi

cat <<EOF >$gen_msg_filename
From: Notmuch Test Suite <test_suite@notmuchmail.org>
To: Notmuch Test Suite <test_suite@notmuchmail.org>
Message-Id: <msg-${gen_msg_cnt}@notmuch-test-suite>
Subject: Test message ${gen_msg_filename}
Date: Tue, 05 Jan 2010 15:43:57 -0800

This is just a test message at ${gen_msg_filename}
EOF
}

do_sleep ()
{
    sleep 1
}

NOTMUCH_IGNORED_OUTPUT_REGEXP='^Processed [0-9]*( total)? file|Found [0-9]* total file'

execute_expecting ()
{
    args=$1
    expected=$2

    output=$($NOTMUCH $args | grep -v -E -e "$NOTMUCH_IGNORED_OUTPUT_REGEXP")
    if [ "$output" = "$expected" ]; then
	echo "	PASS"
    else
	echo "	FAIL"
	echo "	Expected output: $expected"
	echo "	Actual output:   $output"
    fi
}

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

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
EOF

printf "Testing \"notmuch new\" in several variations:\n"
printf " No new messages...\t\t"
execute_expecting new "No new mail."

printf " Single new message...\t\t"
do_sleep
generate_message
execute_expecting new "Added 1 new message to the database."

printf " Multiple new messages...\t"
do_sleep
generate_message
generate_message
execute_expecting new "Added 2 new messages to the database."

printf " No new messages (non-empty DB)... "
execute_expecting new "No new mail."

printf " New directories...\t\t"
rm -rf ${MAIL_DIR}/* ${MAIL_DIR}/.notmuch
mkdir ${MAIL_DIR}/def
mkdir ${MAIL_DIR}/ghi
generate_message def

execute_expecting new "Added 1 new message to the database."

printf " Alternate inode order...\t"

rm -rf ${MAIL_DIR}/.notmuch
mv ${MAIL_DIR}/ghi ${MAIL_DIR}/abc
rm ${MAIL_DIR}/def/*
generate_message abc

execute_expecting new "Added 1 new message to the database."

printf " Message moved in...\t\t"
rm -rf ${MAIL_DIR}/* ${MAIL_DIR}/.notmuch
generate_message
tmp_msg_filename=tmp/$gen_msg_filename
mkdir -p $(dirname $tmp_msg_filename)
mv $gen_msg_filename $tmp_msg_filename
do_sleep
$NOTMUCH new > /dev/null
do_sleep
mv $tmp_msg_filename $gen_msg_filename
execute_expecting new "Added 1 new message to the database."

printf " Renamed message...\t\t"

do_sleep
generate_message
$NOTMUCH new > /dev/null
do_sleep
mv $gen_msg_filename ${gen_msg_filename}-renamed
execute_expecting new "No new mail. Detected 1 file rename."

printf " Deleted message...\t\t"

do_sleep
rm ${gen_msg_filename}-renamed
execute_expecting new "No new mail. Removed 1 message."

printf " Renamed directory...\t\t"

do_sleep
generate_message dir
generate_message dir
generate_message dir

$NOTMUCH new > /dev/null

do_sleep
mv ${MAIL_DIR}/dir ${MAIL_DIR}/dir-renamed

execute_expecting new "No new mail. Detected 3 file renames."

printf " Deleted directory...\t\t"

do_sleep
rm -rf ${MAIL_DIR}/dir-renamed

execute_expecting new "No new mail. Removed 3 messages."

printf " New directory (at end of list)... "

do_sleep
generate_message zzz
generate_message zzz
generate_message zzz

execute_expecting new "Added 3 new messages to the database."

printf " Deleted directory (end of list)... "

do_sleep
rm -rf ${MAIL_DIR}/zzz

execute_expecting new "No new mail. Removed 3 messages."

printf " New symlink to directory...\t"

rm -rf ${MAIL_DIR}/.notmuch
mv ${MAIL_DIR} ${TEST_DIR}/actual_maildir

mkdir ${MAIL_DIR}
ln -s ${TEST_DIR}/actual_maildir ${MAIL_DIR}/symlink

execute_expecting new "Added 1 new message to the database."

printf " New symlink to a file...\t"
do_sleep
generate_message
external_msg_filename=${TEST_DIR}/external/$(basename $gen_msg_filename)
mkdir -p $(dirname $external_msg_filename)
mv $gen_msg_filename $external_msg_filename
ln -s $external_msg_filename $gen_msg_filename

execute_expecting new "Added 1 new message to the database."

printf " New two-level directory...\t"

do_sleep
generate_message two/levels
generate_message two/levels
generate_message two/levels

execute_expecting new "Added 3 new messages to the database."

printf " Deleted two-level directory... "

do_sleep
rm -rf ${MAIL_DIR}/two

execute_expecting new "No new mail. Removed 3 messages."

cat <<EOF
Notmuch test suite complete.

Intermediate state can be examined in:
	${TEST_DIR}
EOF