test: implement and document NOTMUCH_TEST_QUIET variable usage

[notmuch] / test / test-lib.sh

#
# Copyright (c) 2005 Junio C Hamano
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see http://www.gnu.org/licenses/ .

if [ ${BASH_VERSINFO[0]} -lt 4 ]; then
    echo "Error: The notmuch test suite requires a bash version >= 4.0"
    echo "due to use of associative arrays within the test suite."
    echo "Please try again with a newer bash (or help us fix the"
    echo "test suite to be more portable). Thanks."
    exit 1
fi

# Make sure echo builtin does not expand backslash-escape sequences by default.
shopt -u xpg_echo

this_test=${0##*/}
this_test=${this_test%.sh}

# if --tee was passed, write the output not only to the terminal, but
# additionally to the file test-results/$BASENAME.out, too.
case "$GIT_TEST_TEE_STARTED, $* " in
done,*)
        # do not redirect again
        ;;
*' --tee '*|*' --va'*)
        mkdir -p test-results
        BASE=test-results/$this_test
        (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
         echo $? > $BASE.exit) | tee $BASE.out
        test "$(cat $BASE.exit)" = 0
        exit
        ;;
esac

# Keep the original TERM for say_color and test_emacs
ORIGINAL_TERM=$TERM

# dtach(1) provides more capable terminal environment to anything
# that requires more than dumb terminal...
[ x"${TERM:-dumb}" = xdumb ] && DTACH_TERM=vt100 || DTACH_TERM=$TERM

# For repeatability, reset the environment to known value.
LANG=C
LC_ALL=C
PAGER=cat
TZ=UTC
TERM=dumb
export LANG LC_ALL PAGER TERM TZ
GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
if [[ ( -n "$TEST_EMACS" && -z "$TEST_EMACSCLIENT" ) || \
      ( -z "$TEST_EMACS" && -n "$TEST_EMACSCLIENT" ) ]]; then
    echo "error: must specify both or neither of TEST_EMACS and TEST_EMACSCLIENT" >&2
    exit 1
fi
TEST_EMACS=${TEST_EMACS:-${EMACS:-emacs}}
TEST_EMACSCLIENT=${TEST_EMACSCLIENT:-emacsclient}

# Protect ourselves from common misconfiguration to export
# CDPATH into the environment
unset CDPATH

unset GREP_OPTIONS

# Convenience
#
# A regexp to match 5 and 40 hexdigits
_x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
_x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"

_x04='[0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
_x32="$_x04$_x04$_x04$_x04$_x04$_x04$_x04$_x04"

# Each test should start with something like this, after copyright notices:
#
# test_description='Description of this test...
# This test checks if command xyzzy does the right thing...
# '
# . ./test-lib.sh
[ "x$ORIGINAL_TERM" != "xdumb" ] && (
                TERM=$ORIGINAL_TERM &&
                export TERM &&
                [ -t 1 ] &&
                tput bold >/dev/null 2>&1 &&
                tput setaf 1 >/dev/null 2>&1 &&
                tput sgr0 >/dev/null 2>&1
        ) &&
        color=t

while test "$#" -ne 0
do
        case "$1" in
        -d|--d|--de|--deb|--debu|--debug)
                debug=t; shift ;;
        -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
                immediate=t; shift ;;
        -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
                GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
        -h|--h|--he|--hel|--help)
                help=t; shift ;;
        -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
                verbose=t; shift ;;
        -q|--q|--qu|--qui|--quie|--quiet)
                quiet=t; shift ;;
        --with-dashes)
                with_dashes=t; shift ;;
        --no-color)
                color=; shift ;;
        --no-python)
                # noop now...
                shift ;;
        --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
                valgrind=t; verbose=t; shift ;;
        --tee)
                shift ;; # was handled already
        --root=*)
                root=$(expr "z$1" : 'z[^=]*=\(.*\)')
                shift ;;
        *)
                echo "error: unknown test option '$1'" >&2; exit 1 ;;
        esac
done

if test -n "$debug"; then
    print_subtest () {
        printf " %-4s" "[$((test_count - 1))]"
    }
else
    print_subtest () {
        true
    }
fi

if test -n "$color"; then
        say_color () {
                (
                TERM=$ORIGINAL_TERM
                export TERM
                case "$1" in
                        error) tput bold; tput setaf 1;; # bold red
                        skip)  tput bold; tput setaf 2;; # bold green
                        pass)  tput setaf 2;;            # green
                        info)  tput setaf 3;;            # brown
                        *) test -n "$quiet" && return;;
                esac
                shift
                printf " "
                printf "$@"
                tput sgr0
                print_subtest
                )
        }
else
        say_color() {
                test -z "$1" && test -n "$quiet" && return
                shift
                printf " "
                printf "$@"
                print_subtest
        }
fi

error () {
        say_color error "error: $*\n"
        GIT_EXIT_OK=t
        exit 1
}

say () {
        say_color info "$*"
}

test "${test_description}" != "" ||
error "Test script did not set test_description."

if test "$help" = "t"
then
        echo "Tests ${test_description}"
        exit 0
fi

test_description_printed=
print_test_description ()
{
        test -z "$test_description_printed" || return 0
        echo
        echo $this_test: "Testing ${test_description}"
        test_description_printed=1
}
if [ -z "$NOTMUCH_TEST_QUIET" ]
then
        print_test_description
fi

exec 5>&1

test_failure=0
test_count=0
test_fixed=0
test_broken=0
test_success=0

_die_common () {
        code=$?
        trap - EXIT
        set +ex
        rm -rf "$TEST_TMPDIR"
}

die () {
        _die_common
        if test -n "$GIT_EXIT_OK"
        then
                exit $code
        else
                exec >&5
                say_color error '%-6s' FATAL
                echo " $test_subtest_name"
                echo
                echo "Unexpected exit while executing $0. Exit code $code."
                exit 1
        fi
}

die_signal () {
        _die_common
        echo >&5 "FATAL: $0: interrupted by signal" $((code - 128))
        exit $code
}

GIT_EXIT_OK=
# Note: TEST_TMPDIR *NOT* exported!
TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
trap 'die' EXIT
trap 'die_signal' HUP INT TERM

test_decode_color () {
        sed     -e 's/.\[1m/<WHITE>/g' \
                -e 's/.\[31m/<RED>/g' \
                -e 's/.\[32m/<GREEN>/g' \
                -e 's/.\[33m/<YELLOW>/g' \
                -e 's/.\[34m/<BLUE>/g' \
                -e 's/.\[35m/<MAGENTA>/g' \
                -e 's/.\[36m/<CYAN>/g' \
                -e 's/.\[m/<RESET>/g'
}

q_to_nul () {
        perl -pe 'y/Q/\000/'
}

q_to_cr () {
        tr Q '\015'
}

append_cr () {
        sed -e 's/$/Q/' | tr Q '\015'
}

remove_cr () {
        tr '\015' Q | sed -e 's/Q$//'
}

# 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.
#
#  [filename]=name
#
#       Store the message in file 'name'. The default is to store it
#       in 'msg-<count>', where <count> is three-digit number of the
#       message.
#
#  [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>
#  [references]=<message-id>
#  [content-type]=content-type-specification
#  '[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

    gen_msg_cnt=$((gen_msg_cnt + 1))
    if [ -z "${template[filename]}" ]; then
        gen_msg_name="msg-$(printf "%03d" $gen_msg_cnt)"
    else
        gen_msg_name=${template[filename]}
    fi

    if [ -z "${template[id]}" ]; then
        gen_msg_id="${gen_msg_name%:2,*}@notmuch-test-suite"
    else
        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
        if [ -n "$test_subtest_name" ]; then
            template[subject]="$test_subtest_name"
        else
            template[subject]="Test message #${gen_msg_cnt}"
        fi
    fi

    if [ -z "${template[date]}" ]; then
        template[date]="Fri, 05 Jan 2001 15:43:57 +0000"
    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

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

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

    if [ ! -z "${template[content-type]}" ]; then
        additional_headers="Content-Type: ${template[content-type]}
${additional_headers}"
    fi

    if [ ! -z "${template[content-transfer-encoding]}" ]; then
        additional_headers="Content-Transfer-Encoding: ${template[content-transfer-encoding]}
${additional_headers}"
    fi

    # Note that in the way we're setting it above and using it below,
    # `additional_headers' will also serve as the header / body separator
    # (empty line in between).

    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
}

# Generate a new message and add it to the database.
#
# 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
}

# Deliver a message with emacs and add it to the database
#
# Uses emacs to generate and deliver a message to the mail store.
# Accepts arbitrary extra emacs/elisp functions to modify the message
# before sending, which is useful to doing things like attaching files
# to the message and encrypting/signing.
emacs_deliver_message ()
{
    local subject="$1"
    local body="$2"
    shift 2
    # before we can send a message, we have to prepare the FCC maildir
    mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
    # eval'ing smtp-dummy --background will set smtp_dummy_pid
    smtp_dummy_pid=
    eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
    test -n "$smtp_dummy_pid" || return 1

    test_emacs \
        "(let ((message-send-mail-function 'message-smtpmail-send-it)
               (mail-host-address \"example.com\")
               (smtpmail-smtp-server \"localhost\")
               (smtpmail-smtp-service \"25025\"))
           (notmuch-hello)
           (notmuch-mua-mail)
           (message-goto-to)
           (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
           (message-goto-subject)
           (insert \"${subject}\")
           (message-goto-body)
           (insert \"${body}\")
           $@
           (message-send-and-exit))"

    # In case message was sent properly, client waits for confirmation
    # before exiting and resuming control here; therefore making sure
    # that server exits by sending (KILL) signal to it is safe.
    kill -9 $smtp_dummy_pid
    notmuch new >/dev/null
}

# Generate a corpus of email and add it to the database.
#
# This corpus is fixed, (it happens to be 50 messages from early in
# the history of the notmuch mailing list), which allows for reliably
# testing commands that need to operate on a not-totally-trivial
# number of messages.
add_email_corpus ()
{
    rm -rf ${MAIL_DIR}
    if [ -d $TEST_DIRECTORY/corpus.mail ]; then
        cp -a $TEST_DIRECTORY/corpus.mail ${MAIL_DIR}
    else
        cp -a $TEST_DIRECTORY/corpus ${MAIL_DIR}
        notmuch new >/dev/null
        cp -a ${MAIL_DIR} $TEST_DIRECTORY/corpus.mail
    fi
}

test_begin_subtest ()
{
    if [ -n "$inside_subtest" ]; then
        exec 1>&6 2>&7          # Restore stdout and stderr
        error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
    fi
    test_subtest_name="$1"
    test_reset_state_
    # Remember stdout and stderr file descriptors and redirect test
    # output to the previously prepared file descriptors 3 and 4 (see
    # below)
    if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
    exec 6>&1 7>&2 >&3 2>&4
    inside_subtest=t
}

# Pass test if two arguments match
#
# Note: Unlike all other test_expect_* functions, this function does
# not accept a test name. Instead, the caller should call
# test_begin_subtest before calling this function in order to set the
# name.
test_expect_equal ()
{
        exec 1>&6 2>&7          # Restore stdout and stderr
        inside_subtest=
        test "$#" = 3 && { prereq=$1; shift; } || prereq=
        test "$#" = 2 ||
        error "bug in the test script: not 2 or 3 parameters to test_expect_equal"

        output="$1"
        expected="$2"
        if ! test_skip "$test_subtest_name"
        then
                if [ "$output" = "$expected" ]; then
                        test_ok_
                else
                        testname=$this_test.$test_count
                        echo "$expected" > $testname.expected
                        echo "$output" > $testname.output
                        test_failure_ "$(diff -u $testname.expected $testname.output)"
                fi
    fi
}

# Like test_expect_equal, but takes two filenames.
test_expect_equal_file ()
{
        exec 1>&6 2>&7          # Restore stdout and stderr
        inside_subtest=
        test "$#" = 3 && { prereq=$1; shift; } || prereq=
        test "$#" = 2 ||
        error "bug in the test script: not 2 or 3 parameters to test_expect_equal"

        file1="$1"
        basename1=`basename "$file1"`
        file2="$2"
        basename2=`basename "$file2"`
        if ! test_skip "$test_subtest_name"
        then
                if diff -q "$file1" "$file2" >/dev/null ; then
                        test_ok_
                else
                        testname=$this_test.$test_count
                        cp "$file1" "$testname.$basename1"
                        cp "$file2" "$testname.$basename2"
                        test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
                fi
    fi
}

# Like test_expect_equal, but arguments are JSON expressions to be
# canonicalized before diff'ing.  If an argument cannot be parsed, it
# is used unchanged so that there's something to diff against.
test_expect_equal_json () {
    # The test suite forces LC_ALL=C, but this causes Python 3 to
    # decode stdin as ASCII.  We need to read JSON in UTF-8, so
    # override Python's stdio encoding defaults.
    output=$(echo "$1" | PYTHONIOENCODING=utf-8 python -mjson.tool \
        || echo "$1")
    expected=$(echo "$2" | PYTHONIOENCODING=utf-8 python -mjson.tool \
        || echo "$2")
    shift 2
    test_expect_equal "$output" "$expected" "$@"
}

test_emacs_expect_t () {
        test "$#" = 2 && { prereq=$1; shift; } || prereq=
        test "$#" = 1 ||
        error "bug in the test script: not 1 or 2 parameters to test_emacs_expect_t"

        # Run the test.
        if ! test_skip "$test_subtest_name"
        then
                test_emacs "(notmuch-test-run $1)" >/dev/null

                # Restore state after the test.
                exec 1>&6 2>&7          # Restore stdout and stderr
                inside_subtest=

                # Report success/failure.
                result=$(cat OUTPUT)
                if [ "$result" = t ]
                then
                        test_ok_
                else
                        test_failure_ "${result}"
                fi
        else
                # Restore state after the (non) test.
                exec 1>&6 2>&7          # Restore stdout and stderr
                inside_subtest=
        fi
}

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

notmuch_search_sanitize ()
{
    perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
}

NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
notmuch_show_sanitize ()
{
    sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
}
notmuch_show_sanitize_all ()
{
    sed \
        -e 's| filename:.*| filename:XXXXX|' \
        -e 's| id:[^ ]* | id:XXXXX |'
}

notmuch_json_show_sanitize ()
{
    sed \
        -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
        -e 's|"filename": "/[^"]*",|"filename": "YYYYY",|g'
}

notmuch_emacs_error_sanitize ()
{
    local command=$1
    shift
    for file in "$@"; do
        echo "=== $file ==="
        cat "$file"
    done | sed  \
        -e 's/^\[.*\]$/[XXX]/' \
        -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
}
# End of notmuch helper functions

# Use test_set_prereq to tell that a particular prerequisite is available.
# The prerequisite can later be checked for in two ways:
#
# - Explicitly using test_have_prereq.
#
# - Implicitly by specifying the prerequisite tag in the calls to
#   test_expect_{success,failure,code}.
#
# The single parameter is the prerequisite tag (a simple word, in all
# capital letters by convention).

test_set_prereq () {
        satisfied="$satisfied$1 "
}
satisfied=" "

test_have_prereq () {
        case $satisfied in
        *" $1 "*)
                : yes, have it ;;
        *)
                ! : nope ;;
        esac
}

declare -A test_missing_external_prereq_
declare -A test_subtest_missing_external_prereq_

# declare prerequisite for the given external binary
test_declare_external_prereq () {
        binary="$1"
        test "$#" = 2 && name=$2 || name="$binary(1)"

        if ! hash $binary 2>/dev/null; then
                test_missing_external_prereq_["${binary}"]=t
                eval "
$binary () {
        test_subtest_missing_external_prereq_[\"${name}\"]=t
        false
}"
        fi
}

# Explicitly require external prerequisite.  Useful when binary is
# called indirectly (e.g. from emacs).
# Returns success if dependency is available, failure otherwise.
test_require_external_prereq () {
        binary="$1"
        if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
                # dependency is missing, call the replacement function to note it
                eval "$binary"
        else
                true
        fi
}

# You are not expected to call test_ok_ and test_failure_ directly, use
# the text_expect_* functions instead.

test_ok_ () {
        if test "$test_subtest_known_broken_" = "t"; then
                test_known_broken_ok_
                return
        fi
        test_success=$(($test_success + 1))
        if test -n "$NOTMUCH_TEST_QUIET"; then
                return 0
        fi
        say_color pass "%-6s" "PASS"
        echo " $test_subtest_name"
}

test_failure_ () {
        if test "$test_subtest_known_broken_" = "t"; then
                test_known_broken_failure_ "$@"
                return
        fi
        test_failure=$(($test_failure + 1))
        print_test_description
        test_failure_message_ "FAIL" "$test_subtest_name" "$@"
        test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
        return 1
}

test_failure_message_ () {
        say_color error "%-6s" "$1"
        echo " $2"
        shift 2
        echo "$@" | sed -e 's/^/        /'
        if test "$verbose" != "t"; then cat test.output; fi
}

test_known_broken_ok_ () {
        test_reset_state_
        test_fixed=$(($test_fixed+1))
        say_color pass "%-6s" "FIXED"
        echo " $test_subtest_name"
}

test_known_broken_failure_ () {
        test_reset_state_
        test_broken=$(($test_broken+1))
        test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
        return 1
}

test_debug () {
        test "$debug" = "" || eval "$1"
}

test_run_ () {
        test_cleanup=:
        if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
        eval >&3 2>&4 "$1"
        eval_ret=$?
        eval >&3 2>&4 "$test_cleanup"
        return 0
}

test_skip () {
        test_count=$(($test_count+1))
        to_skip=
        for skp in $NOTMUCH_SKIP_TESTS
        do
                case $this_test.$test_count in
                $skp)
                        to_skip=t
                esac
        done
        if test -z "$to_skip" && test -n "$prereq" &&
           ! test_have_prereq "$prereq"
        then
                to_skip=t
        fi
        case "$to_skip" in
        t)
                test_report_skip_ "$@"
                ;;
        *)
                test_check_missing_external_prereqs_ "$@"
                ;;
        esac
}

test_check_missing_external_prereqs_ () {
        if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
                say_color skip >&1 "missing prerequisites: "
                echo ${!test_subtest_missing_external_prereq_[@]} >&1
                test_report_skip_ "$@"
        else
                false
        fi
}

test_report_skip_ () {
        test_reset_state_
        say_color skip >&3 "skipping test:"
        echo " $@" >&3
        say_color skip "%-6s" "SKIP"
        echo " $1"
}

test_subtest_known_broken () {
        test_subtest_known_broken_=t
}

test_expect_success () {
        test "$#" = 3 && { prereq=$1; shift; } || prereq=
        test "$#" = 2 ||
        error "bug in the test script: not 2 or 3 parameters to test-expect-success"
        test_subtest_name="$1"
        test_reset_state_
        if ! test_skip "$@"
        then
                test_run_ "$2"
                run_ret="$?"
                # test_run_ may update missing external prerequisites
                test_check_missing_external_prereqs_ "$@" ||
                if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
                then
                        test_ok_
                else
                        test_failure_ "$2"
                fi
        fi
}

test_expect_code () {
        test "$#" = 4 && { prereq=$1; shift; } || prereq=
        test "$#" = 3 ||
        error "bug in the test script: not 3 or 4 parameters to test-expect-code"
        test_subtest_name="$2"
        test_reset_state_
        if ! test_skip "$@"
        then
                test_run_ "$3"
                run_ret="$?"
                # test_run_ may update missing external prerequisites,
                test_check_missing_external_prereqs_ "$@" ||
                if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
                then
                        test_ok_
                else
                        test_failure_ "exit code $eval_ret, expected $1" "$3"
                fi
        fi
}

# test_external runs external test scripts that provide continuous
# test output about their progress, and succeeds/fails on
# zero/non-zero exit code.  It outputs the test output on stdout even
# in non-verbose mode, and announces the external script with "* run
# <n>: ..." before running it.  When providing relative paths, keep in
# mind that all scripts run in "trash directory".
# Usage: test_external description command arguments...
# Example: test_external 'Perl API' perl ../path/to/test.pl
test_external () {
        test "$#" = 4 && { prereq=$1; shift; } || prereq=
        test "$#" = 3 ||
        error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
        test_subtest_name="$1"
        shift
        test_reset_state_
        if ! test_skip "$test_subtest_name" "$@"
        then
                # Announce the script to reduce confusion about the
                # test output that follows.
                say_color "" " run $test_count: $descr ($*)"
                # Run command; redirect its stderr to &4 as in
                # test_run_, but keep its stdout on our stdout even in
                # non-verbose mode.
                "$@" 2>&4
                if [ "$?" = 0 ]
                then
                        test_ok_
                else
                        test_failure_ "$@"
                fi
        fi
}

# Like test_external, but in addition tests that the command generated
# no output on stderr.
test_external_without_stderr () {
        # The temporary file has no (and must have no) security
        # implications.
        tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
        stderr="$tmp/git-external-stderr.$$.tmp"
        test_external "$@" 4> "$stderr"
        [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
        test_subtest_name="no stderr: $1"
        shift
        if [ ! -s "$stderr" ]; then
                rm "$stderr"
                test_ok_
        else
                if [ "$verbose" = t ]; then
                        output=`echo; echo Stderr is:; cat "$stderr"`
                else
                        output=
                fi
                # rm first in case test_failure exits.
                rm "$stderr"
                test_failure_ "$@" "$output"
        fi
}

# This is not among top-level (test_expect_success)
# but is a prefix that can be used in the test script, like:
#
#       test_expect_success 'complain and die' '
#           do something &&
#           do something else &&
#           test_must_fail git checkout ../outerspace
#       '
#
# Writing this as "! git checkout ../outerspace" is wrong, because
# the failure could be due to a segv.  We want a controlled failure.

test_must_fail () {
        "$@"
        test $? -gt 0 -a $? -le 129 -o $? -gt 192
}

# test_cmp is a helper function to compare actual and expected output.
# You can use it like:
#
#       test_expect_success 'foo works' '
#               echo expected >expected &&
#               foo >actual &&
#               test_cmp expected actual
#       '
#
# This could be written as either "cmp" or "diff -u", but:
# - cmp's output is not nearly as easy to read as diff -u
# - not all diff versions understand "-u"

test_cmp() {
        $GIT_TEST_CMP "$@"
}

# This function can be used to schedule some commands to be run
# unconditionally at the end of the test to restore sanity:
#
#       test_expect_success 'test core.capslock' '
#               git config core.capslock true &&
#               test_when_finished "git config --unset core.capslock" &&
#               hello world
#       '
#
# That would be roughly equivalent to
#
#       test_expect_success 'test core.capslock' '
#               git config core.capslock true &&
#               hello world
#               git config --unset core.capslock
#       '
#
# except that the greeting and config --unset must both succeed for
# the test to pass.

test_when_finished () {
        test_cleanup="{ $*
                } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
}

test_done () {
        GIT_EXIT_OK=t
        test_results_dir="$TEST_DIRECTORY/test-results"
        mkdir -p "$test_results_dir"
        test_results_path="$test_results_dir/$this_test"

        echo "total $test_count" >> $test_results_path
        echo "success $test_success" >> $test_results_path
        echo "fixed $test_fixed" >> $test_results_path
        echo "broken $test_broken" >> $test_results_path
        echo "failed $test_failure" >> $test_results_path
        echo "" >> $test_results_path

        [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'

        if [ "$test_failure" = "0" ]; then
            if [ "$test_broken" = "0" ]; then
                rm -rf "$remove_tmp"
            fi
            exit 0
        else
            exit 1
        fi
}

emacs_generate_script () {
        # Construct a little test script here for the benefit of the user,
        # (who can easily run "run_emacs" to get the same emacs environment
        # for investigating any failures).
        cat <<EOF >"$TMP_DIRECTORY/run_emacs"
#!/bin/sh
export PATH=$PATH
export NOTMUCH_CONFIG=$NOTMUCH_CONFIG

# Here's what we are using here:
#
# --no-init-file        Don't load users ~/.emacs
#
# --no-site-file        Don't load the site-wide startup stuff
#
# --directory           Ensure that the local elisp sources are found
#
# --load                Force loading of notmuch.el and test-lib.el

exec ${TEST_EMACS} --no-init-file --no-site-file \
        --directory "$TEST_DIRECTORY/../emacs" --load notmuch.el \
        --directory "$TEST_DIRECTORY" --load test-lib.el \
        "\$@"
EOF
        chmod a+x "$TMP_DIRECTORY/run_emacs"
}

test_emacs () {
        # test dependencies beforehand to avoid the waiting loop below
        missing_dependencies=
        test_require_external_prereq dtach || missing_dependencies=1
        test_require_external_prereq emacs || missing_dependencies=1
        test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
        test -z "$missing_dependencies" || return

        if [ -z "$EMACS_SERVER" ]; then
                emacs_tests="${this_test}.el"
                if [ -f "$TEST_DIRECTORY/$emacs_tests" ]; then
                        load_emacs_tests="--eval '(load \"$emacs_tests\")'"
                else
                        load_emacs_tests=
                fi
                server_name="notmuch-test-suite-$$"
                # start a detached session with an emacs server
                # user's TERM (or 'vt100' in case user's TERM is unset, empty
                # or 'dumb') is given to dtach which assumes a minimally
                # VT100-compatible terminal -- and emacs inherits that
                TERM=$DTACH_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
                        sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
                                --no-window-system \
                                $load_emacs_tests \
                                --eval '(setq server-name \"$server_name\")' \
                                --eval '(server-start)' \
                                --eval '(orphan-watchdog $$)'" || return
                EMACS_SERVER="$server_name"
                # wait until the emacs server is up
                until test_emacs '()' >/dev/null 2>/dev/null; do
                        sleep 1
                done
        fi

        # Clear test-output output file.  Most Emacs tests end with a
        # call to (test-output).  If the test code fails with an
        # exception before this call, the output file won't get
        # updated.  Since we don't want to compare against an output
        # file from another test, so start out with an empty file.
        rm -f OUTPUT
        touch OUTPUT

        ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(progn $@)"
}

test_python() {
        export LD_LIBRARY_PATH=$TEST_DIRECTORY/../lib
        export PYTHONPATH=$TEST_DIRECTORY/../bindings/python

        # Some distros (e.g. Arch Linux) ship Python 2.* as /usr/bin/python2,
        # most others as /usr/bin/python. So first try python2, and fallback to
        # python if python2 doesn't exist.
        cmd=python2
        [[ ${test_missing_external_prereq_[python2]} == t ]] && cmd=python

        (echo "import sys; _orig_stdout=sys.stdout; sys.stdout=open('OUTPUT', 'w')"; cat) \
                | $cmd -
}

# Creates a script that counts how much time it is executed and calls
# notmuch.  $notmuch_counter_command is set to the path to the
# generated script.  Use notmuch_counter_value() function to get the
# current counter value.
notmuch_counter_reset () {
        notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
        if [ ! -x "$notmuch_counter_command" ]; then
                notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
                cat >"$notmuch_counter_command" <<EOF || return
#!/bin/sh

read count < "$notmuch_counter_state_path"
echo \$((count + 1)) > "$notmuch_counter_state_path"

exec notmuch "\$@"
EOF
                chmod +x "$notmuch_counter_command" || return
        fi

        echo 0 > "$notmuch_counter_state_path"
}

# Returns the current notmuch counter value.
notmuch_counter_value () {
        if [ -r "$notmuch_counter_state_path" ]; then
                read count < "$notmuch_counter_state_path"
        else
                count=0
        fi
        echo $count
}

test_reset_state_ () {
        test -z "$test_init_done_" && test_init_

        test_subtest_known_broken_=
        test_subtest_missing_external_prereq_=()
}

# called once before the first subtest
test_init_ () {
        test_init_done_=t

        # skip all tests if there were external prerequisites missing during init
        test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
}


. ./test-lib-common.sh

emacs_generate_script


# Use -P to resolve symlinks in our working directory so that the cwd
# in subprocesses like git equals our $PWD (for pathname comparisons).
cd -P "$test" || error "Cannot setup test environment"

if test "$verbose" = "t"
then
        exec 4>&2 3>&1
else
        exec 4>test.output 3>&4
fi

for skp in $NOTMUCH_SKIP_TESTS
do
        to_skip=
        for skp in $NOTMUCH_SKIP_TESTS
        do
                case "$this_test" in
                $skp)
                        to_skip=t
                esac
        done
        case "$to_skip" in
        t)
                say_color skip >&3 "skipping test $this_test altogether"
                say_color skip "skip all tests in $this_test"
                test_done
        esac
done

# Provide an implementation of the 'yes' utility
yes () {
        if test $# = 0
        then
                y=y
        else
                y="$*"
        fi

        while echo "$y"
        do
                :
        done
}

# Fix some commands on Windows
case $(uname -s) in
*MINGW*)
        # Windows has its own (incompatible) sort and find
        sort () {
                /usr/bin/sort "$@"
        }
        find () {
                /usr/bin/find "$@"
        }
        sum () {
                md5sum "$@"
        }
        # git sees Windows-style pwd
        pwd () {
                builtin pwd -W
        }
        # no POSIX permissions
        # backslashes in pathspec are converted to '/'
        # exec does not inherit the PID
        ;;
*)
        test_set_prereq POSIXPERM
        test_set_prereq BSLASHPSPEC
        test_set_prereq EXECKEEPSPID
        ;;
esac

test -z "$NO_PERL" && test_set_prereq PERL
test -z "$NO_PYTHON" && test_set_prereq PYTHON

# test whether the filesystem supports symbolic links
ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
rm -f y

# declare prerequisites for external binaries used in tests
test_declare_external_prereq dtach
test_declare_external_prereq emacs
test_declare_external_prereq ${TEST_EMACSCLIENT}
test_declare_external_prereq gdb
test_declare_external_prereq gpg
test_declare_external_prereq python
test_declare_external_prereq python2