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
87 # A regexp to match 5 and 40 hexdigits
88 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
89 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
91 _x04='[0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
92 _x32="$_x04$_x04$_x04$_x04$_x04$_x04$_x04$_x04"
94 # Each test should start with something like this, after copyright notices:
96 # test_description='Description of this test...
97 # This test checks if command xyzzy does the right thing...
100 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
101 TERM=$ORIGINAL_TERM &&
104 tput bold >/dev/null 2>&1 &&
105 tput setaf 1 >/dev/null 2>&1 &&
106 tput sgr0 >/dev/null 2>&1
110 while test "$#" -ne 0
113 -d|--d|--de|--deb|--debu|--debug)
115 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
116 immediate=t; shift ;;
117 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
118 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
119 -h|--h|--he|--hel|--help)
121 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
123 -q|--q|--qu|--qui|--quie|--quiet)
126 with_dashes=t; shift ;;
132 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
133 valgrind=t; verbose=t; shift ;;
135 shift ;; # was handled already
137 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
140 echo "error: unknown test option '$1'" >&2; exit 1 ;;
144 if test -n "$debug"; then
146 printf " %-4s" "[$((test_count - 1))]"
154 if test -n "$color"; then
160 error) tput bold; tput setaf 1;; # bold red
161 skip) tput bold; tput setaf 2;; # bold green
162 pass) tput setaf 2;; # green
163 info) tput setaf 3;; # brown
164 *) test -n "$quiet" && return;;
175 test -z "$1" && test -n "$quiet" && return
184 say_color error "error: $*\n"
193 test "${test_description}" != "" ||
194 error "Test script did not set test_description."
196 if test "$help" = "t"
198 echo "Tests ${test_description}"
202 test_description_printed=
203 print_test_description ()
205 test -z "$test_description_printed" || return 0
207 echo $this_test: "Testing ${test_description}"
208 test_description_printed=1
210 if [ -z "$NOTMUCH_TEST_QUIET" ]
212 print_test_description
225 rm -rf "$TEST_TMPDIR"
230 if test -n "$GIT_EXIT_OK"
235 say_color error '%-6s' FATAL
236 echo " $test_subtest_name"
238 echo "Unexpected exit while executing $0. Exit code $code."
245 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
250 # Note: TEST_TMPDIR *NOT* exported!
251 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
253 trap 'die_signal' HUP INT TERM
255 test_decode_color () {
256 sed -e 's/.\[1m/<WHITE>/g' \
257 -e 's/.\[31m/<RED>/g' \
258 -e 's/.\[32m/<GREEN>/g' \
259 -e 's/.\[33m/<YELLOW>/g' \
260 -e 's/.\[34m/<BLUE>/g' \
261 -e 's/.\[35m/<MAGENTA>/g' \
262 -e 's/.\[36m/<CYAN>/g' \
263 -e 's/.\[m/<RESET>/g'
275 sed -e 's/$/Q/' | tr Q '\015'
279 tr '\015' Q | sed -e 's/Q$//'
282 # Generate a new message in the mail directory, with a unique message
283 # ID and subject. The message is not added to the index.
285 # After this function returns, the filename of the generated message
286 # is available as $gen_msg_filename and the message ID is available as
289 # This function supports named parameters with the bash syntax for
290 # assigning a value to an associative array ([name]=value). The
291 # supported parameters are:
293 # [dir]=directory/of/choice
295 # Generate the message in directory 'directory/of/choice' within
296 # the mail store. The directory will be created if necessary.
300 # Store the message in file 'name'. The default is to store it
301 # in 'msg-<count>', where <count> is three-digit number of the
306 # Text to use as the body of the email message
308 # '[from]="Some User <user@example.com>"'
309 # '[to]="Some User <user@example.com>"'
310 # '[subject]="Subject of email message"'
311 # '[date]="RFC 822 Date"'
313 # Values for email headers. If not provided, default values will
314 # be generated instead.
316 # '[cc]="Some User <user@example.com>"'
317 # [reply-to]=some-address
318 # [in-reply-to]=<message-id>
319 # [references]=<message-id>
320 # [content-type]=content-type-specification
321 # '[header]=full header line, including keyword'
323 # Additional values for email headers. If these are not provided
324 # then the relevant headers will simply not appear in the
329 # Controls the message-id of the created message.
335 # This is our (bash-specific) magic for doing named parameters
336 local -A template="($@)"
337 local additional_headers
339 gen_msg_cnt=$((gen_msg_cnt + 1))
340 if [ -z "${template[filename]}" ]; then
341 gen_msg_name="msg-$(printf "%03d" $gen_msg_cnt)"
343 gen_msg_name=${template[filename]}
346 if [ -z "${template[id]}" ]; then
347 gen_msg_id="${gen_msg_name%:2,*}@notmuch-test-suite"
349 gen_msg_id="${template[id]}"
352 if [ -z "${template[dir]}" ]; then
353 gen_msg_filename="${MAIL_DIR}/$gen_msg_name"
355 gen_msg_filename="${MAIL_DIR}/${template[dir]}/$gen_msg_name"
356 mkdir -p "$(dirname "$gen_msg_filename")"
359 if [ -z "${template[body]}" ]; then
360 template[body]="This is just a test message (#${gen_msg_cnt})"
363 if [ -z "${template[from]}" ]; then
364 template[from]="Notmuch Test Suite <test_suite@notmuchmail.org>"
367 if [ -z "${template[to]}" ]; then
368 template[to]="Notmuch Test Suite <test_suite@notmuchmail.org>"
371 if [ -z "${template[subject]}" ]; then
372 if [ -n "$test_subtest_name" ]; then
373 template[subject]="$test_subtest_name"
375 template[subject]="Test message #${gen_msg_cnt}"
377 elif [ "${template[subject]}" = "@FORCE_EMPTY" ]; then
381 if [ -z "${template[date]}" ]; then
382 # we use decreasing timestamps here for historical reasons;
383 # the existing test suite when we converted to unique timestamps just
384 # happened to have signicantly fewer failures with that choice.
385 local date_secs=$((978709437 - gen_msg_cnt))
386 # printf %(..)T is bash 4.2+ feature. use perl fallback if needed...
387 TZ=UTC printf -v template[date] "%(%a, %d %b %Y %T %z)T" $date_secs 2>/dev/null ||
388 template[date]=`perl -le 'use POSIX "strftime";
389 @time = gmtime '"$date_secs"';
390 print strftime "%a, %d %b %Y %T +0000", @time'`
393 additional_headers=""
394 if [ ! -z "${template[header]}" ]; then
395 additional_headers="${template[header]}
396 ${additional_headers}"
399 if [ ! -z "${template[reply-to]}" ]; then
400 additional_headers="Reply-To: ${template[reply-to]}
401 ${additional_headers}"
404 if [ ! -z "${template[in-reply-to]}" ]; then
405 additional_headers="In-Reply-To: ${template[in-reply-to]}
406 ${additional_headers}"
409 if [ ! -z "${template[cc]}" ]; then
410 additional_headers="Cc: ${template[cc]}
411 ${additional_headers}"
414 if [ ! -z "${template[bcc]}" ]; then
415 additional_headers="Bcc: ${template[bcc]}
416 ${additional_headers}"
419 if [ ! -z "${template[references]}" ]; then
420 additional_headers="References: ${template[references]}
421 ${additional_headers}"
424 if [ ! -z "${template[content-type]}" ]; then
425 additional_headers="Content-Type: ${template[content-type]}
426 ${additional_headers}"
429 if [ ! -z "${template[content-transfer-encoding]}" ]; then
430 additional_headers="Content-Transfer-Encoding: ${template[content-transfer-encoding]}
431 ${additional_headers}"
434 # Note that in the way we're setting it above and using it below,
435 # `additional_headers' will also serve as the header / body separator
436 # (empty line in between).
438 cat <<EOF >"$gen_msg_filename"
439 From: ${template[from]}
441 Message-Id: <${gen_msg_id}>
442 Subject: ${template[subject]}
443 Date: ${template[date]}
444 ${additional_headers}
449 # Generate a new message and add it to the database.
451 # All of the arguments and return values supported by generate_message
452 # are also supported here, so see that function for details.
455 generate_message "$@" &&
456 notmuch new > /dev/null
459 # Deliver a message with emacs and add it to the database
461 # Uses emacs to generate and deliver a message to the mail store.
462 # Accepts arbitrary extra emacs/elisp functions to modify the message
463 # before sending, which is useful to doing things like attaching files
464 # to the message and encrypting/signing.
465 emacs_deliver_message ()
470 # before we can send a message, we have to prepare the FCC maildir
471 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
472 # eval'ing smtp-dummy --background will set smtp_dummy_pid
474 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
475 test -n "$smtp_dummy_pid" || return 1
478 "(let ((message-send-mail-function 'message-smtpmail-send-it)
479 (mail-host-address \"example.com\")
480 (smtpmail-smtp-server \"localhost\")
481 (smtpmail-smtp-service \"25025\"))
484 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
485 (message-goto-subject)
486 (insert \"${subject}\")
490 (message-send-and-exit))"
492 # In case message was sent properly, client waits for confirmation
493 # before exiting and resuming control here; therefore making sure
494 # that server exits by sending (KILL) signal to it is safe.
495 kill -9 $smtp_dummy_pid
496 notmuch new >/dev/null
499 # Pretend to deliver a message with emacs. Really save it to a file
500 # and add it to the database
502 # Uses emacs to generate and deliver a message to the mail store.
503 # Accepts arbitrary extra emacs/elisp functions to modify the message
504 # before sending, which is useful to doing things like attaching files
505 # to the message and encrypting/signing.
511 # before we can send a message, we have to prepare the FCC maildir
512 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
515 "(let ((message-send-mail-function (lambda () t))
516 (mail-host-address \"example.com\"))
519 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
520 (message-goto-subject)
521 (insert \"${subject}\")
525 (message-send-and-exit))" || return 1
526 notmuch new >/dev/null
529 # Generate a corpus of email and add it to the database.
531 # This corpus is fixed, (it happens to be 50 messages from early in
532 # the history of the notmuch mailing list), which allows for reliably
533 # testing commands that need to operate on a not-totally-trivial
534 # number of messages.
538 if [ -d $TEST_DIRECTORY/corpus.mail ]; then
539 cp -a $TEST_DIRECTORY/corpus.mail ${MAIL_DIR}
541 cp -a $TEST_DIRECTORY/corpus ${MAIL_DIR}
542 notmuch new >/dev/null
543 cp -a ${MAIL_DIR} $TEST_DIRECTORY/corpus.mail
547 test_begin_subtest ()
549 if [ -n "$inside_subtest" ]; then
550 exec 1>&6 2>&7 # Restore stdout and stderr
551 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
553 test_subtest_name="$1"
555 # Redirect test output to the previously prepared file descriptors
556 # 3 and 4 (see below)
557 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
562 # Pass test if two arguments match
564 # Note: Unlike all other test_expect_* functions, this function does
565 # not accept a test name. Instead, the caller should call
566 # test_begin_subtest before calling this function in order to set the
570 exec 1>&6 2>&7 # Restore stdout and stderr
572 test "$#" = 3 && { prereq=$1; shift; } || prereq=
574 error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
578 if ! test_skip "$test_subtest_name"
580 if [ "$output" = "$expected" ]; then
583 testname=$this_test.$test_count
584 echo "$expected" > $testname.expected
585 echo "$output" > $testname.output
586 test_failure_ "$(diff -u $testname.expected $testname.output)"
591 # Like test_expect_equal, but takes two filenames.
592 test_expect_equal_file ()
594 exec 1>&6 2>&7 # Restore stdout and stderr
596 test "$#" = 3 && { prereq=$1; shift; } || prereq=
598 error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
601 basename1=`basename "$file1"`
603 basename2=`basename "$file2"`
604 if ! test_skip "$test_subtest_name"
606 if diff -q "$file1" "$file2" >/dev/null ; then
609 testname=$this_test.$test_count
610 cp "$file1" "$testname.$basename1"
611 cp "$file2" "$testname.$basename2"
612 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
617 # Like test_expect_equal, but arguments are JSON expressions to be
618 # canonicalized before diff'ing. If an argument cannot be parsed, it
619 # is used unchanged so that there's something to diff against.
620 test_expect_equal_json () {
621 # The test suite forces LC_ALL=C, but this causes Python 3 to
622 # decode stdin as ASCII. We need to read JSON in UTF-8, so
623 # override Python's stdio encoding defaults.
624 output=$(echo "$1" | PYTHONIOENCODING=utf-8 python -mjson.tool \
626 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 python -mjson.tool \
629 test_expect_equal "$output" "$expected" "$@"
632 # Sort the top-level list of JSON data from stdin.
634 PYTHONIOENCODING=utf-8 python -c \
635 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
638 test_emacs_expect_t () {
639 test "$#" = 2 && { prereq=$1; shift; } || prereq=
641 error "bug in the test script: not 1 or 2 parameters to test_emacs_expect_t"
644 if ! test_skip "$test_subtest_name"
646 test_emacs "(notmuch-test-run $1)" >/dev/null
648 # Restore state after the test.
649 exec 1>&6 2>&7 # Restore stdout and stderr
652 # Report success/failure.
658 test_failure_ "${result}"
661 # Restore state after the (non) test.
662 exec 1>&6 2>&7 # Restore stdout and stderr
669 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
672 notmuch_search_sanitize ()
674 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
677 notmuch_search_files_sanitize()
679 sed -e "s,$MAIL_DIR,MAIL_DIR,"
682 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
683 notmuch_show_sanitize ()
685 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
687 notmuch_show_sanitize_all ()
690 -e 's| filename:.*| filename:XXXXX|' \
691 -e 's| id:[^ ]* | id:XXXXX |' | \
692 notmuch_date_sanitize
695 notmuch_json_show_sanitize ()
698 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
699 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
700 -e 's|"filename": "signature.asc",||g' \
701 -e 's|"filename": "/[^"]*",|"filename": "YYYYY",|g' \
702 -e 's|"timestamp": 97.......|"timestamp": 42|g'
705 notmuch_emacs_error_sanitize ()
713 -e 's/^\[.*\]$/[XXX]/' \
714 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
717 notmuch_date_sanitize ()
720 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
722 # End of notmuch helper functions
724 # Use test_set_prereq to tell that a particular prerequisite is available.
725 # The prerequisite can later be checked for in two ways:
727 # - Explicitly using test_have_prereq.
729 # - Implicitly by specifying the prerequisite tag in the calls to
730 # test_expect_{success,failure,code}.
732 # The single parameter is the prerequisite tag (a simple word, in all
733 # capital letters by convention).
736 satisfied="$satisfied$1 "
740 test_have_prereq () {
749 declare -A test_missing_external_prereq_
750 declare -A test_subtest_missing_external_prereq_
752 # declare prerequisite for the given external binary
753 test_declare_external_prereq () {
755 test "$#" = 2 && name=$2 || name="$binary(1)"
757 if ! hash $binary 2>/dev/null; then
758 test_missing_external_prereq_["${binary}"]=t
761 test_subtest_missing_external_prereq_[\"${name}\"]=t
767 # Explicitly require external prerequisite. Useful when binary is
768 # called indirectly (e.g. from emacs).
769 # Returns success if dependency is available, failure otherwise.
770 test_require_external_prereq () {
772 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
773 # dependency is missing, call the replacement function to note it
780 # You are not expected to call test_ok_ and test_failure_ directly, use
781 # the text_expect_* functions instead.
784 if test "$test_subtest_known_broken_" = "t"; then
785 test_known_broken_ok_
788 test_success=$(($test_success + 1))
789 if test -n "$NOTMUCH_TEST_QUIET"; then
792 say_color pass "%-6s" "PASS"
793 echo " $test_subtest_name"
797 if test "$test_subtest_known_broken_" = "t"; then
798 test_known_broken_failure_ "$@"
801 test_failure=$(($test_failure + 1))
802 print_test_description
803 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
804 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
808 test_failure_message_ () {
809 say_color error "%-6s" "$1"
812 echo "$@" | sed -e 's/^/ /'
813 if test "$verbose" != "t"; then cat test.output; fi
816 test_known_broken_ok_ () {
818 test_fixed=$(($test_fixed+1))
819 say_color pass "%-6s" "FIXED"
820 echo " $test_subtest_name"
823 test_known_broken_failure_ () {
825 test_broken=$(($test_broken+1))
826 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
831 test "$debug" = "" || eval "$1"
836 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
839 eval >&3 2>&4 "$test_cleanup"
844 test_count=$(($test_count+1))
846 for skp in $NOTMUCH_SKIP_TESTS
848 case $this_test.$test_count in
853 case $this_test_bare.$test_count in
859 if test -z "$to_skip" && test -n "$prereq" &&
860 ! test_have_prereq "$prereq"
866 test_report_skip_ "$@"
869 test_check_missing_external_prereqs_ "$@"
874 test_check_missing_external_prereqs_ () {
875 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
876 say_color skip >&1 "missing prerequisites: "
877 echo ${!test_subtest_missing_external_prereq_[@]} >&1
878 test_report_skip_ "$@"
884 test_report_skip_ () {
886 say_color skip >&3 "skipping test:"
888 say_color skip "%-6s" "SKIP"
892 test_subtest_known_broken () {
893 test_subtest_known_broken_=t
896 test_expect_success () {
897 test "$#" = 3 && { prereq=$1; shift; } || prereq=
899 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
900 test_subtest_name="$1"
906 # test_run_ may update missing external prerequisites
907 test_check_missing_external_prereqs_ "$@" ||
908 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
917 test_expect_code () {
918 test "$#" = 4 && { prereq=$1; shift; } || prereq=
920 error "bug in the test script: not 3 or 4 parameters to test-expect-code"
921 test_subtest_name="$2"
927 # test_run_ may update missing external prerequisites,
928 test_check_missing_external_prereqs_ "$@" ||
929 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
933 test_failure_ "exit code $eval_ret, expected $1" "$3"
938 # test_external runs external test scripts that provide continuous
939 # test output about their progress, and succeeds/fails on
940 # zero/non-zero exit code. It outputs the test output on stdout even
941 # in non-verbose mode, and announces the external script with "* run
942 # <n>: ..." before running it. When providing relative paths, keep in
943 # mind that all scripts run in "trash directory".
944 # Usage: test_external description command arguments...
945 # Example: test_external 'Perl API' perl ../path/to/test.pl
947 test "$#" = 4 && { prereq=$1; shift; } || prereq=
949 error >&6 "bug in the test script: not 3 or 4 parameters to test_external"
950 test_subtest_name="$1"
953 if ! test_skip "$test_subtest_name" "$@"
955 # Announce the script to reduce confusion about the
956 # test output that follows.
957 say_color "" " run $test_count: $descr ($*)"
958 # Run command; redirect its stderr to &4 as in
959 # test_run_, but keep its stdout on our stdout even in
971 # Like test_external, but in addition tests that the command generated
972 # no output on stderr.
973 test_external_without_stderr () {
974 # The temporary file has no (and must have no) security
976 tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
977 stderr="$tmp/git-external-stderr.$$.tmp"
978 test_external "$@" 4> "$stderr"
979 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
980 test_subtest_name="no stderr: $1"
982 if [ ! -s "$stderr" ]; then
986 if [ "$verbose" = t ]; then
987 output=`echo; echo Stderr is:; cat "$stderr"`
991 # rm first in case test_failure exits.
993 test_failure_ "$@" "$output"
997 # This is not among top-level (test_expect_success)
998 # but is a prefix that can be used in the test script, like:
1000 # test_expect_success 'complain and die' '
1002 # do something else &&
1003 # test_must_fail git checkout ../outerspace
1006 # Writing this as "! git checkout ../outerspace" is wrong, because
1007 # the failure could be due to a segv. We want a controlled failure.
1011 test $? -gt 0 -a $? -le 129 -o $? -gt 192
1014 # test_cmp is a helper function to compare actual and expected output.
1015 # You can use it like:
1017 # test_expect_success 'foo works' '
1018 # echo expected >expected &&
1020 # test_cmp expected actual
1023 # This could be written as either "cmp" or "diff -u", but:
1024 # - cmp's output is not nearly as easy to read as diff -u
1025 # - not all diff versions understand "-u"
1031 # This function can be used to schedule some commands to be run
1032 # unconditionally at the end of the test to restore sanity:
1034 # test_expect_success 'test core.capslock' '
1035 # git config core.capslock true &&
1036 # test_when_finished "git config --unset core.capslock" &&
1040 # That would be roughly equivalent to
1042 # test_expect_success 'test core.capslock' '
1043 # git config core.capslock true &&
1045 # git config --unset core.capslock
1048 # except that the greeting and config --unset must both succeed for
1051 test_when_finished () {
1053 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
1058 test_results_dir="$TEST_DIRECTORY/test-results"
1059 mkdir -p "$test_results_dir"
1060 test_results_path="$test_results_dir/$this_test"
1062 echo "total $test_count" >> $test_results_path
1063 echo "success $test_success" >> $test_results_path
1064 echo "fixed $test_fixed" >> $test_results_path
1065 echo "broken $test_broken" >> $test_results_path
1066 echo "failed $test_failure" >> $test_results_path
1067 echo "" >> $test_results_path
1069 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
1071 if [ "$test_failure" = "0" ]; then
1072 if [ "$test_broken" = "0" ]; then
1073 rm -rf "$remove_tmp"
1081 emacs_generate_script () {
1082 # Construct a little test script here for the benefit of the user,
1083 # (who can easily run "run_emacs" to get the same emacs environment
1084 # for investigating any failures).
1085 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
1088 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
1090 # Here's what we are using here:
1092 # --quick Use minimal customization. This implies --no-init-file,
1093 # --no-site-file and (emacs 24) --no-site-lisp
1095 # --directory Ensure that the local elisp sources are found
1097 # --load Force loading of notmuch.el and test-lib.el
1099 exec ${TEST_EMACS} --quick \
1100 --directory "$TEST_DIRECTORY/../emacs" --load notmuch.el \
1101 --directory "$TEST_DIRECTORY" --load test-lib.el \
1104 chmod a+x "$TMP_DIRECTORY/run_emacs"
1108 # test dependencies beforehand to avoid the waiting loop below
1109 missing_dependencies=
1110 test_require_external_prereq dtach || missing_dependencies=1
1111 test_require_external_prereq emacs || missing_dependencies=1
1112 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
1113 test -z "$missing_dependencies" || return
1115 if [ -z "$EMACS_SERVER" ]; then
1116 emacs_tests="${this_test_bare}.el"
1117 if [ -f "$TEST_DIRECTORY/$emacs_tests" ]; then
1118 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
1122 server_name="notmuch-test-suite-$$"
1123 # start a detached session with an emacs server
1124 # user's TERM (or 'vt100' in case user's TERM is unset, empty
1125 # or 'dumb') is given to dtach which assumes a minimally
1126 # VT100-compatible terminal -- and emacs inherits that
1127 TERM=$DTACH_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
1128 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
1129 --no-window-system \
1131 --eval '(setq server-name \"$server_name\")' \
1132 --eval '(server-start)' \
1133 --eval '(orphan-watchdog $$)'" || return
1134 EMACS_SERVER="$server_name"
1135 # wait until the emacs server is up
1136 until test_emacs '()' >/dev/null 2>/dev/null; do
1141 # Clear test-output output file. Most Emacs tests end with a
1142 # call to (test-output). If the test code fails with an
1143 # exception before this call, the output file won't get
1144 # updated. Since we don't want to compare against an output
1145 # file from another test, so start out with an empty file.
1149 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $@)"
1153 export LD_LIBRARY_PATH=$TEST_DIRECTORY/../lib
1154 export PYTHONPATH=$TEST_DIRECTORY/../bindings/python
1156 # Some distros (e.g. Arch Linux) ship Python 2.* as /usr/bin/python2,
1157 # most others as /usr/bin/python. So first try python2, and fallback to
1158 # python if python2 doesn't exist.
1160 [[ ${test_missing_external_prereq_[python2]} == t ]] && cmd=python
1162 (echo "import sys; _orig_stdout=sys.stdout; sys.stdout=open('OUTPUT', 'w')"; cat) \
1167 exec_file="test${test_count}"
1168 test_file="${exec_file}.c"
1170 export LD_LIBRARY_PATH=${TEST_DIRECTORY}/../lib
1171 ${TEST_CC} ${TEST_CFLAGS} -I${TEST_DIRECTORY}/../lib -o ${exec_file} ${test_file} -L${TEST_DIRECTORY}/../lib/ -lnotmuch -ltalloc
1172 echo "== stdout ==" > OUTPUT.stdout
1173 echo "== stderr ==" > OUTPUT.stderr
1174 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1175 sed "s,${PWD},CWD,g" OUTPUT.stdout OUTPUT.stderr > OUTPUT
1179 # Creates a script that counts how much time it is executed and calls
1180 # notmuch. $notmuch_counter_command is set to the path to the
1181 # generated script. Use notmuch_counter_value() function to get the
1182 # current counter value.
1183 notmuch_counter_reset () {
1184 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1185 if [ ! -x "$notmuch_counter_command" ]; then
1186 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1187 cat >"$notmuch_counter_command" <<EOF || return
1190 read count < "$notmuch_counter_state_path"
1191 echo \$((count + 1)) > "$notmuch_counter_state_path"
1195 chmod +x "$notmuch_counter_command" || return
1198 echo 0 > "$notmuch_counter_state_path"
1201 # Returns the current notmuch counter value.
1202 notmuch_counter_value () {
1203 if [ -r "$notmuch_counter_state_path" ]; then
1204 read count < "$notmuch_counter_state_path"
1211 test_reset_state_ () {
1212 test -z "$test_init_done_" && test_init_
1214 test_subtest_known_broken_=
1215 test_subtest_missing_external_prereq_=()
1218 # called once before the first subtest
1222 # skip all tests if there were external prerequisites missing during init
1223 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1227 . ./test-lib-common.sh
1229 emacs_generate_script
1232 # Use -P to resolve symlinks in our working directory so that the cwd
1233 # in subprocesses like git equals our $PWD (for pathname comparisons).
1234 cd -P "$test" || error "Cannot setup test environment"
1236 if test "$verbose" = "t"
1240 exec 4>test.output 3>&4
1243 for skp in $NOTMUCH_SKIP_TESTS
1246 for skp in $NOTMUCH_SKIP_TESTS
1248 case "$this_test" in
1253 case "$this_test_bare" in
1261 say_color skip >&3 "skipping test $this_test altogether"
1262 say_color skip "skip all tests in $this_test"
1267 # Provide an implementation of the 'yes' utility
1282 # Fix some commands on Windows
1285 # Windows has its own (incompatible) sort and find
1295 # git sees Windows-style pwd
1299 # no POSIX permissions
1300 # backslashes in pathspec are converted to '/'
1301 # exec does not inherit the PID
1304 test_set_prereq POSIXPERM
1305 test_set_prereq BSLASHPSPEC
1306 test_set_prereq EXECKEEPSPID
1310 test -z "$NO_PERL" && test_set_prereq PERL
1311 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1313 # test whether the filesystem supports symbolic links
1314 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1317 # declare prerequisites for external binaries used in tests
1318 test_declare_external_prereq dtach
1319 test_declare_external_prereq emacs
1320 test_declare_external_prereq ${TEST_EMACSCLIENT}
1321 test_declare_external_prereq gdb
1322 test_declare_external_prereq gpg
1323 test_declare_external_prereq python
1324 test_declare_external_prereq python2