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.
28 # if --tee was passed, write the output not only to the terminal, but
29 # additionally to the file test-results/$BASENAME.out, too.
30 case "$GIT_TEST_TEE_STARTED, $* " in
32 # do not redirect again
34 *' --tee '*|*' --va'*)
36 BASE=test-results/$(basename "$0" .sh)
37 (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
38 echo $? > $BASE.exit) | tee $BASE.out
39 test "$(cat $BASE.exit)" = 0
44 # Keep the original TERM for say_color and test_emacs
47 # dtach(1) provides more capable terminal environment to anything
48 # that requires more than dumb terminal...
49 [ x"${TERM:-dumb}" = xdumb ] && DTACH_TERM=vt100 || DTACH_TERM=$TERM
51 # For repeatability, reset the environment to known value.
57 export LANG LC_ALL PAGER TERM TZ
58 GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
59 if [[ ( -n "$TEST_EMACS" && -z "$TEST_EMACSCLIENT" ) || \
60 ( -z "$TEST_EMACS" && -n "$TEST_EMACSCLIENT" ) ]]; then
61 echo "error: must specify both or neither of TEST_EMACS and TEST_EMACSCLIENT" >&2
64 TEST_EMACS=${TEST_EMACS:-${EMACS:-emacs}}
65 TEST_EMACSCLIENT=${TEST_EMACSCLIENT:-emacsclient}
67 # Protect ourselves from common misconfiguration to export
68 # CDPATH into the environment
75 # A regexp to match 5 and 40 hexdigits
76 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
77 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
79 _x04='[0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
80 _x32="$_x04$_x04$_x04$_x04$_x04$_x04$_x04$_x04"
82 # Each test should start with something like this, after copyright notices:
84 # test_description='Description of this test...
85 # This test checks if command xyzzy does the right thing...
88 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
89 TERM=$ORIGINAL_TERM &&
92 tput bold >/dev/null 2>&1 &&
93 tput setaf 1 >/dev/null 2>&1 &&
94 tput sgr0 >/dev/null 2>&1
101 -d|--d|--de|--deb|--debu|--debug)
103 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
104 immediate=t; shift ;;
105 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
106 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
107 -h|--h|--he|--hel|--help)
109 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
111 -q|--q|--qu|--qui|--quie|--quiet)
114 with_dashes=t; shift ;;
120 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
121 valgrind=t; verbose=t; shift ;;
123 shift ;; # was handled already
125 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
128 echo "error: unknown test option '$1'" >&2; exit 1 ;;
132 if test -n "$debug"; then
134 printf " %-4s" "[$((test_count - 1))]"
142 if test -n "$color"; then
148 error) tput bold; tput setaf 1;; # bold red
149 skip) tput bold; tput setaf 2;; # bold green
150 pass) tput setaf 2;; # green
151 info) tput setaf 3;; # brown
152 *) test -n "$quiet" && return;;
163 test -z "$1" && test -n "$quiet" && return
172 say_color error "error: $*\n"
181 test "${test_description}" != "" ||
182 error "Test script did not set test_description."
184 if test "$help" = "t"
186 echo "Tests ${test_description}"
190 echo $(basename "$0"): "Testing ${test_description}"
204 rm -rf "$TEST_TMPDIR"
209 if test -n "$GIT_EXIT_OK"
214 say_color error '%-6s' FATAL
215 echo " $test_subtest_name"
217 echo "Unexpected exit while executing $0. Exit code $code."
224 echo >&5 "FATAL: $0: interrupted by signal" $((code - 128))
229 # Note: TEST_TMPDIR *NOT* exported!
230 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
232 trap 'die_signal' HUP INT TERM
234 test_decode_color () {
235 sed -e 's/.\[1m/<WHITE>/g' \
236 -e 's/.\[31m/<RED>/g' \
237 -e 's/.\[32m/<GREEN>/g' \
238 -e 's/.\[33m/<YELLOW>/g' \
239 -e 's/.\[34m/<BLUE>/g' \
240 -e 's/.\[35m/<MAGENTA>/g' \
241 -e 's/.\[36m/<CYAN>/g' \
242 -e 's/.\[m/<RESET>/g'
254 sed -e 's/$/Q/' | tr Q '\015'
258 tr '\015' Q | sed -e 's/Q$//'
261 # Generate a new message in the mail directory, with a unique message
262 # ID and subject. The message is not added to the index.
264 # After this function returns, the filename of the generated message
265 # is available as $gen_msg_filename and the message ID is available as
268 # This function supports named parameters with the bash syntax for
269 # assigning a value to an associative array ([name]=value). The
270 # supported parameters are:
272 # [dir]=directory/of/choice
274 # Generate the message in directory 'directory/of/choice' within
275 # the mail store. The directory will be created if necessary.
279 # Store the message in file 'name'. The default is to store it
280 # in 'msg-<count>', where <count> is three-digit number of the
285 # Text to use as the body of the email message
287 # '[from]="Some User <user@example.com>"'
288 # '[to]="Some User <user@example.com>"'
289 # '[subject]="Subject of email message"'
290 # '[date]="RFC 822 Date"'
292 # Values for email headers. If not provided, default values will
293 # be generated instead.
295 # '[cc]="Some User <user@example.com>"'
296 # [reply-to]=some-address
297 # [in-reply-to]=<message-id>
298 # [references]=<message-id>
299 # [content-type]=content-type-specification
300 # '[header]=full header line, including keyword'
302 # Additional values for email headers. If these are not provided
303 # then the relevant headers will simply not appear in the
308 # Controls the message-id of the created message.
314 # This is our (bash-specific) magic for doing named parameters
315 local -A template="($@)"
316 local additional_headers
318 gen_msg_cnt=$((gen_msg_cnt + 1))
319 if [ -z "${template[filename]}" ]; then
320 gen_msg_name="msg-$(printf "%03d" $gen_msg_cnt)"
322 gen_msg_name=${template[filename]}
325 if [ -z "${template[id]}" ]; then
326 gen_msg_id="${gen_msg_name%:2,*}@notmuch-test-suite"
328 gen_msg_id="${template[id]}"
331 if [ -z "${template[dir]}" ]; then
332 gen_msg_filename="${MAIL_DIR}/$gen_msg_name"
334 gen_msg_filename="${MAIL_DIR}/${template[dir]}/$gen_msg_name"
335 mkdir -p "$(dirname "$gen_msg_filename")"
338 if [ -z "${template[body]}" ]; then
339 template[body]="This is just a test message (#${gen_msg_cnt})"
342 if [ -z "${template[from]}" ]; then
343 template[from]="Notmuch Test Suite <test_suite@notmuchmail.org>"
346 if [ -z "${template[to]}" ]; then
347 template[to]="Notmuch Test Suite <test_suite@notmuchmail.org>"
350 if [ -z "${template[subject]}" ]; then
351 if [ -n "$test_subtest_name" ]; then
352 template[subject]="$test_subtest_name"
354 template[subject]="Test message #${gen_msg_cnt}"
358 if [ -z "${template[date]}" ]; then
359 template[date]="Fri, 05 Jan 2001 15:43:57 +0000"
362 additional_headers=""
363 if [ ! -z "${template[header]}" ]; then
364 additional_headers="${template[header]}
365 ${additional_headers}"
368 if [ ! -z "${template[reply-to]}" ]; then
369 additional_headers="Reply-To: ${template[reply-to]}
370 ${additional_headers}"
373 if [ ! -z "${template[in-reply-to]}" ]; then
374 additional_headers="In-Reply-To: ${template[in-reply-to]}
375 ${additional_headers}"
378 if [ ! -z "${template[cc]}" ]; then
379 additional_headers="Cc: ${template[cc]}
380 ${additional_headers}"
383 if [ ! -z "${template[bcc]}" ]; then
384 additional_headers="Bcc: ${template[bcc]}
385 ${additional_headers}"
388 if [ ! -z "${template[references]}" ]; then
389 additional_headers="References: ${template[references]}
390 ${additional_headers}"
393 if [ ! -z "${template[content-type]}" ]; then
394 additional_headers="Content-Type: ${template[content-type]}
395 ${additional_headers}"
398 if [ ! -z "${template[content-transfer-encoding]}" ]; then
399 additional_headers="Content-Transfer-Encoding: ${template[content-transfer-encoding]}
400 ${additional_headers}"
403 # Note that in the way we're setting it above and using it below,
404 # `additional_headers' will also serve as the header / body separator
405 # (empty line in between).
407 cat <<EOF >"$gen_msg_filename"
408 From: ${template[from]}
410 Message-Id: <${gen_msg_id}>
411 Subject: ${template[subject]}
412 Date: ${template[date]}
413 ${additional_headers}
418 # Generate a new message and add it to the database.
420 # All of the arguments and return values supported by generate_message
421 # are also supported here, so see that function for details.
424 generate_message "$@" &&
425 notmuch new > /dev/null
428 # Deliver a message with emacs and add it to the database
430 # Uses emacs to generate and deliver a message to the mail store.
431 # Accepts arbitrary extra emacs/elisp functions to modify the message
432 # before sending, which is useful to doing things like attaching files
433 # to the message and encrypting/signing.
434 emacs_deliver_message ()
439 # before we can send a message, we have to prepare the FCC maildir
440 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
441 # eval'ing smtp-dummy --background will set smtp_dummy_pid
443 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
444 test -n "$smtp_dummy_pid" || return 1
447 "(let ((message-send-mail-function 'message-smtpmail-send-it)
448 (mail-host-address \"example.com\")
449 (smtpmail-smtp-server \"localhost\")
450 (smtpmail-smtp-service \"25025\"))
454 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
455 (message-goto-subject)
456 (insert \"${subject}\")
460 (message-send-and-exit))"
462 # In case message was sent properly, client waits for confirmation
463 # before exiting and resuming control here; therefore making sure
464 # that server exits by sending (KILL) signal to it is safe.
465 kill -9 $smtp_dummy_pid
466 notmuch new >/dev/null
469 # Generate a corpus of email and add it to the database.
471 # This corpus is fixed, (it happens to be 50 messages from early in
472 # the history of the notmuch mailing list), which allows for reliably
473 # testing commands that need to operate on a not-totally-trivial
474 # number of messages.
478 if [ -d $TEST_DIRECTORY/corpus.mail ]; then
479 cp -a $TEST_DIRECTORY/corpus.mail ${MAIL_DIR}
481 cp -a $TEST_DIRECTORY/corpus ${MAIL_DIR}
482 notmuch new >/dev/null
483 cp -a ${MAIL_DIR} $TEST_DIRECTORY/corpus.mail
487 test_begin_subtest ()
489 if [ -n "$inside_subtest" ]; then
490 exec 1>&6 2>&7 # Restore stdout and stderr
491 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
493 test_subtest_name="$1"
495 # Remember stdout and stderr file descriptors and redirect test
496 # output to the previously prepared file descriptors 3 and 4 (see
498 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
499 exec 6>&1 7>&2 >&3 2>&4
503 # Pass test if two arguments match
505 # Note: Unlike all other test_expect_* functions, this function does
506 # not accept a test name. Instead, the caller should call
507 # test_begin_subtest before calling this function in order to set the
511 exec 1>&6 2>&7 # Restore stdout and stderr
513 test "$#" = 3 && { prereq=$1; shift; } || prereq=
515 error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
519 if ! test_skip "$test_subtest_name"
521 if [ "$output" = "$expected" ]; then
524 testname=$this_test.$test_count
525 echo "$expected" > $testname.expected
526 echo "$output" > $testname.output
527 test_failure_ "$(diff -u $testname.expected $testname.output)"
532 # Like test_expect_equal, but takes two filenames.
533 test_expect_equal_file ()
535 exec 1>&6 2>&7 # Restore stdout and stderr
537 test "$#" = 3 && { prereq=$1; shift; } || prereq=
539 error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
542 basename1=`basename "$file1"`
544 basename2=`basename "$file2"`
545 if ! test_skip "$test_subtest_name"
547 if diff -q "$file1" "$file2" >/dev/null ; then
550 testname=$this_test.$test_count
551 cp "$file1" "$testname.$basename1"
552 cp "$file2" "$testname.$basename2"
553 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
558 # Like test_expect_equal, but arguments are JSON expressions to be
559 # canonicalized before diff'ing. If an argument cannot be parsed, it
560 # is used unchanged so that there's something to diff against.
561 test_expect_equal_json () {
562 # The test suite forces LC_ALL=C, but this causes Python 3 to
563 # decode stdin as ASCII. We need to read JSON in UTF-8, so
564 # override Python's stdio encoding defaults.
565 output=$(echo "$1" | PYTHONIOENCODING=utf-8 python -mjson.tool \
567 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 python -mjson.tool \
570 test_expect_equal "$output" "$expected" "$@"
573 test_emacs_expect_t () {
574 test "$#" = 2 && { prereq=$1; shift; } || prereq=
576 error "bug in the test script: not 1 or 2 parameters to test_emacs_expect_t"
579 if ! test_skip "$test_subtest_name"
581 test_emacs "(notmuch-test-run $1)" >/dev/null
583 # Restore state after the test.
584 exec 1>&6 2>&7 # Restore stdout and stderr
587 # Report success/failure.
593 test_failure_ "${result}"
596 # Restore state after the (non) test.
597 exec 1>&6 2>&7 # Restore stdout and stderr
604 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
607 notmuch_search_sanitize ()
609 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
612 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
613 notmuch_show_sanitize ()
615 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
617 notmuch_show_sanitize_all ()
620 -e 's| filename:.*| filename:XXXXX|' \
621 -e 's| id:[^ ]* | id:XXXXX |'
624 notmuch_json_show_sanitize ()
627 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
628 -e 's|"filename": "/[^"]*",|"filename": "YYYYY",|g'
631 notmuch_emacs_error_sanitize ()
639 -e 's/^\[.*\]$/[XXX]/' \
640 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
642 # End of notmuch helper functions
644 # Use test_set_prereq to tell that a particular prerequisite is available.
645 # The prerequisite can later be checked for in two ways:
647 # - Explicitly using test_have_prereq.
649 # - Implicitly by specifying the prerequisite tag in the calls to
650 # test_expect_{success,failure,code}.
652 # The single parameter is the prerequisite tag (a simple word, in all
653 # capital letters by convention).
656 satisfied="$satisfied$1 "
660 test_have_prereq () {
669 declare -A test_missing_external_prereq_
670 declare -A test_subtest_missing_external_prereq_
672 # declare prerequisite for the given external binary
673 test_declare_external_prereq () {
675 test "$#" = 2 && name=$2 || name="$binary(1)"
677 if ! hash $binary 2>/dev/null; then
678 test_missing_external_prereq_["${binary}"]=t
681 test_subtest_missing_external_prereq_[\"${name}\"]=t
687 # Explicitly require external prerequisite. Useful when binary is
688 # called indirectly (e.g. from emacs).
689 # Returns success if dependency is available, failure otherwise.
690 test_require_external_prereq () {
692 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
693 # dependency is missing, call the replacement function to note it
700 # You are not expected to call test_ok_ and test_failure_ directly, use
701 # the text_expect_* functions instead.
704 if test "$test_subtest_known_broken_" = "t"; then
705 test_known_broken_ok_
708 test_success=$(($test_success + 1))
709 say_color pass "%-6s" "PASS"
710 echo " $test_subtest_name"
714 if test "$test_subtest_known_broken_" = "t"; then
715 test_known_broken_failure_ "$@"
718 test_failure=$(($test_failure + 1))
719 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
720 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
724 test_failure_message_ () {
725 say_color error "%-6s" "$1"
728 echo "$@" | sed -e 's/^/ /'
729 if test "$verbose" != "t"; then cat test.output; fi
732 test_known_broken_ok_ () {
734 test_fixed=$(($test_fixed+1))
735 say_color pass "%-6s" "FIXED"
736 echo " $test_subtest_name"
739 test_known_broken_failure_ () {
741 test_broken=$(($test_broken+1))
742 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
747 test "$debug" = "" || eval "$1"
752 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
755 eval >&3 2>&4 "$test_cleanup"
760 test_count=$(($test_count+1))
762 for skp in $NOTMUCH_SKIP_TESTS
764 case $this_test.$test_count in
769 if test -z "$to_skip" && test -n "$prereq" &&
770 ! test_have_prereq "$prereq"
776 test_report_skip_ "$@"
779 test_check_missing_external_prereqs_ "$@"
784 test_check_missing_external_prereqs_ () {
785 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
786 say_color skip >&1 "missing prerequisites: "
787 echo ${!test_subtest_missing_external_prereq_[@]} >&1
788 test_report_skip_ "$@"
794 test_report_skip_ () {
796 say_color skip >&3 "skipping test:"
798 say_color skip "%-6s" "SKIP"
802 test_subtest_known_broken () {
803 test_subtest_known_broken_=t
806 test_expect_success () {
807 test "$#" = 3 && { prereq=$1; shift; } || prereq=
809 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
810 test_subtest_name="$1"
816 # test_run_ may update missing external prerequisites
817 test_check_missing_external_prereqs_ "$@" ||
818 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
827 test_expect_code () {
828 test "$#" = 4 && { prereq=$1; shift; } || prereq=
830 error "bug in the test script: not 3 or 4 parameters to test-expect-code"
831 test_subtest_name="$2"
837 # test_run_ may update missing external prerequisites,
838 test_check_missing_external_prereqs_ "$@" ||
839 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
843 test_failure_ "exit code $eval_ret, expected $1" "$3"
848 # test_external runs external test scripts that provide continuous
849 # test output about their progress, and succeeds/fails on
850 # zero/non-zero exit code. It outputs the test output on stdout even
851 # in non-verbose mode, and announces the external script with "* run
852 # <n>: ..." before running it. When providing relative paths, keep in
853 # mind that all scripts run in "trash directory".
854 # Usage: test_external description command arguments...
855 # Example: test_external 'Perl API' perl ../path/to/test.pl
857 test "$#" = 4 && { prereq=$1; shift; } || prereq=
859 error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
860 test_subtest_name="$1"
863 if ! test_skip "$test_subtest_name" "$@"
865 # Announce the script to reduce confusion about the
866 # test output that follows.
867 say_color "" " run $test_count: $descr ($*)"
868 # Run command; redirect its stderr to &4 as in
869 # test_run_, but keep its stdout on our stdout even in
881 # Like test_external, but in addition tests that the command generated
882 # no output on stderr.
883 test_external_without_stderr () {
884 # The temporary file has no (and must have no) security
886 tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
887 stderr="$tmp/git-external-stderr.$$.tmp"
888 test_external "$@" 4> "$stderr"
889 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
890 test_subtest_name="no stderr: $1"
892 if [ ! -s "$stderr" ]; then
896 if [ "$verbose" = t ]; then
897 output=`echo; echo Stderr is:; cat "$stderr"`
901 # rm first in case test_failure exits.
903 test_failure_ "$@" "$output"
907 # This is not among top-level (test_expect_success)
908 # but is a prefix that can be used in the test script, like:
910 # test_expect_success 'complain and die' '
912 # do something else &&
913 # test_must_fail git checkout ../outerspace
916 # Writing this as "! git checkout ../outerspace" is wrong, because
917 # the failure could be due to a segv. We want a controlled failure.
921 test $? -gt 0 -a $? -le 129 -o $? -gt 192
924 # test_cmp is a helper function to compare actual and expected output.
925 # You can use it like:
927 # test_expect_success 'foo works' '
928 # echo expected >expected &&
930 # test_cmp expected actual
933 # This could be written as either "cmp" or "diff -u", but:
934 # - cmp's output is not nearly as easy to read as diff -u
935 # - not all diff versions understand "-u"
941 # This function can be used to schedule some commands to be run
942 # unconditionally at the end of the test to restore sanity:
944 # test_expect_success 'test core.capslock' '
945 # git config core.capslock true &&
946 # test_when_finished "git config --unset core.capslock" &&
950 # That would be roughly equivalent to
952 # test_expect_success 'test core.capslock' '
953 # git config core.capslock true &&
955 # git config --unset core.capslock
958 # except that the greeting and config --unset must both succeed for
961 test_when_finished () {
963 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
968 test_results_dir="$TEST_DIRECTORY/test-results"
969 mkdir -p "$test_results_dir"
970 test_results_path="$test_results_dir/${0%.sh}"
972 echo "total $test_count" >> $test_results_path
973 echo "success $test_success" >> $test_results_path
974 echo "fixed $test_fixed" >> $test_results_path
975 echo "broken $test_broken" >> $test_results_path
976 echo "failed $test_failure" >> $test_results_path
977 echo "" >> $test_results_path
981 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
983 if [ "$test_failure" = "0" ]; then
984 if [ "$test_broken" = "0" ]; then
993 emacs_generate_script () {
994 # Construct a little test script here for the benefit of the user,
995 # (who can easily run "run_emacs" to get the same emacs environment
996 # for investigating any failures).
997 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
1000 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
1002 # Here's what we are using here:
1004 # --no-init-file Don't load users ~/.emacs
1006 # --no-site-file Don't load the site-wide startup stuff
1008 # --directory Ensure that the local elisp sources are found
1010 # --load Force loading of notmuch.el and test-lib.el
1012 exec ${TEST_EMACS} --no-init-file --no-site-file \
1013 --directory "$TEST_DIRECTORY/../emacs" --load notmuch.el \
1014 --directory "$TEST_DIRECTORY" --load test-lib.el \
1017 chmod a+x "$TMP_DIRECTORY/run_emacs"
1021 # test dependencies beforehand to avoid the waiting loop below
1022 missing_dependencies=
1023 test_require_external_prereq dtach || missing_dependencies=1
1024 test_require_external_prereq emacs || missing_dependencies=1
1025 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
1026 test -z "$missing_dependencies" || return
1028 if [ -z "$EMACS_SERVER" ]; then
1029 emacs_tests="$(basename $0).el"
1030 if [ -f "$TEST_DIRECTORY/$emacs_tests" ]; then
1031 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
1035 server_name="notmuch-test-suite-$$"
1036 # start a detached session with an emacs server
1037 # user's TERM (or 'vt100' in case user's TERM is unset, empty
1038 # or 'dumb') is given to dtach which assumes a minimally
1039 # VT100-compatible terminal -- and emacs inherits that
1040 TERM=$DTACH_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
1041 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
1042 --no-window-system \
1044 --eval '(setq server-name \"$server_name\")' \
1045 --eval '(server-start)' \
1046 --eval '(orphan-watchdog $$)'" || return
1047 EMACS_SERVER="$server_name"
1048 # wait until the emacs server is up
1049 until test_emacs '()' >/dev/null 2>/dev/null; do
1054 # Clear test-output output file. Most Emacs tests end with a
1055 # call to (test-output). If the test code fails with an
1056 # exception before this call, the output file won't get
1057 # updated. Since we don't want to compare against an output
1058 # file from another test, so start out with an empty file.
1062 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(progn $@)"
1066 export LD_LIBRARY_PATH=$TEST_DIRECTORY/../lib
1067 export PYTHONPATH=$TEST_DIRECTORY/../bindings/python
1069 # Some distros (e.g. Arch Linux) ship Python 2.* as /usr/bin/python2,
1070 # most others as /usr/bin/python. So first try python2, and fallback to
1071 # python if python2 doesn't exist.
1073 [[ ${test_missing_external_prereq_[python2]} == t ]] && cmd=python
1075 (echo "import sys; _orig_stdout=sys.stdout; sys.stdout=open('OUTPUT', 'w')"; cat) \
1079 # Creates a script that counts how much time it is executed and calls
1080 # notmuch. $notmuch_counter_command is set to the path to the
1081 # generated script. Use notmuch_counter_value() function to get the
1082 # current counter value.
1083 notmuch_counter_reset () {
1084 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1085 if [ ! -x "$notmuch_counter_command" ]; then
1086 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1087 cat >"$notmuch_counter_command" <<EOF || return
1090 read count < "$notmuch_counter_state_path"
1091 echo \$((count + 1)) > "$notmuch_counter_state_path"
1095 chmod +x "$notmuch_counter_command" || return
1098 echo 0 > "$notmuch_counter_state_path"
1101 # Returns the current notmuch counter value.
1102 notmuch_counter_value () {
1103 if [ -r "$notmuch_counter_state_path" ]; then
1104 read count < "$notmuch_counter_state_path"
1111 test_reset_state_ () {
1112 test -z "$test_init_done_" && test_init_
1114 test_subtest_known_broken_=
1115 test_subtest_missing_external_prereq_=()
1118 # called once before the first subtest
1122 # skip all tests if there were external prerequisites missing during init
1123 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1127 . ./test-lib-common.sh
1129 emacs_generate_script
1132 # Use -P to resolve symlinks in our working directory so that the cwd
1133 # in subprocesses like git equals our $PWD (for pathname comparisons).
1134 cd -P "$test" || error "Cannot setup test environment"
1136 if test "$verbose" = "t"
1140 exec 4>test.output 3>&4
1144 for skp in $NOTMUCH_SKIP_TESTS
1147 for skp in $NOTMUCH_SKIP_TESTS
1149 case "$this_test" in
1156 say_color skip >&3 "skipping test $this_test altogether"
1157 say_color skip "skip all tests in $this_test"
1162 # Provide an implementation of the 'yes' utility
1177 # Fix some commands on Windows
1180 # Windows has its own (incompatible) sort and find
1190 # git sees Windows-style pwd
1194 # no POSIX permissions
1195 # backslashes in pathspec are converted to '/'
1196 # exec does not inherit the PID
1199 test_set_prereq POSIXPERM
1200 test_set_prereq BSLASHPSPEC
1201 test_set_prereq EXECKEEPSPID
1205 test -z "$NO_PERL" && test_set_prereq PERL
1206 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1208 # test whether the filesystem supports symbolic links
1209 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1212 # declare prerequisites for external binaries used in tests
1213 test_declare_external_prereq dtach
1214 test_declare_external_prereq emacs
1215 test_declare_external_prereq ${TEST_EMACSCLIENT}
1216 test_declare_external_prereq gdb
1217 test_declare_external_prereq gpg
1218 test_declare_external_prereq python
1219 test_declare_external_prereq python2