3 # Copyright (c) 2005 Junio C Hamano
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 http://www.gnu.org/licenses/ .
18 # if --tee was passed, write the output not only to the terminal, but
19 # additionally to the file test-results/$BASENAME.out, too.
20 case "$GIT_TEST_TEE_STARTED, $* " in
22 # do not redirect again
24 *' --tee '*|*' --va'*)
26 BASE=test-results/$(basename "$0" .sh)
27 (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
28 echo $? > $BASE.exit) | tee $BASE.out
29 test "$(cat $BASE.exit)" = 0
34 # Keep the original TERM for say_color
37 # For repeatability, reset the environment to known value.
43 export LANG LC_ALL PAGER TERM TZ
44 GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
46 # Protect ourselves from common misconfiguration to export
47 # CDPATH into the environment
52 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
54 echo "* warning: Some tests will not work if GIT_TRACE" \
55 "is set as to trace on STDERR ! *"
56 echo "* warning: Please set GIT_TRACE to something" \
57 "other than 1, 2 or true ! *"
63 # A regexp to match 5 and 40 hexdigits
64 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
65 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
67 _x04='[0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
68 _x32="$_x04$_x04$_x04$_x04$_x04$_x04$_x04$_x04"
70 # Each test should start with something like this, after copyright notices:
72 # test_description='Description of this test...
73 # This test checks if command xyzzy does the right thing...
76 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
77 TERM=$ORIGINAL_TERM &&
80 tput bold >/dev/null 2>&1 &&
81 tput setaf 1 >/dev/null 2>&1 &&
82 tput sgr0 >/dev/null 2>&1
89 -d|--d|--de|--deb|--debu|--debug)
91 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
93 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
94 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
95 -h|--h|--he|--hel|--help)
97 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
99 -q|--q|--qu|--qui|--quie|--quiet)
102 with_dashes=t; shift ;;
108 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
109 valgrind=t; verbose=t; shift ;;
111 shift ;; # was handled already
113 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
116 echo "error: unknown test option '$1'" >&2; exit 1 ;;
120 if test -n "$color"; then
126 error) tput bold; tput setaf 1;; # bold red
127 skip) tput bold; tput setaf 2;; # bold green
128 pass) tput setaf 2;; # green
129 info) tput setaf 3;; # brown
130 *) test -n "$quiet" && return;;
140 test -z "$1" && test -n "$quiet" && return
147 say_color error "error: $*"
156 test "${test_description}" != "" ||
157 error "Test script did not set test_description."
159 if test "$help" = "t"
161 echo "$test_description"
166 if test "$verbose" = "t"
170 exec 4>/dev/null 3>/dev/null
181 if test -n "$GIT_EXIT_OK"
185 echo >&5 "FATAL: Unexpected exit with code $code"
193 test_decode_color () {
194 sed -e 's/.\[1m/<WHITE>/g' \
195 -e 's/.\[31m/<RED>/g' \
196 -e 's/.\[32m/<GREEN>/g' \
197 -e 's/.\[33m/<YELLOW>/g' \
198 -e 's/.\[34m/<BLUE>/g' \
199 -e 's/.\[35m/<MAGENTA>/g' \
200 -e 's/.\[36m/<CYAN>/g' \
201 -e 's/.\[m/<RESET>/g'
213 sed -e 's/$/Q/' | tr Q '\015'
217 tr '\015' Q | sed -e 's/Q$//'
220 # Notmuch helper functions
221 increment_mtime_amount=0
226 increment_mtime_amount=$((increment_mtime_amount + 1))
227 touch -d "+${increment_mtime_amount} seconds" $dir
230 # Generate a new message in the mail directory, with a unique message
231 # ID and subject. The message is not added to the index.
233 # After this function returns, the filename of the generated message
234 # is available as $gen_msg_filename and the message ID is available as
237 # This function supports named parameters with the bash syntax for
238 # assigning a value to an associative array ([name]=value). The
239 # supported parameters are:
241 # [dir]=directory/of/choice
243 # Generate the message in directory 'directory/of/choice' within
244 # the mail store. The directory will be created if necessary.
248 # Text to use as the body of the email message
250 # '[from]="Some User <user@example.com>"'
251 # '[to]="Some User <user@example.com>"'
252 # '[subject]="Subject of email message"'
253 # '[date]="RFC 822 Date"'
255 # Values for email headers. If not provided, default values will
256 # be generated instead.
258 # '[cc]="Some User <user@example.com>"'
259 # [reply-to]=some-address
260 # [in-reply-to]=<message-id>
261 # [references]=<message-id>
262 # [content-type]=content-type-specification
263 # '[header]=full header line, including keyword'
265 # Additional values for email headers. If these are not provided
266 # then the relevant headers will simply not appear in the
271 # Controls the message-id of the created message.
277 # This is our (bash-specific) magic for doing named parameters
278 local -A template="($@)"
279 local additional_headers
281 gen_msg_cnt=$((gen_msg_cnt + 1))
282 gen_msg_name=msg-$(printf "%03d" $gen_msg_cnt)
284 if [ -z "${template[id]}" ]; then
285 gen_msg_id="${gen_msg_name}@notmuch-test-suite"
287 gen_msg_id="${template[id]}"
290 if [ -z "${template[dir]}" ]; then
291 gen_msg_filename="${MAIL_DIR}/$gen_msg_name"
293 gen_msg_filename="${MAIL_DIR}/${template[dir]}/$gen_msg_name"
294 mkdir -p $(dirname $gen_msg_filename)
297 if [ -z "${template[body]}" ]; then
298 template[body]="This is just a test message (#${gen_msg_cnt})"
301 if [ -z "${template[from]}" ]; then
302 template[from]="Notmuch Test Suite <test_suite@notmuchmail.org>"
305 if [ -z "${template[to]}" ]; then
306 template[to]="Notmuch Test Suite <test_suite@notmuchmail.org>"
309 if [ -z "${template[subject]}" ]; then
310 template[subject]="Test message #${gen_msg_cnt}"
313 if [ -z "${template[date]}" ]; then
314 template[date]="Tue, 05 Jan 2001 15:43:57 -0800"
317 additional_headers=""
318 if [ ! -z "${template[header]}" ]; then
319 additional_headers="${template[header]}
320 ${additional_headers}"
323 if [ ! -z "${template[reply-to]}" ]; then
324 additional_headers="Reply-To: ${template[reply-to]}
325 ${additional_headers}"
328 if [ ! -z "${template[in-reply-to]}" ]; then
329 additional_headers="In-Reply-To: ${template[in-reply-to]}
330 ${additional_headers}"
333 if [ ! -z "${template[cc]}" ]; then
334 additional_headers="Cc: ${template[cc]}
335 ${additional_headers}"
338 if [ ! -z "${template[references]}" ]; then
339 additional_headers="References: ${template[references]}
340 ${additional_headers}"
343 if [ ! -z "${template[content-type]}" ]; then
344 additional_headers="Content-Type: ${template[content-type]}
345 ${additional_headers}"
349 cat <<EOF >$gen_msg_filename
350 From: ${template[from]}
352 Message-Id: <${gen_msg_id}>
353 Subject: ${template[subject]}
354 Date: ${template[date]}
355 ${additional_headers}
359 # Ensure that the mtime of the containing directory is updated
360 increment_mtime $(dirname ${gen_msg_filename})
363 # Generate a new message and add it to the index.
365 # All of the arguments and return values supported by generate_message
366 # are also supported here, so see that function for details.
369 generate_message "$@"
371 $NOTMUCH new > /dev/null
384 if [ "$output" = "$expected" ]; then
388 testname=test-$(printf "%03d" $tests)
389 echo "$expected" > $testname.expected
390 echo "$output" > $testname.output
391 diff -u $testname.expected $testname.output || true
392 test_failures=$((test_failures + 1))
396 TEST_DIR=$(pwd)/test.$$
397 MAIL_DIR=${TEST_DIR}/mail
398 export NOTMUCH_CONFIG=${TEST_DIR}/notmuch-config
399 NOTMUCH=$(find_notmuch_binary $(pwd))
403 $NOTMUCH new | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
406 notmuch_search_sanitize ()
408 sed -r -e 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
411 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
412 notmuch_show_sanitize ()
414 sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
417 # End of notmuch helper functions
419 # Use test_set_prereq to tell that a particular prerequisite is available.
420 # The prerequisite can later be checked for in two ways:
422 # - Explicitly using test_have_prereq.
424 # - Implicitly by specifying the prerequisite tag in the calls to
425 # test_expect_{success,failure,code}.
427 # The single parameter is the prerequisite tag (a simple word, in all
428 # capital letters by convention).
431 satisfied="$satisfied$1 "
435 test_have_prereq () {
444 # You are not expected to call test_ok_ and test_failure_ directly, use
445 # the text_expect_* functions instead.
448 test_success=$(($test_success + 1))
449 say_color "" " ok $test_count: $@"
453 test_failure=$(($test_failure + 1))
454 say_color error "FAIL $test_count: $1"
456 echo "$@" | sed -e 's/^/ /'
457 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
460 test_known_broken_ok_ () {
461 test_fixed=$(($test_fixed+1))
462 say_color "" " FIXED $test_count: $@"
465 test_known_broken_failure_ () {
466 test_broken=$(($test_broken+1))
467 say_color skip " still broken $test_count: $@"
471 test "$debug" = "" || eval "$1"
478 eval >&3 2>&4 "$test_cleanup"
483 test_count=$(($test_count+1))
485 for skp in $GIT_SKIP_TESTS
487 case $this_test.$test_count in
492 if test -z "$to_skip" && test -n "$prereq" &&
493 ! test_have_prereq "$prereq"
499 say_color skip >&3 "skipping test: $@"
500 say_color skip "skip $test_count: $1"
509 test_expect_failure () {
510 test "$#" = 3 && { prereq=$1; shift; } || prereq=
512 error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
515 say >&3 "checking known breakage: $2"
517 if [ "$?" = 0 -a "$eval_ret" = 0 ]
519 test_known_broken_ok_ "$1"
521 test_known_broken_failure_ "$1"
527 test_expect_success () {
528 test "$#" = 3 && { prereq=$1; shift; } || prereq=
530 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
533 say >&3 "expecting success: $2"
535 if [ "$?" = 0 -a "$eval_ret" = 0 ]
545 test_expect_code () {
546 test "$#" = 4 && { prereq=$1; shift; } || prereq=
548 error "bug in the test script: not 3 or 4 parameters to test-expect-code"
551 say >&3 "expecting exit code $1: $3"
553 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
563 # test_external runs external test scripts that provide continuous
564 # test output about their progress, and succeeds/fails on
565 # zero/non-zero exit code. It outputs the test output on stdout even
566 # in non-verbose mode, and announces the external script with "* run
567 # <n>: ..." before running it. When providing relative paths, keep in
568 # mind that all scripts run in "trash directory".
569 # Usage: test_external description command arguments...
570 # Example: test_external 'Perl API' perl ../path/to/test.pl
572 test "$#" = 4 && { prereq=$1; shift; } || prereq=
574 error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
577 if ! test_skip "$descr" "$@"
579 # Announce the script to reduce confusion about the
580 # test output that follows.
581 say_color "" " run $test_count: $descr ($*)"
582 # Run command; redirect its stderr to &4 as in
583 # test_run_, but keep its stdout on our stdout even in
590 test_failure_ "$descr" "$@"
595 # Like test_external, but in addition tests that the command generated
596 # no output on stderr.
597 test_external_without_stderr () {
598 # The temporary file has no (and must have no) security
600 tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
601 stderr="$tmp/git-external-stderr.$$.tmp"
602 test_external "$@" 4> "$stderr"
603 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
604 descr="no stderr: $1"
606 say >&3 "expecting no stderr from previous command"
607 if [ ! -s "$stderr" ]; then
611 if [ "$verbose" = t ]; then
612 output=`echo; echo Stderr is:; cat "$stderr"`
616 # rm first in case test_failure exits.
618 test_failure_ "$descr" "$@" "$output"
622 # This is not among top-level (test_expect_success | test_expect_failure)
623 # but is a prefix that can be used in the test script, like:
625 # test_expect_success 'complain and die' '
627 # do something else &&
628 # test_must_fail git checkout ../outerspace
631 # Writing this as "! git checkout ../outerspace" is wrong, because
632 # the failure could be due to a segv. We want a controlled failure.
636 test $? -gt 0 -a $? -le 129 -o $? -gt 192
639 # test_cmp is a helper function to compare actual and expected output.
640 # You can use it like:
642 # test_expect_success 'foo works' '
643 # echo expected >expected &&
645 # test_cmp expected actual
648 # This could be written as either "cmp" or "diff -u", but:
649 # - cmp's output is not nearly as easy to read as diff -u
650 # - not all diff versions understand "-u"
656 # This function can be used to schedule some commands to be run
657 # unconditionally at the end of the test to restore sanity:
659 # test_expect_success 'test core.capslock' '
660 # git config core.capslock true &&
661 # test_when_finished "git config --unset core.capslock" &&
665 # That would be roughly equivalent to
667 # test_expect_success 'test core.capslock' '
668 # git config core.capslock true &&
670 # git config --unset core.capslock
673 # except that the greeting and config --unset must both succeed for
676 test_when_finished () {
678 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
683 test_results_dir="$TEST_DIRECTORY/test-results"
684 mkdir -p "$test_results_dir"
685 test_results_path="$test_results_dir/${0%.sh}-$$"
687 echo "total $test_count" >> $test_results_path
688 echo "success $test_success" >> $test_results_path
689 echo "fixed $test_fixed" >> $test_results_path
690 echo "broken $test_broken" >> $test_results_path
691 echo "failed $test_failure" >> $test_results_path
692 echo "" >> $test_results_path
694 if test "$test_fixed" != 0
696 say_color pass "fixed $test_fixed known breakage(s)"
698 if test "$test_broken" != 0
700 say_color error "still have $test_broken known breakage(s)"
701 msg="remaining $(($test_count-$test_broken)) test(s)"
703 msg="$test_count test(s)"
705 case "$test_failure" in
707 say_color pass "passed all $msg"
709 test -d "$remove_trash" &&
710 cd "$(dirname "$remove_trash")" &&
711 rm -rf "$(basename "$remove_trash")"
716 say_color error "failed $test_failure among $msg"
726 while [ -n "$dir" ]; do
728 if [ -x "$bin" ]; then
732 dir="$(dirname "$dir")"
733 if [ "$dir" = "/" ]; then
739 # Test the binaries we have just built. The tests are kept in
740 # test/ subdirectory and are run in 'trash directory' subdirectory.
741 TEST_DIRECTORY=$(pwd)
742 # FIXME: Only the normal case bellow is updated to notmuch
743 if test -n "$valgrind"
747 test "$1" = "$(readlink "$2")" || {
755 while test -d "$2".lock
757 say "Waiting for lock on $2."
764 make_valgrind_symlink () {
765 # handle only executables
766 test -x "$1" || return
768 base=$(basename "$1")
769 symlink_target=$TEST_DIRECTORY/../$base
770 # do not override scripts
771 if test -x "$symlink_target" &&
772 test ! -d "$symlink_target" &&
773 test "#!" != "$(head -c 2 < "$symlink_target")"
775 symlink_target=../valgrind.sh
779 symlink_target=../unprocessed-script
781 # create the link, or replace it if it is out of date
782 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
785 # override all git executables in TEST_DIRECTORY/..
786 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
787 mkdir -p "$GIT_VALGRIND"/bin
788 for file in $TEST_DIRECTORY/../git* $TEST_DIRECTORY/../test-*
790 make_valgrind_symlink $file
796 ls "$path"/git-* 2> /dev/null |
799 make_valgrind_symlink "$file"
803 PATH=$GIT_VALGRIND/bin:$PATH
804 GIT_EXEC_PATH=$GIT_VALGRIND/bin
806 elif test -n "$GIT_TEST_INSTALLED" ; then
807 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
808 error "Cannot run git from $GIT_TEST_INSTALLED."
809 PATH=$GIT_TEST_INSTALLED:$TEST_DIRECTORY/..:$PATH
810 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
812 notmuch_path=`find_notmuch_path "$TEST_DIRECTORY"`
813 test -n "$notmuch_path" && PATH="$notmuch_path:$PATH"
818 test="trash directory.$(basename "$0" .sh)"
819 test -n "$root" && test="$root/$test"
821 /*) TRASH_DIRECTORY="$test" ;;
822 *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
824 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
827 echo >&5 "FATAL: Cannot prepare test area"
831 MAIL_DIR="${TRASH_DIRECTORY}/mail"
832 export NOTMUCH_CONFIG="${TRASH_DIRECTORY}/notmuch-config"
837 cat <<EOF >"${NOTMUCH_CONFIG}"
842 name=Notmuch Test Suite
843 primary_email=test_suite@notmuchmail.org
844 other_email=test_suite_other@notmuchmail.org;test_suite@otherdomain.org
848 # Use -P to resolve symlinks in our working directory so that the cwd
849 # in subprocesses like git equals our $PWD (for pathname comparisons).
850 cd -P "$test" || error "Cannot setup test environment"
853 this_test=${this_test%%-*}
854 for skp in $GIT_SKIP_TESTS
857 for skp in $GIT_SKIP_TESTS
866 say_color skip >&3 "skipping test $this_test altogether"
867 say_color skip "skip all tests in $this_test"
872 # Provide an implementation of the 'yes' utility
887 # Fix some commands on Windows
890 # Windows has its own (incompatible) sort and find
900 # git sees Windows-style pwd
904 # no POSIX permissions
905 # backslashes in pathspec are converted to '/'
906 # exec does not inherit the PID
909 test_set_prereq POSIXPERM
910 test_set_prereq BSLASHPSPEC
911 test_set_prereq EXECKEEPSPID
915 test -z "$NO_PERL" && test_set_prereq PERL
916 test -z "$NO_PYTHON" && test_set_prereq PYTHON
918 # test whether the filesystem supports symbolic links
919 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS