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 [ -e "${GNUPGHOME}/gpg.conf" ] && return
114 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
115 at_exit_function _gnupg_exit
116 mkdir -p -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 [ -e "$GNUPGHOME/gpgsm.conf" ] && return
136 _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
137 at_exit_function _gnupg_exit
138 mkdir -p -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 gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
149 --disable-dirmngr --import "$NOTMUCH_SRCDIR/test/smime/bob.p12" >>"$GNUPGHOME"/import.log 2>&1 3<<<''
150 test_debug "cat $GNUPGHOME/import.log"
153 # Each test should start with something like this, after copyright notices:
155 # test_description='Description of this test...
156 # This test checks if command xyzzy does the right thing...
158 # . ./test-lib.sh || exit 1
162 while test "$#" -ne 0
168 immediate=t; shift ;;
176 with_dashes=t; shift ;;
183 valgrind=t; verbose=t; shift ;;
185 shift ;; # was handled already
187 echo "error: unknown test option '$1'" >&2; exit 1 ;;
191 if test -n "$debug"; then
193 printf " %-4s" "[$((test_count - 1))]"
201 test -n "$COLORS_WITHOUT_TTY" || [ -t 1 ] || color=
203 if [ -n "$color" ] && [ "$ORIGINAL_TERM" != 'dumb' ] && (
204 TERM=$ORIGINAL_TERM &&
216 if test -n "$color"; then
222 error) tput bold; tput setaf 1;; # bold red
223 skip) tput bold; tput setaf 2;; # bold green
224 pass) tput setaf 2;; # green
225 info) tput setaf 3;; # brown
226 *) test -n "$quiet" && return;;
237 test -z "$1" && test -n "$quiet" && return
246 say_color error "error: $*\n"
255 test "${test_description}" != "" ||
256 error "Test script did not set test_description."
258 if test "$help" = "t"
260 echo "Tests ${test_description}"
264 test_description_printed=
265 print_test_description ()
267 test -z "$test_description_printed" || return 0
269 echo $this_test: "Testing ${test_description}"
270 test_description_printed=1
272 if [ -z "$NOTMUCH_TEST_QUIET" ]
274 print_test_description
283 declare -a _exit_functions=()
285 at_exit_function () {
286 _exit_functions=($1 ${_exit_functions[@]/$1})
289 rm_exit_function () {
290 _exit_functions=(${_exit_functions[@]/$1})
297 for _fn in ${_exit_functions[@]}; do $_fn; done
298 rm -rf "$TEST_TMPDIR"
303 if test -n "$GIT_EXIT_OK"
308 say_color error '%-6s' FATAL
309 echo " $test_subtest_name"
311 echo "Unexpected exit while executing $0. Exit code $code."
318 echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
325 say_color error '%-6s' FATAL
328 echo "Unexpected exit while executing $0."
333 # Note: TEST_TMPDIR *NOT* exported!
334 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
335 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
336 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
337 trap 'trap_exit' EXIT
338 trap 'trap_signal' HUP INT TERM
340 # Deliver a message with emacs and add it to the database
342 # Uses emacs to generate and deliver a message to the mail store.
343 # Accepts arbitrary extra emacs/elisp functions to modify the message
344 # before sending, which is useful to doing things like attaching files
345 # to the message and encrypting/signing.
346 emacs_deliver_message ()
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 local 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
395 while [[ "$1" =~ ^-- ]]; do
396 nmn_args="$nmn_args $1"
402 # before we can send a message, we have to prepare the FCC maildir
403 mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
406 "(let ((message-send-mail-function (lambda () t))
407 (mail-host-address \"example.com\"))
410 (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
411 (message-goto-subject)
412 (insert \"${subject}\")
416 (notmuch-mua-send-and-exit))" || return 1
417 notmuch new $nmn_args >/dev/null
420 # Add an existing, fixed corpus of email to the database.
422 # $1 is the corpus dir under corpora to add, using "default" if unset.
424 # The default corpus is based on about 50 messages from early in the
425 # history of the notmuch mailing list, which allows for reliably
426 # testing commands that need to operate on a not-totally-trivial
427 # number of messages.
433 cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
434 notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
437 test_begin_subtest ()
439 if [ -n "$inside_subtest" ]; then
440 exec 1>&6 2>&7 # Restore stdout and stderr
441 error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
443 test_subtest_name="$1"
445 # Redirect test output to the previously prepared file descriptors
446 # 3 and 4 (see below)
447 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
452 # Pass test if two arguments match
454 # Note: Unlike all other test_expect_* functions, this function does
455 # not accept a test name. Instead, the caller should call
456 # test_begin_subtest before calling this function in order to set the
460 exec 1>&6 2>&7 # Restore stdout and stderr
461 if [ -z "$inside_subtest" ]; then
462 error "bug in the test script: test_expect_equal without test_begin_subtest"
466 error "bug in the test script: not 2 parameters to test_expect_equal"
470 if ! test_skip "$test_subtest_name"
472 if [ "$output" = "$expected" ]; then
475 testname=$this_test.$test_count
476 echo "$expected" > $testname.expected
477 echo "$output" > $testname.output
478 test_failure_ "$(diff -u $testname.expected $testname.output)"
483 # Like test_expect_equal, but takes two filenames.
484 test_expect_equal_file ()
486 exec 1>&6 2>&7 # Restore stdout and stderr
487 if [ -z "$inside_subtest" ]; then
488 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
492 error "bug in the test script: not 2 parameters to test_expect_equal_file"
496 if ! test_skip "$test_subtest_name"
498 if diff -q "$file1" "$file2" >/dev/null ; then
501 testname=$this_test.$test_count
502 basename1=`basename "$file1"`
503 basename2=`basename "$file2"`
504 cp "$file1" "$testname.$basename1"
505 cp "$file2" "$testname.$basename2"
506 test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
511 # Like test_expect_equal, but arguments are JSON expressions to be
512 # canonicalized before diff'ing. If an argument cannot be parsed, it
513 # is used unchanged so that there's something to diff against.
514 test_expect_equal_json () {
515 # The test suite forces LC_ALL=C, but this causes Python 3 to
516 # decode stdin as ASCII. We need to read JSON in UTF-8, so
517 # override Python's stdio encoding defaults.
518 local script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
519 output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
521 expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
524 test_expect_equal "$output" "$expected" "$@"
527 # Ensure that the argument is valid JSON data.
529 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "import sys, json; json.load(sys.stdin)" <<<"$1"
530 test_expect_equal "$?" 0
533 # Sort the top-level list of JSON data from stdin.
535 PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
536 "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
539 # test for json objects:
540 # read the source of test/json_check_nodes.py (or the output when
541 # invoking it without arguments) for an explanation of the syntax.
543 exec 1>&6 2>&7 # Restore stdout and stderr
544 if [ -z "$inside_subtest" ]; then
545 error "bug in the test script: test_json_eval without test_begin_subtest"
549 error "bug in the test script: test_json_nodes needs at least 1 parameter"
551 if ! test_skip "$test_subtest_name"
553 output=$(PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON "$TEST_DIRECTORY"/json_check_nodes.py "$@")
558 test_failure_ "$output"
563 test_emacs_expect_t () {
565 error "bug in the test script: not 1 parameter to test_emacs_expect_t"
566 if [ -z "$inside_subtest" ]; then
567 error "bug in the test script: test_emacs_expect_t without test_begin_subtest"
571 if ! test_skip "$test_subtest_name"
573 test_emacs "(notmuch-test-run $1)" >/dev/null
575 # Restore state after the test.
576 exec 1>&6 2>&7 # Restore stdout and stderr
579 # Report success/failure.
585 test_failure_ "${result}"
588 # Restore state after the (non) test.
589 exec 1>&6 2>&7 # Restore stdout and stderr
596 notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
601 # this relies on the default format being batch-tag, otherwise some tests will break
602 notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
605 notmuch_drop_mail_headers ()
609 msg = email.message_from_file(sys.stdin)
610 for hdr in sys.argv[1:]: del msg[hdr]
611 print(msg.as_string(False))
615 notmuch_search_sanitize ()
617 perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
620 notmuch_search_files_sanitize ()
625 notmuch_dir_sanitize ()
627 sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
630 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
631 notmuch_show_sanitize ()
633 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
635 notmuch_show_sanitize_all ()
638 -e 's| filename:.*| filename:XXXXX|' \
639 -e 's| id:[^ ]* | id:XXXXX |' | \
640 notmuch_date_sanitize
643 notmuch_json_show_sanitize ()
646 -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
647 -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
648 -e 's|"filename": "signature.asc",||g' \
649 -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
650 -e 's|"timestamp": 97.......|"timestamp": 42|g' \
651 -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
654 notmuch_emacs_error_sanitize ()
662 -e 's/^\[.*\]$/[XXX]/' \
663 -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
666 notmuch_date_sanitize ()
669 -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
672 notmuch_uuid_sanitize ()
674 sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
677 notmuch_built_with_sanitize ()
679 sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
682 notmuch_config_sanitize ()
684 notmuch_dir_sanitize | notmuch_built_with_sanitize
689 awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
692 # End of notmuch helper functions
694 # Use test_set_prereq to tell that a particular prerequisite is available.
696 # The prerequisite can later be checked for by using test_have_prereq.
698 # The single parameter is the prerequisite tag (a simple word, in all
699 # capital letters by convention).
702 satisfied="$satisfied$1 "
706 test_have_prereq () {
715 declare -A test_missing_external_prereq_
716 declare -A test_subtest_missing_external_prereq_
718 # declare prerequisite for the given external binary
719 test_declare_external_prereq () {
721 test "$#" = 2 && name=$2 || name="$binary(1)"
723 if ! hash $binary 2>/dev/null; then
724 test_missing_external_prereq_["${binary}"]=t
727 test_subtest_missing_external_prereq_[\"${name}\"]=t
733 # Explicitly require external prerequisite. Useful when binary is
734 # called indirectly (e.g. from emacs).
735 # Returns success if dependency is available, failure otherwise.
736 test_require_external_prereq () {
738 if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
739 # dependency is missing, call the replacement function to note it
746 # You are not expected to call test_ok_ and test_failure_ directly, use
747 # the text_expect_* functions instead.
750 if test "$test_subtest_known_broken_" = "t"; then
751 test_known_broken_ok_
754 test_success=$(($test_success + 1))
755 if test -n "$NOTMUCH_TEST_QUIET"; then
758 say_color pass "%-6s" "PASS"
759 echo " $test_subtest_name"
763 print_test_description
764 if test "$test_subtest_known_broken_" = "t"; then
765 test_known_broken_failure_ "$@"
768 test_failure=$(($test_failure + 1))
769 test_failure_message_ "FAIL" "$test_subtest_name" "$@"
770 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
774 test_failure_message_ () {
775 say_color error "%-6s" "$1"
778 if [ "$#" != "0" ]; then
779 echo "$@" | sed -e 's/^/ /'
781 if test "$verbose" != "t"; then cat test.output; fi
784 test_known_broken_ok_ () {
786 test_fixed=$(($test_fixed+1))
787 say_color pass "%-6s" "FIXED"
788 echo " $test_subtest_name"
791 test_known_broken_failure_ () {
793 test_broken=$(($test_broken+1))
794 if [ -z "$NOTMUCH_TEST_QUIET" ]; then
795 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
797 test_failure_message_ "BROKEN" "$test_subtest_name"
803 test "$debug" = "" || eval "$1"
808 if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
811 eval >&3 2>&4 "$test_cleanup"
816 test_count=$(($test_count+1))
818 for skp in $NOTMUCH_SKIP_TESTS
820 case $this_test.$test_count in
825 case $this_test_bare.$test_count in
833 test_report_skip_ "$@"
836 test_check_missing_external_prereqs_ "$@"
841 test_check_missing_external_prereqs_ () {
842 if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
843 say_color skip >&1 "missing prerequisites: "
844 echo ${!test_subtest_missing_external_prereq_[@]} >&1
845 test_report_skip_ "$@"
851 test_report_skip_ () {
853 say_color skip >&3 "skipping test:"
855 say_color skip "%-6s" "SKIP"
859 test_subtest_known_broken () {
860 test_subtest_known_broken_=t
863 test_expect_success () {
864 exec 1>&6 2>&7 # Restore stdout and stderr
865 if [ -z "$inside_subtest" ]; then
866 error "bug in the test script: test_expect_success without test_begin_subtest"
870 error "bug in the test script: not 1 parameters to test_expect_success"
872 if ! test_skip "$test_subtest_name"
876 # test_run_ may update missing external prerequisites
877 test_check_missing_external_prereqs_ "$@" ||
878 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
887 test_expect_code () {
888 exec 1>&6 2>&7 # Restore stdout and stderr
889 if [ -z "$inside_subtest" ]; then
890 error "bug in the test script: test_expect_code without test_begin_subtest"
894 error "bug in the test script: not 2 parameters to test_expect_code"
896 if ! test_skip "$test_subtest_name"
900 # test_run_ may update missing external prerequisites,
901 test_check_missing_external_prereqs_ "$@" ||
902 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
906 test_failure_ "exit code $eval_ret, expected $1" "$2"
911 # This is not among top-level (test_expect_success)
912 # but is a prefix that can be used in the test script, like:
914 # test_expect_success 'complain and die' '
916 # do something else &&
917 # test_must_fail git checkout ../outerspace
920 # Writing this as "! git checkout ../outerspace" is wrong, because
921 # the failure could be due to a segv. We want a controlled failure.
925 test $? -gt 0 -a $? -le 129 -o $? -gt 192
928 # test_cmp is a helper function to compare actual and expected output.
929 # You can use it like:
931 # test_expect_success 'foo works' '
932 # echo expected >expected &&
934 # test_cmp expected actual
937 # This could be written as either "cmp" or "diff -u", but:
938 # - cmp's output is not nearly as easy to read as diff -u
939 # - not all diff versions understand "-u"
945 # This function can be used to schedule some commands to be run
946 # unconditionally at the end of the test to restore sanity:
948 # test_expect_success 'test core.capslock' '
949 # git config core.capslock true &&
950 # test_when_finished "git config --unset core.capslock" &&
954 # That would be roughly equivalent to
956 # test_expect_success 'test core.capslock' '
957 # git config core.capslock true &&
959 # git config --unset core.capslock
962 # except that the greeting and config --unset must both succeed for
965 test_when_finished () {
967 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
972 test_results_dir="$TEST_DIRECTORY/test-results"
973 mkdir -p "$test_results_dir"
974 test_results_path="$test_results_dir/$this_test"
976 echo "total $test_count" >> $test_results_path
977 echo "success $test_success" >> $test_results_path
978 echo "fixed $test_fixed" >> $test_results_path
979 echo "broken $test_broken" >> $test_results_path
980 echo "failed $test_failure" >> $test_results_path
981 echo "" >> $test_results_path
983 [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
985 if [ "$test_failure" = "0" ]; then
986 if [ "$test_broken" = "0" ]; then
995 emacs_generate_script () {
996 # Construct a little test script here for the benefit of the user,
997 # (who can easily run "run_emacs" to get the same emacs environment
998 # for investigating any failures).
999 cat <<EOF >"$TMP_DIRECTORY/run_emacs"
1002 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
1004 # Here's what we are using here:
1006 # --quick Use minimal customization. This implies --no-init-file,
1007 # --no-site-file and (emacs 24) --no-site-lisp
1009 # --directory Ensure that the local elisp sources are found
1011 # --load Force loading of notmuch.el and test-lib.el
1013 exec ${TEST_EMACS} --quick \
1014 --directory "$NOTMUCH_SRCDIR/emacs" --load notmuch.el \
1015 --directory "$NOTMUCH_SRCDIR/test" --load test-lib.el \
1018 chmod a+x "$TMP_DIRECTORY/run_emacs"
1022 # test dependencies beforehand to avoid the waiting loop below
1023 missing_dependencies=
1024 test_require_external_prereq dtach || missing_dependencies=1
1025 test_require_external_prereq emacs || missing_dependencies=1
1026 test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
1027 test -z "$missing_dependencies" || return
1029 if [ -z "$EMACS_SERVER" ]; then
1030 emacs_tests="$NOTMUCH_SRCDIR/test/${this_test_bare}.el"
1031 if [ -f "$emacs_tests" ]; then
1032 load_emacs_tests="--eval '(load \"$emacs_tests\")'"
1036 server_name="notmuch-test-suite-$$"
1037 # start a detached session with an emacs server
1038 # user's TERM (or 'vt100' in case user's TERM is known dumb
1039 # or unknown) is given to dtach which assumes a minimally
1040 # VT100-compatible terminal -- and emacs inherits that
1041 TERM=$SMART_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
1042 sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
1043 --no-window-system \
1045 --eval '(setq server-name \"$server_name\")' \
1046 --eval '(server-start)' \
1047 --eval '(orphan-watchdog $$)'" || return
1048 EMACS_SERVER="$server_name"
1049 # wait until the emacs server is up
1050 until test_emacs '()' >/dev/null 2>/dev/null; do
1055 # Clear test-output output file. Most Emacs tests end with a
1056 # call to (test-output). If the test code fails with an
1057 # exception before this call, the output file won't get
1058 # updated. Since we don't want to compare against an output
1059 # file from another test, so start out with an empty file.
1063 ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $*)"
1067 # Note: if there is need to print debug information from python program,
1068 # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1069 PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1070 $NOTMUCH_PYTHON -B - > OUTPUT
1074 MAIL_DIR=$MAIL_DIR $NOTMUCH_RUBY -I $NOTMUCH_SRCDIR/bindings/ruby> OUTPUT
1078 exec_file="test${test_count}"
1079 test_file="${exec_file}.c"
1081 ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
1082 echo "== stdout ==" > OUTPUT.stdout
1083 echo "== stderr ==" > OUTPUT.stderr
1084 ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1085 notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr > OUTPUT
1090 test_file="${base_name}.c"
1091 shim_file="${base_name}.so"
1093 ${TEST_CC} ${TEST_CFLAGS} ${TEST_SHIM_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${shim_file} ${test_file} ${TEST_SHIM_LDFLAGS}
1096 notmuch_with_shim () {
1099 shim_file="${base_name}.so"
1100 LD_PRELOAD=./${shim_file}${LD_PRELOAD:+:$LD_PRELOAD} notmuch-shared "$@"
1103 # Creates a script that counts how much time it is executed and calls
1104 # notmuch. $notmuch_counter_command is set to the path to the
1105 # generated script. Use notmuch_counter_value() function to get the
1106 # current counter value.
1107 notmuch_counter_reset () {
1108 notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1109 if [ ! -x "$notmuch_counter_command" ]; then
1110 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1111 cat >"$notmuch_counter_command" <<EOF || return
1114 read count < "$notmuch_counter_state_path"
1115 echo \$((count + 1)) > "$notmuch_counter_state_path"
1119 chmod +x "$notmuch_counter_command" || return
1122 echo 0 > "$notmuch_counter_state_path"
1125 # Returns the current notmuch counter value.
1126 notmuch_counter_value () {
1127 if [ -r "$notmuch_counter_state_path" ]; then
1128 read count < "$notmuch_counter_state_path"
1135 test_reset_state_ () {
1136 test -z "$test_init_done_" && test_init_
1138 test_subtest_known_broken_=
1139 test_subtest_missing_external_prereq_=()
1142 # called once before the first subtest
1146 # skip all tests if there were external prerequisites missing during init
1147 test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1151 # Where to run the tests
1152 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1154 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1156 emacs_generate_script
1159 # Use -P to resolve symlinks in our working directory so that the cwd
1160 # in subprocesses like git equals our $PWD (for pathname comparisons).
1161 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1163 if test "$verbose" = "t"
1167 exec 4>test.output 3>&4
1170 for skp in $NOTMUCH_SKIP_TESTS
1173 for skp in $NOTMUCH_SKIP_TESTS
1175 case "$this_test" in
1180 case "$this_test_bare" in
1188 say_color skip >&3 "skipping test $this_test altogether"
1189 say_color skip "skip all tests in $this_test"
1194 # Provide an implementation of the 'yes' utility
1209 # Fix some commands on Windows
1212 # Windows has its own (incompatible) sort and find
1222 # git sees Windows-style pwd
1226 # no POSIX permissions
1227 # backslashes in pathspec are converted to '/'
1228 # exec does not inherit the PID
1231 test_set_prereq POSIXPERM
1232 test_set_prereq BSLASHPSPEC
1233 test_set_prereq EXECKEEPSPID
1237 test -z "$NO_PERL" && test_set_prereq PERL
1238 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1240 # test whether the filesystem supports symbolic links
1241 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1244 # convert variable from configure to more convenient form
1245 case "$NOTMUCH_DEFAULT_XAPIAN_BACKEND" in
1253 error "Unknown Xapian backend $NOTMUCH_DEFAULT_XAPIAN_BACKEND"
1255 # declare prerequisites for external binaries used in tests
1256 test_declare_external_prereq dtach
1257 test_declare_external_prereq emacs
1258 test_declare_external_prereq ${TEST_EMACSCLIENT}
1259 test_declare_external_prereq ${TEST_GDB}
1260 test_declare_external_prereq gpg
1261 test_declare_external_prereq openssl
1262 test_declare_external_prereq gpgsm
1263 test_declare_external_prereq ${NOTMUCH_PYTHON}