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
107 # For lib/open.cc:_load_key_file
108 unset XDG_CONFIG_HOME
111 unset ALTERNATE_EDITOR
113 # for reproducibility
118 [ -e "${GNUPGHOME}/gpg.conf" ] && return
119 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
120 at_exit_function _gnupg_exit
121 mkdir -p -m 0700 "$GNUPGHOME"
122 gpg --no-tty --import <$NOTMUCH_SRCDIR/test/gnupg-secret-key.asc >"$GNUPGHOME"/import.log 2>&1
123 test_debug "cat $GNUPGHOME/import.log"
124 if (gpg --quick-random --version >/dev/null 2>&1) ; then
125 echo quick-random >> "$GNUPGHOME"/gpg.conf
126 elif (gpg --debug-quick-random --version >/dev/null 2>&1) ; then
127 echo debug-quick-random >> "$GNUPGHOME"/gpg.conf
129 echo no-emit-version >> "$GNUPGHOME"/gpg.conf
131 # Change this if we ship a new test key
132 FINGERPRINT="5AEAB11F5E33DCE875DDB75B6D92612D94E46381"
133 SELF_USERID="Notmuch Test Suite <test_suite@notmuchmail.org> (INSECURE!)"
134 SELF_EMAIL="test_suite@notmuchmail.org"
135 printf '%s:6:\n' "$FINGERPRINT" | gpg --quiet --batch --no-tty --import-ownertrust
139 test_require_external_prereq openssl
142 [ -e "$GNUPGHOME/gpgsm.conf" ] && return
143 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
144 at_exit_function _gnupg_exit
145 mkdir -p -m 0700 "$GNUPGHOME"
146 openssl pkcs12 -export -passout pass: -inkey "$NOTMUCH_SRCDIR/test/smime/key+cert.pem" \
147 < "$NOTMUCH_SRCDIR/test/smime/test.crt" | \
148 gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
149 --disable-dirmngr --import >"$GNUPGHOME"/import.log 2>&1 3<<<''
150 fpr=$(gpgsm --batch --list-key test_suite@notmuchmail.org | sed -n 's/.*fingerprint: //p')
151 echo "$fpr S relax" >> "$GNUPGHOME/trustlist.txt"
152 gpgsm --quiet --batch --no-tty --no-common-certs-import --disable-dirmngr --import < $NOTMUCH_SRCDIR/test/smime/ca.crt
153 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"
154 printf '%s::1\n' include-certs disable-crl-checks | gpgconf --output /dev/null --change-options gpgsm
155 gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
156 --disable-dirmngr --import "$NOTMUCH_SRCDIR/test/smime/bob.p12" >>"$GNUPGHOME"/import.log 2>&1 3<<<''
157 test_debug "cat $GNUPGHOME/import.log"
160 # Each test should start with something like this, after copyright notices:
162 # test_description='Description of this test...
163 # This test checks if command xyzzy does the right thing...
165 # . ./test-lib.sh || exit 1
169 while test "$#" -ne 0
175 immediate=t; shift ;;
183 with_dashes=t; shift ;;
190 valgrind=t; verbose=t; shift ;;
192 shift ;; # was handled already
194 echo "error: unknown test option '$1'" >&2; exit 1 ;;
198 if test -n "$debug"; then
200 printf -v $1 " %-4s" "[$((test_count - 1))]"
208 test -n "$COLORS_WITHOUT_TTY" || [ -t 1 ] || color=
210 if [ -n "$color" ] && [ "$ORIGINAL_TERM" != 'dumb' ] &&
211 tput -T "$ORIGINAL_TERM" -S <<<$'bold\nsetaf\nsgr0\n' >/dev/null 2>&1
220 # _tput run in subshell (``) only
221 _tput () { exec tput -T "$ORIGINAL_TERM" "$@"; }
222 unset BOLD RED GREEN BROWN SGR0
225 error) b=${BOLD=`_tput bold`}
226 c=${RED=`_tput setaf 1`} ;; # bold red
227 skip) b=${BOLD=`_tput bold`}
228 c=${GREEN=`_tput setaf 2`} ;; # bold green
229 pass) b= c=${GREEN=`_tput setaf 2`} ;; # green
230 info) b= c=${BROWN=`_tput setaf 3`} ;; # brown
231 *) b= c=; test -n "$quiet" && return ;;
235 sgr0=${SGR0=`_tput sgr0`}
237 printf " ${b}${c}${f}${sgr0}${st}" "$@"
241 test -z "$1" && test -n "$quiet" && return
245 printf " ${f}${st}" "$@"
250 say_color error "error: $*\n"
259 test "${test_description}" != "" ||
260 error "Test script did not set test_description."
262 if test "$help" = "t"
264 echo "Tests ${test_description}"
268 test_description_printed=
269 print_test_description () {
270 test -z "$test_description_printed" || return 0
272 echo $this_test: "Testing ${test_description}"
273 test_description_printed=1
275 if [ -z "$NOTMUCH_TEST_QUIET" ]
277 print_test_description
286 declare -a _exit_functions=()
288 at_exit_function () {
289 _exit_functions=($1 ${_exit_functions[@]/$1})
292 rm_exit_function () {
293 _exit_functions=(${_exit_functions[@]/$1})
300 for _fn in ${_exit_functions[@]}; do $_fn; done
301 rm -rf "$TEST_TMPDIR"
306 if test -n "$GIT_EXIT_OK"
311 say_color error '%-6s' FATAL
312 echo " $test_subtest_name"
314 echo "Unexpected exit while executing $0. Exit code $code."
321 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
328 say_color error '%-6s' FATAL
331 echo "Unexpected exit while executing $0."
336 # Note: TEST_TMPDIR *NOT* exported!
337 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
338 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
339 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
340 trap 'trap_exit' EXIT
341 trap 'trap_signal' HUP INT TERM
343 # Add an existing, fixed corpus of email to the database.
345 # $1 is the corpus dir under corpora to add, using "default" if unset.
347 # The default corpus is based on about 50 messages from early in the
348 # history of the notmuch mailing list, which allows for reliably
349 # testing commands that need to operate on a not-totally-trivial
350 # number of messages.
351 add_email_corpus () {
356 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
357 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
360 test_begin_subtest () {
361 if [ -n "$inside_subtest" ]; then
362 exec 1>&6 2>&7 # Restore stdout and stderr
363 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
365 test_subtest_name="$1"
367 # Redirect test output to the previously prepared file descriptors
368 # 3 and 4 (see below)
369 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
374 # Pass test if two arguments match
376 # Note: Unlike all other test_expect_* functions, this function does
377 # not accept a test name. Instead, the caller should call
378 # test_begin_subtest before calling this function in order to set the
380 test_expect_equal () {
381 local output expected testname
382 exec 1>&6 2>&7 # Restore stdout and stderr
383 if [ -z "$inside_subtest" ]; then
384 error "bug in the test script: test_expect_equal without test_begin_subtest"
388 error "bug in the test script: not 2 parameters to test_expect_equal"
392 if ! test_skip "$test_subtest_name"
394 if [ "$output" = "$expected" ]; then
397 testname=$this_test.$test_count
398 echo "$expected" > $testname.expected
399 echo "$output" > $testname.output
400 test_failure_ "$(diff -u $testname.expected $testname.output)"
406 local file1 file2 testname basename1 basename2
409 if ! test_skip "$test_subtest_name"
411 if diff -q "$file1" "$file2" >/dev/null ; then
414 testname=$this_test.$test_count
415 basename1=`basename "$file1"`
416 basename2=`basename "$file2"`
417 cp "$file1" "$testname.$basename1"
418 cp "$file2" "$testname.$basename2"
419 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
424 # Like test_expect_equal, but takes two filenames.
425 test_expect_equal_file () {
426 exec 1>&6 2>&7 # Restore stdout and stderr
427 if [ -z "$inside_subtest" ]; then
428 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
432 error "bug in the test script: not 2 parameters to test_expect_equal_file"
434 test_diff_file_ "$1" "$2"
437 # Like test_expect_equal, but takes two filenames. Fails if either is empty
438 test_expect_equal_file_nonempty () {
439 exec 1>&6 2>&7 # Restore stdout and stderr
440 if [ -z "$inside_subtest" ]; then
441 error "bug in the test script: test_expect_equal_file_nonempty without test_begin_subtest"
445 error "bug in the test script: not 2 parameters to test_expect_equal_file_nonempty"
447 for file in "$1" "$2"; do
448 if [ ! -s "$file" ]; then
449 test_failure_ "Missing or zero length file: $file"
454 test_diff_file_ "$1" "$2"
457 # Like test_expect_equal, but arguments are JSON expressions to be
458 # canonicalized before diff'ing. If an argument cannot be parsed, it
459 # is used unchanged so that there's something to diff against.
460 test_expect_equal_json () {
461 local script output expected
462 # The test suite forces LC_ALL=C, but this causes Python 3 to
463 # decode stdin as ASCII. We need to read JSON in UTF-8, so
464 # override Python's stdio encoding defaults.
465 script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
466 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
468 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
471 test_expect_equal "$output" "$expected" "$@"
474 # Ensure that the argument is valid JSON data.
476 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "import sys, json; json.load(sys.stdin)" <<<"$1"
477 test_expect_equal "$?" 0
480 # Sort the top-level list of JSON data from stdin.
482 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
483 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
486 # test for json objects:
487 # read the source of test/json_check_nodes.py (or the output when
488 # invoking it without arguments) for an explanation of the syntax.
491 exec 1>&6 2>&7 # Restore stdout and stderr
492 if [ -z "$inside_subtest" ]; then
493 error "bug in the test script: test_json_eval without test_begin_subtest"
497 error "bug in the test script: test_json_nodes needs at least 1 parameter"
499 if ! test_skip "$test_subtest_name"
501 output=$(PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -B "$NOTMUCH_SRCDIR"/test/json_check_nodes.py "$@")
506 test_failure_ "$output"
512 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
515 NOTMUCH_DUMP_TAGS () {
516 # this relies on the default format being batch-tag, otherwise some tests will break
517 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
520 notmuch_drop_mail_headers () {
523 msg = email.message_from_file(sys.stdin)
524 for hdr in sys.argv[1:]: del msg[hdr]
525 print(msg.as_string(False))
529 notmuch_debug_sanitize () {
533 notmuch_exception_sanitize () {
534 perl -pe 's/(A Xapian exception occurred at .*[.]cc?):([0-9]*)/\1:XXX/'
537 notmuch_search_sanitize () {
538 notmuch_debug_sanitize | perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
541 notmuch_search_files_sanitize () {
545 notmuch_dir_sanitize () {
546 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
549 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
550 notmuch_show_sanitize () {
551 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
553 notmuch_show_sanitize_all () {
554 notmuch_debug_sanitize | \
556 -e 's| filename:.*| filename:XXXXX|' \
557 -e 's| id:[^ ]* | id:XXXXX |' | \
558 notmuch_date_sanitize
561 notmuch_json_show_sanitize () {
563 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
564 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
565 -e 's|"filename": "signature.asc",||g' \
566 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
567 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
568 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
571 notmuch_emacs_error_sanitize () {
577 notmuch_debug_sanitize < "$file"
581 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
584 notmuch_date_sanitize () {
586 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
589 notmuch_uuid_sanitize () {
590 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
593 notmuch_built_with_sanitize () {
594 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
597 notmuch_config_sanitize () {
598 notmuch_dir_sanitize | notmuch_built_with_sanitize
601 notmuch_show_part () {
602 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
605 # End of notmuch helper functions
607 # Use test_set_prereq to tell that a particular prerequisite is available.
609 # The prerequisite can later be checked for by using test_have_prereq.
611 # The single parameter is the prerequisite tag (a simple word, in all
612 # capital letters by convention).
615 satisfied="$satisfied$1 "
619 test_have_prereq () {
628 declare -A test_missing_external_prereq_
629 declare -A test_subtest_missing_external_prereq_
631 # declare prerequisite for the given external binary
632 test_declare_external_prereq () {
635 test "$#" = 2 && name=$2 || name="$binary(1)"
637 if ! hash $binary 2>/dev/null; then
638 test_missing_external_prereq_["${binary}"]=t
641 test_subtest_missing_external_prereq_[\"${name}\"]=t
647 # Explicitly require external prerequisite. Useful when binary is
648 # called indirectly (e.g. from emacs).
649 # Returns success if dependency is available, failure otherwise.
650 test_require_external_prereq () {
653 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
654 # dependency is missing, call the replacement function to note it
661 # You are not expected to call test_ok_ and test_failure_ directly, use
662 # the text_expect_* functions instead.
665 if test "$test_subtest_known_broken_" = "t"; then
666 test_known_broken_ok_
669 test_success=$(($test_success + 1))
670 if test -n "$NOTMUCH_TEST_QUIET"; then
673 say_color pass "%-6s" "PASS"
674 echo " $test_subtest_name"
678 print_test_description
679 if test "$test_subtest_known_broken_" = "t"; then
680 test_known_broken_failure_ "$@"
683 test_failure=$(($test_failure + 1))
684 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
685 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
689 test_failure_message_ () {
690 say_color error "%-6s" "$1"
693 if [ "$#" != "0" ]; then
694 echo "$@" | sed -e 's/^/ /'
696 if test "$verbose" != "t"; then cat test.output; fi
699 test_known_broken_ok_ () {
701 test_fixed=$(($test_fixed+1))
702 say_color pass "%-6s" "FIXED"
703 echo " $test_subtest_name"
706 test_known_broken_failure_ () {
708 test_broken=$(($test_broken+1))
709 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
710 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
712 test_failure_message_ "BROKEN" "$test_subtest_name"
718 test "$debug" = "" || eval "$1"
723 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
726 eval >&3 2>&4 "$test_cleanup"
731 test_count=$(($test_count+1))
733 for skp in $NOTMUCH_SKIP_TESTS
735 case $this_test.$test_count in
740 case $this_test_bare.$test_count in
748 test_report_skip_ "$@"
751 test_check_missing_external_prereqs_ "$@"
756 test_check_missing_external_prereqs_ () {
757 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
758 say_color skip >&1 "missing prerequisites: "
759 echo ${!test_subtest_missing_external_prereq_[@]} >&1
760 test_report_skip_ "$@"
766 test_report_skip_ () {
768 say_color skip >&3 "skipping test:"
770 say_color skip "%-6s" "SKIP"
774 test_subtest_known_broken () {
775 test_subtest_known_broken_=t
778 test_expect_success () {
779 exec 1>&6 2>&7 # Restore stdout and stderr
780 if [ -z "$inside_subtest" ]; then
781 error "bug in the test script: test_expect_success without test_begin_subtest"
785 error "bug in the test script: not 1 parameters to test_expect_success"
787 if ! test_skip "$test_subtest_name"
791 # test_run_ may update missing external prerequisites
792 test_check_missing_external_prereqs_ "$test_subtest_name" ||
793 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
802 test_expect_code () {
803 exec 1>&6 2>&7 # Restore stdout and stderr
804 if [ -z "$inside_subtest" ]; then
805 error "bug in the test script: test_expect_code without test_begin_subtest"
809 error "bug in the test script: not 2 parameters to test_expect_code"
811 if ! test_skip "$test_subtest_name"
815 # test_run_ may update missing external prerequisites,
816 test_check_missing_external_prereqs_ "$test_subtest_name" ||
817 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
821 test_failure_ "exit code $eval_ret, expected $1" "$2"
826 # This is not among top-level (test_expect_success)
827 # but is a prefix that can be used in the test script, like:
829 # test_expect_success 'complain and die' '
831 # do something else &&
832 # test_must_fail git checkout ../outerspace
835 # Writing this as "! git checkout ../outerspace" is wrong, because
836 # the failure could be due to a segv. We want a controlled failure.
840 test $? -gt 0 -a $? -le 129 -o $? -gt 192
843 # test_cmp is a helper function to compare actual and expected output.
844 # You can use it like:
846 # test_expect_success 'foo works' '
847 # echo expected >expected &&
849 # test_cmp expected actual
852 # This could be written as either "cmp" or "diff -u", but:
853 # - cmp's output is not nearly as easy to read as diff -u
854 # - not all diff versions understand "-u"
860 # This function can be used to schedule some commands to be run
861 # unconditionally at the end of the test to restore sanity:
863 # test_expect_success 'test core.capslock' '
864 # git config core.capslock true &&
865 # test_when_finished "git config --unset core.capslock" &&
869 # That would be roughly equivalent to
871 # test_expect_success 'test core.capslock' '
872 # git config core.capslock true &&
874 # git config --unset core.capslock
877 # except that the greeting and config --unset must both succeed for
880 test_when_finished () {
882 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
887 test_results_dir="$TEST_DIRECTORY/test-results"
888 mkdir -p "$test_results_dir"
889 test_results_path="$test_results_dir/$this_test"
892 "success $test_success" \
893 "fixed $test_fixed" \
894 "broken $test_broken" \
895 "failed $test_failure" \
896 "total $test_count" \
899 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
901 if [ "$test_failure" = "0" ]; then
902 if [ "$test_broken" = "0" ]; then
912 # Note: if there is need to print debug information from python program,
913 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
914 PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
915 $NOTMUCH_PYTHON -B - > OUTPUT
919 local exec_file test_file
920 exec_file="test${test_count}"
921 test_file="${exec_file}.c"
923 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
924 echo "== stdout ==" > OUTPUT.stdout
925 echo "== stderr ==" > OUTPUT.stderr
926 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
927 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr | notmuch_exception_sanitize | notmuch_debug_sanitize > OUTPUT
931 local base_name test_file shim_file
933 test_file="${base_name}.c"
934 shim_file="${base_name}.so"
936 ${TEST_CC} ${TEST_CFLAGS} ${TEST_SHIM_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${shim_file} ${test_file} ${TEST_SHIM_LDFLAGS}
939 notmuch_with_shim () {
940 local base_name shim_file
943 shim_file="${base_name}.so"
944 LD_PRELOAD=${LD_PRELOAD:+:$LD_PRELOAD}:./${shim_file} notmuch-shared "$@"
947 # Creates a script that counts how much time it is executed and calls
948 # notmuch. $notmuch_counter_command is set to the path to the
949 # generated script. Use notmuch_counter_value() function to get the
950 # current counter value.
951 notmuch_counter_reset () {
952 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
953 if [ ! -x "$notmuch_counter_command" ]; then
954 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
955 cat >"$notmuch_counter_command" <<EOF || return
958 read count < "$notmuch_counter_state_path"
959 echo \$((count + 1)) > "$notmuch_counter_state_path"
963 chmod +x "$notmuch_counter_command" || return
966 echo 0 > "$notmuch_counter_state_path"
969 # Returns the current notmuch counter value.
970 notmuch_counter_value () {
971 if [ -r "$notmuch_counter_state_path" ]; then
972 read count < "$notmuch_counter_state_path"
979 test_reset_state_ () {
980 test -z "$test_init_done_" && test_init_
982 test_subtest_known_broken_=
983 test_subtest_missing_external_prereq_=()
986 # called once before the first subtest
990 # skip all tests if there were external prerequisites missing during init
991 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
995 # Where to run the tests
996 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
998 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1000 # Use -P to resolve symlinks in our working directory so that the cwd
1001 # in subprocesses like git equals our $PWD (for pathname comparisons).
1002 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1004 if test "$verbose" = "t"
1008 exec 4>test.output 3>&4
1011 for skp in $NOTMUCH_SKIP_TESTS
1014 for skp in $NOTMUCH_SKIP_TESTS
1016 case "$this_test" in
1021 case "$this_test_bare" in
1029 say_color skip >&3 "skipping test $this_test altogether"
1030 say_color skip "skip all tests in $this_test"
1035 # Provide an implementation of the 'yes' utility
1050 # Fix some commands on Windows
1053 # Windows has its own (incompatible) sort and find
1063 # git sees Windows-style pwd
1067 # no POSIX permissions
1068 # backslashes in pathspec are converted to '/'
1069 # exec does not inherit the PID
1072 test_set_prereq POSIXPERM
1073 test_set_prereq BSLASHPSPEC
1074 test_set_prereq EXECKEEPSPID
1078 test -z "$NO_PERL" && test_set_prereq PERL
1079 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1081 # test whether the filesystem supports symbolic links
1082 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1085 # declare prerequisites for external binaries used in tests
1086 test_declare_external_prereq dtach
1087 test_declare_external_prereq emacs
1088 test_declare_external_prereq ${TEST_EMACSCLIENT}
1089 test_declare_external_prereq ${TEST_GDB}
1090 test_declare_external_prereq gpg
1091 test_declare_external_prereq openssl
1092 test_declare_external_prereq gpgsm
1093 test_declare_external_prereq ${NOTMUCH_PYTHON}
1094 test_declare_external_prereq xapian-metadata
1095 test_declare_external_prereq xapian-delve