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"}
98 TEST_SHIM_CFLAGS=${TEST_SHIM_CFLAGS:-"-fpic -shared"}
99 TEST_SHIM_LDFLAGS=${TEST_SHIM_LDFLAGS:-"-ldl"}
101 # Protect ourselves from common misconfiguration to export
102 # CDPATH into the environment
108 unset ALTERNATE_EDITOR
113 [ -d ${GNUPGHOME} ] && return
114 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
115 at_exit_function _gnupg_exit
116 mkdir -m 0700 "$GNUPGHOME"
117 gpg --no-tty --import <$NOTMUCH_SRCDIR/test/gnupg-secret-key.asc >"$GNUPGHOME"/import.log 2>&1
118 test_debug "cat $GNUPGHOME/import.log"
119 if (gpg --quick-random --version >/dev/null 2>&1) ; then
120 echo quick-random >> "$GNUPGHOME"/gpg.conf
121 elif (gpg --debug-quick-random --version >/dev/null 2>&1) ; then
122 echo debug-quick-random >> "$GNUPGHOME"/gpg.conf
124 echo no-emit-version >> "$GNUPGHOME"/gpg.conf
126 # Change this if we ship a new test key
127 FINGERPRINT="5AEAB11F5E33DCE875DDB75B6D92612D94E46381"
128 SELF_USERID="Notmuch Test Suite <test_suite@notmuchmail.org> (INSECURE!)"
129 printf '%s:6:\n' "$FINGERPRINT" | gpg --quiet --batch --no-tty --import-ownertrust
135 [ -d ${GNUPGHOME} ] && return
136 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
137 at_exit_function _gnupg_exit
138 mkdir -m 0700 "$GNUPGHOME"
139 gpgsm --no-tty --no-common-certs-import --disable-dirmngr --import < $NOTMUCH_SRCDIR/test/smime/test.crt >"$GNUPGHOME"/import.log 2>&1
140 fpr=$(gpgsm --list-key test_suite@notmuchmail.org | sed -n 's/.*fingerprint: //p')
141 echo "$fpr S relax" >> $GNUPGHOME/trustlist.txt
142 test_debug "cat $GNUPGHOME/import.log"
145 # Each test should start with something like this, after copyright notices:
147 # test_description='Description of this test...
148 # This test checks if command xyzzy does the right thing...
150 # . ./test-lib.sh || exit 1
154 while test "$#" -ne 0
160 immediate=t; shift ;;
168 with_dashes=t; shift ;;
175 valgrind=t; verbose=t; shift ;;
177 shift ;; # was handled already
179 echo "error: unknown test option '$1'" >&2; exit 1 ;;
183 if test -n "$debug"; then
185 printf " %-4s" "[$((test_count - 1))]"
193 test -n "$COLORS_WITHOUT_TTY" || [ -t 1 ] || color=
195 if [ -n "$color" ] && [ "$ORIGINAL_TERM" != 'dumb' ] && (
196 TERM=$ORIGINAL_TERM &&
208 if test -n "$color"; then
214 error) tput bold; tput setaf 1;; # bold red
215 skip) tput bold; tput setaf 2;; # bold green
216 pass) tput setaf 2;; # green
217 info) tput setaf 3;; # brown
218 *) test -n "$quiet" && return;;
229 test -z "$1" && test -n "$quiet" && return
238 say_color error "error: $*\n"
247 test "${test_description}" != "" ||
248 error "Test script did not set test_description."
250 if test "$help" = "t"
252 echo "Tests ${test_description}"
256 test_description_printed=
257 print_test_description ()
259 test -z "$test_description_printed" || return 0
261 echo $this_test: "Testing ${test_description}"
262 test_description_printed=1
264 if [ -z "$NOTMUCH_TEST_QUIET" ]
266 print_test_description
275 declare -a _exit_functions=()
277 at_exit_function () {
278 _exit_functions=($1 ${_exit_functions[@]/$1})
281 rm_exit_function () {
282 _exit_functions=(${_exit_functions[@]/$1})
289 for _fn in ${_exit_functions[@]}; do $_fn; done
290 rm -rf "$TEST_TMPDIR"
295 if test -n "$GIT_EXIT_OK"
300 say_color error '%-6s' FATAL
301 echo " $test_subtest_name"
303 echo "Unexpected exit while executing $0. Exit code $code."
310 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
317 say_color error '%-6s' FATAL
320 echo "Unexpected exit while executing $0."
325 # Note: TEST_TMPDIR *NOT* exported!
326 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
327 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
328 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
329 trap 'trap_exit' EXIT
330 trap 'trap_signal' HUP INT TERM
332 # Deliver a message with emacs and add it to the database
334 # Uses emacs to generate and deliver a message to the mail store.
335 # Accepts arbitrary extra emacs/elisp functions to modify the message
336 # before sending, which is useful to doing things like attaching files
337 # to the message and encrypting/signing.
338 emacs_deliver_message ()
343 # before we can send a message, we have to prepare the FCC maildir
344 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
345 # eval'ing smtp-dummy --background will set smtp_dummy_pid and -_port
346 local smtp_dummy_pid= smtp_dummy_port=
347 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
348 test -n "$smtp_dummy_pid" || return 1
349 test -n "$smtp_dummy_port" || return 1
352 "(let ((message-send-mail-function 'message-smtpmail-send-it)
353 (mail-host-address \"example.com\")
354 (smtpmail-smtp-server \"localhost\")
355 (smtpmail-smtp-service \"${smtp_dummy_port}\"))
358 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
359 (message-goto-subject)
360 (insert \"${subject}\")
364 (notmuch-mua-send-and-exit))"
366 # In case message was sent properly, client waits for confirmation
367 # before exiting and resuming control here; therefore making sure
368 # that server exits by sending (KILL) signal to it is safe.
369 kill -9 $smtp_dummy_pid
370 notmuch new >/dev/null
373 # Pretend to deliver a message with emacs. Really save it to a file
374 # and add it to the database
376 # Uses emacs to generate and deliver a message to the mail store.
377 # Accepts arbitrary extra emacs/elisp functions to modify the message
378 # before sending, which is useful to doing things like attaching files
379 # to the message and encrypting/signing.
381 # If any GNU-style long-arguments (like --quiet or --decrypt=true) are
382 # at the head of the argument list, they are sent directly to "notmuch
383 # new" after message delivery
387 while [[ "$1" =~ ^-- ]]; do
388 nmn_args="$nmn_args $1"
394 # before we can send a message, we have to prepare the FCC maildir
395 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
398 "(let ((message-send-mail-function (lambda () t))
399 (mail-host-address \"example.com\"))
402 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
403 (message-goto-subject)
404 (insert \"${subject}\")
408 (notmuch-mua-send-and-exit))" || return 1
409 notmuch new $nmn_args >/dev/null
412 # Add an existing, fixed corpus of email to the database.
414 # $1 is the corpus dir under corpora to add, using "default" if unset.
416 # The default corpus is based on about 50 messages from early in the
417 # history of the notmuch mailing list, which allows for reliably
418 # testing commands that need to operate on a not-totally-trivial
419 # number of messages.
425 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
426 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
429 test_begin_subtest ()
431 if [ -n "$inside_subtest" ]; then
432 exec 1>&6 2>&7 # Restore stdout and stderr
433 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
435 test_subtest_name="$1"
437 # Redirect test output to the previously prepared file descriptors
438 # 3 and 4 (see below)
439 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
444 # Pass test if two arguments match
446 # Note: Unlike all other test_expect_* functions, this function does
447 # not accept a test name. Instead, the caller should call
448 # test_begin_subtest before calling this function in order to set the
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 without test_begin_subtest"
458 error "bug in the test script: not 2 parameters to test_expect_equal"
462 if ! test_skip "$test_subtest_name"
464 if [ "$output" = "$expected" ]; then
467 testname=$this_test.$test_count
468 echo "$expected" > $testname.expected
469 echo "$output" > $testname.output
470 test_failure_ "$(diff -u $testname.expected $testname.output)"
475 # Like test_expect_equal, but takes two filenames.
476 test_expect_equal_file ()
478 exec 1>&6 2>&7 # Restore stdout and stderr
479 if [ -z "$inside_subtest" ]; then
480 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
484 error "bug in the test script: not 2 parameters to test_expect_equal_file"
488 if ! test_skip "$test_subtest_name"
490 if diff -q "$file1" "$file2" >/dev/null ; then
493 testname=$this_test.$test_count
494 basename1=`basename "$file1"`
495 basename2=`basename "$file2"`
496 cp "$file1" "$testname.$basename1"
497 cp "$file2" "$testname.$basename2"
498 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
503 # Like test_expect_equal, but arguments are JSON expressions to be
504 # canonicalized before diff'ing. If an argument cannot be parsed, it
505 # is used unchanged so that there's something to diff against.
506 test_expect_equal_json () {
507 # The test suite forces LC_ALL=C, but this causes Python 3 to
508 # decode stdin as ASCII. We need to read JSON in UTF-8, so
509 # override Python's stdio encoding defaults.
510 local script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
511 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
513 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
516 test_expect_equal "$output" "$expected" "$@"
519 # Sort the top-level list of JSON data from stdin.
521 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
522 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
525 # test for json objects:
526 # read the source of test/json_check_nodes.py (or the output when
527 # invoking it without arguments) for an explanation of the syntax.
529 exec 1>&6 2>&7 # Restore stdout and stderr
530 if [ -z "$inside_subtest" ]; then
531 error "bug in the test script: test_json_eval without test_begin_subtest"
535 error "bug in the test script: test_json_nodes needs at least 1 parameter"
537 if ! test_skip "$test_subtest_name"
539 output=$(PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON "$TEST_DIRECTORY"/json_check_nodes.py "$@")
544 test_failure_ "$output"
549 test_emacs_expect_t () {
551 error "bug in the test script: not 1 parameter to test_emacs_expect_t"
552 if [ -z "$inside_subtest" ]; then
553 error "bug in the test script: test_emacs_expect_t without test_begin_subtest"
557 if ! test_skip "$test_subtest_name"
559 test_emacs "(notmuch-test-run $1)" >/dev/null
561 # Restore state after the test.
562 exec 1>&6 2>&7 # Restore stdout and stderr
565 # Report success/failure.
571 test_failure_ "${result}"
574 # Restore state after the (non) test.
575 exec 1>&6 2>&7 # Restore stdout and stderr
582 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
587 # this relies on the default format being batch-tag, otherwise some tests will break
588 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
591 notmuch_drop_mail_headers ()
595 msg = email.message_from_file(sys.stdin)
596 for hdr in sys.argv[1:]: del msg[hdr]
597 print(msg.as_string(False))
601 notmuch_search_sanitize ()
603 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
606 notmuch_search_files_sanitize ()
611 notmuch_dir_sanitize ()
613 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
616 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
617 notmuch_show_sanitize ()
619 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
621 notmuch_show_sanitize_all ()
624 -e 's| filename:.*| filename:XXXXX|' \
625 -e 's| id:[^ ]* | id:XXXXX |' | \
626 notmuch_date_sanitize
629 notmuch_json_show_sanitize ()
632 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
633 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
634 -e 's|"filename": "signature.asc",||g' \
635 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
636 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
637 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
640 notmuch_emacs_error_sanitize ()
648 -e 's/^\[.*\]$/[XXX]/' \
649 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
652 notmuch_date_sanitize ()
655 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
658 notmuch_uuid_sanitize ()
660 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
663 notmuch_built_with_sanitize ()
665 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
668 notmuch_config_sanitize ()
670 notmuch_dir_sanitize | notmuch_built_with_sanitize
675 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
678 # End of notmuch helper functions
680 # Use test_set_prereq to tell that a particular prerequisite is available.
682 # The prerequisite can later be checked for by using test_have_prereq.
684 # The single parameter is the prerequisite tag (a simple word, in all
685 # capital letters by convention).
688 satisfied="$satisfied$1 "
692 test_have_prereq () {
701 declare -A test_missing_external_prereq_
702 declare -A test_subtest_missing_external_prereq_
704 # declare prerequisite for the given external binary
705 test_declare_external_prereq () {
707 test "$#" = 2 && name=$2 || name="$binary(1)"
709 if ! hash $binary 2>/dev/null; then
710 test_missing_external_prereq_["${binary}"]=t
713 test_subtest_missing_external_prereq_[\"${name}\"]=t
719 # Explicitly require external prerequisite. Useful when binary is
720 # called indirectly (e.g. from emacs).
721 # Returns success if dependency is available, failure otherwise.
722 test_require_external_prereq () {
724 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
725 # dependency is missing, call the replacement function to note it
732 # You are not expected to call test_ok_ and test_failure_ directly, use
733 # the text_expect_* functions instead.
736 if test "$test_subtest_known_broken_" = "t"; then
737 test_known_broken_ok_
740 test_success=$(($test_success + 1))
741 if test -n "$NOTMUCH_TEST_QUIET"; then
744 say_color pass "%-6s" "PASS"
745 echo " $test_subtest_name"
749 print_test_description
750 if test "$test_subtest_known_broken_" = "t"; then
751 test_known_broken_failure_ "$@"
754 test_failure=$(($test_failure + 1))
755 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
756 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
760 test_failure_message_ () {
761 say_color error "%-6s" "$1"
764 if [ "$#" != "0" ]; then
765 echo "$@" | sed -e 's/^/ /'
767 if test "$verbose" != "t"; then cat test.output; fi
770 test_known_broken_ok_ () {
772 test_fixed=$(($test_fixed+1))
773 say_color pass "%-6s" "FIXED"
774 echo " $test_subtest_name"
777 test_known_broken_failure_ () {
779 test_broken=$(($test_broken+1))
780 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
781 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
783 test_failure_message_ "BROKEN" "$test_subtest_name"
789 test "$debug" = "" || eval "$1"
794 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
797 eval >&3 2>&4 "$test_cleanup"
802 test_count=$(($test_count+1))
804 for skp in $NOTMUCH_SKIP_TESTS
806 case $this_test.$test_count in
811 case $this_test_bare.$test_count in
819 test_report_skip_ "$@"
822 test_check_missing_external_prereqs_ "$@"
827 test_check_missing_external_prereqs_ () {
828 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
829 say_color skip >&1 "missing prerequisites: "
830 echo ${!test_subtest_missing_external_prereq_[@]} >&1
831 test_report_skip_ "$@"
837 test_report_skip_ () {
839 say_color skip >&3 "skipping test:"
841 say_color skip "%-6s" "SKIP"
845 test_subtest_known_broken () {
846 test_subtest_known_broken_=t
849 test_expect_success () {
850 exec 1>&6 2>&7 # Restore stdout and stderr
851 if [ -z "$inside_subtest" ]; then
852 error "bug in the test script: test_expect_success without test_begin_subtest"
856 error "bug in the test script: not 1 parameters to test_expect_success"
858 if ! test_skip "$test_subtest_name"
862 # test_run_ may update missing external prerequisites
863 test_check_missing_external_prereqs_ "$@" ||
864 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
873 test_expect_code () {
874 exec 1>&6 2>&7 # Restore stdout and stderr
875 if [ -z "$inside_subtest" ]; then
876 error "bug in the test script: test_expect_code without test_begin_subtest"
880 error "bug in the test script: not 2 parameters to test_expect_code"
882 if ! test_skip "$test_subtest_name"
886 # test_run_ may update missing external prerequisites,
887 test_check_missing_external_prereqs_ "$@" ||
888 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
892 test_failure_ "exit code $eval_ret, expected $1" "$2"
897 # This is not among top-level (test_expect_success)
898 # but is a prefix that can be used in the test script, like:
900 # test_expect_success 'complain and die' '
902 # do something else &&
903 # test_must_fail git checkout ../outerspace
906 # Writing this as "! git checkout ../outerspace" is wrong, because
907 # the failure could be due to a segv. We want a controlled failure.
911 test $? -gt 0 -a $? -le 129 -o $? -gt 192
914 # test_cmp is a helper function to compare actual and expected output.
915 # You can use it like:
917 # test_expect_success 'foo works' '
918 # echo expected >expected &&
920 # test_cmp expected actual
923 # This could be written as either "cmp" or "diff -u", but:
924 # - cmp's output is not nearly as easy to read as diff -u
925 # - not all diff versions understand "-u"
931 # This function can be used to schedule some commands to be run
932 # unconditionally at the end of the test to restore sanity:
934 # test_expect_success 'test core.capslock' '
935 # git config core.capslock true &&
936 # test_when_finished "git config --unset core.capslock" &&
940 # That would be roughly equivalent to
942 # test_expect_success 'test core.capslock' '
943 # git config core.capslock true &&
945 # git config --unset core.capslock
948 # except that the greeting and config --unset must both succeed for
951 test_when_finished () {
953 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
958 test_results_dir="$TEST_DIRECTORY/test-results"
959 mkdir -p "$test_results_dir"
960 test_results_path="$test_results_dir/$this_test"
962 echo "total $test_count" >> $test_results_path
963 echo "success $test_success" >> $test_results_path
964 echo "fixed $test_fixed" >> $test_results_path
965 echo "broken $test_broken" >> $test_results_path
966 echo "failed $test_failure" >> $test_results_path
967 echo "" >> $test_results_path
969 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
971 if [ "$test_failure" = "0" ]; then
972 if [ "$test_broken" = "0" ]; then
981 emacs_generate_script () {
982 # Construct a little test script here for the benefit of the user,
983 # (who can easily run "run_emacs" to get the same emacs environment
984 # for investigating any failures).
985 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
988 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
990 # Here's what we are using here:
992 # --quick Use minimal customization. This implies --no-init-file,
993 # --no-site-file and (emacs 24) --no-site-lisp
995 # --directory Ensure that the local elisp sources are found
997 # --load Force loading of notmuch.el and test-lib.el
999 exec ${TEST_EMACS} --quick \
1000 --directory "$NOTMUCH_SRCDIR/emacs" --load notmuch.el \
1001 --directory "$NOTMUCH_SRCDIR/test" --load test-lib.el \
1004 chmod a+x "$TMP_DIRECTORY/run_emacs"
1008 # test dependencies beforehand to avoid the waiting loop below
1009 missing_dependencies=
1010 test_require_external_prereq dtach || missing_dependencies=1
1011 test_require_external_prereq emacs || missing_dependencies=1
1012 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
1013 test -z "$missing_dependencies" || return
1015 if [ -z "$EMACS_SERVER" ]; then
1016 emacs_tests="$NOTMUCH_SRCDIR/test/${this_test_bare}.el"
1017 if [ -f "$emacs_tests" ]; then
1018 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
1022 server_name="notmuch-test-suite-$$"
1023 # start a detached session with an emacs server
1024 # user's TERM (or 'vt100' in case user's TERM is known dumb
1025 # or unknown) is given to dtach which assumes a minimally
1026 # VT100-compatible terminal -- and emacs inherits that
1027 TERM=$SMART_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
1028 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
1029 --no-window-system \
1031 --eval '(setq server-name \"$server_name\")' \
1032 --eval '(server-start)' \
1033 --eval '(orphan-watchdog $$)'" || return
1034 EMACS_SERVER="$server_name"
1035 # wait until the emacs server is up
1036 until test_emacs '()' >/dev/null 2>/dev/null; do
1041 # Clear test-output output file. Most Emacs tests end with a
1042 # call to (test-output). If the test code fails with an
1043 # exception before this call, the output file won't get
1044 # updated. Since we don't want to compare against an output
1045 # file from another test, so start out with an empty file.
1049 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $*)"
1053 # Note: if there is need to print debug information from python program,
1054 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1055 PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1056 $NOTMUCH_PYTHON -B - > OUTPUT
1060 MAIL_DIR=$MAIL_DIR $NOTMUCH_RUBY -I $NOTMUCH_SRCDIR/bindings/ruby> OUTPUT
1064 exec_file="test${test_count}"
1065 test_file="${exec_file}.c"
1067 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
1068 echo "== stdout ==" > OUTPUT.stdout
1069 echo "== stderr ==" > OUTPUT.stderr
1070 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1071 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr > OUTPUT
1076 test_file="${base_name}.c"
1077 shim_file="${base_name}.so"
1079 ${TEST_CC} ${TEST_CFLAGS} ${TEST_SHIM_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${shim_file} ${test_file} ${TEST_SHIM_LDFLAGS}
1082 notmuch_with_shim () {
1085 shim_file="${base_name}.so"
1086 LD_PRELOAD=./${shim_file}${LD_PRELOAD:+:$LD_PRELOAD} notmuch-shared "$@"
1089 # Creates a script that counts how much time it is executed and calls
1090 # notmuch. $notmuch_counter_command is set to the path to the
1091 # generated script. Use notmuch_counter_value() function to get the
1092 # current counter value.
1093 notmuch_counter_reset () {
1094 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1095 if [ ! -x "$notmuch_counter_command" ]; then
1096 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1097 cat >"$notmuch_counter_command" <<EOF || return
1100 read count < "$notmuch_counter_state_path"
1101 echo \$((count + 1)) > "$notmuch_counter_state_path"
1105 chmod +x "$notmuch_counter_command" || return
1108 echo 0 > "$notmuch_counter_state_path"
1111 # Returns the current notmuch counter value.
1112 notmuch_counter_value () {
1113 if [ -r "$notmuch_counter_state_path" ]; then
1114 read count < "$notmuch_counter_state_path"
1121 test_reset_state_ () {
1122 test -z "$test_init_done_" && test_init_
1124 test_subtest_known_broken_=
1125 test_subtest_missing_external_prereq_=()
1128 # called once before the first subtest
1132 # skip all tests if there were external prerequisites missing during init
1133 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1137 # Where to run the tests
1138 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1140 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1142 emacs_generate_script
1145 # Use -P to resolve symlinks in our working directory so that the cwd
1146 # in subprocesses like git equals our $PWD (for pathname comparisons).
1147 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1149 if test "$verbose" = "t"
1153 exec 4>test.output 3>&4
1156 for skp in $NOTMUCH_SKIP_TESTS
1159 for skp in $NOTMUCH_SKIP_TESTS
1161 case "$this_test" in
1166 case "$this_test_bare" in
1174 say_color skip >&3 "skipping test $this_test altogether"
1175 say_color skip "skip all tests in $this_test"
1180 # Provide an implementation of the 'yes' utility
1195 # Fix some commands on Windows
1198 # Windows has its own (incompatible) sort and find
1208 # git sees Windows-style pwd
1212 # no POSIX permissions
1213 # backslashes in pathspec are converted to '/'
1214 # exec does not inherit the PID
1217 test_set_prereq POSIXPERM
1218 test_set_prereq BSLASHPSPEC
1219 test_set_prereq EXECKEEPSPID
1223 test -z "$NO_PERL" && test_set_prereq PERL
1224 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1226 # test whether the filesystem supports symbolic links
1227 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1230 # convert variable from configure to more convenient form
1231 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1239 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1241 # declare prerequisites for external binaries used in tests
1242 test_declare_external_prereq dtach
1243 test_declare_external_prereq emacs
1244 test_declare_external_prereq ${TEST_EMACSCLIENT}
1245 test_declare_external_prereq ${TEST_GDB}
1246 test_declare_external_prereq gpg
1247 test_declare_external_prereq openssl
1248 test_declare_external_prereq gpgsm
1249 test_declare_external_prereq ${NOTMUCH_PYTHON}