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 # STDIN from /dev/null. EOF for readers (and ENOTTY for tty related ioctls).
61 # Save STDOUT to fd 6 and STDERR to fd 7.
63 # Make xtrace debugging (when used) use redirected STDERR, with verbose lead:
65 export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
67 # Keep the original TERM for say_color and test_emacs
70 # Set SMART_TERM to vt100 for known dumb/unknown terminal.
71 # Otherwise use whatever TERM is currently used so that
72 # users' actual TERM environments are being used in tests.
80 # For repeatability, reset the environment to known value.
86 export LANG LC_ALL PAGER TERM TZ
87 GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
88 if [[ ( -n "$TEST_EMACS" && -z "$TEST_EMACSCLIENT" ) || \
89 ( -z "$TEST_EMACS" && -n "$TEST_EMACSCLIENT" ) ]]; then
90 echo "error: must specify both or neither of TEST_EMACS and TEST_EMACSCLIENT" >&2
93 TEST_EMACS=${TEST_EMACS:-${EMACS:-emacs}}
94 TEST_EMACSCLIENT=${TEST_EMACSCLIENT:-emacsclient}
95 TEST_GDB=${TEST_GDB:-gdb}
96 TEST_CC=${TEST_CC:-cc}
97 TEST_CFLAGS=${TEST_CFLAGS:-"-g -O0"}
99 # Protect ourselves from common misconfiguration to export
100 # CDPATH into the environment
106 unset ALTERNATE_EDITOR
111 [ -d ${GNUPGHOME} ] && return
112 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
113 at_exit_function _gnupg_exit
114 mkdir -m 0700 "$GNUPGHOME"
115 gpg --no-tty --import <$NOTMUCH_SRCDIR/test/gnupg-secret-key.asc >"$GNUPGHOME"/import.log 2>&1
116 test_debug "cat $GNUPGHOME/import.log"
117 if (gpg --quick-random --version >/dev/null 2>&1) ; then
118 echo quick-random >> "$GNUPGHOME"/gpg.conf
119 elif (gpg --debug-quick-random --version >/dev/null 2>&1) ; then
120 echo debug-quick-random >> "$GNUPGHOME"/gpg.conf
122 echo no-emit-version >> "$GNUPGHOME"/gpg.conf
124 # Change this if we ship a new test key
125 FINGERPRINT="5AEAB11F5E33DCE875DDB75B6D92612D94E46381"
126 SELF_USERID="Notmuch Test Suite <test_suite@notmuchmail.org> (INSECURE!)"
127 printf '%s:6:\n' "$FINGERPRINT" | gpg --quiet --batch --no-tty --import-ownertrust
130 # Each test should start with something like this, after copyright notices:
132 # test_description='Description of this test...
133 # This test checks if command xyzzy does the right thing...
135 # . ./test-lib.sh || exit 1
137 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
138 TERM=$ORIGINAL_TERM &&
141 tput bold >/dev/null 2>&1 &&
142 tput setaf 1 >/dev/null 2>&1 &&
143 tput sgr0 >/dev/null 2>&1
147 while test "$#" -ne 0
153 immediate=t; shift ;;
161 with_dashes=t; shift ;;
168 valgrind=t; verbose=t; shift ;;
170 shift ;; # was handled already
172 echo "error: unknown test option '$1'" >&2; exit 1 ;;
176 if test -n "$debug"; then
178 printf " %-4s" "[$((test_count - 1))]"
186 if test -n "$color"; then
192 error) tput bold; tput setaf 1;; # bold red
193 skip) tput bold; tput setaf 2;; # bold green
194 pass) tput setaf 2;; # green
195 info) tput setaf 3;; # brown
196 *) test -n "$quiet" && return;;
207 test -z "$1" && test -n "$quiet" && return
216 say_color error "error: $*\n"
225 test "${test_description}" != "" ||
226 error "Test script did not set test_description."
228 if test "$help" = "t"
230 echo "Tests ${test_description}"
234 test_description_printed=
235 print_test_description ()
237 test -z "$test_description_printed" || return 0
239 echo $this_test: "Testing ${test_description}"
240 test_description_printed=1
242 if [ -z "$NOTMUCH_TEST_QUIET" ]
244 print_test_description
253 declare -a _exit_functions=()
255 at_exit_function () {
256 _exit_functions=($1 ${_exit_functions[@]/$1})
259 rm_exit_function () {
260 _exit_functions=(${_exit_functions[@]/$1})
267 for _fn in ${_exit_functions[@]}; do $_fn; done
268 rm -rf "$TEST_TMPDIR"
273 if test -n "$GIT_EXIT_OK"
278 say_color error '%-6s' FATAL
279 echo " $test_subtest_name"
281 echo "Unexpected exit while executing $0. Exit code $code."
288 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
295 say_color error '%-6s' FATAL
298 echo "Unexpected exit while executing $0."
303 # Note: TEST_TMPDIR *NOT* exported!
304 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
305 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
306 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
307 trap 'trap_exit' EXIT
308 trap 'trap_signal' HUP INT TERM
310 # Deliver a message with emacs and add it to the database
312 # Uses emacs to generate and deliver a message to the mail store.
313 # Accepts arbitrary extra emacs/elisp functions to modify the message
314 # before sending, which is useful to doing things like attaching files
315 # to the message and encrypting/signing.
316 emacs_deliver_message ()
321 # before we can send a message, we have to prepare the FCC maildir
322 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
323 # eval'ing smtp-dummy --background will set smtp_dummy_pid
325 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
326 test -n "$smtp_dummy_pid" || return 1
329 "(let ((message-send-mail-function 'message-smtpmail-send-it)
330 (mail-host-address \"example.com\")
331 (smtpmail-smtp-server \"localhost\")
332 (smtpmail-smtp-service \"${smtp_dummy_port}\"))
335 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
336 (message-goto-subject)
337 (insert \"${subject}\")
341 (notmuch-mua-send-and-exit))"
343 # In case message was sent properly, client waits for confirmation
344 # before exiting and resuming control here; therefore making sure
345 # that server exits by sending (KILL) signal to it is safe.
346 kill -9 $smtp_dummy_pid
347 notmuch new >/dev/null
350 # Pretend to deliver a message with emacs. Really save it to a file
351 # and add it to the database
353 # Uses emacs to generate and deliver a message to the mail store.
354 # Accepts arbitrary extra emacs/elisp functions to modify the message
355 # before sending, which is useful to doing things like attaching files
356 # to the message and encrypting/signing.
358 # If any GNU-style long-arguments (like --quiet or --decrypt=true) are
359 # at the head of the argument list, they are sent directly to "notmuch
360 # new" after message delivery
364 while [[ "$1" =~ ^-- ]]; do
365 nmn_args="$nmn_args $1"
371 # before we can send a message, we have to prepare the FCC maildir
372 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
375 "(let ((message-send-mail-function (lambda () t))
376 (mail-host-address \"example.com\"))
379 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
380 (message-goto-subject)
381 (insert \"${subject}\")
385 (notmuch-mua-send-and-exit))" || return 1
386 notmuch new $nmn_args >/dev/null
389 # Add an existing, fixed corpus of email to the database.
391 # $1 is the corpus dir under corpora to add, using "default" if unset.
393 # The default corpus is based on about 50 messages from early in the
394 # history of the notmuch mailing list, which allows for reliably
395 # testing commands that need to operate on a not-totally-trivial
396 # number of messages.
402 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
403 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
406 test_begin_subtest ()
408 if [ -n "$inside_subtest" ]; then
409 exec 1>&6 2>&7 # Restore stdout and stderr
410 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
412 test_subtest_name="$1"
414 # Redirect test output to the previously prepared file descriptors
415 # 3 and 4 (see below)
416 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
421 # Pass test if two arguments match
423 # Note: Unlike all other test_expect_* functions, this function does
424 # not accept a test name. Instead, the caller should call
425 # test_begin_subtest before calling this function in order to set the
429 exec 1>&6 2>&7 # Restore stdout and stderr
430 if [ -z "$inside_subtest" ]; then
431 error "bug in the test script: test_expect_equal without test_begin_subtest"
435 error "bug in the test script: not 2 parameters to test_expect_equal"
439 if ! test_skip "$test_subtest_name"
441 if [ "$output" = "$expected" ]; then
444 testname=$this_test.$test_count
445 echo "$expected" > $testname.expected
446 echo "$output" > $testname.output
447 test_failure_ "$(diff -u $testname.expected $testname.output)"
452 # Like test_expect_equal, but takes two filenames.
453 test_expect_equal_file ()
455 exec 1>&6 2>&7 # Restore stdout and stderr
456 if [ -z "$inside_subtest" ]; then
457 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
461 error "bug in the test script: not 2 parameters to test_expect_equal_file"
465 if ! test_skip "$test_subtest_name"
467 if diff -q "$file1" "$file2" >/dev/null ; then
470 testname=$this_test.$test_count
471 basename1=`basename "$file1"`
472 basename2=`basename "$file2"`
473 cp "$file1" "$testname.$basename1"
474 cp "$file2" "$testname.$basename2"
475 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
480 # Like test_expect_equal, but arguments are JSON expressions to be
481 # canonicalized before diff'ing. If an argument cannot be parsed, it
482 # is used unchanged so that there's something to diff against.
483 test_expect_equal_json () {
484 # The test suite forces LC_ALL=C, but this causes Python 3 to
485 # decode stdin as ASCII. We need to read JSON in UTF-8, so
486 # override Python's stdio encoding defaults.
487 local script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
488 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
490 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
493 test_expect_equal "$output" "$expected" "$@"
496 # Sort the top-level list of JSON data from stdin.
498 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
499 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
502 test_emacs_expect_t () {
504 error "bug in the test script: not 1 parameter to test_emacs_expect_t"
505 if [ -z "$inside_subtest" ]; then
506 error "bug in the test script: test_emacs_expect_t without test_begin_subtest"
510 if ! test_skip "$test_subtest_name"
512 test_emacs "(notmuch-test-run $1)" >/dev/null
514 # Restore state after the test.
515 exec 1>&6 2>&7 # Restore stdout and stderr
518 # Report success/failure.
524 test_failure_ "${result}"
527 # Restore state after the (non) test.
528 exec 1>&6 2>&7 # Restore stdout and stderr
535 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
540 # this relies on the default format being batch-tag, otherwise some tests will break
541 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
544 notmuch_drop_mail_headers ()
548 msg = email.message_from_file(sys.stdin)
549 for hdr in sys.argv[1:]: del msg[hdr]
550 print(msg.as_string(False))
554 notmuch_search_sanitize ()
556 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
559 notmuch_search_files_sanitize ()
564 notmuch_dir_sanitize ()
566 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
569 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
570 notmuch_show_sanitize ()
572 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
574 notmuch_show_sanitize_all ()
577 -e 's| filename:.*| filename:XXXXX|' \
578 -e 's| id:[^ ]* | id:XXXXX |' | \
579 notmuch_date_sanitize
582 notmuch_json_show_sanitize ()
585 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
586 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
587 -e 's|"filename": "signature.asc",||g' \
588 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
589 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
590 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
593 notmuch_emacs_error_sanitize ()
601 -e 's/^\[.*\]$/[XXX]/' \
602 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
605 notmuch_date_sanitize ()
608 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
611 notmuch_uuid_sanitize ()
613 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
616 notmuch_built_with_sanitize ()
618 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
621 notmuch_config_sanitize ()
623 notmuch_dir_sanitize | notmuch_built_with_sanitize
628 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
631 # End of notmuch helper functions
633 # Use test_set_prereq to tell that a particular prerequisite is available.
635 # The prerequisite can later be checked for by using test_have_prereq.
637 # The single parameter is the prerequisite tag (a simple word, in all
638 # capital letters by convention).
641 satisfied="$satisfied$1 "
645 test_have_prereq () {
654 declare -A test_missing_external_prereq_
655 declare -A test_subtest_missing_external_prereq_
657 # declare prerequisite for the given external binary
658 test_declare_external_prereq () {
660 test "$#" = 2 && name=$2 || name="$binary(1)"
662 if ! hash $binary 2>/dev/null; then
663 test_missing_external_prereq_["${binary}"]=t
666 test_subtest_missing_external_prereq_[\"${name}\"]=t
672 # Explicitly require external prerequisite. Useful when binary is
673 # called indirectly (e.g. from emacs).
674 # Returns success if dependency is available, failure otherwise.
675 test_require_external_prereq () {
677 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
678 # dependency is missing, call the replacement function to note it
685 # You are not expected to call test_ok_ and test_failure_ directly, use
686 # the text_expect_* functions instead.
689 if test "$test_subtest_known_broken_" = "t"; then
690 test_known_broken_ok_
693 test_success=$(($test_success + 1))
694 if test -n "$NOTMUCH_TEST_QUIET"; then
697 say_color pass "%-6s" "PASS"
698 echo " $test_subtest_name"
702 print_test_description
703 if test "$test_subtest_known_broken_" = "t"; then
704 test_known_broken_failure_ "$@"
707 test_failure=$(($test_failure + 1))
708 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
709 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
713 test_failure_message_ () {
714 say_color error "%-6s" "$1"
717 if [ "$#" != "0" ]; then
718 echo "$@" | sed -e 's/^/ /'
720 if test "$verbose" != "t"; then cat test.output; fi
723 test_known_broken_ok_ () {
725 test_fixed=$(($test_fixed+1))
726 say_color pass "%-6s" "FIXED"
727 echo " $test_subtest_name"
730 test_known_broken_failure_ () {
732 test_broken=$(($test_broken+1))
733 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
734 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
736 test_failure_message_ "BROKEN" "$test_subtest_name"
742 test "$debug" = "" || eval "$1"
747 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
750 eval >&3 2>&4 "$test_cleanup"
755 test_count=$(($test_count+1))
757 for skp in $NOTMUCH_SKIP_TESTS
759 case $this_test.$test_count in
764 case $this_test_bare.$test_count in
772 test_report_skip_ "$@"
775 test_check_missing_external_prereqs_ "$@"
780 test_check_missing_external_prereqs_ () {
781 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
782 say_color skip >&1 "missing prerequisites: "
783 echo ${!test_subtest_missing_external_prereq_[@]} >&1
784 test_report_skip_ "$@"
790 test_report_skip_ () {
792 say_color skip >&3 "skipping test:"
794 say_color skip "%-6s" "SKIP"
798 test_subtest_known_broken () {
799 test_subtest_known_broken_=t
802 test_expect_success () {
803 exec 1>&6 2>&7 # Restore stdout and stderr
804 if [ -z "$inside_subtest" ]; then
805 error "bug in the test script: test_expect_success without test_begin_subtest"
809 error "bug in the test script: not 1 parameters to test_expect_success"
811 if ! test_skip "$test_subtest_name"
815 # test_run_ may update missing external prerequisites
816 test_check_missing_external_prereqs_ "$@" ||
817 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
826 test_expect_code () {
827 exec 1>&6 2>&7 # Restore stdout and stderr
828 if [ -z "$inside_subtest" ]; then
829 error "bug in the test script: test_expect_code without test_begin_subtest"
833 error "bug in the test script: not 2 parameters to test_expect_code"
835 if ! test_skip "$test_subtest_name"
839 # test_run_ may update missing external prerequisites,
840 test_check_missing_external_prereqs_ "$@" ||
841 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
845 test_failure_ "exit code $eval_ret, expected $1" "$2"
850 # This is not among top-level (test_expect_success)
851 # but is a prefix that can be used in the test script, like:
853 # test_expect_success 'complain and die' '
855 # do something else &&
856 # test_must_fail git checkout ../outerspace
859 # Writing this as "! git checkout ../outerspace" is wrong, because
860 # the failure could be due to a segv. We want a controlled failure.
864 test $? -gt 0 -a $? -le 129 -o $? -gt 192
867 # test_cmp is a helper function to compare actual and expected output.
868 # You can use it like:
870 # test_expect_success 'foo works' '
871 # echo expected >expected &&
873 # test_cmp expected actual
876 # This could be written as either "cmp" or "diff -u", but:
877 # - cmp's output is not nearly as easy to read as diff -u
878 # - not all diff versions understand "-u"
884 # This function can be used to schedule some commands to be run
885 # unconditionally at the end of the test to restore sanity:
887 # test_expect_success 'test core.capslock' '
888 # git config core.capslock true &&
889 # test_when_finished "git config --unset core.capslock" &&
893 # That would be roughly equivalent to
895 # test_expect_success 'test core.capslock' '
896 # git config core.capslock true &&
898 # git config --unset core.capslock
901 # except that the greeting and config --unset must both succeed for
904 test_when_finished () {
906 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
911 test_results_dir="$TEST_DIRECTORY/test-results"
912 mkdir -p "$test_results_dir"
913 test_results_path="$test_results_dir/$this_test"
915 echo "total $test_count" >> $test_results_path
916 echo "success $test_success" >> $test_results_path
917 echo "fixed $test_fixed" >> $test_results_path
918 echo "broken $test_broken" >> $test_results_path
919 echo "failed $test_failure" >> $test_results_path
920 echo "" >> $test_results_path
922 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
924 if [ "$test_failure" = "0" ]; then
925 if [ "$test_broken" = "0" ]; then
934 emacs_generate_script () {
935 # Construct a little test script here for the benefit of the user,
936 # (who can easily run "run_emacs" to get the same emacs environment
937 # for investigating any failures).
938 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
941 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
943 # Here's what we are using here:
945 # --quick Use minimal customization. This implies --no-init-file,
946 # --no-site-file and (emacs 24) --no-site-lisp
948 # --directory Ensure that the local elisp sources are found
950 # --load Force loading of notmuch.el and test-lib.el
952 exec ${TEST_EMACS} --quick \
953 --directory "$NOTMUCH_SRCDIR/emacs" --load notmuch.el \
954 --directory "$NOTMUCH_SRCDIR/test" --load test-lib.el \
957 chmod a+x "$TMP_DIRECTORY/run_emacs"
961 # test dependencies beforehand to avoid the waiting loop below
962 missing_dependencies=
963 test_require_external_prereq dtach || missing_dependencies=1
964 test_require_external_prereq emacs || missing_dependencies=1
965 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
966 test -z "$missing_dependencies" || return
968 if [ -z "$EMACS_SERVER" ]; then
969 emacs_tests="$NOTMUCH_SRCDIR/test/${this_test_bare}.el"
970 if [ -f "$emacs_tests" ]; then
971 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
975 server_name="notmuch-test-suite-$$"
976 # start a detached session with an emacs server
977 # user's TERM (or 'vt100' in case user's TERM is known dumb
978 # or unknown) is given to dtach which assumes a minimally
979 # VT100-compatible terminal -- and emacs inherits that
980 TERM=$SMART_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
981 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
984 --eval '(setq server-name \"$server_name\")' \
985 --eval '(server-start)' \
986 --eval '(orphan-watchdog $$)'" || return
987 EMACS_SERVER="$server_name"
988 # wait until the emacs server is up
989 until test_emacs '()' >/dev/null 2>/dev/null; do
994 # Clear test-output output file. Most Emacs tests end with a
995 # call to (test-output). If the test code fails with an
996 # exception before this call, the output file won't get
997 # updated. Since we don't want to compare against an output
998 # file from another test, so start out with an empty file.
1002 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $@)"
1006 # Note: if there is need to print debug information from python program,
1007 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1008 PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1009 $NOTMUCH_PYTHON -B - > OUTPUT
1013 MAIL_DIR=$MAIL_DIR $NOTMUCH_RUBY -I $NOTMUCH_SRCDIR/bindings/ruby> OUTPUT
1017 exec_file="test${test_count}"
1018 test_file="${exec_file}.c"
1020 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
1021 echo "== stdout ==" > OUTPUT.stdout
1022 echo "== stderr ==" > OUTPUT.stderr
1023 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1024 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr > OUTPUT
1028 # Creates a script that counts how much time it is executed and calls
1029 # notmuch. $notmuch_counter_command is set to the path to the
1030 # generated script. Use notmuch_counter_value() function to get the
1031 # current counter value.
1032 notmuch_counter_reset () {
1033 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1034 if [ ! -x "$notmuch_counter_command" ]; then
1035 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1036 cat >"$notmuch_counter_command" <<EOF || return
1039 read count < "$notmuch_counter_state_path"
1040 echo \$((count + 1)) > "$notmuch_counter_state_path"
1044 chmod +x "$notmuch_counter_command" || return
1047 echo 0 > "$notmuch_counter_state_path"
1050 # Returns the current notmuch counter value.
1051 notmuch_counter_value () {
1052 if [ -r "$notmuch_counter_state_path" ]; then
1053 read count < "$notmuch_counter_state_path"
1060 test_reset_state_ () {
1061 test -z "$test_init_done_" && test_init_
1063 test_subtest_known_broken_=
1064 test_subtest_missing_external_prereq_=()
1067 # called once before the first subtest
1071 # skip all tests if there were external prerequisites missing during init
1072 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1076 # Where to run the tests
1077 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1079 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1081 emacs_generate_script
1084 # Use -P to resolve symlinks in our working directory so that the cwd
1085 # in subprocesses like git equals our $PWD (for pathname comparisons).
1086 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1088 if test "$verbose" = "t"
1092 exec 4>test.output 3>&4
1095 for skp in $NOTMUCH_SKIP_TESTS
1098 for skp in $NOTMUCH_SKIP_TESTS
1100 case "$this_test" in
1105 case "$this_test_bare" in
1113 say_color skip >&3 "skipping test $this_test altogether"
1114 say_color skip "skip all tests in $this_test"
1119 # Provide an implementation of the 'yes' utility
1134 # Fix some commands on Windows
1137 # Windows has its own (incompatible) sort and find
1147 # git sees Windows-style pwd
1151 # no POSIX permissions
1152 # backslashes in pathspec are converted to '/'
1153 # exec does not inherit the PID
1156 test_set_prereq POSIXPERM
1157 test_set_prereq BSLASHPSPEC
1158 test_set_prereq EXECKEEPSPID
1162 test -z "$NO_PERL" && test_set_prereq PERL
1163 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1165 # test whether the filesystem supports symbolic links
1166 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1169 # convert variable from configure to more convenient form
1170 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1178 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1180 # declare prerequisites for external binaries used in tests
1181 test_declare_external_prereq dtach
1182 test_declare_external_prereq emacs
1183 test_declare_external_prereq ${TEST_EMACSCLIENT}
1184 test_declare_external_prereq ${TEST_GDB}
1185 test_declare_external_prereq gpg
1186 test_declare_external_prereq openssl
1187 test_declare_external_prereq gpgsm
1188 test_declare_external_prereq ${NOTMUCH_PYTHON}