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 openssl pkcs12 -export -passout pass: -inkey "$NOTMUCH_SRCDIR/test/smime/key+cert.pem" \
140 < "$NOTMUCH_SRCDIR/test/smime/test.crt" | \
141 gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
142 --disable-dirmngr --import >"$GNUPGHOME"/import.log 2>&1 3<<<''
143 fpr=$(gpgsm --batch --list-key test_suite@notmuchmail.org | sed -n 's/.*fingerprint: //p')
144 echo "$fpr S relax" >> "$GNUPGHOME/trustlist.txt"
145 gpgsm --quiet --batch --no-tty --no-common-certs-import --disable-dirmngr --import < $NOTMUCH_SRCDIR/test/smime/ca.crt
146 echo "4D:E0:FF:63:C0:E9:EC:01:29:11:C8:7A:EE:DA:3A:9A:7F:6E:C1:0D S" >> "$GNUPGHOME/trustlist.txt"
147 echo include-certs::1 | gpgconf --output /dev/null --change-options gpgsm
148 test_debug "cat $GNUPGHOME/import.log"
151 # Each test should start with something like this, after copyright notices:
153 # test_description='Description of this test...
154 # This test checks if command xyzzy does the right thing...
156 # . ./test-lib.sh || exit 1
160 while test "$#" -ne 0
166 immediate=t; shift ;;
174 with_dashes=t; shift ;;
181 valgrind=t; verbose=t; shift ;;
183 shift ;; # was handled already
185 echo "error: unknown test option '$1'" >&2; exit 1 ;;
189 if test -n "$debug"; then
191 printf " %-4s" "[$((test_count - 1))]"
199 test -n "$COLORS_WITHOUT_TTY" || [ -t 1 ] || color=
201 if [ -n "$color" ] && [ "$ORIGINAL_TERM" != 'dumb' ] && (
202 TERM=$ORIGINAL_TERM &&
214 if test -n "$color"; then
220 error) tput bold; tput setaf 1;; # bold red
221 skip) tput bold; tput setaf 2;; # bold green
222 pass) tput setaf 2;; # green
223 info) tput setaf 3;; # brown
224 *) test -n "$quiet" && return;;
235 test -z "$1" && test -n "$quiet" && return
244 say_color error "error: $*\n"
253 test "${test_description}" != "" ||
254 error "Test script did not set test_description."
256 if test "$help" = "t"
258 echo "Tests ${test_description}"
262 test_description_printed=
263 print_test_description ()
265 test -z "$test_description_printed" || return 0
267 echo $this_test: "Testing ${test_description}"
268 test_description_printed=1
270 if [ -z "$NOTMUCH_TEST_QUIET" ]
272 print_test_description
281 declare -a _exit_functions=()
283 at_exit_function () {
284 _exit_functions=($1 ${_exit_functions[@]/$1})
287 rm_exit_function () {
288 _exit_functions=(${_exit_functions[@]/$1})
295 for _fn in ${_exit_functions[@]}; do $_fn; done
296 rm -rf "$TEST_TMPDIR"
301 if test -n "$GIT_EXIT_OK"
306 say_color error '%-6s' FATAL
307 echo " $test_subtest_name"
309 echo "Unexpected exit while executing $0. Exit code $code."
316 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
323 say_color error '%-6s' FATAL
326 echo "Unexpected exit while executing $0."
331 # Note: TEST_TMPDIR *NOT* exported!
332 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
333 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
334 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
335 trap 'trap_exit' EXIT
336 trap 'trap_signal' HUP INT TERM
338 # Deliver a message with emacs and add it to the database
340 # Uses emacs to generate and deliver a message to the mail store.
341 # Accepts arbitrary extra emacs/elisp functions to modify the message
342 # before sending, which is useful to doing things like attaching files
343 # to the message and encrypting/signing.
344 emacs_deliver_message ()
349 # before we can send a message, we have to prepare the FCC maildir
350 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
351 # eval'ing smtp-dummy --background will set smtp_dummy_pid and -_port
352 local smtp_dummy_pid= smtp_dummy_port=
353 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
354 test -n "$smtp_dummy_pid" || return 1
355 test -n "$smtp_dummy_port" || return 1
358 "(let ((message-send-mail-function 'message-smtpmail-send-it)
359 (mail-host-address \"example.com\")
360 (smtpmail-smtp-server \"localhost\")
361 (smtpmail-smtp-service \"${smtp_dummy_port}\"))
364 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
365 (message-goto-subject)
366 (insert \"${subject}\")
370 (notmuch-mua-send-and-exit))"
372 # In case message was sent properly, client waits for confirmation
373 # before exiting and resuming control here; therefore making sure
374 # that server exits by sending (KILL) signal to it is safe.
375 kill -9 $smtp_dummy_pid
376 notmuch new >/dev/null
379 # Pretend to deliver a message with emacs. Really save it to a file
380 # and add it to the database
382 # Uses emacs to generate and deliver a message to the mail store.
383 # Accepts arbitrary extra emacs/elisp functions to modify the message
384 # before sending, which is useful to doing things like attaching files
385 # to the message and encrypting/signing.
387 # If any GNU-style long-arguments (like --quiet or --decrypt=true) are
388 # at the head of the argument list, they are sent directly to "notmuch
389 # new" after message delivery
393 while [[ "$1" =~ ^-- ]]; do
394 nmn_args="$nmn_args $1"
400 # before we can send a message, we have to prepare the FCC maildir
401 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
404 "(let ((message-send-mail-function (lambda () t))
405 (mail-host-address \"example.com\"))
408 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
409 (message-goto-subject)
410 (insert \"${subject}\")
414 (notmuch-mua-send-and-exit))" || return 1
415 notmuch new $nmn_args >/dev/null
418 # Add an existing, fixed corpus of email to the database.
420 # $1 is the corpus dir under corpora to add, using "default" if unset.
422 # The default corpus is based on about 50 messages from early in the
423 # history of the notmuch mailing list, which allows for reliably
424 # testing commands that need to operate on a not-totally-trivial
425 # number of messages.
431 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
432 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
435 test_begin_subtest ()
437 if [ -n "$inside_subtest" ]; then
438 exec 1>&6 2>&7 # Restore stdout and stderr
439 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
441 test_subtest_name="$1"
443 # Redirect test output to the previously prepared file descriptors
444 # 3 and 4 (see below)
445 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
450 # Pass test if two arguments match
452 # Note: Unlike all other test_expect_* functions, this function does
453 # not accept a test name. Instead, the caller should call
454 # test_begin_subtest before calling this function in order to set the
458 exec 1>&6 2>&7 # Restore stdout and stderr
459 if [ -z "$inside_subtest" ]; then
460 error "bug in the test script: test_expect_equal without test_begin_subtest"
464 error "bug in the test script: not 2 parameters to test_expect_equal"
468 if ! test_skip "$test_subtest_name"
470 if [ "$output" = "$expected" ]; then
473 testname=$this_test.$test_count
474 echo "$expected" > $testname.expected
475 echo "$output" > $testname.output
476 test_failure_ "$(diff -u $testname.expected $testname.output)"
481 # Like test_expect_equal, but takes two filenames.
482 test_expect_equal_file ()
484 exec 1>&6 2>&7 # Restore stdout and stderr
485 if [ -z "$inside_subtest" ]; then
486 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
490 error "bug in the test script: not 2 parameters to test_expect_equal_file"
494 if ! test_skip "$test_subtest_name"
496 if diff -q "$file1" "$file2" >/dev/null ; then
499 testname=$this_test.$test_count
500 basename1=`basename "$file1"`
501 basename2=`basename "$file2"`
502 cp "$file1" "$testname.$basename1"
503 cp "$file2" "$testname.$basename2"
504 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
509 # Like test_expect_equal, but arguments are JSON expressions to be
510 # canonicalized before diff'ing. If an argument cannot be parsed, it
511 # is used unchanged so that there's something to diff against.
512 test_expect_equal_json () {
513 # The test suite forces LC_ALL=C, but this causes Python 3 to
514 # decode stdin as ASCII. We need to read JSON in UTF-8, so
515 # override Python's stdio encoding defaults.
516 local script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
517 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
519 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
522 test_expect_equal "$output" "$expected" "$@"
525 # Sort the top-level list of JSON data from stdin.
527 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
528 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
531 # test for json objects:
532 # read the source of test/json_check_nodes.py (or the output when
533 # invoking it without arguments) for an explanation of the syntax.
535 exec 1>&6 2>&7 # Restore stdout and stderr
536 if [ -z "$inside_subtest" ]; then
537 error "bug in the test script: test_json_eval without test_begin_subtest"
541 error "bug in the test script: test_json_nodes needs at least 1 parameter"
543 if ! test_skip "$test_subtest_name"
545 output=$(PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON "$TEST_DIRECTORY"/json_check_nodes.py "$@")
550 test_failure_ "$output"
555 test_emacs_expect_t () {
557 error "bug in the test script: not 1 parameter to test_emacs_expect_t"
558 if [ -z "$inside_subtest" ]; then
559 error "bug in the test script: test_emacs_expect_t without test_begin_subtest"
563 if ! test_skip "$test_subtest_name"
565 test_emacs "(notmuch-test-run $1)" >/dev/null
567 # Restore state after the test.
568 exec 1>&6 2>&7 # Restore stdout and stderr
571 # Report success/failure.
577 test_failure_ "${result}"
580 # Restore state after the (non) test.
581 exec 1>&6 2>&7 # Restore stdout and stderr
588 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
593 # this relies on the default format being batch-tag, otherwise some tests will break
594 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
597 notmuch_drop_mail_headers ()
601 msg = email.message_from_file(sys.stdin)
602 for hdr in sys.argv[1:]: del msg[hdr]
603 print(msg.as_string(False))
607 notmuch_search_sanitize ()
609 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
612 notmuch_search_files_sanitize ()
617 notmuch_dir_sanitize ()
619 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
622 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
623 notmuch_show_sanitize ()
625 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
627 notmuch_show_sanitize_all ()
630 -e 's| filename:.*| filename:XXXXX|' \
631 -e 's| id:[^ ]* | id:XXXXX |' | \
632 notmuch_date_sanitize
635 notmuch_json_show_sanitize ()
638 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
639 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
640 -e 's|"filename": "signature.asc",||g' \
641 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
642 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
643 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
646 notmuch_emacs_error_sanitize ()
654 -e 's/^\[.*\]$/[XXX]/' \
655 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
658 notmuch_date_sanitize ()
661 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
664 notmuch_uuid_sanitize ()
666 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
669 notmuch_built_with_sanitize ()
671 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
674 notmuch_config_sanitize ()
676 notmuch_dir_sanitize | notmuch_built_with_sanitize
681 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
684 # End of notmuch helper functions
686 # Use test_set_prereq to tell that a particular prerequisite is available.
688 # The prerequisite can later be checked for by using test_have_prereq.
690 # The single parameter is the prerequisite tag (a simple word, in all
691 # capital letters by convention).
694 satisfied="$satisfied$1 "
698 test_have_prereq () {
707 declare -A test_missing_external_prereq_
708 declare -A test_subtest_missing_external_prereq_
710 # declare prerequisite for the given external binary
711 test_declare_external_prereq () {
713 test "$#" = 2 && name=$2 || name="$binary(1)"
715 if ! hash $binary 2>/dev/null; then
716 test_missing_external_prereq_["${binary}"]=t
719 test_subtest_missing_external_prereq_[\"${name}\"]=t
725 # Explicitly require external prerequisite. Useful when binary is
726 # called indirectly (e.g. from emacs).
727 # Returns success if dependency is available, failure otherwise.
728 test_require_external_prereq () {
730 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
731 # dependency is missing, call the replacement function to note it
738 # You are not expected to call test_ok_ and test_failure_ directly, use
739 # the text_expect_* functions instead.
742 if test "$test_subtest_known_broken_" = "t"; then
743 test_known_broken_ok_
746 test_success=$(($test_success + 1))
747 if test -n "$NOTMUCH_TEST_QUIET"; then
750 say_color pass "%-6s" "PASS"
751 echo " $test_subtest_name"
755 print_test_description
756 if test "$test_subtest_known_broken_" = "t"; then
757 test_known_broken_failure_ "$@"
760 test_failure=$(($test_failure + 1))
761 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
762 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
766 test_failure_message_ () {
767 say_color error "%-6s" "$1"
770 if [ "$#" != "0" ]; then
771 echo "$@" | sed -e 's/^/ /'
773 if test "$verbose" != "t"; then cat test.output; fi
776 test_known_broken_ok_ () {
778 test_fixed=$(($test_fixed+1))
779 say_color pass "%-6s" "FIXED"
780 echo " $test_subtest_name"
783 test_known_broken_failure_ () {
785 test_broken=$(($test_broken+1))
786 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
787 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
789 test_failure_message_ "BROKEN" "$test_subtest_name"
795 test "$debug" = "" || eval "$1"
800 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
803 eval >&3 2>&4 "$test_cleanup"
808 test_count=$(($test_count+1))
810 for skp in $NOTMUCH_SKIP_TESTS
812 case $this_test.$test_count in
817 case $this_test_bare.$test_count in
825 test_report_skip_ "$@"
828 test_check_missing_external_prereqs_ "$@"
833 test_check_missing_external_prereqs_ () {
834 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
835 say_color skip >&1 "missing prerequisites: "
836 echo ${!test_subtest_missing_external_prereq_[@]} >&1
837 test_report_skip_ "$@"
843 test_report_skip_ () {
845 say_color skip >&3 "skipping test:"
847 say_color skip "%-6s" "SKIP"
851 test_subtest_known_broken () {
852 test_subtest_known_broken_=t
855 test_expect_success () {
856 exec 1>&6 2>&7 # Restore stdout and stderr
857 if [ -z "$inside_subtest" ]; then
858 error "bug in the test script: test_expect_success without test_begin_subtest"
862 error "bug in the test script: not 1 parameters to test_expect_success"
864 if ! test_skip "$test_subtest_name"
868 # test_run_ may update missing external prerequisites
869 test_check_missing_external_prereqs_ "$@" ||
870 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
879 test_expect_code () {
880 exec 1>&6 2>&7 # Restore stdout and stderr
881 if [ -z "$inside_subtest" ]; then
882 error "bug in the test script: test_expect_code without test_begin_subtest"
886 error "bug in the test script: not 2 parameters to test_expect_code"
888 if ! test_skip "$test_subtest_name"
892 # test_run_ may update missing external prerequisites,
893 test_check_missing_external_prereqs_ "$@" ||
894 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
898 test_failure_ "exit code $eval_ret, expected $1" "$2"
903 # This is not among top-level (test_expect_success)
904 # but is a prefix that can be used in the test script, like:
906 # test_expect_success 'complain and die' '
908 # do something else &&
909 # test_must_fail git checkout ../outerspace
912 # Writing this as "! git checkout ../outerspace" is wrong, because
913 # the failure could be due to a segv. We want a controlled failure.
917 test $? -gt 0 -a $? -le 129 -o $? -gt 192
920 # test_cmp is a helper function to compare actual and expected output.
921 # You can use it like:
923 # test_expect_success 'foo works' '
924 # echo expected >expected &&
926 # test_cmp expected actual
929 # This could be written as either "cmp" or "diff -u", but:
930 # - cmp's output is not nearly as easy to read as diff -u
931 # - not all diff versions understand "-u"
937 # This function can be used to schedule some commands to be run
938 # unconditionally at the end of the test to restore sanity:
940 # test_expect_success 'test core.capslock' '
941 # git config core.capslock true &&
942 # test_when_finished "git config --unset core.capslock" &&
946 # That would be roughly equivalent to
948 # test_expect_success 'test core.capslock' '
949 # git config core.capslock true &&
951 # git config --unset core.capslock
954 # except that the greeting and config --unset must both succeed for
957 test_when_finished () {
959 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
964 test_results_dir="$TEST_DIRECTORY/test-results"
965 mkdir -p "$test_results_dir"
966 test_results_path="$test_results_dir/$this_test"
968 echo "total $test_count" >> $test_results_path
969 echo "success $test_success" >> $test_results_path
970 echo "fixed $test_fixed" >> $test_results_path
971 echo "broken $test_broken" >> $test_results_path
972 echo "failed $test_failure" >> $test_results_path
973 echo "" >> $test_results_path
975 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
977 if [ "$test_failure" = "0" ]; then
978 if [ "$test_broken" = "0" ]; then
987 emacs_generate_script () {
988 # Construct a little test script here for the benefit of the user,
989 # (who can easily run "run_emacs" to get the same emacs environment
990 # for investigating any failures).
991 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
994 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
996 # Here's what we are using here:
998 # --quick Use minimal customization. This implies --no-init-file,
999 # --no-site-file and (emacs 24) --no-site-lisp
1001 # --directory Ensure that the local elisp sources are found
1003 # --load Force loading of notmuch.el and test-lib.el
1005 exec ${TEST_EMACS} --quick \
1006 --directory "$NOTMUCH_SRCDIR/emacs" --load notmuch.el \
1007 --directory "$NOTMUCH_SRCDIR/test" --load test-lib.el \
1010 chmod a+x "$TMP_DIRECTORY/run_emacs"
1014 # test dependencies beforehand to avoid the waiting loop below
1015 missing_dependencies=
1016 test_require_external_prereq dtach || missing_dependencies=1
1017 test_require_external_prereq emacs || missing_dependencies=1
1018 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
1019 test -z "$missing_dependencies" || return
1021 if [ -z "$EMACS_SERVER" ]; then
1022 emacs_tests="$NOTMUCH_SRCDIR/test/${this_test_bare}.el"
1023 if [ -f "$emacs_tests" ]; then
1024 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
1028 server_name="notmuch-test-suite-$$"
1029 # start a detached session with an emacs server
1030 # user's TERM (or 'vt100' in case user's TERM is known dumb
1031 # or unknown) is given to dtach which assumes a minimally
1032 # VT100-compatible terminal -- and emacs inherits that
1033 TERM=$SMART_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
1034 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
1035 --no-window-system \
1037 --eval '(setq server-name \"$server_name\")' \
1038 --eval '(server-start)' \
1039 --eval '(orphan-watchdog $$)'" || return
1040 EMACS_SERVER="$server_name"
1041 # wait until the emacs server is up
1042 until test_emacs '()' >/dev/null 2>/dev/null; do
1047 # Clear test-output output file. Most Emacs tests end with a
1048 # call to (test-output). If the test code fails with an
1049 # exception before this call, the output file won't get
1050 # updated. Since we don't want to compare against an output
1051 # file from another test, so start out with an empty file.
1055 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $*)"
1059 # Note: if there is need to print debug information from python program,
1060 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1061 PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1062 $NOTMUCH_PYTHON -B - > OUTPUT
1066 MAIL_DIR=$MAIL_DIR $NOTMUCH_RUBY -I $NOTMUCH_SRCDIR/bindings/ruby> OUTPUT
1070 exec_file="test${test_count}"
1071 test_file="${exec_file}.c"
1073 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
1074 echo "== stdout ==" > OUTPUT.stdout
1075 echo "== stderr ==" > OUTPUT.stderr
1076 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1077 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr > OUTPUT
1082 test_file="${base_name}.c"
1083 shim_file="${base_name}.so"
1085 ${TEST_CC} ${TEST_CFLAGS} ${TEST_SHIM_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${shim_file} ${test_file} ${TEST_SHIM_LDFLAGS}
1088 notmuch_with_shim () {
1091 shim_file="${base_name}.so"
1092 LD_PRELOAD=./${shim_file}${LD_PRELOAD:+:$LD_PRELOAD} notmuch-shared "$@"
1095 # Creates a script that counts how much time it is executed and calls
1096 # notmuch. $notmuch_counter_command is set to the path to the
1097 # generated script. Use notmuch_counter_value() function to get the
1098 # current counter value.
1099 notmuch_counter_reset () {
1100 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1101 if [ ! -x "$notmuch_counter_command" ]; then
1102 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1103 cat >"$notmuch_counter_command" <<EOF || return
1106 read count < "$notmuch_counter_state_path"
1107 echo \$((count + 1)) > "$notmuch_counter_state_path"
1111 chmod +x "$notmuch_counter_command" || return
1114 echo 0 > "$notmuch_counter_state_path"
1117 # Returns the current notmuch counter value.
1118 notmuch_counter_value () {
1119 if [ -r "$notmuch_counter_state_path" ]; then
1120 read count < "$notmuch_counter_state_path"
1127 test_reset_state_ () {
1128 test -z "$test_init_done_" && test_init_
1130 test_subtest_known_broken_=
1131 test_subtest_missing_external_prereq_=()
1134 # called once before the first subtest
1138 # skip all tests if there were external prerequisites missing during init
1139 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1143 # Where to run the tests
1144 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1146 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1148 emacs_generate_script
1151 # Use -P to resolve symlinks in our working directory so that the cwd
1152 # in subprocesses like git equals our $PWD (for pathname comparisons).
1153 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1155 if test "$verbose" = "t"
1159 exec 4>test.output 3>&4
1162 for skp in $NOTMUCH_SKIP_TESTS
1165 for skp in $NOTMUCH_SKIP_TESTS
1167 case "$this_test" in
1172 case "$this_test_bare" in
1180 say_color skip >&3 "skipping test $this_test altogether"
1181 say_color skip "skip all tests in $this_test"
1186 # Provide an implementation of the 'yes' utility
1201 # Fix some commands on Windows
1204 # Windows has its own (incompatible) sort and find
1214 # git sees Windows-style pwd
1218 # no POSIX permissions
1219 # backslashes in pathspec are converted to '/'
1220 # exec does not inherit the PID
1223 test_set_prereq POSIXPERM
1224 test_set_prereq BSLASHPSPEC
1225 test_set_prereq EXECKEEPSPID
1229 test -z "$NO_PERL" && test_set_prereq PERL
1230 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1232 # test whether the filesystem supports symbolic links
1233 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1236 # convert variable from configure to more convenient form
1237 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1245 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1247 # declare prerequisites for external binaries used in tests
1248 test_declare_external_prereq dtach
1249 test_declare_external_prereq emacs
1250 test_declare_external_prereq ${TEST_EMACSCLIENT}
1251 test_declare_external_prereq ${TEST_GDB}
1252 test_declare_external_prereq gpg
1253 test_declare_external_prereq openssl
1254 test_declare_external_prereq gpgsm
1255 test_declare_external_prereq ${NOTMUCH_PYTHON}