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
112 [ -e "${GNUPGHOME}/gpg.conf" ] && return
113 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
114 at_exit_function _gnupg_exit
115 mkdir -p -m 0700 "$GNUPGHOME"
116 gpg --no-tty --import <$NOTMUCH_SRCDIR/test/gnupg-secret-key.asc >"$GNUPGHOME"/import.log 2>&1
117 test_debug "cat $GNUPGHOME/import.log"
118 if (gpg --quick-random --version >/dev/null 2>&1) ; then
119 echo quick-random >> "$GNUPGHOME"/gpg.conf
120 elif (gpg --debug-quick-random --version >/dev/null 2>&1) ; then
121 echo debug-quick-random >> "$GNUPGHOME"/gpg.conf
123 echo no-emit-version >> "$GNUPGHOME"/gpg.conf
125 # Change this if we ship a new test key
126 FINGERPRINT="5AEAB11F5E33DCE875DDB75B6D92612D94E46381"
127 SELF_USERID="Notmuch Test Suite <test_suite@notmuchmail.org> (INSECURE!)"
128 printf '%s:6:\n' "$FINGERPRINT" | gpg --quiet --batch --no-tty --import-ownertrust
134 [ -e "$GNUPGHOME/gpgsm.conf" ] && return
135 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
136 at_exit_function _gnupg_exit
137 mkdir -p -m 0700 "$GNUPGHOME"
138 openssl pkcs12 -export -passout pass: -inkey "$NOTMUCH_SRCDIR/test/smime/key+cert.pem" \
139 < "$NOTMUCH_SRCDIR/test/smime/test.crt" | \
140 gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
141 --disable-dirmngr --import >"$GNUPGHOME"/import.log 2>&1 3<<<''
142 fpr=$(gpgsm --batch --list-key test_suite@notmuchmail.org | sed -n 's/.*fingerprint: //p')
143 echo "$fpr S relax" >> "$GNUPGHOME/trustlist.txt"
144 gpgsm --quiet --batch --no-tty --no-common-certs-import --disable-dirmngr --import < $NOTMUCH_SRCDIR/test/smime/ca.crt
145 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"
146 printf '%s::1\n' include-certs disable-crl-checks | gpgconf --output /dev/null --change-options gpgsm
147 gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
148 --disable-dirmngr --import "$NOTMUCH_SRCDIR/test/smime/bob.p12" >>"$GNUPGHOME"/import.log 2>&1 3<<<''
149 test_debug "cat $GNUPGHOME/import.log"
152 # Each test should start with something like this, after copyright notices:
154 # test_description='Description of this test...
155 # This test checks if command xyzzy does the right thing...
157 # . ./test-lib.sh || exit 1
161 while test "$#" -ne 0
167 immediate=t; shift ;;
175 with_dashes=t; shift ;;
182 valgrind=t; verbose=t; shift ;;
184 shift ;; # was handled already
186 echo "error: unknown test option '$1'" >&2; exit 1 ;;
190 if test -n "$debug"; then
192 printf " %-4s" "[$((test_count - 1))]"
200 test -n "$COLORS_WITHOUT_TTY" || [ -t 1 ] || color=
202 if [ -n "$color" ] && [ "$ORIGINAL_TERM" != 'dumb' ] && (
203 TERM=$ORIGINAL_TERM &&
215 if test -n "$color"; then
221 error) tput bold; tput setaf 1;; # bold red
222 skip) tput bold; tput setaf 2;; # bold green
223 pass) tput setaf 2;; # green
224 info) tput setaf 3;; # brown
225 *) test -n "$quiet" && return;;
236 test -z "$1" && test -n "$quiet" && return
245 say_color error "error: $*\n"
254 test "${test_description}" != "" ||
255 error "Test script did not set test_description."
257 if test "$help" = "t"
259 echo "Tests ${test_description}"
263 test_description_printed=
264 print_test_description ()
266 test -z "$test_description_printed" || return 0
268 echo $this_test: "Testing ${test_description}"
269 test_description_printed=1
271 if [ -z "$NOTMUCH_TEST_QUIET" ]
273 print_test_description
282 declare -a _exit_functions=()
284 at_exit_function () {
285 _exit_functions=($1 ${_exit_functions[@]/$1})
288 rm_exit_function () {
289 _exit_functions=(${_exit_functions[@]/$1})
296 for _fn in ${_exit_functions[@]}; do $_fn; done
297 rm -rf "$TEST_TMPDIR"
302 if test -n "$GIT_EXIT_OK"
307 say_color error '%-6s' FATAL
308 echo " $test_subtest_name"
310 echo "Unexpected exit while executing $0. Exit code $code."
317 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
324 say_color error '%-6s' FATAL
327 echo "Unexpected exit while executing $0."
332 # Note: TEST_TMPDIR *NOT* exported!
333 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
334 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
335 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
336 trap 'trap_exit' EXIT
337 trap 'trap_signal' HUP INT TERM
339 # Deliver a message with emacs and add it to the database
341 # Uses emacs to generate and deliver a message to the mail store.
342 # Accepts arbitrary extra emacs/elisp functions to modify the message
343 # before sending, which is useful to doing things like attaching files
344 # to the message and encrypting/signing.
345 emacs_deliver_message ()
347 local subject body smtp_dummy_pid smtp_dummy_port
351 # before we can send a message, we have to prepare the FCC maildir
352 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
353 # eval'ing smtp-dummy --background will set smtp_dummy_pid and -_port
354 smtp_dummy_pid= smtp_dummy_port=
355 eval `$TEST_DIRECTORY/smtp-dummy --background sent_message`
356 test -n "$smtp_dummy_pid" || return 1
357 test -n "$smtp_dummy_port" || return 1
360 "(let ((message-send-mail-function 'message-smtpmail-send-it)
361 (mail-host-address \"example.com\")
362 (smtpmail-smtp-server \"localhost\")
363 (smtpmail-smtp-service \"${smtp_dummy_port}\"))
366 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
367 (message-goto-subject)
368 (insert \"${subject}\")
372 (notmuch-mua-send-and-exit))"
374 # In case message was sent properly, client waits for confirmation
375 # before exiting and resuming control here; therefore making sure
376 # that server exits by sending (KILL) signal to it is safe.
377 kill -9 $smtp_dummy_pid
378 notmuch new >/dev/null
381 # Pretend to deliver a message with emacs. Really save it to a file
382 # and add it to the database
384 # Uses emacs to generate and deliver a message to the mail store.
385 # Accepts arbitrary extra emacs/elisp functions to modify the message
386 # before sending, which is useful to doing things like attaching files
387 # to the message and encrypting/signing.
389 # If any GNU-style long-arguments (like --quiet or --decrypt=true) are
390 # at the head of the argument list, they are sent directly to "notmuch
391 # new" after message delivery
394 local nmn_args subject body
396 while [[ "$1" =~ ^-- ]]; do
397 nmn_args="$nmn_args $1"
403 # before we can send a message, we have to prepare the FCC maildir
404 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
407 "(let ((message-send-mail-function (lambda () t))
408 (mail-host-address \"example.com\"))
411 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
412 (message-goto-subject)
413 (insert \"${subject}\")
417 (notmuch-mua-send-and-exit))" || return 1
418 notmuch new $nmn_args >/dev/null
421 # Add an existing, fixed corpus of email to the database.
423 # $1 is the corpus dir under corpora to add, using "default" if unset.
425 # The default corpus is based on about 50 messages from early in the
426 # history of the notmuch mailing list, which allows for reliably
427 # testing commands that need to operate on a not-totally-trivial
428 # number of messages.
435 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
436 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
439 test_begin_subtest ()
441 if [ -n "$inside_subtest" ]; then
442 exec 1>&6 2>&7 # Restore stdout and stderr
443 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
445 test_subtest_name="$1"
447 # Redirect test output to the previously prepared file descriptors
448 # 3 and 4 (see below)
449 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
454 # Pass test if two arguments match
456 # Note: Unlike all other test_expect_* functions, this function does
457 # not accept a test name. Instead, the caller should call
458 # test_begin_subtest before calling this function in order to set the
462 local output expected testname
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 without test_begin_subtest"
469 error "bug in the test script: not 2 parameters to test_expect_equal"
473 if ! test_skip "$test_subtest_name"
475 if [ "$output" = "$expected" ]; then
478 testname=$this_test.$test_count
479 echo "$expected" > $testname.expected
480 echo "$output" > $testname.output
481 test_failure_ "$(diff -u $testname.expected $testname.output)"
486 # Like test_expect_equal, but takes two filenames.
487 test_expect_equal_file ()
489 local file1 file2 testname basename1 basename2
490 exec 1>&6 2>&7 # Restore stdout and stderr
491 if [ -z "$inside_subtest" ]; then
492 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
496 error "bug in the test script: not 2 parameters to test_expect_equal_file"
500 if ! test_skip "$test_subtest_name"
502 if diff -q "$file1" "$file2" >/dev/null ; then
505 testname=$this_test.$test_count
506 basename1=`basename "$file1"`
507 basename2=`basename "$file2"`
508 cp "$file1" "$testname.$basename1"
509 cp "$file2" "$testname.$basename2"
510 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
515 # Like test_expect_equal, but arguments are JSON expressions to be
516 # canonicalized before diff'ing. If an argument cannot be parsed, it
517 # is used unchanged so that there's something to diff against.
518 test_expect_equal_json () {
519 local script output expected
520 # The test suite forces LC_ALL=C, but this causes Python 3 to
521 # decode stdin as ASCII. We need to read JSON in UTF-8, so
522 # override Python's stdio encoding defaults.
523 script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
524 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
526 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
529 test_expect_equal "$output" "$expected" "$@"
532 # Ensure that the argument is valid JSON data.
534 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "import sys, json; json.load(sys.stdin)" <<<"$1"
535 test_expect_equal "$?" 0
538 # Sort the top-level list of JSON data from stdin.
540 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
541 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
544 # test for json objects:
545 # read the source of test/json_check_nodes.py (or the output when
546 # invoking it without arguments) for an explanation of the syntax.
549 exec 1>&6 2>&7 # Restore stdout and stderr
550 if [ -z "$inside_subtest" ]; then
551 error "bug in the test script: test_json_eval without test_begin_subtest"
555 error "bug in the test script: test_json_nodes needs at least 1 parameter"
557 if ! test_skip "$test_subtest_name"
559 output=$(PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -B "$NOTMUCH_SRCDIR"/test/json_check_nodes.py "$@")
564 test_failure_ "$output"
569 test_emacs_expect_t () {
572 error "bug in the test script: not 1 parameter to test_emacs_expect_t"
573 if [ -z "$inside_subtest" ]; then
574 error "bug in the test script: test_emacs_expect_t without test_begin_subtest"
578 if ! test_skip "$test_subtest_name"
580 test_emacs "(notmuch-test-run $1)" >/dev/null
582 # Restore state after the test.
583 exec 1>&6 2>&7 # Restore stdout and stderr
586 # Report success/failure.
592 test_failure_ "${result}"
595 # Restore state after the (non) test.
596 exec 1>&6 2>&7 # Restore stdout and stderr
603 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
608 # this relies on the default format being batch-tag, otherwise some tests will break
609 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
612 notmuch_drop_mail_headers ()
616 msg = email.message_from_file(sys.stdin)
617 for hdr in sys.argv[1:]: del msg[hdr]
618 print(msg.as_string(False))
622 notmuch_exception_sanitize ()
624 perl -pe 's/(A Xapian exception occurred at .*[.]cc?):([0-9]*)/\1:XXX/'
627 notmuch_search_sanitize ()
629 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
632 notmuch_search_files_sanitize ()
637 notmuch_dir_sanitize ()
639 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
642 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
643 notmuch_show_sanitize ()
645 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
647 notmuch_show_sanitize_all ()
650 -e 's| filename:.*| filename:XXXXX|' \
651 -e 's| id:[^ ]* | id:XXXXX |' | \
652 notmuch_date_sanitize
655 notmuch_json_show_sanitize ()
658 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
659 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
660 -e 's|"filename": "signature.asc",||g' \
661 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
662 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
663 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
666 notmuch_emacs_error_sanitize ()
675 -e 's/^\[.*\]$/[XXX]/' \
676 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
679 notmuch_date_sanitize ()
682 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
685 notmuch_uuid_sanitize ()
687 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
690 notmuch_built_with_sanitize ()
692 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
695 notmuch_config_sanitize ()
697 notmuch_dir_sanitize | notmuch_built_with_sanitize
702 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
705 # End of notmuch helper functions
707 # Use test_set_prereq to tell that a particular prerequisite is available.
709 # The prerequisite can later be checked for by using test_have_prereq.
711 # The single parameter is the prerequisite tag (a simple word, in all
712 # capital letters by convention).
715 satisfied="$satisfied$1 "
719 test_have_prereq () {
728 declare -A test_missing_external_prereq_
729 declare -A test_subtest_missing_external_prereq_
731 # declare prerequisite for the given external binary
732 test_declare_external_prereq () {
735 test "$#" = 2 && name=$2 || name="$binary(1)"
737 if ! hash $binary 2>/dev/null; then
738 test_missing_external_prereq_["${binary}"]=t
741 test_subtest_missing_external_prereq_[\"${name}\"]=t
747 # Explicitly require external prerequisite. Useful when binary is
748 # called indirectly (e.g. from emacs).
749 # Returns success if dependency is available, failure otherwise.
750 test_require_external_prereq () {
753 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
754 # dependency is missing, call the replacement function to note it
761 # You are not expected to call test_ok_ and test_failure_ directly, use
762 # the text_expect_* functions instead.
765 if test "$test_subtest_known_broken_" = "t"; then
766 test_known_broken_ok_
769 test_success=$(($test_success + 1))
770 if test -n "$NOTMUCH_TEST_QUIET"; then
773 say_color pass "%-6s" "PASS"
774 echo " $test_subtest_name"
778 print_test_description
779 if test "$test_subtest_known_broken_" = "t"; then
780 test_known_broken_failure_ "$@"
783 test_failure=$(($test_failure + 1))
784 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
785 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
789 test_failure_message_ () {
790 say_color error "%-6s" "$1"
793 if [ "$#" != "0" ]; then
794 echo "$@" | sed -e 's/^/ /'
796 if test "$verbose" != "t"; then cat test.output; fi
799 test_known_broken_ok_ () {
801 test_fixed=$(($test_fixed+1))
802 say_color pass "%-6s" "FIXED"
803 echo " $test_subtest_name"
806 test_known_broken_failure_ () {
808 test_broken=$(($test_broken+1))
809 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
810 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
812 test_failure_message_ "BROKEN" "$test_subtest_name"
818 test "$debug" = "" || eval "$1"
823 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
826 eval >&3 2>&4 "$test_cleanup"
831 test_count=$(($test_count+1))
833 for skp in $NOTMUCH_SKIP_TESTS
835 case $this_test.$test_count in
840 case $this_test_bare.$test_count in
848 test_report_skip_ "$@"
851 test_check_missing_external_prereqs_ "$@"
856 test_check_missing_external_prereqs_ () {
857 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
858 say_color skip >&1 "missing prerequisites: "
859 echo ${!test_subtest_missing_external_prereq_[@]} >&1
860 test_report_skip_ "$@"
866 test_report_skip_ () {
868 say_color skip >&3 "skipping test:"
870 say_color skip "%-6s" "SKIP"
874 test_subtest_known_broken () {
875 test_subtest_known_broken_=t
878 test_expect_success () {
879 exec 1>&6 2>&7 # Restore stdout and stderr
880 if [ -z "$inside_subtest" ]; then
881 error "bug in the test script: test_expect_success without test_begin_subtest"
885 error "bug in the test script: not 1 parameters to test_expect_success"
887 if ! test_skip "$test_subtest_name"
891 # test_run_ may update missing external prerequisites
892 test_check_missing_external_prereqs_ "$@" ||
893 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
902 test_expect_code () {
903 exec 1>&6 2>&7 # Restore stdout and stderr
904 if [ -z "$inside_subtest" ]; then
905 error "bug in the test script: test_expect_code without test_begin_subtest"
909 error "bug in the test script: not 2 parameters to test_expect_code"
911 if ! test_skip "$test_subtest_name"
915 # test_run_ may update missing external prerequisites,
916 test_check_missing_external_prereqs_ "$@" ||
917 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
921 test_failure_ "exit code $eval_ret, expected $1" "$2"
926 # This is not among top-level (test_expect_success)
927 # but is a prefix that can be used in the test script, like:
929 # test_expect_success 'complain and die' '
931 # do something else &&
932 # test_must_fail git checkout ../outerspace
935 # Writing this as "! git checkout ../outerspace" is wrong, because
936 # the failure could be due to a segv. We want a controlled failure.
940 test $? -gt 0 -a $? -le 129 -o $? -gt 192
943 # test_cmp is a helper function to compare actual and expected output.
944 # You can use it like:
946 # test_expect_success 'foo works' '
947 # echo expected >expected &&
949 # test_cmp expected actual
952 # This could be written as either "cmp" or "diff -u", but:
953 # - cmp's output is not nearly as easy to read as diff -u
954 # - not all diff versions understand "-u"
960 # This function can be used to schedule some commands to be run
961 # unconditionally at the end of the test to restore sanity:
963 # test_expect_success 'test core.capslock' '
964 # git config core.capslock true &&
965 # test_when_finished "git config --unset core.capslock" &&
969 # That would be roughly equivalent to
971 # test_expect_success 'test core.capslock' '
972 # git config core.capslock true &&
974 # git config --unset core.capslock
977 # except that the greeting and config --unset must both succeed for
980 test_when_finished () {
982 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
987 test_results_dir="$TEST_DIRECTORY/test-results"
988 mkdir -p "$test_results_dir"
989 test_results_path="$test_results_dir/$this_test"
991 echo "total $test_count" >> $test_results_path
992 echo "success $test_success" >> $test_results_path
993 echo "fixed $test_fixed" >> $test_results_path
994 echo "broken $test_broken" >> $test_results_path
995 echo "failed $test_failure" >> $test_results_path
996 echo "" >> $test_results_path
998 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
1000 if [ "$test_failure" = "0" ]; then
1001 if [ "$test_broken" = "0" ]; then
1002 rm -rf "$remove_tmp"
1010 emacs_generate_script () {
1011 # Construct a little test script here for the benefit of the user,
1012 # (who can easily run "run_emacs" to get the same emacs environment
1013 # for investigating any failures).
1014 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
1017 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
1019 # Here's what we are using here:
1021 # --quick Use minimal customization. This implies --no-init-file,
1022 # --no-site-file and (emacs 24) --no-site-lisp
1024 # --directory Ensure that the local elisp sources are found
1026 # --load Force loading of notmuch.el and test-lib.el
1028 exec ${TEST_EMACS} --quick \
1029 --directory "$NOTMUCH_BUILDDIR/emacs" --load notmuch.el \
1030 --directory "$NOTMUCH_SRCDIR/test" --load test-lib.el \
1033 chmod a+x "$TMP_DIRECTORY/run_emacs"
1037 # test dependencies beforehand to avoid the waiting loop below
1038 missing_dependencies=
1039 test_require_external_prereq dtach || missing_dependencies=1
1040 test_require_external_prereq emacs || missing_dependencies=1
1041 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
1042 test -z "$missing_dependencies" || return
1044 if [ -z "$EMACS_SERVER" ]; then
1045 emacs_tests="$NOTMUCH_SRCDIR/test/${this_test_bare}.el"
1046 if [ -f "$emacs_tests" ]; then
1047 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
1051 server_name="notmuch-test-suite-$$"
1052 # start a detached session with an emacs server
1053 # user's TERM (or 'vt100' in case user's TERM is known dumb
1054 # or unknown) is given to dtach which assumes a minimally
1055 # VT100-compatible terminal -- and emacs inherits that
1056 TERM=$SMART_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
1057 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
1058 --no-window-system \
1060 --eval '(setq server-name \"$server_name\")' \
1061 --eval '(server-start)' \
1062 --eval '(orphan-watchdog $$)'" || return
1063 EMACS_SERVER="$server_name"
1064 # wait until the emacs server is up
1065 until test_emacs '()' >/dev/null 2>/dev/null; do
1070 # Clear test-output output file. Most Emacs tests end with a
1071 # call to (test-output). If the test code fails with an
1072 # exception before this call, the output file won't get
1073 # updated. Since we don't want to compare against an output
1074 # file from another test, so start out with an empty file.
1078 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $*)"
1082 # Note: if there is need to print debug information from python program,
1083 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1084 PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1085 $NOTMUCH_PYTHON -B - > OUTPUT
1089 MAIL_DIR=$MAIL_DIR $NOTMUCH_RUBY -I "$NOTMUCH_BUILDDIR/bindings/ruby"> OUTPUT
1093 local exec_file test_file
1094 exec_file="test${test_count}"
1095 test_file="${exec_file}.c"
1097 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
1098 echo "== stdout ==" > OUTPUT.stdout
1099 echo "== stderr ==" > OUTPUT.stderr
1100 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1101 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr | notmuch_exception_sanitize > OUTPUT
1105 local base_name test_file shim_file
1107 test_file="${base_name}.c"
1108 shim_file="${base_name}.so"
1110 ${TEST_CC} ${TEST_CFLAGS} ${TEST_SHIM_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${shim_file} ${test_file} ${TEST_SHIM_LDFLAGS}
1113 notmuch_with_shim () {
1114 local base_name shim_file
1117 shim_file="${base_name}.so"
1118 LD_PRELOAD=./${shim_file}${LD_PRELOAD:+:$LD_PRELOAD} notmuch-shared "$@"
1121 # Creates a script that counts how much time it is executed and calls
1122 # notmuch. $notmuch_counter_command is set to the path to the
1123 # generated script. Use notmuch_counter_value() function to get the
1124 # current counter value.
1125 notmuch_counter_reset () {
1126 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1127 if [ ! -x "$notmuch_counter_command" ]; then
1128 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1129 cat >"$notmuch_counter_command" <<EOF || return
1132 read count < "$notmuch_counter_state_path"
1133 echo \$((count + 1)) > "$notmuch_counter_state_path"
1137 chmod +x "$notmuch_counter_command" || return
1140 echo 0 > "$notmuch_counter_state_path"
1143 # Returns the current notmuch counter value.
1144 notmuch_counter_value () {
1145 if [ -r "$notmuch_counter_state_path" ]; then
1146 read count < "$notmuch_counter_state_path"
1153 test_reset_state_ () {
1154 test -z "$test_init_done_" && test_init_
1156 test_subtest_known_broken_=
1157 test_subtest_missing_external_prereq_=()
1160 # called once before the first subtest
1164 # skip all tests if there were external prerequisites missing during init
1165 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1169 # Where to run the tests
1170 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1172 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1174 emacs_generate_script
1177 # Use -P to resolve symlinks in our working directory so that the cwd
1178 # in subprocesses like git equals our $PWD (for pathname comparisons).
1179 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1181 if test "$verbose" = "t"
1185 exec 4>test.output 3>&4
1188 for skp in $NOTMUCH_SKIP_TESTS
1191 for skp in $NOTMUCH_SKIP_TESTS
1193 case "$this_test" in
1198 case "$this_test_bare" in
1206 say_color skip >&3 "skipping test $this_test altogether"
1207 say_color skip "skip all tests in $this_test"
1212 # Provide an implementation of the 'yes' utility
1227 # Fix some commands on Windows
1230 # Windows has its own (incompatible) sort and find
1240 # git sees Windows-style pwd
1244 # no POSIX permissions
1245 # backslashes in pathspec are converted to '/'
1246 # exec does not inherit the PID
1249 test_set_prereq POSIXPERM
1250 test_set_prereq BSLASHPSPEC
1251 test_set_prereq EXECKEEPSPID
1255 test -z "$NO_PERL" && test_set_prereq PERL
1256 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1258 # test whether the filesystem supports symbolic links
1259 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1262 # convert variable from configure to more convenient form
1263 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1271 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1273 # declare prerequisites for external binaries used in tests
1274 test_declare_external_prereq dtach
1275 test_declare_external_prereq emacs
1276 test_declare_external_prereq ${TEST_EMACSCLIENT}
1277 test_declare_external_prereq ${TEST_GDB}
1278 test_declare_external_prereq gpg
1279 test_declare_external_prereq openssl
1280 test_declare_external_prereq gpgsm
1281 test_declare_external_prereq ${NOTMUCH_PYTHON}