git.notmuchmail.org Git - notmuch/blob - test/test-lib.sh

   1 #!/usr/bin/env bash
   2 #
   3 # Copyright (c) 2005 Junio C Hamano
   4 #
   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.
   9 #
  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.
  14 #
  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/ .
  17
  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."
  23     exit 1
  24 fi
  25
  26 # if --tee was passed, write the output not only to the terminal, but
  27 # additionally to the file test-results/$BASENAME.out, too.
  28 case "$GIT_TEST_TEE_STARTED, $* " in
  29 done,*)
  30         # do not redirect again
  31         ;;
  32 *' --tee '*|*' --va'*)
  33         mkdir -p test-results
  34         BASE=test-results/$(basename "$0" .sh)
  35         (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
  36          echo $? > $BASE.exit) | tee $BASE.out
  37         test "$(cat $BASE.exit)" = 0
  38         exit
  39         ;;
  40 esac
  41
  42 # Keep the original TERM for say_color and test_emacs
  43 ORIGINAL_TERM=$TERM
  44
  45 # For repeatability, reset the environment to known value.
  46 LANG=C
  47 LC_ALL=C
  48 PAGER=cat
  49 TZ=UTC
  50 TERM=dumb
  51 export LANG LC_ALL PAGER TERM TZ
  52 GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
  53
  54 # Protect ourselves from common misconfiguration to export
  55 # CDPATH into the environment
  56 unset CDPATH
  57
  58 unset GREP_OPTIONS
  59
  60 # Convenience
  61 #
  62 # A regexp to match 5 and 40 hexdigits
  63 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
  64 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
  65
  66 _x04='[0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
  67 _x32="$_x04$_x04$_x04$_x04$_x04$_x04$_x04$_x04"
  68
  69 # Each test should start with something like this, after copyright notices:
  70 #
  71 # test_description='Description of this test...
  72 # This test checks if command xyzzy does the right thing...
  73 # '
  74 # . ./test-lib.sh
  75 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
  76                 TERM=$ORIGINAL_TERM &&
  77                 export TERM &&
  78                 [ -t 1 ] &&
  79                 tput bold >/dev/null 2>&1 &&
  80                 tput setaf 1 >/dev/null 2>&1 &&
  81                 tput sgr0 >/dev/null 2>&1
  82         ) &&
  83         color=t
  84
  85 while test "$#" -ne 0
  86 do
  87         case "$1" in
  88         -d|--d|--de|--deb|--debu|--debug)
  89                 debug=t; shift ;;
  90         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
  91                 immediate=t; shift ;;
  92         -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
  93                 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
  94         -h|--h|--he|--hel|--help)
  95                 help=t; shift ;;
  96         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
  97                 verbose=t; shift ;;
  98         -q|--q|--qu|--qui|--quie|--quiet)
  99                 quiet=t; shift ;;
 100         --with-dashes)
 101                 with_dashes=t; shift ;;
 102         --no-color)
 103                 color=; shift ;;
 104         --no-python)
 105                 # noop now...
 106                 shift ;;
 107         --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
 108                 valgrind=t; verbose=t; shift ;;
 109         --tee)
 110                 shift ;; # was handled already
 111         --root=*)
 112                 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
 113                 shift ;;
 114         *)
 115                 echo "error: unknown test option '$1'" >&2; exit 1 ;;
 116         esac
 117 done
 118
 119 if test -n "$color"; then
 120         say_color () {
 121                 (
 122                 TERM=$ORIGINAL_TERM
 123                 export TERM
 124                 case "$1" in
 125                         error) tput bold; tput setaf 1;; # bold red
 126                         skip)  tput bold; tput setaf 2;; # bold green
 127                         pass)  tput setaf 2;;            # green
 128                         info)  tput setaf 3;;            # brown
 129                         *) test -n "$quiet" && return;;
 130                 esac
 131                 shift
 132                 printf " "
 133                 printf "$@"
 134                 tput sgr0
 135                 )
 136         }
 137 else
 138         say_color() {
 139                 test -z "$1" && test -n "$quiet" && return
 140                 shift
 141                 printf " "
 142                 printf "$@"
 143         }
 144 fi
 145
 146 error () {
 147         say_color error "error: $*\n"
 148         GIT_EXIT_OK=t
 149         exit 1
 150 }
 151
 152 say () {
 153         say_color info "$*"
 154 }
 155
 156 test "${test_description}" != "" ||
 157 error "Test script did not set test_description."
 158
 159 if test "$help" = "t"
 160 then
 161         echo "Tests ${test_description}"
 162         exit 0
 163 fi
 164
 165 echo $(basename "$0"): "Testing ${test_description}"
 166
 167 exec 5>&1
 168
 169 test_failure=0
 170 test_count=0
 171 test_fixed=0
 172 test_broken=0
 173 test_success=0
 174
 175 die () {
 176         code=$?
 177         rm -rf "$TEST_TMPDIR"
 178         if test -n "$GIT_EXIT_OK"
 179         then
 180                 exit $code
 181         else
 182                 echo >&5 "FATAL: Unexpected exit with code $code"
 183                 exit 1
 184         fi
 185 }
 186
 187 GIT_EXIT_OK=
 188 # Note: TEST_TMPDIR *NOT* exported!
 189 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
 190 trap 'die' EXIT
 191
 192 test_decode_color () {
 193         sed     -e 's/.\[1m/<WHITE>/g' \
 194                 -e 's/.\[31m/<RED>/g' \
 195                 -e 's/.\[32m/<GREEN>/g' \
 196                 -e 's/.\[33m/<YELLOW>/g' \
 197                 -e 's/.\[34m/<BLUE>/g' \
 198                 -e 's/.\[35m/<MAGENTA>/g' \
 199                 -e 's/.\[36m/<CYAN>/g' \
 200                 -e 's/.\[m/<RESET>/g'
 201 }
 202
 203 q_to_nul () {
 204         perl -pe 'y/Q/\000/'
 205 }
 206
 207 q_to_cr () {
 208         tr Q '\015'
 209 }
 210
 211 append_cr () {
 212         sed -e 's/$/Q/' | tr Q '\015'
 213 }
 214
 215 remove_cr () {
 216         tr '\015' Q | sed -e 's/Q$//'
 217 }
 218
 219 # Generate a new message in the mail directory, with a unique message
 220 # ID and subject. The message is not added to the index.
 221 #
 222 # After this function returns, the filename of the generated message
 223 # is available as $gen_msg_filename and the message ID is available as
 224 # $gen_msg_id .
 225 #
 226 # This function supports named parameters with the bash syntax for
 227 # assigning a value to an associative array ([name]=value). The
 228 # supported parameters are:
 229 #
 230 #  [dir]=directory/of/choice
 231 #
 232 #       Generate the message in directory 'directory/of/choice' within
 233 #       the mail store. The directory will be created if necessary.
 234 #
 235 #  [filename]=name
 236 #
 237 #       Store the message in file 'name'. The default is to store it
 238 #       in 'msg-<count>', where <count> is three-digit number of the
 239 #       message.
 240 #
 241 #  [body]=text
 242 #
 243 #       Text to use as the body of the email message
 244 #
 245 #  '[from]="Some User <user@example.com>"'
 246 #  '[to]="Some User <user@example.com>"'
 247 #  '[subject]="Subject of email message"'
 248 #  '[date]="RFC 822 Date"'
 249 #
 250 #       Values for email headers. If not provided, default values will
 251 #       be generated instead.
 252 #
 253 #  '[cc]="Some User <user@example.com>"'
 254 #  [reply-to]=some-address
 255 #  [in-reply-to]=<message-id>
 256 #  [references]=<message-id>
 257 #  [content-type]=content-type-specification
 258 #  '[header]=full header line, including keyword'
 259 #
 260 #       Additional values for email headers. If these are not provided
 261 #       then the relevant headers will simply not appear in the
 262 #       message.
 263 #
 264 #  '[id]=message-id'
 265 #
 266 #       Controls the message-id of the created message.
 267 gen_msg_cnt=0
 268 gen_msg_filename=""
 269 gen_msg_id=""
 270 generate_message ()
 271 {
 272     # This is our (bash-specific) magic for doing named parameters
 273     local -A template="($@)"
 274     local additional_headers
 275
 276     gen_msg_cnt=$((gen_msg_cnt + 1))
 277     if [ -z "${template[filename]}" ]; then
 278         gen_msg_name="msg-$(printf "%03d" $gen_msg_cnt)"
 279     else
 280         gen_msg_name=${template[filename]}
 281     fi
 282
 283     if [ -z "${template[id]}" ]; then
 284         gen_msg_id="${gen_msg_name%:2,*}@notmuch-test-suite"
 285     else
 286         gen_msg_id="${template[id]}"
 287     fi
 288
 289     if [ -z "${template[dir]}" ]; then
 290         gen_msg_filename="${MAIL_DIR}/$gen_msg_name"
 291     else
 292         gen_msg_filename="${MAIL_DIR}/${template[dir]}/$gen_msg_name"
 293         mkdir -p "$(dirname "$gen_msg_filename")"
 294     fi
 295
 296     if [ -z "${template[body]}" ]; then
 297         template[body]="This is just a test message (#${gen_msg_cnt})"
 298     fi
 299
 300     if [ -z "${template[from]}" ]; then
 301         template[from]="Notmuch Test Suite <test_suite@notmuchmail.org>"
 302     fi
 303
 304     if [ -z "${template[to]}" ]; then
 305         template[to]="Notmuch Test Suite <test_suite@notmuchmail.org>"
 306     fi
 307
 308     if [ -z "${template[subject]}" ]; then
 309         template[subject]="Test message #${gen_msg_cnt}"
 310     fi
 311
 312     if [ -z "${template[date]}" ]; then
 313         template[date]="Tue, 05 Jan 2001 15:43:57 -0000"
 314     fi
 315
 316     additional_headers=""
 317     if [ ! -z "${template[header]}" ]; then
 318         additional_headers="${template[header]}
 319 ${additional_headers}"
 320     fi
 321
 322     if [ ! -z "${template[reply-to]}" ]; then
 323         additional_headers="Reply-To: ${template[reply-to]}
 324 ${additional_headers}"
 325     fi
 326
 327     if [ ! -z "${template[in-reply-to]}" ]; then
 328         additional_headers="In-Reply-To: ${template[in-reply-to]}
 329 ${additional_headers}"
 330     fi
 331
 332     if [ ! -z "${template[cc]}" ]; then
 333         additional_headers="Cc: ${template[cc]}
 334 ${additional_headers}"
 335     fi
 336
 337     if [ ! -z "${template[references]}" ]; then
 338         additional_headers="References: ${template[references]}
 339 ${additional_headers}"
 340     fi
 341
 342     if [ ! -z "${template[content-type]}" ]; then
 343         additional_headers="Content-Type: ${template[content-type]}
 344 ${additional_headers}"
 345     fi
 346
 347     # Note that in the way we're setting it above and using it below,
 348     # `additional_headers' will also serve as the header / body separator
 349     # (empty line in between).
 350
 351     cat <<EOF >"$gen_msg_filename"
 352 From: ${template[from]}
 353 To: ${template[to]}
 354 Message-Id: <${gen_msg_id}>
 355 Subject: ${template[subject]}
 356 Date: ${template[date]}
 357 ${additional_headers}
 358 ${template[body]}
 359 EOF
 360 }
 361
 362 # Generate a new message and add it to the database.
 363 #
 364 # All of the arguments and return values supported by generate_message
 365 # are also supported here, so see that function for details.
 366 add_message ()
 367 {
 368     generate_message "$@" &&
 369     notmuch new > /dev/null
 370 }
 371
 372 # Deliver a message with emacs and add it to the database
 373 #
 374 # Uses emacs to generate and deliver a message to the mail store.
 375 # Accepts arbitrary extra emacs/elisp functions to modify the message
 376 # before sending, which is useful to doing things like attaching files
 377 # to the message and encrypting/signing.
 378 emacs_deliver_message ()
 379 {
 380     local subject="$1"
 381     local body="$2"
 382     shift 2
 383     # before we can send a message, we have to prepare the FCC maildir
 384     mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
 385     $TEST_DIRECTORY/smtp-dummy sent_message &
 386     smtp_dummy_pid=$!
 387     test_emacs \
 388         "(let ((message-send-mail-function 'message-smtpmail-send-it)
 389                (smtpmail-smtp-server \"localhost\")
 390                (smtpmail-smtp-service \"25025\"))
 391            (notmuch-hello)
 392            (notmuch-mua-mail)
 393            (message-goto-to)
 394            (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
 395            (message-goto-subject)
 396            (insert \"${subject}\")
 397            (message-goto-body)
 398            (insert \"${body}\")
 399            $@
 400            (message-send-and-exit))"
 401     # opportunistically quit smtp-dummy in case above fails.
 402     { echo QUIT > /dev/tcp/localhost/25025; } 2>/dev/null
 403     wait ${smtp_dummy_pid}
 404     notmuch new >/dev/null
 405 }
 406
 407 # Generate a corpus of email and add it to the database.
 408 #
 409 # This corpus is fixed, (it happens to be 50 messages from early in
 410 # the history of the notmuch mailing list), which allows for reliably
 411 # testing commands that need to operate on a not-totally-trivial
 412 # number of messages.
 413 add_email_corpus ()
 414 {
 415     rm -rf ${MAIL_DIR}
 416     if [ -d $TEST_DIRECTORY/corpus.mail ]; then
 417         cp -a $TEST_DIRECTORY/corpus.mail ${MAIL_DIR}
 418     else
 419         cp -a $TEST_DIRECTORY/corpus ${MAIL_DIR}
 420         notmuch new >/dev/null
 421         cp -a ${MAIL_DIR} $TEST_DIRECTORY/corpus.mail
 422     fi
 423 }
 424
 425 test_begin_subtest ()
 426 {
 427     if [ -n "$inside_subtest" ]; then
 428         exec 1>&6 2>&7          # Restore stdout and stderr
 429         error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
 430     fi
 431     test_subtest_name="$1"
 432     test_reset_state_
 433     # Remember stdout and stderr file descriptors and redirect test
 434     # output to the previously prepared file descriptors 3 and 4 (see
 435     # below)
 436     if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
 437     exec 6>&1 7>&2 >&3 2>&4
 438     inside_subtest=t
 439 }
 440
 441 # Pass test if two arguments match
 442 #
 443 # Note: Unlike all other test_expect_* functions, this function does
 444 # not accept a test name. Instead, the caller should call
 445 # test_begin_subtest before calling this function in order to set the
 446 # name.
 447 test_expect_equal ()
 448 {
 449         exec 1>&6 2>&7          # Restore stdout and stderr
 450         inside_subtest=
 451         test "$#" = 3 && { prereq=$1; shift; } || prereq=
 452         test "$#" = 2 ||
 453         error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
 454
 455         output="$1"
 456         expected="$2"
 457         if ! test_skip "$test_subtest_name"
 458         then
 459                 if [ "$output" = "$expected" ]; then
 460                         test_ok_ "$test_subtest_name"
 461                 else
 462                         testname=$this_test.$test_count
 463                         echo "$expected" > $testname.expected
 464                         echo "$output" > $testname.output
 465                         test_failure_ "$test_subtest_name" "$(diff -u $testname.expected $testname.output)"
 466                 fi
 467     fi
 468 }
 469
 470 # Like test_expect_equal, but takes two filenames.
 471 test_expect_equal_file ()
 472 {
 473         exec 1>&6 2>&7          # Restore stdout and stderr
 474         inside_subtest=
 475         test "$#" = 3 && { prereq=$1; shift; } || prereq=
 476         test "$#" = 2 ||
 477         error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
 478
 479         output="$1"
 480         expected="$2"
 481         if ! test_skip "$test_subtest_name"
 482         then
 483                 if diff -q "$expected" "$output" >/dev/null ; then
 484                         test_ok_ "$test_subtest_name"
 485                 else
 486                         testname=$this_test.$test_count
 487                         cp "$output" $testname.output
 488                         cp "$expected" $testname.expected
 489                         test_failure_ "$test_subtest_name" "$(diff -u $testname.expected $testname.output)"
 490                 fi
 491     fi
 492 }
 493
 494 NOTMUCH_NEW ()
 495 {
 496     notmuch new | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
 497 }
 498
 499 notmuch_search_sanitize ()
 500 {
 501     sed -r -e 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
 502 }
 503
 504 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
 505 notmuch_show_sanitize ()
 506 {
 507     sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
 508 }
 509 notmuch_show_sanitize_all ()
 510 {
 511     sed \
 512         -e 's| filename:.*| filename:XXXXX|' \
 513         -e 's| id:[^ ]* | id:XXXXX |'
 514 }
 515
 516 notmuch_json_show_sanitize ()
 517 {
 518     sed -e 's|, |,\n |g' | \
 519         sed \
 520         -e 's|"id": "[^"]*",|"id": "XXXXX",|' \
 521         -e 's|"filename": "[^"]*",|"filename": "YYYYY",|'
 522 }
 523
 524 # End of notmuch helper functions
 525
 526 # Use test_set_prereq to tell that a particular prerequisite is available.
 527 # The prerequisite can later be checked for in two ways:
 528 #
 529 # - Explicitly using test_have_prereq.
 530 #
 531 # - Implicitly by specifying the prerequisite tag in the calls to
 532 #   test_expect_{success,failure,code}.
 533 #
 534 # The single parameter is the prerequisite tag (a simple word, in all
 535 # capital letters by convention).
 536
 537 test_set_prereq () {
 538         satisfied="$satisfied$1 "
 539 }
 540 satisfied=" "
 541
 542 test_have_prereq () {
 543         case $satisfied in
 544         *" $1 "*)
 545                 : yes, have it ;;
 546         *)
 547                 ! : nope ;;
 548         esac
 549 }
 550
 551 # You are not expected to call test_ok_ and test_failure_ directly, use
 552 # the text_expect_* functions instead.
 553
 554 test_ok_ () {
 555         if test "$test_subtest_known_broken_" = "t"; then
 556                 test_known_broken_ok_ "$@"
 557                 return
 558         fi
 559         test_success=$(($test_success + 1))
 560         say_color pass "%-6s" "PASS"
 561         echo " $@"
 562 }
 563
 564 test_failure_ () {
 565         if test "$test_subtest_known_broken_" = "t"; then
 566                 test_known_broken_failure_ "$@"
 567                 return
 568         fi
 569         test_failure=$(($test_failure + 1))
 570         test_failure_message_ "FAIL" "$@"
 571         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 572         return 1
 573 }
 574
 575 test_failure_message_ () {
 576         say_color error "%-6s" "$1"
 577         echo " $2"
 578         shift 2
 579         echo "$@" | sed -e 's/^/        /'
 580         if test "$verbose" != "t"; then cat test.output; fi
 581 }
 582
 583 test_known_broken_ok_ () {
 584         test_reset_state_
 585         test_fixed=$(($test_fixed+1))
 586         say_color pass "%-6s" "FIXED"
 587         echo " $@"
 588 }
 589
 590 test_known_broken_failure_ () {
 591         test_reset_state_
 592         test_broken=$(($test_broken+1))
 593         test_failure_message_ "BROKEN" "$@"
 594         return 1
 595 }
 596
 597 test_debug () {
 598         test "$debug" = "" || eval "$1"
 599 }
 600
 601 test_run_ () {
 602         test_cleanup=:
 603         if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
 604         eval >&3 2>&4 "$1"
 605         eval_ret=$?
 606         eval >&3 2>&4 "$test_cleanup"
 607         return 0
 608 }
 609
 610 test_skip () {
 611         test_count=$(($test_count+1))
 612         to_skip=
 613         for skp in $NOTMUCH_SKIP_TESTS
 614         do
 615                 case $this_test.$test_count in
 616                 $skp)
 617                         to_skip=t
 618                 esac
 619         done
 620         if test -z "$to_skip" && test -n "$prereq" &&
 621            ! test_have_prereq "$prereq"
 622         then
 623                 to_skip=t
 624         fi
 625         case "$to_skip" in
 626         t)
 627                 test_reset_state_
 628                 say_color skip >&3 "skipping test: $@"
 629                 say_color skip "%-6s" "SKIP"
 630                 echo " $1"
 631                 : true
 632                 ;;
 633         *)
 634                 false
 635                 ;;
 636         esac
 637 }
 638
 639 test_subtest_known_broken () {
 640         test_subtest_known_broken_=t
 641 }
 642
 643 test_expect_success () {
 644         test "$#" = 3 && { prereq=$1; shift; } || prereq=
 645         test "$#" = 2 ||
 646         error "bug in the test script: not 2 or 3 parameters to test-expect-success"
 647         test_reset_state_
 648         if ! test_skip "$@"
 649         then
 650                 test_run_ "$2"
 651                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
 652                 then
 653                         test_ok_ "$1"
 654                 else
 655                         test_failure_ "$@"
 656                 fi
 657         fi
 658 }
 659
 660 test_expect_code () {
 661         test "$#" = 4 && { prereq=$1; shift; } || prereq=
 662         test "$#" = 3 ||
 663         error "bug in the test script: not 3 or 4 parameters to test-expect-code"
 664         test_reset_state_
 665         if ! test_skip "$@"
 666         then
 667                 test_run_ "$3"
 668                 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
 669                 then
 670                         test_ok_ "$2"
 671                 else
 672                         test_failure_ "$@"
 673                 fi
 674         fi
 675 }
 676
 677 # test_external runs external test scripts that provide continuous
 678 # test output about their progress, and succeeds/fails on
 679 # zero/non-zero exit code.  It outputs the test output on stdout even
 680 # in non-verbose mode, and announces the external script with "* run
 681 # <n>: ..." before running it.  When providing relative paths, keep in
 682 # mind that all scripts run in "trash directory".
 683 # Usage: test_external description command arguments...
 684 # Example: test_external 'Perl API' perl ../path/to/test.pl
 685 test_external () {
 686         test "$#" = 4 && { prereq=$1; shift; } || prereq=
 687         test "$#" = 3 ||
 688         error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
 689         descr="$1"
 690         shift
 691         test_reset_state_
 692         if ! test_skip "$descr" "$@"
 693         then
 694                 # Announce the script to reduce confusion about the
 695                 # test output that follows.
 696                 say_color "" " run $test_count: $descr ($*)"
 697                 # Run command; redirect its stderr to &4 as in
 698                 # test_run_, but keep its stdout on our stdout even in
 699                 # non-verbose mode.
 700                 "$@" 2>&4
 701                 if [ "$?" = 0 ]
 702                 then
 703                         test_ok_ "$descr"
 704                 else
 705                         test_failure_ "$descr" "$@"
 706                 fi
 707         fi
 708 }
 709
 710 # Like test_external, but in addition tests that the command generated
 711 # no output on stderr.
 712 test_external_without_stderr () {
 713         # The temporary file has no (and must have no) security
 714         # implications.
 715         tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
 716         stderr="$tmp/git-external-stderr.$$.tmp"
 717         test_external "$@" 4> "$stderr"
 718         [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
 719         descr="no stderr: $1"
 720         shift
 721         if [ ! -s "$stderr" ]; then
 722                 rm "$stderr"
 723                 test_ok_ "$descr"
 724         else
 725                 if [ "$verbose" = t ]; then
 726                         output=`echo; echo Stderr is:; cat "$stderr"`
 727                 else
 728                         output=
 729                 fi
 730                 # rm first in case test_failure exits.
 731                 rm "$stderr"
 732                 test_failure_ "$descr" "$@" "$output"
 733         fi
 734 }
 735
 736 # This is not among top-level (test_expect_success)
 737 # but is a prefix that can be used in the test script, like:
 738 #
 739 #       test_expect_success 'complain and die' '
 740 #           do something &&
 741 #           do something else &&
 742 #           test_must_fail git checkout ../outerspace
 743 #       '
 744 #
 745 # Writing this as "! git checkout ../outerspace" is wrong, because
 746 # the failure could be due to a segv.  We want a controlled failure.
 747
 748 test_must_fail () {
 749         "$@"
 750         test $? -gt 0 -a $? -le 129 -o $? -gt 192
 751 }
 752
 753 # test_cmp is a helper function to compare actual and expected output.
 754 # You can use it like:
 755 #
 756 #       test_expect_success 'foo works' '
 757 #               echo expected >expected &&
 758 #               foo >actual &&
 759 #               test_cmp expected actual
 760 #       '
 761 #
 762 # This could be written as either "cmp" or "diff -u", but:
 763 # - cmp's output is not nearly as easy to read as diff -u
 764 # - not all diff versions understand "-u"
 765
 766 test_cmp() {
 767         $GIT_TEST_CMP "$@"
 768 }
 769
 770 # This function can be used to schedule some commands to be run
 771 # unconditionally at the end of the test to restore sanity:
 772 #
 773 #       test_expect_success 'test core.capslock' '
 774 #               git config core.capslock true &&
 775 #               test_when_finished "git config --unset core.capslock" &&
 776 #               hello world
 777 #       '
 778 #
 779 # That would be roughly equivalent to
 780 #
 781 #       test_expect_success 'test core.capslock' '
 782 #               git config core.capslock true &&
 783 #               hello world
 784 #               git config --unset core.capslock
 785 #       '
 786 #
 787 # except that the greeting and config --unset must both succeed for
 788 # the test to pass.
 789
 790 test_when_finished () {
 791         test_cleanup="{ $*
 792                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
 793 }
 794
 795 test_done () {
 796         GIT_EXIT_OK=t
 797         test_results_dir="$TEST_DIRECTORY/test-results"
 798         mkdir -p "$test_results_dir"
 799         test_results_path="$test_results_dir/${0%.sh}-$$"
 800
 801         echo "total $test_count" >> $test_results_path
 802         echo "success $test_success" >> $test_results_path
 803         echo "fixed $test_fixed" >> $test_results_path
 804         echo "broken $test_broken" >> $test_results_path
 805         echo "failed $test_failure" >> $test_results_path
 806         echo "" >> $test_results_path
 807
 808         echo
 809
 810         [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
 811
 812         if [ "$test_failure" = "0" ]; then
 813             if [ "$test_broken" = "0" ]; then
 814                 rm -rf "$remove_tmp"
 815             fi
 816             exit 0
 817         else
 818             exit 1
 819         fi
 820 }
 821
 822 emacs_generate_script () {
 823         # Construct a little test script here for the benefit of the user,
 824         # (who can easily run "run_emacs" to get the same emacs environment
 825         # for investigating any failures).
 826         cat <<EOF >"$TMP_DIRECTORY/run_emacs"
 827 #!/bin/sh
 828 export PATH=$PATH
 829 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
 830
 831 # Here's what we are using here:
 832 #
 833 # --no-init-file        Don't load users ~/.emacs
 834 #
 835 # --no-site-file        Don't load the site-wide startup stuff
 836 #
 837 # --directory           Ensure that the local elisp sources are found
 838 #
 839 # --load                Force loading of notmuch.el and test-lib.el
 840
 841 exec emacs --no-init-file --no-site-file \
 842         --directory "$TEST_DIRECTORY/../emacs" --load notmuch.el \
 843         --directory "$TEST_DIRECTORY" --load test-lib.el \
 844         "\$@"
 845 EOF
 846         chmod a+x "$TMP_DIRECTORY/run_emacs"
 847 }
 848
 849 test_emacs () {
 850         if [ -z "$EMACS_SERVER" ]; then
 851                 server_name="notmuch-test-suite-$$"
 852                 # start a detached session with an emacs server
 853                 # user's TERM is given to dtach which assumes a minimally
 854                 # VT100-compatible terminal -- and emacs inherits that
 855                 TERM=$ORIGINAL_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
 856                         sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
 857                                 --no-window-system \
 858                                 --eval '(setq server-name \"$server_name\")' \
 859                                 --eval '(server-start)' \
 860                                 --eval '(orphan-watchdog $$)'" || return
 861                 EMACS_SERVER="$server_name"
 862                 # wait until the emacs server is up
 863                 until test_emacs '()' 2>/dev/null; do
 864                         sleep 1
 865                 done
 866         fi
 867
 868         emacsclient --socket-name="$EMACS_SERVER" --eval "(progn $@)"
 869 }
 870
 871 test_reset_state_ () {
 872         test_subtest_known_broken_=
 873 }
 874
 875
 876 find_notmuch_path ()
 877 {
 878     dir="$1"
 879
 880     while [ -n "$dir" ]; do
 881         bin="$dir/notmuch"
 882         if [ -x "$bin" ]; then
 883             echo "$dir"
 884             return
 885         fi
 886         dir="$(dirname "$dir")"
 887         if [ "$dir" = "/" ]; then
 888             break
 889         fi
 890     done
 891 }
 892
 893 # Test the binaries we have just built.  The tests are kept in
 894 # test/ subdirectory and are run in 'trash directory' subdirectory.
 895 TEST_DIRECTORY=$(pwd)
 896 if test -n "$valgrind"
 897 then
 898         make_symlink () {
 899                 test -h "$2" &&
 900                 test "$1" = "$(readlink "$2")" || {
 901                         # be super paranoid
 902                         if mkdir "$2".lock
 903                         then
 904                                 rm -f "$2" &&
 905                                 ln -s "$1" "$2" &&
 906                                 rm -r "$2".lock
 907                         else
 908                                 while test -d "$2".lock
 909                                 do
 910                                         say "Waiting for lock on $2."
 911                                         sleep 1
 912                                 done
 913                         fi
 914                 }
 915         }
 916
 917         make_valgrind_symlink () {
 918                 # handle only executables
 919                 test -x "$1" || return
 920
 921                 base=$(basename "$1")
 922                 symlink_target=$TEST_DIRECTORY/../$base
 923                 # do not override scripts
 924                 if test -x "$symlink_target" &&
 925                     test ! -d "$symlink_target" &&
 926                     test "#!" != "$(head -c 2 < "$symlink_target")"
 927                 then
 928                         symlink_target=$TEST_DIRECTORY/valgrind.sh
 929                 fi
 930                 case "$base" in
 931                 *.sh|*.perl)
 932                         symlink_target=$TEST_DIRECTORY/unprocessed-script
 933                 esac
 934                 # create the link, or replace it if it is out of date
 935                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 936         }
 937
 938         # override notmuch executable in TEST_DIRECTORY/..
 939         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 940         mkdir -p "$GIT_VALGRIND"/bin
 941         make_valgrind_symlink $TEST_DIRECTORY/../notmuch
 942         OLDIFS=$IFS
 943         IFS=:
 944         for path in $PATH
 945         do
 946                 ls "$path"/notmuch 2> /dev/null |
 947                 while read file
 948                 do
 949                         make_valgrind_symlink "$file"
 950                 done
 951         done
 952         IFS=$OLDIFS
 953         PATH=$GIT_VALGRIND/bin:$PATH
 954         GIT_EXEC_PATH=$GIT_VALGRIND/bin
 955         export GIT_VALGRIND
 956 else # normal case
 957         notmuch_path=`find_notmuch_path "$TEST_DIRECTORY"`
 958         test -n "$notmuch_path" && PATH="$notmuch_path:$PATH"
 959 fi
 960 export PATH
 961
 962 # Test repository
 963 test="tmp.$(basename "$0" .sh)"
 964 test -n "$root" && test="$root/$test"
 965 case "$test" in
 966 /*) TMP_DIRECTORY="$test" ;;
 967  *) TMP_DIRECTORY="$TEST_DIRECTORY/$test" ;;
 968 esac
 969 test ! -z "$debug" || remove_tmp=$TMP_DIRECTORY
 970 rm -fr "$test" || {
 971         GIT_EXIT_OK=t
 972         echo >&5 "FATAL: Cannot prepare test area"
 973         exit 1
 974 }
 975
 976 # A temporary home directory is needed by at least:
 977 # - emacs/"Sending a message via (fake) SMTP"
 978 # - emacs/"Reply within emacs"
 979 # - crypto/emacs_deliver_message
 980 export HOME="${TMP_DIRECTORY}/home"
 981 mkdir -p "${HOME}"
 982
 983 MAIL_DIR="${TMP_DIRECTORY}/mail"
 984 export GNUPGHOME="${TMP_DIRECTORY}/gnupg"
 985 export NOTMUCH_CONFIG="${TMP_DIRECTORY}/notmuch-config"
 986
 987 mkdir -p "${test}"
 988 mkdir -p "${MAIL_DIR}"
 989
 990 cat <<EOF >"${NOTMUCH_CONFIG}"
 991 [database]
 992 path=${MAIL_DIR}
 993
 994 [user]
 995 name=Notmuch Test Suite
 996 primary_email=test_suite@notmuchmail.org
 997 other_email=test_suite_other@notmuchmail.org;test_suite@otherdomain.org
 998 EOF
 999
1000 emacs_generate_script
1001
1002
1003 # Use -P to resolve symlinks in our working directory so that the cwd
1004 # in subprocesses like git equals our $PWD (for pathname comparisons).
1005 cd -P "$test" || error "Cannot setup test environment"
1006
1007 if test "$verbose" = "t"
1008 then
1009         exec 4>&2 3>&1
1010 else
1011         exec 4>test.output 3>&4
1012 fi
1013
1014 this_test=${0##*/}
1015 for skp in $NOTMUCH_SKIP_TESTS
1016 do
1017         to_skip=
1018         for skp in $NOTMUCH_SKIP_TESTS
1019         do
1020                 case "$this_test" in
1021                 $skp)
1022                         to_skip=t
1023                 esac
1024         done
1025         case "$to_skip" in
1026         t)
1027                 say_color skip >&3 "skipping test $this_test altogether"
1028                 say_color skip "skip all tests in $this_test"
1029                 test_done
1030         esac
1031 done
1032
1033 # Provide an implementation of the 'yes' utility
1034 yes () {
1035         if test $# = 0
1036         then
1037                 y=y
1038         else
1039                 y="$*"
1040         fi
1041
1042         while echo "$y"
1043         do
1044                 :
1045         done
1046 }
1047
1048 # Fix some commands on Windows
1049 case $(uname -s) in
1050 *MINGW*)
1051         # Windows has its own (incompatible) sort and find
1052         sort () {
1053                 /usr/bin/sort "$@"
1054         }
1055         find () {
1056                 /usr/bin/find "$@"
1057         }
1058         sum () {
1059                 md5sum "$@"
1060         }
1061         # git sees Windows-style pwd
1062         pwd () {
1063                 builtin pwd -W
1064         }
1065         # no POSIX permissions
1066         # backslashes in pathspec are converted to '/'
1067         # exec does not inherit the PID
1068         ;;
1069 *)
1070         test_set_prereq POSIXPERM
1071         test_set_prereq BSLASHPSPEC
1072         test_set_prereq EXECKEEPSPID
1073         ;;
1074 esac
1075
1076 test -z "$NO_PERL" && test_set_prereq PERL
1077 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1078
1079 # test whether the filesystem supports symbolic links
1080 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1081 rm -f y