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"
125 # Each test should start with something like this, after copyright notices:
127 # test_description='Description of this test...
128 # This test checks if command xyzzy does the right thing...
130 # . ./test-lib.sh || exit 1
132 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
133 TERM=$ORIGINAL_TERM &&
136 tput bold >/dev/null 2>&1 &&
137 tput setaf 1 >/dev/null 2>&1 &&
138 tput sgr0 >/dev/null 2>&1
142 while test "$#" -ne 0
148 immediate=t; shift ;;
156 with_dashes=t; shift ;;
163 valgrind=t; verbose=t; shift ;;
165 shift ;; # was handled already
167 echo "error: unknown test option '$1'" >&2; exit 1 ;;
171 if test -n "$debug"; then
173 printf " %-4s" "[$((test_count - 1))]"
181 if test -n "$color"; then
187 error) tput bold; tput setaf 1;; # bold red
188 skip) tput bold; tput setaf 2;; # bold green
189 pass) tput setaf 2;; # green
190 info) tput setaf 3;; # brown
191 *) test -n "$quiet" && return;;
202 test -z "$1" && test -n "$quiet" && return
211 say_color error "error: $*\n"
220 test "${test_description}" != "" ||
221 error "Test script did not set test_description."
223 if test "$help" = "t"
225 echo "Tests ${test_description}"
229 test_description_printed=
230 print_test_description ()
232 test -z "$test_description_printed" || return 0
234 echo $this_test: "Testing ${test_description}"
235 test_description_printed=1
237 if [ -z "$NOTMUCH_TEST_QUIET" ]
239 print_test_description
248 declare -a _exit_functions=()
250 at_exit_function () {
251 _exit_functions=($1 ${_exit_functions[@]/$1})
254 rm_exit_function () {
255 _exit_functions=(${_exit_functions[@]/$1})
262 for _fn in ${_exit_functions[@]}; do $_fn; done
263 rm -rf "$TEST_TMPDIR"
268 if test -n "$GIT_EXIT_OK"
273 say_color error '%-6s' FATAL
274 echo " $test_subtest_name"
276 echo "Unexpected exit while executing $0. Exit code $code."
283 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
290 say_color error '%-6s' FATAL
293 echo "Unexpected exit while executing $0."
298 # Note: TEST_TMPDIR *NOT* exported!
299 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
300 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
301 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
302 trap 'trap_exit' EXIT
303 trap 'trap_signal' HUP INT TERM
305 # Deliver a message with emacs and add it to the database
307 # Uses emacs to generate and deliver a message to the mail store.
308 # Accepts arbitrary extra emacs/elisp functions to modify the message
309 # before sending, which is useful to doing things like attaching files
310 # to the message and encrypting/signing.
311 emacs_deliver_message ()
316 # before we can send a message, we have to prepare the FCC maildir
317 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
318 # eval'ing smtp-dummy --background will set smtp_dummy_pid
320 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
321 test -n "$smtp_dummy_pid" || return 1
324 "(let ((message-send-mail-function 'message-smtpmail-send-it)
325 (mail-host-address \"example.com\")
326 (smtpmail-smtp-server \"localhost\")
327 (smtpmail-smtp-service \"25025\"))
330 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
331 (message-goto-subject)
332 (insert \"${subject}\")
336 (notmuch-mua-send-and-exit))"
338 # In case message was sent properly, client waits for confirmation
339 # before exiting and resuming control here; therefore making sure
340 # that server exits by sending (KILL) signal to it is safe.
341 kill -9 $smtp_dummy_pid
342 notmuch new >/dev/null
345 # Pretend to deliver a message with emacs. Really save it to a file
346 # and add it to the database
348 # Uses emacs to generate and deliver a message to the mail store.
349 # Accepts arbitrary extra emacs/elisp functions to modify the message
350 # before sending, which is useful to doing things like attaching files
351 # to the message and encrypting/signing.
353 # If any GNU-style long-arguments (like --quiet or --decrypt=true) are
354 # at the head of the argument list, they are sent directly to "notmuch
355 # new" after message delivery
359 while [[ "$1" =~ ^-- ]]; do
360 nmn_args="$nmn_args $1"
366 # before we can send a message, we have to prepare the FCC maildir
367 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
370 "(let ((message-send-mail-function (lambda () t))
371 (mail-host-address \"example.com\"))
374 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
375 (message-goto-subject)
376 (insert \"${subject}\")
380 (notmuch-mua-send-and-exit))" || return 1
381 notmuch new $nmn_args >/dev/null
384 # Add an existing, fixed corpus of email to the database.
386 # $1 is the corpus dir under corpora to add, using "default" if unset.
388 # The default corpus is based on about 50 messages from early in the
389 # history of the notmuch mailing list, which allows for reliably
390 # testing commands that need to operate on a not-totally-trivial
391 # number of messages.
397 if [ -d $TEST_DIRECTORY/corpora.mail/$corpus ]; then
398 cp -a $TEST_DIRECTORY/corpora.mail/$corpus ${MAIL_DIR}
400 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
401 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
402 mkdir -p $TEST_DIRECTORY/corpora.mail
403 cp -a ${MAIL_DIR} $TEST_DIRECTORY/corpora.mail/$corpus
407 test_begin_subtest ()
409 if [ -n "$inside_subtest" ]; then
410 exec 1>&6 2>&7 # Restore stdout and stderr
411 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
413 test_subtest_name="$1"
415 # Redirect test output to the previously prepared file descriptors
416 # 3 and 4 (see below)
417 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
422 # Pass test if two arguments match
424 # Note: Unlike all other test_expect_* functions, this function does
425 # not accept a test name. Instead, the caller should call
426 # test_begin_subtest before calling this function in order to set the
430 exec 1>&6 2>&7 # Restore stdout and stderr
431 if [ -z "$inside_subtest" ]; then
432 error "bug in the test script: test_expect_equal without test_begin_subtest"
436 error "bug in the test script: not 2 parameters to test_expect_equal"
440 if ! test_skip "$test_subtest_name"
442 if [ "$output" = "$expected" ]; then
445 testname=$this_test.$test_count
446 echo "$expected" > $testname.expected
447 echo "$output" > $testname.output
448 test_failure_ "$(diff -u $testname.expected $testname.output)"
453 # Like test_expect_equal, but takes two filenames.
454 test_expect_equal_file ()
456 exec 1>&6 2>&7 # Restore stdout and stderr
457 if [ -z "$inside_subtest" ]; then
458 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
462 error "bug in the test script: not 2 parameters to test_expect_equal_file"
466 if ! test_skip "$test_subtest_name"
468 if diff -q "$file1" "$file2" >/dev/null ; then
471 testname=$this_test.$test_count
472 basename1=`basename "$file1"`
473 basename2=`basename "$file2"`
474 cp "$file1" "$testname.$basename1"
475 cp "$file2" "$testname.$basename2"
476 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
481 # Like test_expect_equal, but arguments are JSON expressions to be
482 # canonicalized before diff'ing. If an argument cannot be parsed, it
483 # is used unchanged so that there's something to diff against.
484 test_expect_equal_json () {
485 # The test suite forces LC_ALL=C, but this causes Python 3 to
486 # decode stdin as ASCII. We need to read JSON in UTF-8, so
487 # override Python's stdio encoding defaults.
488 local script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
489 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
491 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
494 test_expect_equal "$output" "$expected" "$@"
497 # Sort the top-level list of JSON data from stdin.
499 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
500 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
503 test_emacs_expect_t () {
505 error "bug in the test script: not 1 parameter to test_emacs_expect_t"
506 if [ -z "$inside_subtest" ]; then
507 error "bug in the test script: test_emacs_expect_t without test_begin_subtest"
511 if ! test_skip "$test_subtest_name"
513 test_emacs "(notmuch-test-run $1)" >/dev/null
515 # Restore state after the test.
516 exec 1>&6 2>&7 # Restore stdout and stderr
519 # Report success/failure.
525 test_failure_ "${result}"
528 # Restore state after the (non) test.
529 exec 1>&6 2>&7 # Restore stdout and stderr
536 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
541 # this relies on the default format being batch-tag, otherwise some tests will break
542 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
545 notmuch_drop_mail_headers ()
549 msg = email.message_from_file(sys.stdin)
550 for hdr in sys.argv[1:]: del msg[hdr]
551 print(msg.as_string(False))
555 notmuch_search_sanitize ()
557 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
560 notmuch_search_files_sanitize ()
565 notmuch_dir_sanitize ()
567 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
570 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
571 notmuch_show_sanitize ()
573 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
575 notmuch_show_sanitize_all ()
578 -e 's| filename:.*| filename:XXXXX|' \
579 -e 's| id:[^ ]* | id:XXXXX |' | \
580 notmuch_date_sanitize
583 notmuch_json_show_sanitize ()
586 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
587 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
588 -e 's|"filename": "signature.asc",||g' \
589 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
590 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
591 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
594 notmuch_emacs_error_sanitize ()
602 -e 's/^\[.*\]$/[XXX]/' \
603 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
606 notmuch_date_sanitize ()
609 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
612 notmuch_uuid_sanitize ()
614 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
617 notmuch_built_with_sanitize ()
619 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
622 notmuch_config_sanitize ()
624 notmuch_dir_sanitize | notmuch_built_with_sanitize
629 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
632 # End of notmuch helper functions
634 # Use test_set_prereq to tell that a particular prerequisite is available.
636 # The prerequisite can later be checked for by using test_have_prereq.
638 # The single parameter is the prerequisite tag (a simple word, in all
639 # capital letters by convention).
642 satisfied="$satisfied$1 "
646 test_have_prereq () {
655 declare -A test_missing_external_prereq_
656 declare -A test_subtest_missing_external_prereq_
658 # declare prerequisite for the given external binary
659 test_declare_external_prereq () {
661 test "$#" = 2 && name=$2 || name="$binary(1)"
663 if ! hash $binary 2>/dev/null; then
664 test_missing_external_prereq_["${binary}"]=t
667 test_subtest_missing_external_prereq_[\"${name}\"]=t
673 # Explicitly require external prerequisite. Useful when binary is
674 # called indirectly (e.g. from emacs).
675 # Returns success if dependency is available, failure otherwise.
676 test_require_external_prereq () {
678 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
679 # dependency is missing, call the replacement function to note it
686 # You are not expected to call test_ok_ and test_failure_ directly, use
687 # the text_expect_* functions instead.
690 if test "$test_subtest_known_broken_" = "t"; then
691 test_known_broken_ok_
694 test_success=$(($test_success + 1))
695 if test -n "$NOTMUCH_TEST_QUIET"; then
698 say_color pass "%-6s" "PASS"
699 echo " $test_subtest_name"
703 print_test_description
704 if test "$test_subtest_known_broken_" = "t"; then
705 test_known_broken_failure_ "$@"
708 test_failure=$(($test_failure + 1))
709 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
710 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
714 test_failure_message_ () {
715 say_color error "%-6s" "$1"
718 if [ "$#" != "0" ]; then
719 echo "$@" | sed -e 's/^/ /'
721 if test "$verbose" != "t"; then cat test.output; fi
724 test_known_broken_ok_ () {
726 test_fixed=$(($test_fixed+1))
727 say_color pass "%-6s" "FIXED"
728 echo " $test_subtest_name"
731 test_known_broken_failure_ () {
733 test_broken=$(($test_broken+1))
734 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
735 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
737 test_failure_message_ "BROKEN" "$test_subtest_name"
743 test "$debug" = "" || eval "$1"
748 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
751 eval >&3 2>&4 "$test_cleanup"
756 test_count=$(($test_count+1))
758 for skp in $NOTMUCH_SKIP_TESTS
760 case $this_test.$test_count in
765 case $this_test_bare.$test_count in
773 test_report_skip_ "$@"
776 test_check_missing_external_prereqs_ "$@"
781 test_check_missing_external_prereqs_ () {
782 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
783 say_color skip >&1 "missing prerequisites: "
784 echo ${!test_subtest_missing_external_prereq_[@]} >&1
785 test_report_skip_ "$@"
791 test_report_skip_ () {
793 say_color skip >&3 "skipping test:"
795 say_color skip "%-6s" "SKIP"
799 test_subtest_known_broken () {
800 test_subtest_known_broken_=t
803 test_expect_success () {
804 exec 1>&6 2>&7 # Restore stdout and stderr
805 if [ -z "$inside_subtest" ]; then
806 error "bug in the test script: test_expect_success without test_begin_subtest"
810 error "bug in the test script: not 1 parameters to test_expect_success"
812 if ! test_skip "$test_subtest_name"
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 exec 1>&6 2>&7 # Restore stdout and stderr
829 if [ -z "$inside_subtest" ]; then
830 error "bug in the test script: test_expect_code without test_begin_subtest"
834 error "bug in the test script: not 2 parameters to test_expect_code"
836 if ! test_skip "$test_subtest_name"
840 # test_run_ may update missing external prerequisites,
841 test_check_missing_external_prereqs_ "$@" ||
842 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
846 test_failure_ "exit code $eval_ret, expected $1" "$2"
851 # This is not among top-level (test_expect_success)
852 # but is a prefix that can be used in the test script, like:
854 # test_expect_success 'complain and die' '
856 # do something else &&
857 # test_must_fail git checkout ../outerspace
860 # Writing this as "! git checkout ../outerspace" is wrong, because
861 # the failure could be due to a segv. We want a controlled failure.
865 test $? -gt 0 -a $? -le 129 -o $? -gt 192
868 # test_cmp is a helper function to compare actual and expected output.
869 # You can use it like:
871 # test_expect_success 'foo works' '
872 # echo expected >expected &&
874 # test_cmp expected actual
877 # This could be written as either "cmp" or "diff -u", but:
878 # - cmp's output is not nearly as easy to read as diff -u
879 # - not all diff versions understand "-u"
885 # This function can be used to schedule some commands to be run
886 # unconditionally at the end of the test to restore sanity:
888 # test_expect_success 'test core.capslock' '
889 # git config core.capslock true &&
890 # test_when_finished "git config --unset core.capslock" &&
894 # That would be roughly equivalent to
896 # test_expect_success 'test core.capslock' '
897 # git config core.capslock true &&
899 # git config --unset core.capslock
902 # except that the greeting and config --unset must both succeed for
905 test_when_finished () {
907 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
912 test_results_dir="$TEST_DIRECTORY/test-results"
913 mkdir -p "$test_results_dir"
914 test_results_path="$test_results_dir/$this_test"
916 echo "total $test_count" >> $test_results_path
917 echo "success $test_success" >> $test_results_path
918 echo "fixed $test_fixed" >> $test_results_path
919 echo "broken $test_broken" >> $test_results_path
920 echo "failed $test_failure" >> $test_results_path
921 echo "" >> $test_results_path
923 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
925 if [ "$test_failure" = "0" ]; then
926 if [ "$test_broken" = "0" ]; then
935 emacs_generate_script () {
936 # Construct a little test script here for the benefit of the user,
937 # (who can easily run "run_emacs" to get the same emacs environment
938 # for investigating any failures).
939 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
942 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
944 # Here's what we are using here:
946 # --quick Use minimal customization. This implies --no-init-file,
947 # --no-site-file and (emacs 24) --no-site-lisp
949 # --directory Ensure that the local elisp sources are found
951 # --load Force loading of notmuch.el and test-lib.el
953 exec ${TEST_EMACS} --quick \
954 --directory "$NOTMUCH_SRCDIR/emacs" --load notmuch.el \
955 --directory "$NOTMUCH_SRCDIR/test" --load test-lib.el \
958 chmod a+x "$TMP_DIRECTORY/run_emacs"
962 # test dependencies beforehand to avoid the waiting loop below
963 missing_dependencies=
964 test_require_external_prereq dtach || missing_dependencies=1
965 test_require_external_prereq emacs || missing_dependencies=1
966 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
967 test -z "$missing_dependencies" || return
969 if [ -z "$EMACS_SERVER" ]; then
970 emacs_tests="$NOTMUCH_SRCDIR/test/${this_test_bare}.el"
971 if [ -f "$emacs_tests" ]; then
972 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
976 server_name="notmuch-test-suite-$$"
977 # start a detached session with an emacs server
978 # user's TERM (or 'vt100' in case user's TERM is known dumb
979 # or unknown) is given to dtach which assumes a minimally
980 # VT100-compatible terminal -- and emacs inherits that
981 TERM=$SMART_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
982 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
985 --eval '(setq server-name \"$server_name\")' \
986 --eval '(server-start)' \
987 --eval '(orphan-watchdog $$)'" || return
988 EMACS_SERVER="$server_name"
989 # wait until the emacs server is up
990 until test_emacs '()' >/dev/null 2>/dev/null; do
995 # Clear test-output output file. Most Emacs tests end with a
996 # call to (test-output). If the test code fails with an
997 # exception before this call, the output file won't get
998 # updated. Since we don't want to compare against an output
999 # file from another test, so start out with an empty file.
1003 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $@)"
1007 # Note: if there is need to print debug information from python program,
1008 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1009 PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1010 $NOTMUCH_PYTHON -B - > OUTPUT
1014 MAIL_DIR=$MAIL_DIR $NOTMUCH_RUBY -I $NOTMUCH_SRCDIR/bindings/ruby> OUTPUT
1018 exec_file="test${test_count}"
1019 test_file="${exec_file}.c"
1021 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
1022 echo "== stdout ==" > OUTPUT.stdout
1023 echo "== stderr ==" > OUTPUT.stderr
1024 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1025 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr > OUTPUT
1029 # Creates a script that counts how much time it is executed and calls
1030 # notmuch. $notmuch_counter_command is set to the path to the
1031 # generated script. Use notmuch_counter_value() function to get the
1032 # current counter value.
1033 notmuch_counter_reset () {
1034 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1035 if [ ! -x "$notmuch_counter_command" ]; then
1036 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1037 cat >"$notmuch_counter_command" <<EOF || return
1040 read count < "$notmuch_counter_state_path"
1041 echo \$((count + 1)) > "$notmuch_counter_state_path"
1045 chmod +x "$notmuch_counter_command" || return
1048 echo 0 > "$notmuch_counter_state_path"
1051 # Returns the current notmuch counter value.
1052 notmuch_counter_value () {
1053 if [ -r "$notmuch_counter_state_path" ]; then
1054 read count < "$notmuch_counter_state_path"
1061 test_reset_state_ () {
1062 test -z "$test_init_done_" && test_init_
1064 test_subtest_known_broken_=
1065 test_subtest_missing_external_prereq_=()
1068 # called once before the first subtest
1072 # skip all tests if there were external prerequisites missing during init
1073 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1077 # Where to run the tests
1078 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1080 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1082 if [ "${NOTMUCH_GMIME_MAJOR}" = 3 ]; then
1083 test_subtest_broken_gmime_3 () {
1084 test_subtest_known_broken
1086 test_subtest_broken_gmime_2 () {
1090 test_subtest_broken_gmime_3 () {
1093 test_subtest_broken_gmime_2 () {
1094 test_subtest_known_broken
1098 emacs_generate_script
1101 # Use -P to resolve symlinks in our working directory so that the cwd
1102 # in subprocesses like git equals our $PWD (for pathname comparisons).
1103 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1105 if test "$verbose" = "t"
1109 exec 4>test.output 3>&4
1112 for skp in $NOTMUCH_SKIP_TESTS
1115 for skp in $NOTMUCH_SKIP_TESTS
1117 case "$this_test" in
1122 case "$this_test_bare" in
1130 say_color skip >&3 "skipping test $this_test altogether"
1131 say_color skip "skip all tests in $this_test"
1136 # Provide an implementation of the 'yes' utility
1151 # Fix some commands on Windows
1154 # Windows has its own (incompatible) sort and find
1164 # git sees Windows-style pwd
1168 # no POSIX permissions
1169 # backslashes in pathspec are converted to '/'
1170 # exec does not inherit the PID
1173 test_set_prereq POSIXPERM
1174 test_set_prereq BSLASHPSPEC
1175 test_set_prereq EXECKEEPSPID
1179 test -z "$NO_PERL" && test_set_prereq PERL
1180 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1182 # test whether the filesystem supports symbolic links
1183 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1186 # convert variable from configure to more convenient form
1187 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1195 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1197 # declare prerequisites for external binaries used in tests
1198 test_declare_external_prereq dtach
1199 test_declare_external_prereq emacs
1200 test_declare_external_prereq ${TEST_EMACSCLIENT}
1201 test_declare_external_prereq ${TEST_GDB}
1202 test_declare_external_prereq gpg
1203 test_declare_external_prereq openssl
1204 test_declare_external_prereq gpgsm
1205 test_declare_external_prereq ${NOTMUCH_PYTHON}