2 # Copyright (c) 2005 Junio C Hamano
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation, either version 2 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see http://www.gnu.org/licenses/ .
17 if [ ${BASH_VERSINFO[0]} -lt 4 ]; then
18 echo "Error: The notmuch test suite requires a bash version >= 4.0"
19 echo "due to use of associative arrays within the test suite."
20 echo "Please try again with a newer bash (or help us fix the"
21 echo "test suite to be more portable). Thanks."
25 # Make sure echo builtin does not expand backslash-escape sequences by default.
29 this_test=${this_test%.sh}
30 this_test_bare=${this_test#T[0-9][0-9][0-9]-}
32 # if --tee was passed, write the output not only to the terminal, but
33 # additionally to the file test-results/$BASENAME.out, too.
34 case "$GIT_TEST_TEE_STARTED, $* " in
36 # do not redirect again
38 *' --tee '*|*' --va'*)
40 BASE=test-results/$this_test
41 (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
42 echo $? > $BASE.exit) | tee $BASE.out
43 test "$(cat $BASE.exit)" = 0
48 # Save STDOUT to fd 6 and STDERR to fd 7.
50 # Make xtrace debugging (when used) use redirected STDERR, with verbose lead:
52 export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
54 # Keep the original TERM for say_color and test_emacs
57 # dtach(1) provides more capable terminal environment to anything
58 # that requires more than dumb terminal...
59 [ x"${TERM:-dumb}" = xdumb ] && DTACH_TERM=vt100 || DTACH_TERM=$TERM
61 # For repeatability, reset the environment to known value.
67 export LANG LC_ALL PAGER TERM TZ
68 GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
69 if [[ ( -n "$TEST_EMACS" && -z "$TEST_EMACSCLIENT" ) || \
70 ( -z "$TEST_EMACS" && -n "$TEST_EMACSCLIENT" ) ]]; then
71 echo "error: must specify both or neither of TEST_EMACS and TEST_EMACSCLIENT" >&2
74 TEST_EMACS=${TEST_EMACS:-${EMACS:-emacs}}
75 TEST_EMACSCLIENT=${TEST_EMACSCLIENT:-emacsclient}
76 TEST_CC=${TEST_CC:-cc}
77 TEST_CFLAGS=${TEST_CFLAGS:-"-g -O0"}
79 # Protect ourselves from common misconfiguration to export
80 # CDPATH into the environment
86 unset ALTERNATE_EDITOR
90 # A regexp to match 5 and 40 hexdigits
91 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
92 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
94 _x04='[0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
95 _x32="$_x04$_x04$_x04$_x04$_x04$_x04$_x04$_x04"
97 # Each test should start with something like this, after copyright notices:
99 # test_description='Description of this test...
100 # This test checks if command xyzzy does the right thing...
102 # . ./test-lib.sh || exit 1
104 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
105 TERM=$ORIGINAL_TERM &&
108 tput bold >/dev/null 2>&1 &&
109 tput setaf 1 >/dev/null 2>&1 &&
110 tput sgr0 >/dev/null 2>&1
114 while test "$#" -ne 0
117 -d|--d|--de|--deb|--debu|--debug)
119 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
120 immediate=t; shift ;;
121 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
122 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
123 -h|--h|--he|--hel|--help)
125 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
127 -q|--q|--qu|--qui|--quie|--quiet)
130 with_dashes=t; shift ;;
136 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
137 valgrind=t; verbose=t; shift ;;
139 shift ;; # was handled already
141 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
144 echo "error: unknown test option '$1'" >&2; exit 1 ;;
148 if test -n "$debug"; then
150 printf " %-4s" "[$((test_count - 1))]"
158 if test -n "$color"; then
164 error) tput bold; tput setaf 1;; # bold red
165 skip) tput bold; tput setaf 2;; # bold green
166 pass) tput setaf 2;; # green
167 info) tput setaf 3;; # brown
168 *) test -n "$quiet" && return;;
179 test -z "$1" && test -n "$quiet" && return
188 say_color error "error: $*\n"
197 test "${test_description}" != "" ||
198 error "Test script did not set test_description."
200 if test "$help" = "t"
202 echo "Tests ${test_description}"
206 test_description_printed=
207 print_test_description ()
209 test -z "$test_description_printed" || return 0
211 echo $this_test: "Testing ${test_description}"
212 test_description_printed=1
214 if [ -z "$NOTMUCH_TEST_QUIET" ]
216 print_test_description
229 rm -rf "$TEST_TMPDIR"
234 if test -n "$GIT_EXIT_OK"
239 say_color error '%-6s' FATAL
240 echo " $test_subtest_name"
242 echo "Unexpected exit while executing $0. Exit code $code."
249 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
254 # Note: TEST_TMPDIR *NOT* exported!
255 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
257 trap 'die_signal' HUP INT TERM
259 test_decode_color () {
260 sed -e 's/.\[1m/<WHITE>/g' \
261 -e 's/.\[31m/<RED>/g' \
262 -e 's/.\[32m/<GREEN>/g' \
263 -e 's/.\[33m/<YELLOW>/g' \
264 -e 's/.\[34m/<BLUE>/g' \
265 -e 's/.\[35m/<MAGENTA>/g' \
266 -e 's/.\[36m/<CYAN>/g' \
267 -e 's/.\[m/<RESET>/g'
279 sed -e 's/$/Q/' | tr Q '\015'
283 tr '\015' Q | sed -e 's/Q$//'
286 # Generate a new message in the mail directory, with a unique message
287 # ID and subject. The message is not added to the index.
289 # After this function returns, the filename of the generated message
290 # is available as $gen_msg_filename and the message ID is available as
293 # This function supports named parameters with the bash syntax for
294 # assigning a value to an associative array ([name]=value). The
295 # supported parameters are:
297 # [dir]=directory/of/choice
299 # Generate the message in directory 'directory/of/choice' within
300 # the mail store. The directory will be created if necessary.
304 # Store the message in file 'name'. The default is to store it
305 # in 'msg-<count>', where <count> is three-digit number of the
310 # Text to use as the body of the email message
312 # '[from]="Some User <user@example.com>"'
313 # '[to]="Some User <user@example.com>"'
314 # '[subject]="Subject of email message"'
315 # '[date]="RFC 822 Date"'
317 # Values for email headers. If not provided, default values will
318 # be generated instead.
320 # '[cc]="Some User <user@example.com>"'
321 # [reply-to]=some-address
322 # [in-reply-to]=<message-id>
323 # [references]=<message-id>
324 # [content-type]=content-type-specification
325 # '[header]=full header line, including keyword'
327 # Additional values for email headers. If these are not provided
328 # then the relevant headers will simply not appear in the
333 # Controls the message-id of the created message.
339 # This is our (bash-specific) magic for doing named parameters
340 local -A template="($@)"
341 local additional_headers
343 gen_msg_cnt=$((gen_msg_cnt + 1))
344 if [ -z "${template[filename]}" ]; then
345 gen_msg_name="msg-$(printf "%03d" $gen_msg_cnt)"
347 gen_msg_name=${template[filename]}
350 if [ -z "${template[id]}" ]; then
351 gen_msg_id="${gen_msg_name%:2,*}@notmuch-test-suite"
353 gen_msg_id="${template[id]}"
356 if [ -z "${template[dir]}" ]; then
357 gen_msg_filename="${MAIL_DIR}/$gen_msg_name"
359 gen_msg_filename="${MAIL_DIR}/${template[dir]}/$gen_msg_name"
360 mkdir -p "$(dirname "$gen_msg_filename")"
363 if [ -z "${template[body]}" ]; then
364 template[body]="This is just a test message (#${gen_msg_cnt})"
367 if [ -z "${template[from]}" ]; then
368 template[from]="Notmuch Test Suite <test_suite@notmuchmail.org>"
371 if [ -z "${template[to]}" ]; then
372 template[to]="Notmuch Test Suite <test_suite@notmuchmail.org>"
375 if [ -z "${template[subject]}" ]; then
376 if [ -n "$test_subtest_name" ]; then
377 template[subject]="$test_subtest_name"
379 template[subject]="Test message #${gen_msg_cnt}"
381 elif [ "${template[subject]}" = "@FORCE_EMPTY" ]; then
385 if [ -z "${template[date]}" ]; then
386 # we use decreasing timestamps here for historical reasons;
387 # the existing test suite when we converted to unique timestamps just
388 # happened to have signicantly fewer failures with that choice.
389 local date_secs=$((978709437 - gen_msg_cnt))
390 # printf %(..)T is bash 4.2+ feature. use perl fallback if needed...
391 TZ=UTC printf -v template[date] "%(%a, %d %b %Y %T %z)T" $date_secs 2>/dev/null ||
392 template[date]=`perl -le 'use POSIX "strftime";
393 @time = gmtime '"$date_secs"';
394 print strftime "%a, %d %b %Y %T +0000", @time'`
397 additional_headers=""
398 if [ ! -z "${template[header]}" ]; then
399 additional_headers="${template[header]}
400 ${additional_headers}"
403 if [ ! -z "${template[reply-to]}" ]; then
404 additional_headers="Reply-To: ${template[reply-to]}
405 ${additional_headers}"
408 if [ ! -z "${template[in-reply-to]}" ]; then
409 additional_headers="In-Reply-To: ${template[in-reply-to]}
410 ${additional_headers}"
413 if [ ! -z "${template[cc]}" ]; then
414 additional_headers="Cc: ${template[cc]}
415 ${additional_headers}"
418 if [ ! -z "${template[bcc]}" ]; then
419 additional_headers="Bcc: ${template[bcc]}
420 ${additional_headers}"
423 if [ ! -z "${template[references]}" ]; then
424 additional_headers="References: ${template[references]}
425 ${additional_headers}"
428 if [ ! -z "${template[content-type]}" ]; then
429 additional_headers="Content-Type: ${template[content-type]}
430 ${additional_headers}"
433 if [ ! -z "${template[content-transfer-encoding]}" ]; then
434 additional_headers="Content-Transfer-Encoding: ${template[content-transfer-encoding]}
435 ${additional_headers}"
438 # Note that in the way we're setting it above and using it below,
439 # `additional_headers' will also serve as the header / body separator
440 # (empty line in between).
442 cat <<EOF >"$gen_msg_filename"
443 From: ${template[from]}
445 Message-Id: <${gen_msg_id}>
446 Subject: ${template[subject]}
447 Date: ${template[date]}
448 ${additional_headers}
453 # Generate a new message and add it to the database.
455 # All of the arguments and return values supported by generate_message
456 # are also supported here, so see that function for details.
459 generate_message "$@" &&
460 notmuch new > /dev/null
463 # Deliver a message with emacs and add it to the database
465 # Uses emacs to generate and deliver a message to the mail store.
466 # Accepts arbitrary extra emacs/elisp functions to modify the message
467 # before sending, which is useful to doing things like attaching files
468 # to the message and encrypting/signing.
469 emacs_deliver_message ()
474 # before we can send a message, we have to prepare the FCC maildir
475 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
476 # eval'ing smtp-dummy --background will set smtp_dummy_pid
478 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
479 test -n "$smtp_dummy_pid" || return 1
482 "(let ((message-send-mail-function 'message-smtpmail-send-it)
483 (mail-host-address \"example.com\")
484 (smtpmail-smtp-server \"localhost\")
485 (smtpmail-smtp-service \"25025\"))
488 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
489 (message-goto-subject)
490 (insert \"${subject}\")
494 (notmuch-mua-send-and-exit))"
496 # In case message was sent properly, client waits for confirmation
497 # before exiting and resuming control here; therefore making sure
498 # that server exits by sending (KILL) signal to it is safe.
499 kill -9 $smtp_dummy_pid
500 notmuch new >/dev/null
503 # Pretend to deliver a message with emacs. Really save it to a file
504 # and add it to the database
506 # Uses emacs to generate and deliver a message to the mail store.
507 # Accepts arbitrary extra emacs/elisp functions to modify the message
508 # before sending, which is useful to doing things like attaching files
509 # to the message and encrypting/signing.
515 # before we can send a message, we have to prepare the FCC maildir
516 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
519 "(let ((message-send-mail-function (lambda () t))
520 (mail-host-address \"example.com\"))
523 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
524 (message-goto-subject)
525 (insert \"${subject}\")
529 (notmuch-mua-send-and-exit))" || return 1
530 notmuch new >/dev/null
533 # Generate a corpus of email and add it to the database.
535 # This corpus is fixed, (it happens to be 50 messages from early in
536 # the history of the notmuch mailing list), which allows for reliably
537 # testing commands that need to operate on a not-totally-trivial
538 # number of messages.
542 if [ -d $TEST_DIRECTORY/corpus.mail ]; then
543 cp -a $TEST_DIRECTORY/corpus.mail ${MAIL_DIR}
545 cp -a $TEST_DIRECTORY/corpus ${MAIL_DIR}
546 notmuch new >/dev/null
547 cp -a ${MAIL_DIR} $TEST_DIRECTORY/corpus.mail
551 test_begin_subtest ()
553 if [ -n "$inside_subtest" ]; then
554 exec 1>&6 2>&7 # Restore stdout and stderr
555 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
557 test_subtest_name="$1"
559 # Redirect test output to the previously prepared file descriptors
560 # 3 and 4 (see below)
561 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
566 # Pass test if two arguments match
568 # Note: Unlike all other test_expect_* functions, this function does
569 # not accept a test name. Instead, the caller should call
570 # test_begin_subtest before calling this function in order to set the
574 exec 1>&6 2>&7 # Restore stdout and stderr
576 test "$#" = 3 && { prereq=$1; shift; } || prereq=
578 error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
582 if ! test_skip "$test_subtest_name"
584 if [ "$output" = "$expected" ]; then
587 testname=$this_test.$test_count
588 echo "$expected" > $testname.expected
589 echo "$output" > $testname.output
590 test_failure_ "$(diff -u $testname.expected $testname.output)"
595 # Like test_expect_equal, but takes two filenames.
596 test_expect_equal_file ()
598 exec 1>&6 2>&7 # Restore stdout and stderr
600 test "$#" = 3 && { prereq=$1; shift; } || prereq=
602 error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
605 basename1=`basename "$file1"`
607 basename2=`basename "$file2"`
608 if ! test_skip "$test_subtest_name"
610 if diff -q "$file1" "$file2" >/dev/null ; then
613 testname=$this_test.$test_count
614 cp "$file1" "$testname.$basename1"
615 cp "$file2" "$testname.$basename2"
616 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
621 # Like test_expect_equal, but arguments are JSON expressions to be
622 # canonicalized before diff'ing. If an argument cannot be parsed, it
623 # is used unchanged so that there's something to diff against.
624 test_expect_equal_json () {
625 # The test suite forces LC_ALL=C, but this causes Python 3 to
626 # decode stdin as ASCII. We need to read JSON in UTF-8, so
627 # override Python's stdio encoding defaults.
628 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -mjson.tool \
630 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -mjson.tool \
633 test_expect_equal "$output" "$expected" "$@"
636 # Sort the top-level list of JSON data from stdin.
638 PYTHONIOENCODING=utf-8 python -c \
639 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
642 test_emacs_expect_t () {
643 test "$#" = 2 && { prereq=$1; shift; } || prereq=
645 error "bug in the test script: not 1 or 2 parameters to test_emacs_expect_t"
648 if ! test_skip "$test_subtest_name"
650 test_emacs "(notmuch-test-run $1)" >/dev/null
652 # Restore state after the test.
653 exec 1>&6 2>&7 # Restore stdout and stderr
656 # Report success/failure.
662 test_failure_ "${result}"
665 # Restore state after the (non) test.
666 exec 1>&6 2>&7 # Restore stdout and stderr
673 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
676 notmuch_search_sanitize ()
678 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
681 notmuch_search_files_sanitize ()
686 notmuch_dir_sanitize ()
688 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
691 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
692 notmuch_show_sanitize ()
694 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
696 notmuch_show_sanitize_all ()
699 -e 's| filename:.*| filename:XXXXX|' \
700 -e 's| id:[^ ]* | id:XXXXX |' | \
701 notmuch_date_sanitize
704 notmuch_json_show_sanitize ()
707 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
708 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
709 -e 's|"filename": "signature.asc",||g' \
710 -e 's|"filename": "/[^"]*",|"filename": "YYYYY",|g' \
711 -e 's|"timestamp": 97.......|"timestamp": 42|g'
714 notmuch_emacs_error_sanitize ()
722 -e 's/^\[.*\]$/[XXX]/' \
723 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
726 notmuch_date_sanitize ()
729 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
732 notmuch_uuid_sanitize ()
734 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
736 # End of notmuch helper functions
738 # Use test_set_prereq to tell that a particular prerequisite is available.
739 # The prerequisite can later be checked for in two ways:
741 # - Explicitly using test_have_prereq.
743 # - Implicitly by specifying the prerequisite tag in the calls to
744 # test_expect_{success,failure,code}.
746 # The single parameter is the prerequisite tag (a simple word, in all
747 # capital letters by convention).
750 satisfied="$satisfied$1 "
754 test_have_prereq () {
763 declare -A test_missing_external_prereq_
764 declare -A test_subtest_missing_external_prereq_
766 # declare prerequisite for the given external binary
767 test_declare_external_prereq () {
769 test "$#" = 2 && name=$2 || name="$binary(1)"
771 if ! hash $binary 2>/dev/null; then
772 test_missing_external_prereq_["${binary}"]=t
775 test_subtest_missing_external_prereq_[\"${name}\"]=t
781 # Explicitly require external prerequisite. Useful when binary is
782 # called indirectly (e.g. from emacs).
783 # Returns success if dependency is available, failure otherwise.
784 test_require_external_prereq () {
786 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
787 # dependency is missing, call the replacement function to note it
794 # You are not expected to call test_ok_ and test_failure_ directly, use
795 # the text_expect_* functions instead.
798 if test "$test_subtest_known_broken_" = "t"; then
799 test_known_broken_ok_
802 test_success=$(($test_success + 1))
803 if test -n "$NOTMUCH_TEST_QUIET"; then
806 say_color pass "%-6s" "PASS"
807 echo " $test_subtest_name"
811 if test "$test_subtest_known_broken_" = "t"; then
812 test_known_broken_failure_ "$@"
815 test_failure=$(($test_failure + 1))
816 print_test_description
817 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
818 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
822 test_failure_message_ () {
823 say_color error "%-6s" "$1"
826 echo "$@" | sed -e 's/^/ /'
827 if test "$verbose" != "t"; then cat test.output; fi
830 test_known_broken_ok_ () {
832 test_fixed=$(($test_fixed+1))
833 say_color pass "%-6s" "FIXED"
834 echo " $test_subtest_name"
837 test_known_broken_failure_ () {
839 test_broken=$(($test_broken+1))
840 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
845 test "$debug" = "" || eval "$1"
850 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
853 eval >&3 2>&4 "$test_cleanup"
858 test_count=$(($test_count+1))
860 for skp in $NOTMUCH_SKIP_TESTS
862 case $this_test.$test_count in
867 case $this_test_bare.$test_count in
873 if test -z "$to_skip" && test -n "$prereq" &&
874 ! test_have_prereq "$prereq"
880 test_report_skip_ "$@"
883 test_check_missing_external_prereqs_ "$@"
888 test_check_missing_external_prereqs_ () {
889 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
890 say_color skip >&1 "missing prerequisites: "
891 echo ${!test_subtest_missing_external_prereq_[@]} >&1
892 test_report_skip_ "$@"
898 test_report_skip_ () {
900 say_color skip >&3 "skipping test:"
902 say_color skip "%-6s" "SKIP"
906 test_subtest_known_broken () {
907 test_subtest_known_broken_=t
910 test_expect_success () {
911 test "$#" = 3 && { prereq=$1; shift; } || prereq=
913 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
914 test_subtest_name="$1"
920 # test_run_ may update missing external prerequisites
921 test_check_missing_external_prereqs_ "$@" ||
922 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
931 test_expect_code () {
932 test "$#" = 4 && { prereq=$1; shift; } || prereq=
934 error "bug in the test script: not 3 or 4 parameters to test-expect-code"
935 test_subtest_name="$2"
941 # test_run_ may update missing external prerequisites,
942 test_check_missing_external_prereqs_ "$@" ||
943 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
947 test_failure_ "exit code $eval_ret, expected $1" "$3"
952 # test_external runs external test scripts that provide continuous
953 # test output about their progress, and succeeds/fails on
954 # zero/non-zero exit code. It outputs the test output on stdout even
955 # in non-verbose mode, and announces the external script with "* run
956 # <n>: ..." before running it. When providing relative paths, keep in
957 # mind that all scripts run in "trash directory".
958 # Usage: test_external description command arguments...
959 # Example: test_external 'Perl API' perl ../path/to/test.pl
961 test "$#" = 4 && { prereq=$1; shift; } || prereq=
963 error >&6 "bug in the test script: not 3 or 4 parameters to test_external"
964 test_subtest_name="$1"
967 if ! test_skip "$test_subtest_name" "$@"
969 # Announce the script to reduce confusion about the
970 # test output that follows.
971 say_color "" " run $test_count: $descr ($*)"
972 # Run command; redirect its stderr to &4 as in
973 # test_run_, but keep its stdout on our stdout even in
985 # Like test_external, but in addition tests that the command generated
986 # no output on stderr.
987 test_external_without_stderr () {
988 # The temporary file has no (and must have no) security
990 tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
991 stderr="$tmp/git-external-stderr.$$.tmp"
992 test_external "$@" 4> "$stderr"
993 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
994 test_subtest_name="no stderr: $1"
996 if [ ! -s "$stderr" ]; then
1000 if [ "$verbose" = t ]; then
1001 output=`echo; echo Stderr is:; cat "$stderr"`
1005 # rm first in case test_failure exits.
1007 test_failure_ "$@" "$output"
1011 # This is not among top-level (test_expect_success)
1012 # but is a prefix that can be used in the test script, like:
1014 # test_expect_success 'complain and die' '
1016 # do something else &&
1017 # test_must_fail git checkout ../outerspace
1020 # Writing this as "! git checkout ../outerspace" is wrong, because
1021 # the failure could be due to a segv. We want a controlled failure.
1025 test $? -gt 0 -a $? -le 129 -o $? -gt 192
1028 # test_cmp is a helper function to compare actual and expected output.
1029 # You can use it like:
1031 # test_expect_success 'foo works' '
1032 # echo expected >expected &&
1034 # test_cmp expected actual
1037 # This could be written as either "cmp" or "diff -u", but:
1038 # - cmp's output is not nearly as easy to read as diff -u
1039 # - not all diff versions understand "-u"
1045 # This function can be used to schedule some commands to be run
1046 # unconditionally at the end of the test to restore sanity:
1048 # test_expect_success 'test core.capslock' '
1049 # git config core.capslock true &&
1050 # test_when_finished "git config --unset core.capslock" &&
1054 # That would be roughly equivalent to
1056 # test_expect_success 'test core.capslock' '
1057 # git config core.capslock true &&
1059 # git config --unset core.capslock
1062 # except that the greeting and config --unset must both succeed for
1065 test_when_finished () {
1067 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
1072 test_results_dir="$TEST_DIRECTORY/test-results"
1073 mkdir -p "$test_results_dir"
1074 test_results_path="$test_results_dir/$this_test"
1076 echo "total $test_count" >> $test_results_path
1077 echo "success $test_success" >> $test_results_path
1078 echo "fixed $test_fixed" >> $test_results_path
1079 echo "broken $test_broken" >> $test_results_path
1080 echo "failed $test_failure" >> $test_results_path
1081 echo "" >> $test_results_path
1083 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
1085 if [ "$test_failure" = "0" ]; then
1086 if [ "$test_broken" = "0" ]; then
1087 rm -rf "$remove_tmp"
1095 emacs_generate_script () {
1096 # Construct a little test script here for the benefit of the user,
1097 # (who can easily run "run_emacs" to get the same emacs environment
1098 # for investigating any failures).
1099 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
1102 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
1104 # Here's what we are using here:
1106 # --quick Use minimal customization. This implies --no-init-file,
1107 # --no-site-file and (emacs 24) --no-site-lisp
1109 # --directory Ensure that the local elisp sources are found
1111 # --load Force loading of notmuch.el and test-lib.el
1113 exec ${TEST_EMACS} --quick \
1114 --directory "$TEST_DIRECTORY/../emacs" --load notmuch.el \
1115 --directory "$TEST_DIRECTORY" --load test-lib.el \
1118 chmod a+x "$TMP_DIRECTORY/run_emacs"
1122 # test dependencies beforehand to avoid the waiting loop below
1123 missing_dependencies=
1124 test_require_external_prereq dtach || missing_dependencies=1
1125 test_require_external_prereq emacs || missing_dependencies=1
1126 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
1127 test -z "$missing_dependencies" || return
1129 if [ -z "$EMACS_SERVER" ]; then
1130 emacs_tests="${this_test_bare}.el"
1131 if [ -f "$TEST_DIRECTORY/$emacs_tests" ]; then
1132 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
1136 server_name="notmuch-test-suite-$$"
1137 # start a detached session with an emacs server
1138 # user's TERM (or 'vt100' in case user's TERM is unset, empty
1139 # or 'dumb') is given to dtach which assumes a minimally
1140 # VT100-compatible terminal -- and emacs inherits that
1141 TERM=$DTACH_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
1142 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
1143 --no-window-system \
1145 --eval '(setq server-name \"$server_name\")' \
1146 --eval '(server-start)' \
1147 --eval '(orphan-watchdog $$)'" || return
1148 EMACS_SERVER="$server_name"
1149 # wait until the emacs server is up
1150 until test_emacs '()' >/dev/null 2>/dev/null; do
1155 # Clear test-output output file. Most Emacs tests end with a
1156 # call to (test-output). If the test code fails with an
1157 # exception before this call, the output file won't get
1158 # updated. Since we don't want to compare against an output
1159 # file from another test, so start out with an empty file.
1163 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $@)"
1167 export LD_LIBRARY_PATH=$TEST_DIRECTORY/../lib
1168 export PYTHONPATH=$TEST_DIRECTORY/../bindings/python
1170 (echo "import sys; _orig_stdout=sys.stdout; sys.stdout=open('OUTPUT', 'w')"; cat) \
1175 export LD_LIBRARY_PATH=$TEST_DIRECTORY/../lib
1176 MAIL_DIR=$MAIL_DIR ruby -I $TEST_DIRECTORY/../bindings/ruby> OUTPUT
1180 exec_file="test${test_count}"
1181 test_file="${exec_file}.c"
1183 export LD_LIBRARY_PATH=${TEST_DIRECTORY}/../lib
1184 ${TEST_CC} ${TEST_CFLAGS} -I${TEST_DIRECTORY}/../lib -o ${exec_file} ${test_file} -L${TEST_DIRECTORY}/../lib/ -lnotmuch -ltalloc
1185 echo "== stdout ==" > OUTPUT.stdout
1186 echo "== stderr ==" > OUTPUT.stderr
1187 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1188 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr > OUTPUT
1192 # Creates a script that counts how much time it is executed and calls
1193 # notmuch. $notmuch_counter_command is set to the path to the
1194 # generated script. Use notmuch_counter_value() function to get the
1195 # current counter value.
1196 notmuch_counter_reset () {
1197 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1198 if [ ! -x "$notmuch_counter_command" ]; then
1199 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1200 cat >"$notmuch_counter_command" <<EOF || return
1203 read count < "$notmuch_counter_state_path"
1204 echo \$((count + 1)) > "$notmuch_counter_state_path"
1208 chmod +x "$notmuch_counter_command" || return
1211 echo 0 > "$notmuch_counter_state_path"
1214 # Returns the current notmuch counter value.
1215 notmuch_counter_value () {
1216 if [ -r "$notmuch_counter_state_path" ]; then
1217 read count < "$notmuch_counter_state_path"
1224 test_reset_state_ () {
1225 test -z "$test_init_done_" && test_init_
1227 test_subtest_known_broken_=
1228 test_subtest_missing_external_prereq_=()
1231 # called once before the first subtest
1235 # skip all tests if there were external prerequisites missing during init
1236 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1240 . ./test-lib-common.sh || exit 1
1242 emacs_generate_script
1245 # Use -P to resolve symlinks in our working directory so that the cwd
1246 # in subprocesses like git equals our $PWD (for pathname comparisons).
1247 cd -P "$test" || error "Cannot set up test environment"
1249 if test "$verbose" = "t"
1253 exec 4>test.output 3>&4
1256 for skp in $NOTMUCH_SKIP_TESTS
1259 for skp in $NOTMUCH_SKIP_TESTS
1261 case "$this_test" in
1266 case "$this_test_bare" in
1274 say_color skip >&3 "skipping test $this_test altogether"
1275 say_color skip "skip all tests in $this_test"
1280 # Provide an implementation of the 'yes' utility
1295 # Fix some commands on Windows
1298 # Windows has its own (incompatible) sort and find
1308 # git sees Windows-style pwd
1312 # no POSIX permissions
1313 # backslashes in pathspec are converted to '/'
1314 # exec does not inherit the PID
1317 test_set_prereq POSIXPERM
1318 test_set_prereq BSLASHPSPEC
1319 test_set_prereq EXECKEEPSPID
1323 test -z "$NO_PERL" && test_set_prereq PERL
1324 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1326 # test whether the filesystem supports symbolic links
1327 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1330 # convert variable from configure to more convenient form
1331 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1339 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1341 # declare prerequisites for external binaries used in tests
1342 test_declare_external_prereq dtach
1343 test_declare_external_prereq emacs
1344 test_declare_external_prereq ${TEST_EMACSCLIENT}
1345 test_declare_external_prereq gdb
1346 test_declare_external_prereq gpg
1347 test_declare_external_prereq openssl
1348 test_declare_external_prereq gpgsm
1349 test_declare_external_prereq ${NOTMUCH_PYTHON}