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.
29 # Ensure NOTMUCH_SRCDIR and NOTMUCH_BUILDDIR are set.
30 . $(dirname "$0")/export-dirs.sh || exit 1
32 # It appears that people try to run tests without building...
33 if [[ ! -x "$NOTMUCH_BUILDDIR/notmuch" ]]; then
34 echo >&2 'You do not seem to have built notmuch yet.'
39 this_test=${this_test%.sh}
40 this_test_bare=${this_test#T[0-9][0-9][0-9]-}
42 # if --tee was passed, write the output not only to the terminal, but
43 # additionally to the file test-results/$BASENAME.out, too.
44 case "$GIT_TEST_TEE_STARTED, $* " in
46 # do not redirect again
48 *' --tee '*|*' --va'*)
50 BASE=test-results/$this_test
51 (GIT_TEST_TEE_STARTED=done "$BASH" "$0" "$@" 2>&1;
52 echo $? > $BASE.exit) | tee $BASE.out
53 test "$(cat $BASE.exit)" = 0
58 # Save STDOUT to fd 6 and STDERR to fd 7.
60 # Make xtrace debugging (when used) use redirected STDERR, with verbose lead:
62 export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
64 # Keep the original TERM for say_color and test_emacs
67 # Set SMART_TERM to vt100 for known dumb/unknown terminal.
68 # Otherwise use whatever TERM is currently used so that
69 # users' actual TERM environments are being used in tests.
77 # For repeatability, reset the environment to known value.
83 export LANG LC_ALL PAGER TERM TZ
84 GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
85 if [[ ( -n "$TEST_EMACS" && -z "$TEST_EMACSCLIENT" ) || \
86 ( -z "$TEST_EMACS" && -n "$TEST_EMACSCLIENT" ) ]]; then
87 echo "error: must specify both or neither of TEST_EMACS and TEST_EMACSCLIENT" >&2
90 TEST_EMACS=${TEST_EMACS:-${EMACS:-emacs}}
91 TEST_EMACSCLIENT=${TEST_EMACSCLIENT:-emacsclient}
92 TEST_GDB=${TEST_GDB:-gdb}
93 TEST_CC=${TEST_CC:-cc}
94 TEST_CFLAGS=${TEST_CFLAGS:-"-g -O0"}
96 # Protect ourselves from common misconfiguration to export
97 # CDPATH into the environment
103 unset ALTERNATE_EDITOR
108 [ -d ${GNUPGHOME} ] && return
109 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
110 at_exit_function _gnupg_exit
111 mkdir -m 0700 "$GNUPGHOME"
112 gpg --no-tty --import <$NOTMUCH_SRCDIR/test/gnupg-secret-key.asc >"$GNUPGHOME"/import.log 2>&1
113 test_debug "cat $GNUPGHOME/import.log"
114 if (gpg --quick-random --version >/dev/null 2>&1) ; then
115 echo quick-random >> "$GNUPGHOME"/gpg.conf
116 elif (gpg --debug-quick-random --version >/dev/null 2>&1) ; then
117 echo debug-quick-random >> "$GNUPGHOME"/gpg.conf
119 echo no-emit-version >> "$GNUPGHOME"/gpg.conf
121 # Change this if we ship a new test key
122 FINGERPRINT="5AEAB11F5E33DCE875DDB75B6D92612D94E46381"
123 SELF_USERID="Notmuch Test Suite <test_suite@notmuchmail.org> (INSECURE!)"
124 printf '%s:6:\n' "$FINGERPRINT" | gpg --quiet --batch --no-tty --import-ownertrust
127 # Each test should start with something like this, after copyright notices:
129 # test_description='Description of this test...
130 # This test checks if command xyzzy does the right thing...
132 # . ./test-lib.sh || exit 1
134 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
135 TERM=$ORIGINAL_TERM &&
138 tput bold >/dev/null 2>&1 &&
139 tput setaf 1 >/dev/null 2>&1 &&
140 tput sgr0 >/dev/null 2>&1
144 while test "$#" -ne 0
150 immediate=t; shift ;;
158 with_dashes=t; shift ;;
165 valgrind=t; verbose=t; shift ;;
167 shift ;; # was handled already
169 echo "error: unknown test option '$1'" >&2; exit 1 ;;
173 if test -n "$debug"; then
175 printf " %-4s" "[$((test_count - 1))]"
183 if test -n "$color"; then
189 error) tput bold; tput setaf 1;; # bold red
190 skip) tput bold; tput setaf 2;; # bold green
191 pass) tput setaf 2;; # green
192 info) tput setaf 3;; # brown
193 *) test -n "$quiet" && return;;
204 test -z "$1" && test -n "$quiet" && return
213 say_color error "error: $*\n"
222 test "${test_description}" != "" ||
223 error "Test script did not set test_description."
225 if test "$help" = "t"
227 echo "Tests ${test_description}"
231 test_description_printed=
232 print_test_description ()
234 test -z "$test_description_printed" || return 0
236 echo $this_test: "Testing ${test_description}"
237 test_description_printed=1
239 if [ -z "$NOTMUCH_TEST_QUIET" ]
241 print_test_description
250 declare -a _exit_functions=()
252 at_exit_function () {
253 _exit_functions=($1 ${_exit_functions[@]/$1})
256 rm_exit_function () {
257 _exit_functions=(${_exit_functions[@]/$1})
264 for _fn in ${_exit_functions[@]}; do $_fn; done
265 rm -rf "$TEST_TMPDIR"
270 if test -n "$GIT_EXIT_OK"
275 say_color error '%-6s' FATAL
276 echo " $test_subtest_name"
278 echo "Unexpected exit while executing $0. Exit code $code."
285 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
292 say_color error '%-6s' FATAL
295 echo "Unexpected exit while executing $0."
300 # Note: TEST_TMPDIR *NOT* exported!
301 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
302 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
303 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
304 trap 'trap_exit' EXIT
305 trap 'trap_signal' HUP INT TERM
307 # Deliver a message with emacs and add it to the database
309 # Uses emacs to generate and deliver a message to the mail store.
310 # Accepts arbitrary extra emacs/elisp functions to modify the message
311 # before sending, which is useful to doing things like attaching files
312 # to the message and encrypting/signing.
313 emacs_deliver_message ()
318 # before we can send a message, we have to prepare the FCC maildir
319 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
320 # eval'ing smtp-dummy --background will set smtp_dummy_pid
322 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
323 test -n "$smtp_dummy_pid" || return 1
326 "(let ((message-send-mail-function 'message-smtpmail-send-it)
327 (mail-host-address \"example.com\")
328 (smtpmail-smtp-server \"localhost\")
329 (smtpmail-smtp-service \"${smtp_dummy_port}\"))
332 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
333 (message-goto-subject)
334 (insert \"${subject}\")
338 (notmuch-mua-send-and-exit))"
340 # In case message was sent properly, client waits for confirmation
341 # before exiting and resuming control here; therefore making sure
342 # that server exits by sending (KILL) signal to it is safe.
343 kill -9 $smtp_dummy_pid
344 notmuch new >/dev/null
347 # Pretend to deliver a message with emacs. Really save it to a file
348 # and add it to the database
350 # Uses emacs to generate and deliver a message to the mail store.
351 # Accepts arbitrary extra emacs/elisp functions to modify the message
352 # before sending, which is useful to doing things like attaching files
353 # to the message and encrypting/signing.
355 # If any GNU-style long-arguments (like --quiet or --decrypt=true) are
356 # at the head of the argument list, they are sent directly to "notmuch
357 # new" after message delivery
361 while [[ "$1" =~ ^-- ]]; do
362 nmn_args="$nmn_args $1"
368 # before we can send a message, we have to prepare the FCC maildir
369 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
372 "(let ((message-send-mail-function (lambda () t))
373 (mail-host-address \"example.com\"))
376 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
377 (message-goto-subject)
378 (insert \"${subject}\")
382 (notmuch-mua-send-and-exit))" || return 1
383 notmuch new $nmn_args >/dev/null
386 # Add an existing, fixed corpus of email to the database.
388 # $1 is the corpus dir under corpora to add, using "default" if unset.
390 # The default corpus is based on about 50 messages from early in the
391 # history of the notmuch mailing list, which allows for reliably
392 # testing commands that need to operate on a not-totally-trivial
393 # number of messages.
399 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
400 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
403 test_begin_subtest ()
405 if [ -n "$inside_subtest" ]; then
406 exec 1>&6 2>&7 # Restore stdout and stderr
407 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
409 test_subtest_name="$1"
411 # Redirect test output to the previously prepared file descriptors
412 # 3 and 4 (see below)
413 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
418 # Pass test if two arguments match
420 # Note: Unlike all other test_expect_* functions, this function does
421 # not accept a test name. Instead, the caller should call
422 # test_begin_subtest before calling this function in order to set the
426 exec 1>&6 2>&7 # Restore stdout and stderr
427 if [ -z "$inside_subtest" ]; then
428 error "bug in the test script: test_expect_equal without test_begin_subtest"
432 error "bug in the test script: not 2 parameters to test_expect_equal"
436 if ! test_skip "$test_subtest_name"
438 if [ "$output" = "$expected" ]; then
441 testname=$this_test.$test_count
442 echo "$expected" > $testname.expected
443 echo "$output" > $testname.output
444 test_failure_ "$(diff -u $testname.expected $testname.output)"
449 # Like test_expect_equal, but takes two filenames.
450 test_expect_equal_file ()
452 exec 1>&6 2>&7 # Restore stdout and stderr
453 if [ -z "$inside_subtest" ]; then
454 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
458 error "bug in the test script: not 2 parameters to test_expect_equal_file"
462 if ! test_skip "$test_subtest_name"
464 if diff -q "$file1" "$file2" >/dev/null ; then
467 testname=$this_test.$test_count
468 basename1=`basename "$file1"`
469 basename2=`basename "$file2"`
470 cp "$file1" "$testname.$basename1"
471 cp "$file2" "$testname.$basename2"
472 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
477 # Like test_expect_equal, but arguments are JSON expressions to be
478 # canonicalized before diff'ing. If an argument cannot be parsed, it
479 # is used unchanged so that there's something to diff against.
480 test_expect_equal_json () {
481 # The test suite forces LC_ALL=C, but this causes Python 3 to
482 # decode stdin as ASCII. We need to read JSON in UTF-8, so
483 # override Python's stdio encoding defaults.
484 local script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
485 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
487 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
490 test_expect_equal "$output" "$expected" "$@"
493 # Sort the top-level list of JSON data from stdin.
495 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
496 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
499 test_emacs_expect_t () {
501 error "bug in the test script: not 1 parameter to test_emacs_expect_t"
502 if [ -z "$inside_subtest" ]; then
503 error "bug in the test script: test_emacs_expect_t without test_begin_subtest"
507 if ! test_skip "$test_subtest_name"
509 test_emacs "(notmuch-test-run $1)" >/dev/null
511 # Restore state after the test.
512 exec 1>&6 2>&7 # Restore stdout and stderr
515 # Report success/failure.
521 test_failure_ "${result}"
524 # Restore state after the (non) test.
525 exec 1>&6 2>&7 # Restore stdout and stderr
532 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
537 # this relies on the default format being batch-tag, otherwise some tests will break
538 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
541 notmuch_drop_mail_headers ()
545 msg = email.message_from_file(sys.stdin)
546 for hdr in sys.argv[1:]: del msg[hdr]
547 print(msg.as_string(False))
551 notmuch_search_sanitize ()
553 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
556 notmuch_search_files_sanitize ()
561 notmuch_dir_sanitize ()
563 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
566 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
567 notmuch_show_sanitize ()
569 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
571 notmuch_show_sanitize_all ()
574 -e 's| filename:.*| filename:XXXXX|' \
575 -e 's| id:[^ ]* | id:XXXXX |' | \
576 notmuch_date_sanitize
579 notmuch_json_show_sanitize ()
582 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
583 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
584 -e 's|"filename": "signature.asc",||g' \
585 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
586 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
587 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
590 notmuch_emacs_error_sanitize ()
598 -e 's/^\[.*\]$/[XXX]/' \
599 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
602 notmuch_date_sanitize ()
605 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
608 notmuch_uuid_sanitize ()
610 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
613 notmuch_built_with_sanitize ()
615 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
618 notmuch_config_sanitize ()
620 notmuch_dir_sanitize | notmuch_built_with_sanitize
625 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
628 # End of notmuch helper functions
630 # Use test_set_prereq to tell that a particular prerequisite is available.
632 # The prerequisite can later be checked for by using test_have_prereq.
634 # The single parameter is the prerequisite tag (a simple word, in all
635 # capital letters by convention).
638 satisfied="$satisfied$1 "
642 test_have_prereq () {
651 declare -A test_missing_external_prereq_
652 declare -A test_subtest_missing_external_prereq_
654 # declare prerequisite for the given external binary
655 test_declare_external_prereq () {
657 test "$#" = 2 && name=$2 || name="$binary(1)"
659 if ! hash $binary 2>/dev/null; then
660 test_missing_external_prereq_["${binary}"]=t
663 test_subtest_missing_external_prereq_[\"${name}\"]=t
669 # Explicitly require external prerequisite. Useful when binary is
670 # called indirectly (e.g. from emacs).
671 # Returns success if dependency is available, failure otherwise.
672 test_require_external_prereq () {
674 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
675 # dependency is missing, call the replacement function to note it
682 # You are not expected to call test_ok_ and test_failure_ directly, use
683 # the text_expect_* functions instead.
686 if test "$test_subtest_known_broken_" = "t"; then
687 test_known_broken_ok_
690 test_success=$(($test_success + 1))
691 if test -n "$NOTMUCH_TEST_QUIET"; then
694 say_color pass "%-6s" "PASS"
695 echo " $test_subtest_name"
699 print_test_description
700 if test "$test_subtest_known_broken_" = "t"; then
701 test_known_broken_failure_ "$@"
704 test_failure=$(($test_failure + 1))
705 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
706 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
710 test_failure_message_ () {
711 say_color error "%-6s" "$1"
714 if [ "$#" != "0" ]; then
715 echo "$@" | sed -e 's/^/ /'
717 if test "$verbose" != "t"; then cat test.output; fi
720 test_known_broken_ok_ () {
722 test_fixed=$(($test_fixed+1))
723 say_color pass "%-6s" "FIXED"
724 echo " $test_subtest_name"
727 test_known_broken_failure_ () {
729 test_broken=$(($test_broken+1))
730 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
731 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
733 test_failure_message_ "BROKEN" "$test_subtest_name"
739 test "$debug" = "" || eval "$1"
744 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
747 eval >&3 2>&4 "$test_cleanup"
752 test_count=$(($test_count+1))
754 for skp in $NOTMUCH_SKIP_TESTS
756 case $this_test.$test_count in
761 case $this_test_bare.$test_count in
769 test_report_skip_ "$@"
772 test_check_missing_external_prereqs_ "$@"
777 test_check_missing_external_prereqs_ () {
778 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
779 say_color skip >&1 "missing prerequisites: "
780 echo ${!test_subtest_missing_external_prereq_[@]} >&1
781 test_report_skip_ "$@"
787 test_report_skip_ () {
789 say_color skip >&3 "skipping test:"
791 say_color skip "%-6s" "SKIP"
795 test_subtest_known_broken () {
796 test_subtest_known_broken_=t
799 test_expect_success () {
800 exec 1>&6 2>&7 # Restore stdout and stderr
801 if [ -z "$inside_subtest" ]; then
802 error "bug in the test script: test_expect_success without test_begin_subtest"
806 error "bug in the test script: not 1 parameters to test_expect_success"
808 if ! test_skip "$test_subtest_name"
812 # test_run_ may update missing external prerequisites
813 test_check_missing_external_prereqs_ "$@" ||
814 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
823 test_expect_code () {
824 exec 1>&6 2>&7 # Restore stdout and stderr
825 if [ -z "$inside_subtest" ]; then
826 error "bug in the test script: test_expect_code without test_begin_subtest"
830 error "bug in the test script: not 2 parameters to test_expect_code"
832 if ! test_skip "$test_subtest_name"
836 # test_run_ may update missing external prerequisites,
837 test_check_missing_external_prereqs_ "$@" ||
838 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
842 test_failure_ "exit code $eval_ret, expected $1" "$2"
847 # This is not among top-level (test_expect_success)
848 # but is a prefix that can be used in the test script, like:
850 # test_expect_success 'complain and die' '
852 # do something else &&
853 # test_must_fail git checkout ../outerspace
856 # Writing this as "! git checkout ../outerspace" is wrong, because
857 # the failure could be due to a segv. We want a controlled failure.
861 test $? -gt 0 -a $? -le 129 -o $? -gt 192
864 # test_cmp is a helper function to compare actual and expected output.
865 # You can use it like:
867 # test_expect_success 'foo works' '
868 # echo expected >expected &&
870 # test_cmp expected actual
873 # This could be written as either "cmp" or "diff -u", but:
874 # - cmp's output is not nearly as easy to read as diff -u
875 # - not all diff versions understand "-u"
881 # This function can be used to schedule some commands to be run
882 # unconditionally at the end of the test to restore sanity:
884 # test_expect_success 'test core.capslock' '
885 # git config core.capslock true &&
886 # test_when_finished "git config --unset core.capslock" &&
890 # That would be roughly equivalent to
892 # test_expect_success 'test core.capslock' '
893 # git config core.capslock true &&
895 # git config --unset core.capslock
898 # except that the greeting and config --unset must both succeed for
901 test_when_finished () {
903 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
908 test_results_dir="$TEST_DIRECTORY/test-results"
909 mkdir -p "$test_results_dir"
910 test_results_path="$test_results_dir/$this_test"
912 echo "total $test_count" >> $test_results_path
913 echo "success $test_success" >> $test_results_path
914 echo "fixed $test_fixed" >> $test_results_path
915 echo "broken $test_broken" >> $test_results_path
916 echo "failed $test_failure" >> $test_results_path
917 echo "" >> $test_results_path
919 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
921 if [ "$test_failure" = "0" ]; then
922 if [ "$test_broken" = "0" ]; then
931 emacs_generate_script () {
932 # Construct a little test script here for the benefit of the user,
933 # (who can easily run "run_emacs" to get the same emacs environment
934 # for investigating any failures).
935 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
938 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
940 # Here's what we are using here:
942 # --quick Use minimal customization. This implies --no-init-file,
943 # --no-site-file and (emacs 24) --no-site-lisp
945 # --directory Ensure that the local elisp sources are found
947 # --load Force loading of notmuch.el and test-lib.el
949 exec ${TEST_EMACS} --quick \
950 --directory "$NOTMUCH_SRCDIR/emacs" --load notmuch.el \
951 --directory "$NOTMUCH_SRCDIR/test" --load test-lib.el \
954 chmod a+x "$TMP_DIRECTORY/run_emacs"
958 # test dependencies beforehand to avoid the waiting loop below
959 missing_dependencies=
960 test_require_external_prereq dtach || missing_dependencies=1
961 test_require_external_prereq emacs || missing_dependencies=1
962 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
963 test -z "$missing_dependencies" || return
965 if [ -z "$EMACS_SERVER" ]; then
966 emacs_tests="$NOTMUCH_SRCDIR/test/${this_test_bare}.el"
967 if [ -f "$emacs_tests" ]; then
968 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
972 server_name="notmuch-test-suite-$$"
973 # start a detached session with an emacs server
974 # user's TERM (or 'vt100' in case user's TERM is known dumb
975 # or unknown) is given to dtach which assumes a minimally
976 # VT100-compatible terminal -- and emacs inherits that
977 TERM=$SMART_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
978 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
981 --eval '(setq server-name \"$server_name\")' \
982 --eval '(server-start)' \
983 --eval '(orphan-watchdog $$)'" || return
984 EMACS_SERVER="$server_name"
985 # wait until the emacs server is up
986 until test_emacs '()' >/dev/null 2>/dev/null; do
991 # Clear test-output output file. Most Emacs tests end with a
992 # call to (test-output). If the test code fails with an
993 # exception before this call, the output file won't get
994 # updated. Since we don't want to compare against an output
995 # file from another test, so start out with an empty file.
999 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $@)"
1003 # Note: if there is need to print debug information from python program,
1004 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1005 PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1006 $NOTMUCH_PYTHON -B - > OUTPUT
1010 MAIL_DIR=$MAIL_DIR $NOTMUCH_RUBY -I $NOTMUCH_SRCDIR/bindings/ruby> OUTPUT
1014 exec_file="test${test_count}"
1015 test_file="${exec_file}.c"
1017 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
1018 echo "== stdout ==" > OUTPUT.stdout
1019 echo "== stderr ==" > OUTPUT.stderr
1020 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1021 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr > OUTPUT
1025 # Creates a script that counts how much time it is executed and calls
1026 # notmuch. $notmuch_counter_command is set to the path to the
1027 # generated script. Use notmuch_counter_value() function to get the
1028 # current counter value.
1029 notmuch_counter_reset () {
1030 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1031 if [ ! -x "$notmuch_counter_command" ]; then
1032 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1033 cat >"$notmuch_counter_command" <<EOF || return
1036 read count < "$notmuch_counter_state_path"
1037 echo \$((count + 1)) > "$notmuch_counter_state_path"
1041 chmod +x "$notmuch_counter_command" || return
1044 echo 0 > "$notmuch_counter_state_path"
1047 # Returns the current notmuch counter value.
1048 notmuch_counter_value () {
1049 if [ -r "$notmuch_counter_state_path" ]; then
1050 read count < "$notmuch_counter_state_path"
1057 test_reset_state_ () {
1058 test -z "$test_init_done_" && test_init_
1060 test_subtest_known_broken_=
1061 test_subtest_missing_external_prereq_=()
1064 # called once before the first subtest
1068 # skip all tests if there were external prerequisites missing during init
1069 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1073 # Where to run the tests
1074 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1076 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1078 emacs_generate_script
1081 # Use -P to resolve symlinks in our working directory so that the cwd
1082 # in subprocesses like git equals our $PWD (for pathname comparisons).
1083 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1085 if test "$verbose" = "t"
1089 exec 4>test.output 3>&4
1092 for skp in $NOTMUCH_SKIP_TESTS
1095 for skp in $NOTMUCH_SKIP_TESTS
1097 case "$this_test" in
1102 case "$this_test_bare" in
1110 say_color skip >&3 "skipping test $this_test altogether"
1111 say_color skip "skip all tests in $this_test"
1116 # Provide an implementation of the 'yes' utility
1131 # Fix some commands on Windows
1134 # Windows has its own (incompatible) sort and find
1144 # git sees Windows-style pwd
1148 # no POSIX permissions
1149 # backslashes in pathspec are converted to '/'
1150 # exec does not inherit the PID
1153 test_set_prereq POSIXPERM
1154 test_set_prereq BSLASHPSPEC
1155 test_set_prereq EXECKEEPSPID
1159 test -z "$NO_PERL" && test_set_prereq PERL
1160 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1162 # test whether the filesystem supports symbolic links
1163 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1166 # convert variable from configure to more convenient form
1167 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1175 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1177 # declare prerequisites for external binaries used in tests
1178 test_declare_external_prereq dtach
1179 test_declare_external_prereq emacs
1180 test_declare_external_prereq ${TEST_EMACSCLIENT}
1181 test_declare_external_prereq ${TEST_GDB}
1182 test_declare_external_prereq gpg
1183 test_declare_external_prereq openssl
1184 test_declare_external_prereq gpgsm
1185 test_declare_external_prereq ${NOTMUCH_PYTHON}