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
139 while test "$#" -ne 0
145 immediate=t; shift ;;
153 with_dashes=t; shift ;;
160 valgrind=t; verbose=t; shift ;;
162 shift ;; # was handled already
164 echo "error: unknown test option '$1'" >&2; exit 1 ;;
168 if test -n "$debug"; then
170 printf " %-4s" "[$((test_count - 1))]"
178 test -n "$COLORS_WITHOUT_TTY" || [ -t 1 ] || color=
180 if [ -n "$color" ] && [ "$ORIGINAL_TERM" != 'dumb' ] && (
181 TERM=$ORIGINAL_TERM &&
193 if test -n "$color"; then
199 error) tput bold; tput setaf 1;; # bold red
200 skip) tput bold; tput setaf 2;; # bold green
201 pass) tput setaf 2;; # green
202 info) tput setaf 3;; # brown
203 *) test -n "$quiet" && return;;
214 test -z "$1" && test -n "$quiet" && return
223 say_color error "error: $*\n"
232 test "${test_description}" != "" ||
233 error "Test script did not set test_description."
235 if test "$help" = "t"
237 echo "Tests ${test_description}"
241 test_description_printed=
242 print_test_description ()
244 test -z "$test_description_printed" || return 0
246 echo $this_test: "Testing ${test_description}"
247 test_description_printed=1
249 if [ -z "$NOTMUCH_TEST_QUIET" ]
251 print_test_description
260 declare -a _exit_functions=()
262 at_exit_function () {
263 _exit_functions=($1 ${_exit_functions[@]/$1})
266 rm_exit_function () {
267 _exit_functions=(${_exit_functions[@]/$1})
274 for _fn in ${_exit_functions[@]}; do $_fn; done
275 rm -rf "$TEST_TMPDIR"
280 if test -n "$GIT_EXIT_OK"
285 say_color error '%-6s' FATAL
286 echo " $test_subtest_name"
288 echo "Unexpected exit while executing $0. Exit code $code."
295 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
302 say_color error '%-6s' FATAL
305 echo "Unexpected exit while executing $0."
310 # Note: TEST_TMPDIR *NOT* exported!
311 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
312 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
313 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
314 trap 'trap_exit' EXIT
315 trap 'trap_signal' HUP INT TERM
317 # Deliver a message with emacs and add it to the database
319 # Uses emacs to generate and deliver a message to the mail store.
320 # Accepts arbitrary extra emacs/elisp functions to modify the message
321 # before sending, which is useful to doing things like attaching files
322 # to the message and encrypting/signing.
323 emacs_deliver_message ()
328 # before we can send a message, we have to prepare the FCC maildir
329 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
330 # eval'ing smtp-dummy --background will set smtp_dummy_pid and -_port
331 local smtp_dummy_pid= smtp_dummy_port=
332 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
333 test -n "$smtp_dummy_pid" || return 1
334 test -n "$smtp_dummy_port" || return 1
337 "(let ((message-send-mail-function 'message-smtpmail-send-it)
338 (mail-host-address \"example.com\")
339 (smtpmail-smtp-server \"localhost\")
340 (smtpmail-smtp-service \"${smtp_dummy_port}\"))
343 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
344 (message-goto-subject)
345 (insert \"${subject}\")
349 (notmuch-mua-send-and-exit))"
351 # In case message was sent properly, client waits for confirmation
352 # before exiting and resuming control here; therefore making sure
353 # that server exits by sending (KILL) signal to it is safe.
354 kill -9 $smtp_dummy_pid
355 notmuch new >/dev/null
358 # Pretend to deliver a message with emacs. Really save it to a file
359 # and add it to the database
361 # Uses emacs to generate and deliver a message to the mail store.
362 # Accepts arbitrary extra emacs/elisp functions to modify the message
363 # before sending, which is useful to doing things like attaching files
364 # to the message and encrypting/signing.
366 # If any GNU-style long-arguments (like --quiet or --decrypt=true) are
367 # at the head of the argument list, they are sent directly to "notmuch
368 # new" after message delivery
372 while [[ "$1" =~ ^-- ]]; do
373 nmn_args="$nmn_args $1"
379 # before we can send a message, we have to prepare the FCC maildir
380 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
383 "(let ((message-send-mail-function (lambda () t))
384 (mail-host-address \"example.com\"))
387 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
388 (message-goto-subject)
389 (insert \"${subject}\")
393 (notmuch-mua-send-and-exit))" || return 1
394 notmuch new $nmn_args >/dev/null
397 # Add an existing, fixed corpus of email to the database.
399 # $1 is the corpus dir under corpora to add, using "default" if unset.
401 # The default corpus is based on about 50 messages from early in the
402 # history of the notmuch mailing list, which allows for reliably
403 # testing commands that need to operate on a not-totally-trivial
404 # number of messages.
410 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
411 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
414 test_begin_subtest ()
416 if [ -n "$inside_subtest" ]; then
417 exec 1>&6 2>&7 # Restore stdout and stderr
418 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
420 test_subtest_name="$1"
422 # Redirect test output to the previously prepared file descriptors
423 # 3 and 4 (see below)
424 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
429 # Pass test if two arguments match
431 # Note: Unlike all other test_expect_* functions, this function does
432 # not accept a test name. Instead, the caller should call
433 # test_begin_subtest before calling this function in order to set the
437 exec 1>&6 2>&7 # Restore stdout and stderr
438 if [ -z "$inside_subtest" ]; then
439 error "bug in the test script: test_expect_equal without test_begin_subtest"
443 error "bug in the test script: not 2 parameters to test_expect_equal"
447 if ! test_skip "$test_subtest_name"
449 if [ "$output" = "$expected" ]; then
452 testname=$this_test.$test_count
453 echo "$expected" > $testname.expected
454 echo "$output" > $testname.output
455 test_failure_ "$(diff -u $testname.expected $testname.output)"
460 # Like test_expect_equal, but takes two filenames.
461 test_expect_equal_file ()
463 exec 1>&6 2>&7 # Restore stdout and stderr
464 if [ -z "$inside_subtest" ]; then
465 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
469 error "bug in the test script: not 2 parameters to test_expect_equal_file"
473 if ! test_skip "$test_subtest_name"
475 if diff -q "$file1" "$file2" >/dev/null ; then
478 testname=$this_test.$test_count
479 basename1=`basename "$file1"`
480 basename2=`basename "$file2"`
481 cp "$file1" "$testname.$basename1"
482 cp "$file2" "$testname.$basename2"
483 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
488 # Like test_expect_equal, but arguments are JSON expressions to be
489 # canonicalized before diff'ing. If an argument cannot be parsed, it
490 # is used unchanged so that there's something to diff against.
491 test_expect_equal_json () {
492 # The test suite forces LC_ALL=C, but this causes Python 3 to
493 # decode stdin as ASCII. We need to read JSON in UTF-8, so
494 # override Python's stdio encoding defaults.
495 local script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
496 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
498 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
501 test_expect_equal "$output" "$expected" "$@"
504 # Sort the top-level list of JSON data from stdin.
506 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
507 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
510 test_emacs_expect_t () {
512 error "bug in the test script: not 1 parameter to test_emacs_expect_t"
513 if [ -z "$inside_subtest" ]; then
514 error "bug in the test script: test_emacs_expect_t without test_begin_subtest"
518 if ! test_skip "$test_subtest_name"
520 test_emacs "(notmuch-test-run $1)" >/dev/null
522 # Restore state after the test.
523 exec 1>&6 2>&7 # Restore stdout and stderr
526 # Report success/failure.
532 test_failure_ "${result}"
535 # Restore state after the (non) test.
536 exec 1>&6 2>&7 # Restore stdout and stderr
543 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
548 # this relies on the default format being batch-tag, otherwise some tests will break
549 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
552 notmuch_drop_mail_headers ()
556 msg = email.message_from_file(sys.stdin)
557 for hdr in sys.argv[1:]: del msg[hdr]
558 print(msg.as_string(False))
562 notmuch_search_sanitize ()
564 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
567 notmuch_search_files_sanitize ()
572 notmuch_dir_sanitize ()
574 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
577 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
578 notmuch_show_sanitize ()
580 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
582 notmuch_show_sanitize_all ()
585 -e 's| filename:.*| filename:XXXXX|' \
586 -e 's| id:[^ ]* | id:XXXXX |' | \
587 notmuch_date_sanitize
590 notmuch_json_show_sanitize ()
593 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
594 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
595 -e 's|"filename": "signature.asc",||g' \
596 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
597 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
598 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
601 notmuch_emacs_error_sanitize ()
609 -e 's/^\[.*\]$/[XXX]/' \
610 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
613 notmuch_date_sanitize ()
616 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
619 notmuch_uuid_sanitize ()
621 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
624 notmuch_built_with_sanitize ()
626 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
629 notmuch_config_sanitize ()
631 notmuch_dir_sanitize | notmuch_built_with_sanitize
636 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
639 # End of notmuch helper functions
641 # Use test_set_prereq to tell that a particular prerequisite is available.
643 # The prerequisite can later be checked for by using test_have_prereq.
645 # The single parameter is the prerequisite tag (a simple word, in all
646 # capital letters by convention).
649 satisfied="$satisfied$1 "
653 test_have_prereq () {
662 declare -A test_missing_external_prereq_
663 declare -A test_subtest_missing_external_prereq_
665 # declare prerequisite for the given external binary
666 test_declare_external_prereq () {
668 test "$#" = 2 && name=$2 || name="$binary(1)"
670 if ! hash $binary 2>/dev/null; then
671 test_missing_external_prereq_["${binary}"]=t
674 test_subtest_missing_external_prereq_[\"${name}\"]=t
680 # Explicitly require external prerequisite. Useful when binary is
681 # called indirectly (e.g. from emacs).
682 # Returns success if dependency is available, failure otherwise.
683 test_require_external_prereq () {
685 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
686 # dependency is missing, call the replacement function to note it
693 # You are not expected to call test_ok_ and test_failure_ directly, use
694 # the text_expect_* functions instead.
697 if test "$test_subtest_known_broken_" = "t"; then
698 test_known_broken_ok_
701 test_success=$(($test_success + 1))
702 if test -n "$NOTMUCH_TEST_QUIET"; then
705 say_color pass "%-6s" "PASS"
706 echo " $test_subtest_name"
710 print_test_description
711 if test "$test_subtest_known_broken_" = "t"; then
712 test_known_broken_failure_ "$@"
715 test_failure=$(($test_failure + 1))
716 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
717 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
721 test_failure_message_ () {
722 say_color error "%-6s" "$1"
725 if [ "$#" != "0" ]; then
726 echo "$@" | sed -e 's/^/ /'
728 if test "$verbose" != "t"; then cat test.output; fi
731 test_known_broken_ok_ () {
733 test_fixed=$(($test_fixed+1))
734 say_color pass "%-6s" "FIXED"
735 echo " $test_subtest_name"
738 test_known_broken_failure_ () {
740 test_broken=$(($test_broken+1))
741 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
742 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
744 test_failure_message_ "BROKEN" "$test_subtest_name"
750 test "$debug" = "" || eval "$1"
755 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
758 eval >&3 2>&4 "$test_cleanup"
763 test_count=$(($test_count+1))
765 for skp in $NOTMUCH_SKIP_TESTS
767 case $this_test.$test_count in
772 case $this_test_bare.$test_count in
780 test_report_skip_ "$@"
783 test_check_missing_external_prereqs_ "$@"
788 test_check_missing_external_prereqs_ () {
789 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
790 say_color skip >&1 "missing prerequisites: "
791 echo ${!test_subtest_missing_external_prereq_[@]} >&1
792 test_report_skip_ "$@"
798 test_report_skip_ () {
800 say_color skip >&3 "skipping test:"
802 say_color skip "%-6s" "SKIP"
806 test_subtest_known_broken () {
807 test_subtest_known_broken_=t
810 test_expect_success () {
811 exec 1>&6 2>&7 # Restore stdout and stderr
812 if [ -z "$inside_subtest" ]; then
813 error "bug in the test script: test_expect_success without test_begin_subtest"
817 error "bug in the test script: not 1 parameters to test_expect_success"
819 if ! test_skip "$test_subtest_name"
823 # test_run_ may update missing external prerequisites
824 test_check_missing_external_prereqs_ "$@" ||
825 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
834 test_expect_code () {
835 exec 1>&6 2>&7 # Restore stdout and stderr
836 if [ -z "$inside_subtest" ]; then
837 error "bug in the test script: test_expect_code without test_begin_subtest"
841 error "bug in the test script: not 2 parameters to test_expect_code"
843 if ! test_skip "$test_subtest_name"
847 # test_run_ may update missing external prerequisites,
848 test_check_missing_external_prereqs_ "$@" ||
849 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
853 test_failure_ "exit code $eval_ret, expected $1" "$2"
858 # This is not among top-level (test_expect_success)
859 # but is a prefix that can be used in the test script, like:
861 # test_expect_success 'complain and die' '
863 # do something else &&
864 # test_must_fail git checkout ../outerspace
867 # Writing this as "! git checkout ../outerspace" is wrong, because
868 # the failure could be due to a segv. We want a controlled failure.
872 test $? -gt 0 -a $? -le 129 -o $? -gt 192
875 # test_cmp is a helper function to compare actual and expected output.
876 # You can use it like:
878 # test_expect_success 'foo works' '
879 # echo expected >expected &&
881 # test_cmp expected actual
884 # This could be written as either "cmp" or "diff -u", but:
885 # - cmp's output is not nearly as easy to read as diff -u
886 # - not all diff versions understand "-u"
892 # This function can be used to schedule some commands to be run
893 # unconditionally at the end of the test to restore sanity:
895 # test_expect_success 'test core.capslock' '
896 # git config core.capslock true &&
897 # test_when_finished "git config --unset core.capslock" &&
901 # That would be roughly equivalent to
903 # test_expect_success 'test core.capslock' '
904 # git config core.capslock true &&
906 # git config --unset core.capslock
909 # except that the greeting and config --unset must both succeed for
912 test_when_finished () {
914 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
919 test_results_dir="$TEST_DIRECTORY/test-results"
920 mkdir -p "$test_results_dir"
921 test_results_path="$test_results_dir/$this_test"
923 echo "total $test_count" >> $test_results_path
924 echo "success $test_success" >> $test_results_path
925 echo "fixed $test_fixed" >> $test_results_path
926 echo "broken $test_broken" >> $test_results_path
927 echo "failed $test_failure" >> $test_results_path
928 echo "" >> $test_results_path
930 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
932 if [ "$test_failure" = "0" ]; then
933 if [ "$test_broken" = "0" ]; then
942 emacs_generate_script () {
943 # Construct a little test script here for the benefit of the user,
944 # (who can easily run "run_emacs" to get the same emacs environment
945 # for investigating any failures).
946 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
949 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
951 # Here's what we are using here:
953 # --quick Use minimal customization. This implies --no-init-file,
954 # --no-site-file and (emacs 24) --no-site-lisp
956 # --directory Ensure that the local elisp sources are found
958 # --load Force loading of notmuch.el and test-lib.el
960 exec ${TEST_EMACS} --quick \
961 --directory "$NOTMUCH_SRCDIR/emacs" --load notmuch.el \
962 --directory "$NOTMUCH_SRCDIR/test" --load test-lib.el \
965 chmod a+x "$TMP_DIRECTORY/run_emacs"
969 # test dependencies beforehand to avoid the waiting loop below
970 missing_dependencies=
971 test_require_external_prereq dtach || missing_dependencies=1
972 test_require_external_prereq emacs || missing_dependencies=1
973 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
974 test -z "$missing_dependencies" || return
976 if [ -z "$EMACS_SERVER" ]; then
977 emacs_tests="$NOTMUCH_SRCDIR/test/${this_test_bare}.el"
978 if [ -f "$emacs_tests" ]; then
979 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
983 server_name="notmuch-test-suite-$$"
984 # start a detached session with an emacs server
985 # user's TERM (or 'vt100' in case user's TERM is known dumb
986 # or unknown) is given to dtach which assumes a minimally
987 # VT100-compatible terminal -- and emacs inherits that
988 TERM=$SMART_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
989 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
992 --eval '(setq server-name \"$server_name\")' \
993 --eval '(server-start)' \
994 --eval '(orphan-watchdog $$)'" || return
995 EMACS_SERVER="$server_name"
996 # wait until the emacs server is up
997 until test_emacs '()' >/dev/null 2>/dev/null; do
1002 # Clear test-output output file. Most Emacs tests end with a
1003 # call to (test-output). If the test code fails with an
1004 # exception before this call, the output file won't get
1005 # updated. Since we don't want to compare against an output
1006 # file from another test, so start out with an empty file.
1010 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $*)"
1014 # Note: if there is need to print debug information from python program,
1015 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1016 PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1017 $NOTMUCH_PYTHON -B - > OUTPUT
1021 MAIL_DIR=$MAIL_DIR $NOTMUCH_RUBY -I $NOTMUCH_SRCDIR/bindings/ruby> OUTPUT
1025 exec_file="test${test_count}"
1026 test_file="${exec_file}.c"
1028 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
1029 echo "== stdout ==" > OUTPUT.stdout
1030 echo "== stderr ==" > OUTPUT.stderr
1031 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1032 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr > OUTPUT
1036 # Creates a script that counts how much time it is executed and calls
1037 # notmuch. $notmuch_counter_command is set to the path to the
1038 # generated script. Use notmuch_counter_value() function to get the
1039 # current counter value.
1040 notmuch_counter_reset () {
1041 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1042 if [ ! -x "$notmuch_counter_command" ]; then
1043 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1044 cat >"$notmuch_counter_command" <<EOF || return
1047 read count < "$notmuch_counter_state_path"
1048 echo \$((count + 1)) > "$notmuch_counter_state_path"
1052 chmod +x "$notmuch_counter_command" || return
1055 echo 0 > "$notmuch_counter_state_path"
1058 # Returns the current notmuch counter value.
1059 notmuch_counter_value () {
1060 if [ -r "$notmuch_counter_state_path" ]; then
1061 read count < "$notmuch_counter_state_path"
1068 test_reset_state_ () {
1069 test -z "$test_init_done_" && test_init_
1071 test_subtest_known_broken_=
1072 test_subtest_missing_external_prereq_=()
1075 # called once before the first subtest
1079 # skip all tests if there were external prerequisites missing during init
1080 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1084 # Where to run the tests
1085 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1087 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1089 emacs_generate_script
1092 # Use -P to resolve symlinks in our working directory so that the cwd
1093 # in subprocesses like git equals our $PWD (for pathname comparisons).
1094 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1096 if test "$verbose" = "t"
1100 exec 4>test.output 3>&4
1103 for skp in $NOTMUCH_SKIP_TESTS
1106 for skp in $NOTMUCH_SKIP_TESTS
1108 case "$this_test" in
1113 case "$this_test_bare" in
1121 say_color skip >&3 "skipping test $this_test altogether"
1122 say_color skip "skip all tests in $this_test"
1127 # Provide an implementation of the 'yes' utility
1142 # Fix some commands on Windows
1145 # Windows has its own (incompatible) sort and find
1155 # git sees Windows-style pwd
1159 # no POSIX permissions
1160 # backslashes in pathspec are converted to '/'
1161 # exec does not inherit the PID
1164 test_set_prereq POSIXPERM
1165 test_set_prereq BSLASHPSPEC
1166 test_set_prereq EXECKEEPSPID
1170 test -z "$NO_PERL" && test_set_prereq PERL
1171 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1173 # test whether the filesystem supports symbolic links
1174 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1177 # convert variable from configure to more convenient form
1178 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1186 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1188 # declare prerequisites for external binaries used in tests
1189 test_declare_external_prereq dtach
1190 test_declare_external_prereq emacs
1191 test_declare_external_prereq ${TEST_EMACSCLIENT}
1192 test_declare_external_prereq ${TEST_GDB}
1193 test_declare_external_prereq gpg
1194 test_declare_external_prereq openssl
1195 test_declare_external_prereq gpgsm
1196 test_declare_external_prereq ${NOTMUCH_PYTHON}