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 gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
147 --disable-dirmngr --import >"$GNUPGHOME"/import.log 2>&1 3<<<'' <$NOTMUCH_SRCDIR/test/smime/0xE0972A47.p12
148 fpr=$(gpgsm --batch --with-colons --list-key test_suite@notmuchmail.org | awk -F: '/^fpr/ {print $10}')
149 echo "$fpr S relax" >> "$GNUPGHOME/trustlist.txt"
150 gpgsm --quiet --batch --no-tty --no-common-certs-import --disable-dirmngr --import < $NOTMUCH_SRCDIR/test/smime/ca.crt
151 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"
152 printf '%s::1\n' include-certs disable-crl-checks | gpgconf --output /dev/null --change-options gpgsm
153 gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
154 --disable-dirmngr --import "$NOTMUCH_SRCDIR/test/smime/bob.p12" >>"$GNUPGHOME"/import.log 2>&1 3<<<''
155 test_debug "cat $GNUPGHOME/import.log"
158 # Each test should start with something like this, after copyright notices:
160 # test_description='Description of this test...
161 # This test checks if command xyzzy does the right thing...
163 # . ./test-lib.sh || exit 1
167 while test "$#" -ne 0
173 immediate=t; shift ;;
181 with_dashes=t; shift ;;
188 valgrind=t; verbose=t; shift ;;
190 shift ;; # was handled already
192 echo "error: unknown test option '$1'" >&2; exit 1 ;;
196 if test -n "$debug"; then
198 printf -v $1 " %-4s" "[$((test_count - 1))]"
206 test -n "$COLORS_WITHOUT_TTY" || [ -t 1 ] || color=
208 if [ -n "$color" ] && [ "$ORIGINAL_TERM" != 'dumb' ] &&
209 tput -T "$ORIGINAL_TERM" -S <<<$'bold\nsetaf\nsgr0\n' >/dev/null 2>&1
218 # _tput run in subshell (``) only
219 _tput () { exec tput -T "$ORIGINAL_TERM" "$@"; }
220 unset BOLD RED GREEN BROWN SGR0
223 error) b=${BOLD=`_tput bold`}
224 c=${RED=`_tput setaf 1`} ;; # bold red
225 skip) b=${BOLD=`_tput bold`}
226 c=${GREEN=`_tput setaf 2`} ;; # bold green
227 pass) b= c=${GREEN=`_tput setaf 2`} ;; # green
228 info) b= c=${BROWN=`_tput setaf 3`} ;; # brown
229 *) b= c=; test -n "$quiet" && return ;;
233 sgr0=${SGR0=`_tput sgr0`}
235 printf " ${b}${c}${f}${sgr0}${st}" "$@"
239 test -z "$1" && test -n "$quiet" && return
243 printf " ${f}${st}" "$@"
248 say_color error "error: $*\n"
257 test "${test_description}" != "" ||
258 error "Test script did not set test_description."
260 if test "$help" = "t"
262 echo "Tests ${test_description}"
266 test_description_printed=
267 print_test_description () {
268 test -z "$test_description_printed" || return 0
270 echo $this_test: "Testing ${test_description}"
271 test_description_printed=1
273 if [ -z "$NOTMUCH_TEST_QUIET" ]
275 print_test_description
284 declare -a _exit_functions=()
286 at_exit_function () {
287 _exit_functions=($1 ${_exit_functions[@]/$1})
290 rm_exit_function () {
291 _exit_functions=(${_exit_functions[@]/$1})
298 for _fn in ${_exit_functions[@]}; do $_fn; done
299 rm -rf "$TEST_TMPDIR"
304 if test -n "$GIT_EXIT_OK"
309 say_color error '%-6s' FATAL
310 echo " $test_subtest_name"
312 echo "Unexpected exit while executing $0. Exit code $code."
319 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
326 say_color error '%-6s' FATAL
329 echo "Unexpected exit while executing $0."
334 # Note: TEST_TMPDIR *NOT* exported!
335 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
336 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
337 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
338 trap 'trap_exit' EXIT
339 trap 'trap_signal' HUP INT TERM
341 # Add an existing, fixed corpus of email to the database.
343 # $1 is the corpus dir under corpora to add, using "default" if unset.
345 # The default corpus is based on about 50 messages from early in the
346 # history of the notmuch mailing list, which allows for reliably
347 # testing commands that need to operate on a not-totally-trivial
348 # number of messages.
349 add_email_corpus () {
354 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
355 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
358 test_begin_subtest () {
359 if [ -n "$inside_subtest" ]; then
360 exec 1>&6 2>&7 # Restore stdout and stderr
361 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
363 test_subtest_name="$1"
365 # Redirect test output to the previously prepared file descriptors
366 # 3 and 4 (see below)
367 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
372 # Pass test if two arguments match
374 # Note: Unlike all other test_expect_* functions, this function does
375 # not accept a test name. Instead, the caller should call
376 # test_begin_subtest before calling this function in order to set the
378 test_expect_equal () {
379 local output expected testname
380 exec 1>&6 2>&7 # Restore stdout and stderr
381 if [ -z "$inside_subtest" ]; then
382 error "bug in the test script: test_expect_equal without test_begin_subtest"
386 error "bug in the test script: not 2 parameters to test_expect_equal"
390 if ! test_skip "$test_subtest_name"
392 if [ "$output" = "$expected" ]; then
395 testname=$this_test.$test_count
396 echo "$expected" > $testname.expected
397 echo "$output" > $testname.output
398 test_failure_ "$(diff -u $testname.expected $testname.output)"
404 local file1 file2 testname basename1 basename2
407 if ! test_skip "$test_subtest_name"
409 if diff -q "$file1" "$file2" >/dev/null ; then
412 testname=$this_test.$test_count
413 basename1=`basename "$file1"`
414 basename2=`basename "$file2"`
415 cp "$file1" "$testname.$basename1"
416 cp "$file2" "$testname.$basename2"
417 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
422 # Like test_expect_equal, but takes two filenames.
423 test_expect_equal_file () {
424 exec 1>&6 2>&7 # Restore stdout and stderr
425 if [ -z "$inside_subtest" ]; then
426 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
430 error "bug in the test script: not 2 parameters to test_expect_equal_file"
432 test_diff_file_ "$1" "$2"
435 # Like test_expect_equal_file, but compare the part of the two files after the first blank line
436 test_expect_equal_message_body () {
437 exec 1>&6 2>&7 # Restore stdout and stderr
438 if [ -z "$inside_subtest" ]; then
439 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
442 error "bug in the test script: not 2 parameters to test_expect_equal_file"
444 expected=$(sed '1,/^$/d' "$1")
445 output=$(sed '1,/^$/d' "$2")
446 test_expect_equal "$expected" "$output"
449 # Like test_expect_equal, but takes two filenames. Fails if either is empty
450 test_expect_equal_file_nonempty () {
451 exec 1>&6 2>&7 # Restore stdout and stderr
452 if [ -z "$inside_subtest" ]; then
453 error "bug in the test script: test_expect_equal_file_nonempty without test_begin_subtest"
457 error "bug in the test script: not 2 parameters to test_expect_equal_file_nonempty"
459 for file in "$1" "$2"; do
460 if [ ! -s "$file" ]; then
461 test_failure_ "Missing or zero length file: $file"
466 test_diff_file_ "$1" "$2"
469 # Like test_expect_equal, but arguments are JSON expressions to be
470 # canonicalized before diff'ing. If an argument cannot be parsed, it
471 # is used unchanged so that there's something to diff against.
472 test_expect_equal_json () {
473 local script output expected
474 # The test suite forces LC_ALL=C, but this causes Python 3 to
475 # decode stdin as ASCII. We need to read JSON in UTF-8, so
476 # override Python's stdio encoding defaults.
477 script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
478 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
480 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
483 test_expect_equal "$output" "$expected" "$@"
486 # Ensure that the argument is valid JSON data.
488 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "import sys, json; json.load(sys.stdin)" <<<"$1"
489 test_expect_equal "$?" 0
492 # Sort the top-level list of JSON data from stdin.
494 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
495 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
498 # test for json objects:
499 # read the source of test/json_check_nodes.py (or the output when
500 # invoking it without arguments) for an explanation of the syntax.
503 exec 1>&6 2>&7 # Restore stdout and stderr
504 if [ -z "$inside_subtest" ]; then
505 error "bug in the test script: test_json_eval without test_begin_subtest"
509 error "bug in the test script: test_json_nodes needs at least 1 parameter"
511 if ! test_skip "$test_subtest_name"
513 output=$(PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -B "$NOTMUCH_SRCDIR"/test/json_check_nodes.py "$@")
518 test_failure_ "$output"
524 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
527 NOTMUCH_DUMP_TAGS () {
528 # this relies on the default format being batch-tag, otherwise some tests will break
529 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
532 notmuch_drop_mail_headers () {
535 msg = email.message_from_file(sys.stdin)
536 for hdr in sys.argv[1:]: del msg[hdr]
537 print(msg.as_string(False))
541 notmuch_debug_sanitize () {
545 notmuch_exception_sanitize () {
546 perl -pe 's,(A Xapian exception occurred at) .*?([^/]*[.]cc?):([0-9]*),\1 \2:XXX,'
549 notmuch_search_sanitize () {
550 notmuch_debug_sanitize | perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
553 notmuch_search_files_sanitize () {
554 notmuch_dir_sanitize | sed 's/msg-[0-9][0-9][0-9]/msg-XXX/'
557 notmuch_dir_sanitize () {
558 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
561 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
562 notmuch_show_sanitize () {
563 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
565 notmuch_show_sanitize_all () {
566 notmuch_debug_sanitize | \
568 -e 's| filename:.*| filename:XXXXX|' \
569 -e 's| id:[^ ]* | id:XXXXX |' | \
570 notmuch_date_sanitize
573 notmuch_json_show_sanitize () {
575 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
576 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
577 -e 's|"filename": "signature.asc",||g' \
578 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
579 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
580 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
583 notmuch_emacs_error_sanitize () {
589 notmuch_debug_sanitize < "$file"
593 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
596 notmuch_date_sanitize () {
598 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
601 notmuch_uuid_sanitize () {
602 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
605 notmuch_built_with_sanitize () {
606 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
609 notmuch_config_sanitize () {
610 notmuch_dir_sanitize | notmuch_built_with_sanitize
613 notmuch_show_part () {
614 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
617 # End of notmuch helper functions
619 # Use test_set_prereq to tell that a particular prerequisite is available.
621 # The prerequisite can later be checked for by using test_have_prereq.
623 # The single parameter is the prerequisite tag (a simple word, in all
624 # capital letters by convention).
627 satisfied="$satisfied$1 "
631 test_have_prereq () {
640 declare -A test_missing_external_prereq_
641 declare -A test_subtest_missing_external_prereq_
643 # declare prerequisite for the given external binary
644 test_declare_external_prereq () {
647 test "$#" = 2 && name=$2 || name="$binary(1)"
649 if ! hash $binary 2>/dev/null; then
650 test_missing_external_prereq_["${binary}"]=t
653 test_subtest_missing_external_prereq_[\"${name}\"]=t
659 # Explicitly require external prerequisite. Useful when binary is
660 # called indirectly (e.g. from emacs).
661 # Returns success if dependency is available, failure otherwise.
662 test_require_external_prereq () {
665 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
666 # dependency is missing, call the replacement function to note it
673 # You are not expected to call test_ok_ and test_failure_ directly, use
674 # the text_expect_* functions instead.
677 if test "$test_subtest_known_broken_" = "t"; then
678 test_known_broken_ok_
681 test_success=$(($test_success + 1))
682 if test -n "$NOTMUCH_TEST_QUIET"; then
685 say_color pass "%-6s" "PASS"
686 echo " $test_subtest_name"
690 print_test_description
691 if test "$test_subtest_known_broken_" = "t"; then
692 test_known_broken_failure_ "$@"
695 test_failure=$(($test_failure + 1))
696 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
697 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
701 test_failure_message_ () {
702 say_color error "%-6s" "$1"
705 if [ "$#" != "0" ]; then
706 echo "$@" | sed -e 's/^/ /'
708 if test "$verbose" != "t"; then cat test.output; fi
711 test_known_broken_ok_ () {
713 test_fixed=$(($test_fixed+1))
714 say_color pass "%-6s" "FIXED"
715 echo " $test_subtest_name"
718 test_known_broken_failure_ () {
720 test_broken=$(($test_broken+1))
721 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
722 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
724 test_failure_message_ "BROKEN" "$test_subtest_name"
730 test "$debug" = "" || eval "$1"
735 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
738 eval >&3 2>&4 "$test_cleanup"
743 test_count=$(($test_count+1))
745 for skp in $NOTMUCH_SKIP_TESTS
747 case $this_test.$test_count in
752 case $this_test_bare.$test_count in
760 test_report_skip_ "$@"
763 test_check_missing_external_prereqs_ "$@"
768 test_check_missing_external_prereqs_ () {
769 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
770 say_color skip >&1 "missing prerequisites: "
771 echo ${!test_subtest_missing_external_prereq_[@]} >&1
772 test_report_skip_ "$@"
778 test_report_skip_ () {
780 say_color skip >&3 "skipping test:"
782 say_color skip "%-6s" "SKIP"
786 test_subtest_known_broken () {
787 test_subtest_known_broken_=t
790 test_expect_success () {
791 exec 1>&6 2>&7 # Restore stdout and stderr
792 if [ -z "$inside_subtest" ]; then
793 error "bug in the test script: test_expect_success without test_begin_subtest"
797 error "bug in the test script: not 1 parameters to test_expect_success"
799 if ! test_skip "$test_subtest_name"
803 # test_run_ may update missing external prerequisites
804 test_check_missing_external_prereqs_ "$test_subtest_name" ||
805 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
814 test_expect_code () {
815 exec 1>&6 2>&7 # Restore stdout and stderr
816 if [ -z "$inside_subtest" ]; then
817 error "bug in the test script: test_expect_code without test_begin_subtest"
821 error "bug in the test script: not 2 parameters to test_expect_code"
823 if ! test_skip "$test_subtest_name"
827 # test_run_ may update missing external prerequisites,
828 test_check_missing_external_prereqs_ "$test_subtest_name" ||
829 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
833 test_failure_ "exit code $eval_ret, expected $1" "$2"
838 # This is not among top-level (test_expect_success)
839 # but is a prefix that can be used in the test script, like:
841 # test_expect_success 'complain and die' '
843 # do something else &&
844 # test_must_fail git checkout ../outerspace
847 # Writing this as "! git checkout ../outerspace" is wrong, because
848 # the failure could be due to a segv. We want a controlled failure.
852 test $? -gt 0 -a $? -le 129 -o $? -gt 192
855 # test_cmp is a helper function to compare actual and expected output.
856 # You can use it like:
858 # test_expect_success 'foo works' '
859 # echo expected >expected &&
861 # test_cmp expected actual
864 # This could be written as either "cmp" or "diff -u", but:
865 # - cmp's output is not nearly as easy to read as diff -u
866 # - not all diff versions understand "-u"
872 # This function can be used to schedule some commands to be run
873 # unconditionally at the end of the test to restore sanity:
875 # test_expect_success 'test core.capslock' '
876 # git config core.capslock true &&
877 # test_when_finished "git config --unset core.capslock" &&
881 # That would be roughly equivalent to
883 # test_expect_success 'test core.capslock' '
884 # git config core.capslock true &&
886 # git config --unset core.capslock
889 # except that the greeting and config --unset must both succeed for
892 test_when_finished () {
894 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
899 test_results_dir="$TEST_DIRECTORY/test-results"
900 mkdir -p "$test_results_dir"
901 test_results_path="$test_results_dir/$this_test"
904 "success $test_success" \
905 "fixed $test_fixed" \
906 "broken $test_broken" \
907 "failed $test_failure" \
908 "total $test_count" \
911 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
913 if [ "$test_failure" = "0" ]; then
914 if [ "$test_broken" = "0" ]; then
924 # Note: if there is need to print debug information from python program,
925 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
926 PYTHONPATH="$NOTMUCH_BUILDDIR/bindings/python-cffi/build/stage:$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
927 $NOTMUCH_PYTHON -B - > OUTPUT
931 local exec_file test_file
932 exec_file="test${test_count}"
933 test_file="${exec_file}.c"
935 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
936 echo "== stdout ==" > OUTPUT.stdout
937 echo "== stderr ==" > OUTPUT.stderr
938 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
939 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr | notmuch_exception_sanitize | notmuch_debug_sanitize > OUTPUT
943 local base_name test_file shim_file
945 test_file="${base_name}.c"
946 shim_file="${base_name}.so"
948 ${TEST_CC} ${TEST_CFLAGS} ${TEST_SHIM_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${shim_file} ${test_file} ${TEST_SHIM_LDFLAGS}
951 notmuch_with_shim () {
952 local base_name shim_file
955 shim_file="${base_name}.so"
956 LD_PRELOAD=${LD_PRELOAD:+:$LD_PRELOAD}:./${shim_file} notmuch-shared "$@"
959 # Creates a script that counts how much time it is executed and calls
960 # notmuch. $notmuch_counter_command is set to the path to the
961 # generated script. Use notmuch_counter_value() function to get the
962 # current counter value.
963 notmuch_counter_reset () {
964 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
965 if [ ! -x "$notmuch_counter_command" ]; then
966 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
967 cat >"$notmuch_counter_command" <<EOF || return
970 read count < "$notmuch_counter_state_path"
971 echo \$((count + 1)) > "$notmuch_counter_state_path"
975 chmod +x "$notmuch_counter_command" || return
978 echo 0 > "$notmuch_counter_state_path"
981 # Returns the current notmuch counter value.
982 notmuch_counter_value () {
983 if [ -r "$notmuch_counter_state_path" ]; then
984 read count < "$notmuch_counter_state_path"
991 test_reset_state_ () {
992 test -z "$test_init_done_" && test_init_
994 test_subtest_known_broken_=
995 test_subtest_missing_external_prereq_=()
998 # called once before the first subtest
1002 # skip all tests if there were external prerequisites missing during init
1003 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1007 # Where to run the tests
1008 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1010 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1012 # Use -P to resolve symlinks in our working directory so that the cwd
1013 # in subprocesses like git equals our $PWD (for pathname comparisons).
1014 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1016 if test "$verbose" = "t"
1020 exec 4>test.output 3>&4
1023 for skp in $NOTMUCH_SKIP_TESTS
1026 for skp in $NOTMUCH_SKIP_TESTS
1028 case "$this_test" in
1033 case "$this_test_bare" in
1041 say_color skip >&3 "skipping test $this_test altogether"
1042 say_color skip "skip all tests in $this_test"
1047 # Provide an implementation of the 'yes' utility
1062 # Fix some commands on Windows
1065 # Windows has its own (incompatible) sort and find
1075 # git sees Windows-style pwd
1079 # no POSIX permissions
1080 # backslashes in pathspec are converted to '/'
1081 # exec does not inherit the PID
1084 test_set_prereq POSIXPERM
1085 test_set_prereq BSLASHPSPEC
1086 test_set_prereq EXECKEEPSPID
1090 test -z "$NO_PERL" && test_set_prereq PERL
1091 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1093 # test whether the filesystem supports symbolic links
1094 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1097 # declare prerequisites for external binaries used in tests
1098 test_declare_external_prereq dtach
1099 test_declare_external_prereq emacs
1100 test_declare_external_prereq ${TEST_EMACSCLIENT}
1101 test_declare_external_prereq ${TEST_GDB}
1102 test_declare_external_prereq gpg
1103 test_declare_external_prereq openssl
1104 test_declare_external_prereq gpgsm
1105 test_declare_external_prereq ${NOTMUCH_PYTHON}
1106 test_declare_external_prereq xapian-metadata
1107 test_declare_external_prereq xapian-delve