2 # Copyright (c) 2005 Junio C Hamano
3 # Copyright (c) 2010 Notmuch Developers
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see https://www.gnu.org/licenses/ .
18 if [ ${BASH_VERSINFO[0]} -lt 4 ]; then
19 echo "Error: The notmuch test suite requires a bash version >= 4.0"
20 echo "due to use of associative arrays within the test suite."
21 echo "Please try again with a newer bash (or help us fix the"
22 echo "test suite to be more portable). Thanks."
26 # Make sure echo builtin does not expand backslash-escape sequences by default.
30 this_test=${this_test%.sh}
31 this_test_bare=${this_test#T[0-9][0-9][0-9]-}
33 # if --tee was passed, write the output not only to the terminal, but
34 # additionally to the file test-results/$BASENAME.out, too.
35 case "$GIT_TEST_TEE_STARTED, $* " in
37 # do not redirect again
39 *' --tee '*|*' --va'*)
41 BASE=test-results/$this_test
42 (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
43 echo $? > $BASE.exit) | tee $BASE.out
44 test "$(cat $BASE.exit)" = 0
49 # Save STDOUT to fd 6 and STDERR to fd 7.
51 # Make xtrace debugging (when used) use redirected STDERR, with verbose lead:
53 export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
55 # Keep the original TERM for say_color and test_emacs
58 # dtach(1) provides more capable terminal environment to anything
59 # that requires more than dumb terminal...
60 [ x"${TERM:-dumb}" = xdumb ] && DTACH_TERM=vt100 || DTACH_TERM=$TERM
62 # For repeatability, reset the environment to known value.
68 export LANG LC_ALL PAGER TERM TZ
69 GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
70 if [[ ( -n "$TEST_EMACS" && -z "$TEST_EMACSCLIENT" ) || \
71 ( -z "$TEST_EMACS" && -n "$TEST_EMACSCLIENT" ) ]]; then
72 echo "error: must specify both or neither of TEST_EMACS and TEST_EMACSCLIENT" >&2
75 TEST_EMACS=${TEST_EMACS:-${EMACS:-emacs}}
76 TEST_EMACSCLIENT=${TEST_EMACSCLIENT:-emacsclient}
77 TEST_CC=${TEST_CC:-cc}
78 TEST_CFLAGS=${TEST_CFLAGS:-"-g -O0"}
80 # Protect ourselves from common misconfiguration to export
81 # CDPATH into the environment
87 unset ALTERNATE_EDITOR
91 # A regexp to match 5 and 40 hexdigits
92 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
93 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
95 _x04='[0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
96 _x32="$_x04$_x04$_x04$_x04$_x04$_x04$_x04$_x04"
98 # Each test should start with something like this, after copyright notices:
100 # test_description='Description of this test...
101 # This test checks if command xyzzy does the right thing...
103 # . ./test-lib.sh || exit 1
105 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
106 TERM=$ORIGINAL_TERM &&
109 tput bold >/dev/null 2>&1 &&
110 tput setaf 1 >/dev/null 2>&1 &&
111 tput sgr0 >/dev/null 2>&1
115 while test "$#" -ne 0
118 -d|--d|--de|--deb|--debu|--debug)
120 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
121 immediate=t; shift ;;
122 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
123 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
124 -h|--h|--he|--hel|--help)
126 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
128 -q|--q|--qu|--qui|--quie|--quiet)
131 with_dashes=t; shift ;;
137 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
138 valgrind=t; verbose=t; shift ;;
140 shift ;; # was handled already
142 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
145 echo "error: unknown test option '$1'" >&2; exit 1 ;;
149 if test -n "$debug"; then
151 printf " %-4s" "[$((test_count - 1))]"
159 if test -n "$color"; then
165 error) tput bold; tput setaf 1;; # bold red
166 skip) tput bold; tput setaf 2;; # bold green
167 pass) tput setaf 2;; # green
168 info) tput setaf 3;; # brown
169 *) test -n "$quiet" && return;;
180 test -z "$1" && test -n "$quiet" && return
189 say_color error "error: $*\n"
198 test "${test_description}" != "" ||
199 error "Test script did not set test_description."
201 if test "$help" = "t"
203 echo "Tests ${test_description}"
207 test_description_printed=
208 print_test_description ()
210 test -z "$test_description_printed" || return 0
212 echo $this_test: "Testing ${test_description}"
213 test_description_printed=1
215 if [ -z "$NOTMUCH_TEST_QUIET" ]
217 print_test_description
230 rm -rf "$TEST_TMPDIR"
235 if test -n "$GIT_EXIT_OK"
240 say_color error '%-6s' FATAL
241 echo " $test_subtest_name"
243 echo "Unexpected exit while executing $0. Exit code $code."
250 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
257 say_color error '%-6s' FATAL
260 echo "Unexpected exit while executing $0."
265 # Note: TEST_TMPDIR *NOT* exported!
266 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
267 trap 'trap_exit' EXIT
268 trap 'trap_signal' HUP INT TERM
270 test_decode_color () {
271 sed -e 's/.\[1m/<WHITE>/g' \
272 -e 's/.\[31m/<RED>/g' \
273 -e 's/.\[32m/<GREEN>/g' \
274 -e 's/.\[33m/<YELLOW>/g' \
275 -e 's/.\[34m/<BLUE>/g' \
276 -e 's/.\[35m/<MAGENTA>/g' \
277 -e 's/.\[36m/<CYAN>/g' \
278 -e 's/.\[m/<RESET>/g'
290 sed -e 's/$/Q/' | tr Q '\015'
294 tr '\015' Q | sed -e 's/Q$//'
297 # Generate a new message in the mail directory, with a unique message
298 # ID and subject. The message is not added to the index.
300 # After this function returns, the filename of the generated message
301 # is available as $gen_msg_filename and the message ID is available as
304 # This function supports named parameters with the bash syntax for
305 # assigning a value to an associative array ([name]=value). The
306 # supported parameters are:
308 # [dir]=directory/of/choice
310 # Generate the message in directory 'directory/of/choice' within
311 # the mail store. The directory will be created if necessary.
315 # Store the message in file 'name'. The default is to store it
316 # in 'msg-<count>', where <count> is three-digit number of the
321 # Text to use as the body of the email message
323 # '[from]="Some User <user@example.com>"'
324 # '[to]="Some User <user@example.com>"'
325 # '[subject]="Subject of email message"'
326 # '[date]="RFC 822 Date"'
328 # Values for email headers. If not provided, default values will
329 # be generated instead.
331 # '[cc]="Some User <user@example.com>"'
332 # [reply-to]=some-address
333 # [in-reply-to]=<message-id>
334 # [references]=<message-id>
335 # [content-type]=content-type-specification
336 # '[header]=full header line, including keyword'
338 # Additional values for email headers. If these are not provided
339 # then the relevant headers will simply not appear in the
344 # Controls the message-id of the created message.
350 # This is our (bash-specific) magic for doing named parameters
351 local -A template="($@)"
352 local additional_headers
354 gen_msg_cnt=$((gen_msg_cnt + 1))
355 if [ -z "${template[filename]}" ]; then
356 gen_msg_name="msg-$(printf "%03d" $gen_msg_cnt)"
358 gen_msg_name=${template[filename]}
361 if [ -z "${template[id]}" ]; then
362 gen_msg_id="${gen_msg_name%:2,*}@notmuch-test-suite"
364 gen_msg_id="${template[id]}"
367 if [ -z "${template[dir]}" ]; then
368 gen_msg_filename="${MAIL_DIR}/$gen_msg_name"
370 gen_msg_filename="${MAIL_DIR}/${template[dir]}/$gen_msg_name"
371 mkdir -p "$(dirname "$gen_msg_filename")"
374 if [ -z "${template[body]}" ]; then
375 template[body]="This is just a test message (#${gen_msg_cnt})"
378 if [ -z "${template[from]}" ]; then
379 template[from]="Notmuch Test Suite <test_suite@notmuchmail.org>"
382 if [ -z "${template[to]}" ]; then
383 template[to]="Notmuch Test Suite <test_suite@notmuchmail.org>"
386 if [ -z "${template[subject]}" ]; then
387 if [ -n "$test_subtest_name" ]; then
388 template[subject]="$test_subtest_name"
390 template[subject]="Test message #${gen_msg_cnt}"
392 elif [ "${template[subject]}" = "@FORCE_EMPTY" ]; then
396 if [ -z "${template[date]}" ]; then
397 # we use decreasing timestamps here for historical reasons;
398 # the existing test suite when we converted to unique timestamps just
399 # happened to have signicantly fewer failures with that choice.
400 local date_secs=$((978709437 - gen_msg_cnt))
401 # printf %(..)T is bash 4.2+ feature. use perl fallback if needed...
402 TZ=UTC printf -v template[date] "%(%a, %d %b %Y %T %z)T" $date_secs 2>/dev/null ||
403 template[date]=`perl -le 'use POSIX "strftime";
404 @time = gmtime '"$date_secs"';
405 print strftime "%a, %d %b %Y %T +0000", @time'`
408 additional_headers=""
409 if [ ! -z "${template[header]}" ]; then
410 additional_headers="${template[header]}
411 ${additional_headers}"
414 if [ ! -z "${template[reply-to]}" ]; then
415 additional_headers="Reply-To: ${template[reply-to]}
416 ${additional_headers}"
419 if [ ! -z "${template[in-reply-to]}" ]; then
420 additional_headers="In-Reply-To: ${template[in-reply-to]}
421 ${additional_headers}"
424 if [ ! -z "${template[cc]}" ]; then
425 additional_headers="Cc: ${template[cc]}
426 ${additional_headers}"
429 if [ ! -z "${template[bcc]}" ]; then
430 additional_headers="Bcc: ${template[bcc]}
431 ${additional_headers}"
434 if [ ! -z "${template[references]}" ]; then
435 additional_headers="References: ${template[references]}
436 ${additional_headers}"
439 if [ ! -z "${template[content-type]}" ]; then
440 additional_headers="Content-Type: ${template[content-type]}
441 ${additional_headers}"
444 if [ ! -z "${template[content-transfer-encoding]}" ]; then
445 additional_headers="Content-Transfer-Encoding: ${template[content-transfer-encoding]}
446 ${additional_headers}"
449 # Note that in the way we're setting it above and using it below,
450 # `additional_headers' will also serve as the header / body separator
451 # (empty line in between).
453 cat <<EOF >"$gen_msg_filename"
454 From: ${template[from]}
456 Message-Id: <${gen_msg_id}>
457 Subject: ${template[subject]}
458 Date: ${template[date]}
459 ${additional_headers}
464 # Generate a new message and add it to the database.
466 # All of the arguments and return values supported by generate_message
467 # are also supported here, so see that function for details.
470 generate_message "$@" &&
471 notmuch new > /dev/null
474 # Deliver a message with emacs and add it to the database
476 # Uses emacs to generate and deliver a message to the mail store.
477 # Accepts arbitrary extra emacs/elisp functions to modify the message
478 # before sending, which is useful to doing things like attaching files
479 # to the message and encrypting/signing.
480 emacs_deliver_message ()
485 # before we can send a message, we have to prepare the FCC maildir
486 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
487 # eval'ing smtp-dummy --background will set smtp_dummy_pid
489 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
490 test -n "$smtp_dummy_pid" || return 1
493 "(let ((message-send-mail-function 'message-smtpmail-send-it)
494 (mail-host-address \"example.com\")
495 (smtpmail-smtp-server \"localhost\")
496 (smtpmail-smtp-service \"25025\"))
499 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
500 (message-goto-subject)
501 (insert \"${subject}\")
505 (notmuch-mua-send-and-exit))"
507 # In case message was sent properly, client waits for confirmation
508 # before exiting and resuming control here; therefore making sure
509 # that server exits by sending (KILL) signal to it is safe.
510 kill -9 $smtp_dummy_pid
511 notmuch new >/dev/null
514 # Pretend to deliver a message with emacs. Really save it to a file
515 # and add it to the database
517 # Uses emacs to generate and deliver a message to the mail store.
518 # Accepts arbitrary extra emacs/elisp functions to modify the message
519 # before sending, which is useful to doing things like attaching files
520 # to the message and encrypting/signing.
526 # before we can send a message, we have to prepare the FCC maildir
527 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
530 "(let ((message-send-mail-function (lambda () t))
531 (mail-host-address \"example.com\"))
534 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
535 (message-goto-subject)
536 (insert \"${subject}\")
540 (notmuch-mua-send-and-exit))" || return 1
541 notmuch new >/dev/null
544 # Generate a corpus of email and add it to the database.
546 # This corpus is fixed, (it happens to be 50 messages from early in
547 # the history of the notmuch mailing list), which allows for reliably
548 # testing commands that need to operate on a not-totally-trivial
549 # number of messages.
553 if [ -d $TEST_DIRECTORY/corpus.mail ]; then
554 cp -a $TEST_DIRECTORY/corpus.mail ${MAIL_DIR}
556 cp -a $TEST_DIRECTORY/corpus ${MAIL_DIR}
557 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
558 cp -a ${MAIL_DIR} $TEST_DIRECTORY/corpus.mail
562 test_begin_subtest ()
564 if [ -n "$inside_subtest" ]; then
565 exec 1>&6 2>&7 # Restore stdout and stderr
566 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
568 test_subtest_name="$1"
570 # Redirect test output to the previously prepared file descriptors
571 # 3 and 4 (see below)
572 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
577 # Pass test if two arguments match
579 # Note: Unlike all other test_expect_* functions, this function does
580 # not accept a test name. Instead, the caller should call
581 # test_begin_subtest before calling this function in order to set the
585 exec 1>&6 2>&7 # Restore stdout and stderr
587 test "$#" = 3 && { prereq=$1; shift; } || prereq=
589 error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
593 if ! test_skip "$test_subtest_name"
595 if [ "$output" = "$expected" ]; then
598 testname=$this_test.$test_count
599 echo "$expected" > $testname.expected
600 echo "$output" > $testname.output
601 test_failure_ "$(diff -u $testname.expected $testname.output)"
606 # Like test_expect_equal, but takes two filenames.
607 test_expect_equal_file ()
609 exec 1>&6 2>&7 # Restore stdout and stderr
611 test "$#" = 3 && { prereq=$1; shift; } || prereq=
613 error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
616 basename1=`basename "$file1"`
618 basename2=`basename "$file2"`
619 if ! test_skip "$test_subtest_name"
621 if diff -q "$file1" "$file2" >/dev/null ; then
624 testname=$this_test.$test_count
625 cp "$file1" "$testname.$basename1"
626 cp "$file2" "$testname.$basename2"
627 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
632 # Like test_expect_equal, but arguments are JSON expressions to be
633 # canonicalized before diff'ing. If an argument cannot be parsed, it
634 # is used unchanged so that there's something to diff against.
635 test_expect_equal_json () {
636 # The test suite forces LC_ALL=C, but this causes Python 3 to
637 # decode stdin as ASCII. We need to read JSON in UTF-8, so
638 # override Python's stdio encoding defaults.
639 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -mjson.tool \
641 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -mjson.tool \
644 test_expect_equal "$output" "$expected" "$@"
647 # Sort the top-level list of JSON data from stdin.
649 PYTHONIOENCODING=utf-8 python -c \
650 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
653 test_emacs_expect_t () {
654 test "$#" = 2 && { prereq=$1; shift; } || prereq=
656 error "bug in the test script: not 1 or 2 parameters to test_emacs_expect_t"
659 if ! test_skip "$test_subtest_name"
661 test_emacs "(notmuch-test-run $1)" >/dev/null
663 # Restore state after the test.
664 exec 1>&6 2>&7 # Restore stdout and stderr
667 # Report success/failure.
673 test_failure_ "${result}"
676 # Restore state after the (non) test.
677 exec 1>&6 2>&7 # Restore stdout and stderr
684 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
689 # this relies on the default format being batch-tag, otherwise some tests will break
690 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
693 notmuch_search_sanitize ()
695 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
698 notmuch_search_files_sanitize ()
703 notmuch_dir_sanitize ()
705 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
708 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
709 notmuch_show_sanitize ()
711 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
713 notmuch_show_sanitize_all ()
716 -e 's| filename:.*| filename:XXXXX|' \
717 -e 's| id:[^ ]* | id:XXXXX |' | \
718 notmuch_date_sanitize
721 notmuch_json_show_sanitize ()
724 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
725 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
726 -e 's|"filename": "signature.asc",||g' \
727 -e 's|"filename": "/[^"]*",|"filename": "YYYYY",|g' \
728 -e 's|"timestamp": 97.......|"timestamp": 42|g'
731 notmuch_emacs_error_sanitize ()
739 -e 's/^\[.*\]$/[XXX]/' \
740 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
743 notmuch_date_sanitize ()
746 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
749 notmuch_uuid_sanitize ()
751 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
754 notmuch_built_with_sanitize ()
756 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
759 notmuch_config_sanitize ()
761 notmuch_dir_sanitize | notmuch_built_with_sanitize
764 # End of notmuch helper functions
766 # Use test_set_prereq to tell that a particular prerequisite is available.
767 # The prerequisite can later be checked for in two ways:
769 # - Explicitly using test_have_prereq.
771 # - Implicitly by specifying the prerequisite tag in the calls to
772 # test_expect_{success,failure,code}.
774 # The single parameter is the prerequisite tag (a simple word, in all
775 # capital letters by convention).
778 satisfied="$satisfied$1 "
782 test_have_prereq () {
791 declare -A test_missing_external_prereq_
792 declare -A test_subtest_missing_external_prereq_
794 # declare prerequisite for the given external binary
795 test_declare_external_prereq () {
797 test "$#" = 2 && name=$2 || name="$binary(1)"
799 if ! hash $binary 2>/dev/null; then
800 test_missing_external_prereq_["${binary}"]=t
803 test_subtest_missing_external_prereq_[\"${name}\"]=t
809 # Explicitly require external prerequisite. Useful when binary is
810 # called indirectly (e.g. from emacs).
811 # Returns success if dependency is available, failure otherwise.
812 test_require_external_prereq () {
814 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
815 # dependency is missing, call the replacement function to note it
822 # You are not expected to call test_ok_ and test_failure_ directly, use
823 # the text_expect_* functions instead.
826 if test "$test_subtest_known_broken_" = "t"; then
827 test_known_broken_ok_
830 test_success=$(($test_success + 1))
831 if test -n "$NOTMUCH_TEST_QUIET"; then
834 say_color pass "%-6s" "PASS"
835 echo " $test_subtest_name"
839 if test "$test_subtest_known_broken_" = "t"; then
840 test_known_broken_failure_ "$@"
843 test_failure=$(($test_failure + 1))
844 print_test_description
845 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
846 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
850 test_failure_message_ () {
851 say_color error "%-6s" "$1"
854 echo "$@" | sed -e 's/^/ /'
855 if test "$verbose" != "t"; then cat test.output; fi
858 test_known_broken_ok_ () {
860 test_fixed=$(($test_fixed+1))
861 say_color pass "%-6s" "FIXED"
862 echo " $test_subtest_name"
865 test_known_broken_failure_ () {
867 test_broken=$(($test_broken+1))
868 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
873 test "$debug" = "" || eval "$1"
878 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
881 eval >&3 2>&4 "$test_cleanup"
886 test_count=$(($test_count+1))
888 for skp in $NOTMUCH_SKIP_TESTS
890 case $this_test.$test_count in
895 case $this_test_bare.$test_count in
901 if test -z "$to_skip" && test -n "$prereq" &&
902 ! test_have_prereq "$prereq"
908 test_report_skip_ "$@"
911 test_check_missing_external_prereqs_ "$@"
916 test_check_missing_external_prereqs_ () {
917 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
918 say_color skip >&1 "missing prerequisites: "
919 echo ${!test_subtest_missing_external_prereq_[@]} >&1
920 test_report_skip_ "$@"
926 test_report_skip_ () {
928 say_color skip >&3 "skipping test:"
930 say_color skip "%-6s" "SKIP"
934 test_subtest_known_broken () {
935 test_subtest_known_broken_=t
938 test_expect_success () {
939 test "$#" = 3 && { prereq=$1; shift; } || prereq=
941 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
942 test_subtest_name="$1"
948 # test_run_ may update missing external prerequisites
949 test_check_missing_external_prereqs_ "$@" ||
950 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
959 test_expect_code () {
960 test "$#" = 4 && { prereq=$1; shift; } || prereq=
962 error "bug in the test script: not 3 or 4 parameters to test-expect-code"
963 test_subtest_name="$2"
969 # test_run_ may update missing external prerequisites,
970 test_check_missing_external_prereqs_ "$@" ||
971 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
975 test_failure_ "exit code $eval_ret, expected $1" "$3"
980 # test_external runs external test scripts that provide continuous
981 # test output about their progress, and succeeds/fails on
982 # zero/non-zero exit code. It outputs the test output on stdout even
983 # in non-verbose mode, and announces the external script with "* run
984 # <n>: ..." before running it. When providing relative paths, keep in
985 # mind that all scripts run in "trash directory".
986 # Usage: test_external description command arguments...
987 # Example: test_external 'Perl API' perl ../path/to/test.pl
989 test "$#" = 4 && { prereq=$1; shift; } || prereq=
991 error >&6 "bug in the test script: not 3 or 4 parameters to test_external"
992 test_subtest_name="$1"
995 if ! test_skip "$test_subtest_name" "$@"
997 # Announce the script to reduce confusion about the
998 # test output that follows.
999 say_color "" " run $test_count: $descr ($*)"
1000 # Run command; redirect its stderr to &4 as in
1001 # test_run_, but keep its stdout on our stdout even in
1013 # Like test_external, but in addition tests that the command generated
1014 # no output on stderr.
1015 test_external_without_stderr () {
1016 # The temporary file has no (and must have no) security
1018 tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
1019 stderr="$tmp/git-external-stderr.$$.tmp"
1020 test_external "$@" 4> "$stderr"
1021 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
1022 test_subtest_name="no stderr: $1"
1024 if [ ! -s "$stderr" ]; then
1028 if [ "$verbose" = t ]; then
1029 output=`echo; echo Stderr is:; cat "$stderr"`
1033 # rm first in case test_failure exits.
1035 test_failure_ "$@" "$output"
1039 # This is not among top-level (test_expect_success)
1040 # but is a prefix that can be used in the test script, like:
1042 # test_expect_success 'complain and die' '
1044 # do something else &&
1045 # test_must_fail git checkout ../outerspace
1048 # Writing this as "! git checkout ../outerspace" is wrong, because
1049 # the failure could be due to a segv. We want a controlled failure.
1053 test $? -gt 0 -a $? -le 129 -o $? -gt 192
1056 # test_cmp is a helper function to compare actual and expected output.
1057 # You can use it like:
1059 # test_expect_success 'foo works' '
1060 # echo expected >expected &&
1062 # test_cmp expected actual
1065 # This could be written as either "cmp" or "diff -u", but:
1066 # - cmp's output is not nearly as easy to read as diff -u
1067 # - not all diff versions understand "-u"
1073 # This function can be used to schedule some commands to be run
1074 # unconditionally at the end of the test to restore sanity:
1076 # test_expect_success 'test core.capslock' '
1077 # git config core.capslock true &&
1078 # test_when_finished "git config --unset core.capslock" &&
1082 # That would be roughly equivalent to
1084 # test_expect_success 'test core.capslock' '
1085 # git config core.capslock true &&
1087 # git config --unset core.capslock
1090 # except that the greeting and config --unset must both succeed for
1093 test_when_finished () {
1095 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
1100 test_results_dir="$TEST_DIRECTORY/test-results"
1101 mkdir -p "$test_results_dir"
1102 test_results_path="$test_results_dir/$this_test"
1104 echo "total $test_count" >> $test_results_path
1105 echo "success $test_success" >> $test_results_path
1106 echo "fixed $test_fixed" >> $test_results_path
1107 echo "broken $test_broken" >> $test_results_path
1108 echo "failed $test_failure" >> $test_results_path
1109 echo "" >> $test_results_path
1111 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
1113 if [ "$test_failure" = "0" ]; then
1114 if [ "$test_broken" = "0" ]; then
1115 rm -rf "$remove_tmp"
1123 emacs_generate_script () {
1124 # Construct a little test script here for the benefit of the user,
1125 # (who can easily run "run_emacs" to get the same emacs environment
1126 # for investigating any failures).
1127 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
1130 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
1132 # Here's what we are using here:
1134 # --quick Use minimal customization. This implies --no-init-file,
1135 # --no-site-file and (emacs 24) --no-site-lisp
1137 # --directory Ensure that the local elisp sources are found
1139 # --load Force loading of notmuch.el and test-lib.el
1141 exec ${TEST_EMACS} --quick \
1142 --directory "$TEST_DIRECTORY/../emacs" --load notmuch.el \
1143 --directory "$TEST_DIRECTORY" --load test-lib.el \
1146 chmod a+x "$TMP_DIRECTORY/run_emacs"
1150 # test dependencies beforehand to avoid the waiting loop below
1151 missing_dependencies=
1152 test_require_external_prereq dtach || missing_dependencies=1
1153 test_require_external_prereq emacs || missing_dependencies=1
1154 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
1155 test -z "$missing_dependencies" || return
1157 if [ -z "$EMACS_SERVER" ]; then
1158 emacs_tests="${this_test_bare}.el"
1159 if [ -f "$TEST_DIRECTORY/$emacs_tests" ]; then
1160 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
1164 server_name="notmuch-test-suite-$$"
1165 # start a detached session with an emacs server
1166 # user's TERM (or 'vt100' in case user's TERM is unset, empty
1167 # or 'dumb') is given to dtach which assumes a minimally
1168 # VT100-compatible terminal -- and emacs inherits that
1169 TERM=$DTACH_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
1170 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
1171 --no-window-system \
1173 --eval '(setq server-name \"$server_name\")' \
1174 --eval '(server-start)' \
1175 --eval '(orphan-watchdog $$)'" || return
1176 EMACS_SERVER="$server_name"
1177 # wait until the emacs server is up
1178 until test_emacs '()' >/dev/null 2>/dev/null; do
1183 # Clear test-output output file. Most Emacs tests end with a
1184 # call to (test-output). If the test code fails with an
1185 # exception before this call, the output file won't get
1186 # updated. Since we don't want to compare against an output
1187 # file from another test, so start out with an empty file.
1191 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $@)"
1195 # Note: if there is need to print debug information from python program,
1196 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1197 PYTHONPATH="$TEST_DIRECTORY/../bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1198 $NOTMUCH_PYTHON -B - > OUTPUT
1202 MAIL_DIR=$MAIL_DIR ruby -I $TEST_DIRECTORY/../bindings/ruby> OUTPUT
1206 exec_file="test${test_count}"
1207 test_file="${exec_file}.c"
1209 ${TEST_CC} ${TEST_CFLAGS} -I${TEST_DIRECTORY} -I${TEST_DIRECTORY}/../lib -o ${exec_file} ${test_file} -L${TEST_DIRECTORY}/../lib/ -lnotmuch -ltalloc
1210 echo "== stdout ==" > OUTPUT.stdout
1211 echo "== stderr ==" > OUTPUT.stderr
1212 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1213 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr > OUTPUT
1217 # Creates a script that counts how much time it is executed and calls
1218 # notmuch. $notmuch_counter_command is set to the path to the
1219 # generated script. Use notmuch_counter_value() function to get the
1220 # current counter value.
1221 notmuch_counter_reset () {
1222 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1223 if [ ! -x "$notmuch_counter_command" ]; then
1224 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1225 cat >"$notmuch_counter_command" <<EOF || return
1228 read count < "$notmuch_counter_state_path"
1229 echo \$((count + 1)) > "$notmuch_counter_state_path"
1233 chmod +x "$notmuch_counter_command" || return
1236 echo 0 > "$notmuch_counter_state_path"
1239 # Returns the current notmuch counter value.
1240 notmuch_counter_value () {
1241 if [ -r "$notmuch_counter_state_path" ]; then
1242 read count < "$notmuch_counter_state_path"
1249 test_reset_state_ () {
1250 test -z "$test_init_done_" && test_init_
1252 test_subtest_known_broken_=
1253 test_subtest_missing_external_prereq_=()
1256 # called once before the first subtest
1260 # skip all tests if there were external prerequisites missing during init
1261 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1265 . ./test-lib-common.sh || exit 1
1267 emacs_generate_script
1270 # Use -P to resolve symlinks in our working directory so that the cwd
1271 # in subprocesses like git equals our $PWD (for pathname comparisons).
1272 cd -P "$test" || error "Cannot set up test environment"
1274 if test "$verbose" = "t"
1278 exec 4>test.output 3>&4
1281 for skp in $NOTMUCH_SKIP_TESTS
1284 for skp in $NOTMUCH_SKIP_TESTS
1286 case "$this_test" in
1291 case "$this_test_bare" in
1299 say_color skip >&3 "skipping test $this_test altogether"
1300 say_color skip "skip all tests in $this_test"
1305 # Provide an implementation of the 'yes' utility
1320 # Fix some commands on Windows
1323 # Windows has its own (incompatible) sort and find
1333 # git sees Windows-style pwd
1337 # no POSIX permissions
1338 # backslashes in pathspec are converted to '/'
1339 # exec does not inherit the PID
1342 test_set_prereq POSIXPERM
1343 test_set_prereq BSLASHPSPEC
1344 test_set_prereq EXECKEEPSPID
1348 test -z "$NO_PERL" && test_set_prereq PERL
1349 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1351 # test whether the filesystem supports symbolic links
1352 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1355 # convert variable from configure to more convenient form
1356 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1364 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1366 # declare prerequisites for external binaries used in tests
1367 test_declare_external_prereq dtach
1368 test_declare_external_prereq emacs
1369 test_declare_external_prereq ${TEST_EMACSCLIENT}
1370 test_declare_external_prereq gdb
1371 test_declare_external_prereq gpg
1372 test_declare_external_prereq openssl
1373 test_declare_external_prereq gpgsm
1374 test_declare_external_prereq ${NOTMUCH_PYTHON}