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

   1 #
   2 # Copyright (c) 2005 Junio C Hamano
   3 # Copyright (c) 2010 Notmuch Developers
   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 https://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 # Make sure echo builtin does not expand backslash-escape sequences by default.
  27 shopt -u xpg_echo
  28
  29 # Ensure NOTMUCH_SRCDIR and NOTMUCH_BUILDDIR are set.
  30 . $(dirname "$0")/export-dirs.sh || exit 1
  31
  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.'
  35         exit 1
  36 fi
  37
  38 this_test=${0##*/}
  39 this_test=${this_test%.sh}
  40 this_test_bare=${this_test#T[0-9][0-9][0-9]-}
  41
  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
  45 done,*)
  46         # do not redirect again
  47         ;;
  48 *' --tee '*|*' --va'*)
  49         mkdir -p test-results
  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
  54         exit
  55         ;;
  56 esac
  57
  58 # STDIN from /dev/null. EOF for readers (and ENOTTY for tty related ioctls).
  59 exec </dev/null
  60
  61 # Save STDOUT to fd 6 and STDERR to fd 7.
  62 exec 6>&1 7>&2
  63 # Make xtrace debugging (when used) use redirected STDERR, with verbose lead:
  64 BASH_XTRACEFD=7
  65 export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
  66
  67 # Keep the original TERM for say_color and test_emacs
  68 ORIGINAL_TERM=$TERM
  69
  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.
  73 case ${TERM-} in
  74         '' | dumb | unknown )
  75                 SMART_TERM=vt100 ;;
  76         *)
  77                 SMART_TERM=$TERM ;;
  78 esac
  79
  80 # For repeatability, reset the environment to known value.
  81 LANG=C
  82 LC_ALL=C
  83 PAGER=cat
  84 TZ=UTC
  85 TERM=dumb
  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
  91     exit 1
  92 fi
  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"}
 100
 101 # Protect ourselves from common misconfiguration to export
 102 # CDPATH into the environment
 103 unset CDPATH
 104
 105 unset GREP_OPTIONS
 106
 107 # For emacsclient
 108 unset ALTERNATE_EDITOR
 109
 110 add_gnupg_home ()
 111 {
 112     [ -e "${GNUPGHOME}/gpg.conf" ] && return
 113     _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
 114     at_exit_function _gnupg_exit
 115     mkdir -p -m 0700 "$GNUPGHOME"
 116     gpg --no-tty --import <$NOTMUCH_SRCDIR/test/gnupg-secret-key.asc >"$GNUPGHOME"/import.log 2>&1
 117     test_debug "cat $GNUPGHOME/import.log"
 118     if (gpg --quick-random --version >/dev/null 2>&1) ; then
 119         echo quick-random >> "$GNUPGHOME"/gpg.conf
 120     elif (gpg --debug-quick-random --version >/dev/null 2>&1) ; then
 121         echo debug-quick-random >> "$GNUPGHOME"/gpg.conf
 122     fi
 123     echo no-emit-version >> "$GNUPGHOME"/gpg.conf
 124
 125     # Change this if we ship a new test key
 126     FINGERPRINT="5AEAB11F5E33DCE875DDB75B6D92612D94E46381"
 127     SELF_USERID="Notmuch Test Suite <test_suite@notmuchmail.org> (INSECURE!)"
 128     printf '%s:6:\n' "$FINGERPRINT" | gpg --quiet --batch --no-tty --import-ownertrust
 129 }
 130
 131 add_gpgsm_home ()
 132 {
 133     local fpr
 134     [ -e "$GNUPGHOME/gpgsm.conf" ] && return
 135     _gnupg_exit () { gpgconf --kill all 2>/dev/null || true; }
 136     at_exit_function _gnupg_exit
 137     mkdir -p -m 0700 "$GNUPGHOME"
 138     openssl pkcs12 -export -passout pass: -inkey "$NOTMUCH_SRCDIR/test/smime/key+cert.pem" \
 139         < "$NOTMUCH_SRCDIR/test/smime/test.crt" | \
 140         gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
 141               --disable-dirmngr --import  >"$GNUPGHOME"/import.log 2>&1 3<<<''
 142     fpr=$(gpgsm --batch --list-key test_suite@notmuchmail.org | sed -n 's/.*fingerprint: //p')
 143     echo "$fpr S relax" >> "$GNUPGHOME/trustlist.txt"
 144     gpgsm --quiet --batch --no-tty --no-common-certs-import --disable-dirmngr --import < $NOTMUCH_SRCDIR/test/smime/ca.crt
 145     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"
 146     printf '%s::1\n' include-certs disable-crl-checks | gpgconf --output /dev/null --change-options gpgsm
 147     gpgsm --batch --no-tty --no-common-certs-import --pinentry-mode=loopback --passphrase-fd 3 \
 148               --disable-dirmngr --import "$NOTMUCH_SRCDIR/test/smime/bob.p12" >>"$GNUPGHOME"/import.log 2>&1 3<<<''
 149     test_debug "cat $GNUPGHOME/import.log"
 150 }
 151
 152 # Each test should start with something like this, after copyright notices:
 153 #
 154 # test_description='Description of this test...
 155 # This test checks if command xyzzy does the right thing...
 156 # '
 157 # . ./test-lib.sh || exit 1
 158
 159 color=maybe
 160
 161 while test "$#" -ne 0
 162 do
 163         case "$1" in
 164         -d|--debug)
 165                 debug=t; shift ;;
 166         -i|--immediate)
 167                 immediate=t; shift ;;
 168         -h|--help)
 169                 help=t; shift ;;
 170         -v|--verbose)
 171                 verbose=t; shift ;;
 172         -q|--quiet)
 173                 quiet=t; shift ;;
 174         --with-dashes)
 175                 with_dashes=t; shift ;;
 176         --no-color)
 177                 color=; shift ;;
 178         --no-python)
 179                 # noop now...
 180                 shift ;;
 181         --valgrind)
 182                 valgrind=t; verbose=t; shift ;;
 183         --tee)
 184                 shift ;; # was handled already
 185         *)
 186                 echo "error: unknown test option '$1'" >&2; exit 1 ;;
 187         esac
 188 done
 189
 190 if test -n "$debug"; then
 191     print_subtest () {
 192         printf " %-4s" "[$((test_count - 1))]"
 193     }
 194 else
 195     print_subtest () {
 196         true
 197     }
 198 fi
 199
 200 test -n "$COLORS_WITHOUT_TTY" || [ -t 1 ] || color=
 201
 202 if [ -n "$color" ] && [ "$ORIGINAL_TERM" != 'dumb' ] && (
 203                 TERM=$ORIGINAL_TERM &&
 204                 export TERM &&
 205                 tput bold
 206                 tput setaf
 207                 tput sgr0
 208         ) >/dev/null 2>&1
 209 then
 210         color=t
 211 else
 212         color=
 213 fi
 214
 215 if test -n "$color"; then
 216         say_color () {
 217                 (
 218                 TERM=$ORIGINAL_TERM
 219                 export TERM
 220                 case "$1" in
 221                         error) tput bold; tput setaf 1;; # bold red
 222                         skip)  tput bold; tput setaf 2;; # bold green
 223                         pass)  tput setaf 2;;            # green
 224                         info)  tput setaf 3;;            # brown
 225                         *) test -n "$quiet" && return;;
 226                 esac
 227                 shift
 228                 printf " "
 229                 printf "$@"
 230                 tput sgr0
 231                 print_subtest
 232                 )
 233         }
 234 else
 235         say_color() {
 236                 test -z "$1" && test -n "$quiet" && return
 237                 shift
 238                 printf " "
 239                 printf "$@"
 240                 print_subtest
 241         }
 242 fi
 243
 244 error () {
 245         say_color error "error: $*\n"
 246         GIT_EXIT_OK=t
 247         exit 1
 248 }
 249
 250 say () {
 251         say_color info "$*"
 252 }
 253
 254 test "${test_description}" != "" ||
 255 error "Test script did not set test_description."
 256
 257 if test "$help" = "t"
 258 then
 259         echo "Tests ${test_description}"
 260         exit 0
 261 fi
 262
 263 test_description_printed=
 264 print_test_description ()
 265 {
 266         test -z "$test_description_printed" || return 0
 267         echo
 268         echo $this_test: "Testing ${test_description}"
 269         test_description_printed=1
 270 }
 271 if [ -z "$NOTMUCH_TEST_QUIET" ]
 272 then
 273         print_test_description
 274 fi
 275
 276 test_failure=0
 277 test_count=0
 278 test_fixed=0
 279 test_broken=0
 280 test_success=0
 281
 282 declare -a _exit_functions=()
 283
 284 at_exit_function () {
 285         _exit_functions=($1 ${_exit_functions[@]/$1})
 286 }
 287
 288 rm_exit_function () {
 289         _exit_functions=(${_exit_functions[@]/$1})
 290 }
 291
 292 _exit_common () {
 293         code=$?
 294         trap - EXIT
 295         set +ex
 296         for _fn in ${_exit_functions[@]}; do $_fn; done
 297         rm -rf "$TEST_TMPDIR"
 298 }
 299
 300 trap_exit () {
 301         _exit_common
 302         if test -n "$GIT_EXIT_OK"
 303         then
 304                 exit $code
 305         else
 306                 exec >&6
 307                 say_color error '%-6s' FATAL
 308                 echo " $test_subtest_name"
 309                 echo
 310                 echo "Unexpected exit while executing $0. Exit code $code."
 311                 exit 1
 312         fi
 313 }
 314
 315 trap_signal () {
 316         _exit_common
 317         echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))
 318         exit $code
 319 }
 320
 321 die () {
 322         _exit_common
 323         exec >&6
 324         say_color error '%-6s' FATAL
 325         echo " $*"
 326         echo
 327         echo "Unexpected exit while executing $0."
 328         exit 1
 329 }
 330
 331 GIT_EXIT_OK=
 332 # Note: TEST_TMPDIR *NOT* exported!
 333 TEST_TMPDIR=$(mktemp -d "${TMPDIR:-/tmp}/notmuch-test-$$.XXXXXX")
 334 # Put GNUPGHOME in TMPDIR to avoid problems with long paths.
 335 export GNUPGHOME="${TEST_TMPDIR}/gnupg"
 336 trap 'trap_exit' EXIT
 337 trap 'trap_signal' HUP INT TERM
 338
 339 # Deliver a message with emacs and add it to the database
 340 #
 341 # Uses emacs to generate and deliver a message to the mail store.
 342 # Accepts arbitrary extra emacs/elisp functions to modify the message
 343 # before sending, which is useful to doing things like attaching files
 344 # to the message and encrypting/signing.
 345 emacs_deliver_message ()
 346 {
 347     local subject body smtp_dummy_pid smtp_dummy_port
 348     subject="$1"
 349     body="$2"
 350     shift 2
 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     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
 358
 359     test_emacs \
 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}\"))
 364            (notmuch-mua-mail)
 365            (message-goto-to)
 366            (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
 367            (message-goto-subject)
 368            (insert \"${subject}\")
 369            (message-goto-body)
 370            (insert \"${body}\")
 371            $*
 372            (notmuch-mua-send-and-exit))"
 373
 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
 379 }
 380
 381 # Pretend to deliver a message with emacs. Really save it to a file
 382 # and add it to the database
 383 #
 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.
 388 #
 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
 392 emacs_fcc_message ()
 393 {
 394     local nmn_args subject body
 395     nmn_args=''
 396     while [[ "$1" =~ ^-- ]]; do
 397         nmn_args="$nmn_args $1"
 398         shift
 399     done
 400     subject="$1"
 401     body="$2"
 402     shift 2
 403     # before we can send a message, we have to prepare the FCC maildir
 404     mkdir -p "$MAIL_DIR"/sent/{cur,new,tmp}
 405
 406     test_emacs \
 407         "(let ((message-send-mail-function (lambda () t))
 408                (mail-host-address \"example.com\"))
 409            (notmuch-mua-mail)
 410            (message-goto-to)
 411            (insert \"test_suite@notmuchmail.org\nDate: 01 Jan 2000 12:00:00 -0000\")
 412            (message-goto-subject)
 413            (insert \"${subject}\")
 414            (message-goto-body)
 415            (insert \"${body}\")
 416            $*
 417            (let ((mml-secure-smime-sign-with-sender t)
 418                  (mml-secure-openpgp-sign-with-sender t))
 419              (notmuch-mua-send-and-exit)))" || return 1
 420     notmuch new $nmn_args >/dev/null
 421 }
 422
 423 # Add an existing, fixed corpus of email to the database.
 424 #
 425 # $1 is the corpus dir under corpora to add, using "default" if unset.
 426 #
 427 # The default corpus is based on about 50 messages from early in the
 428 # history of the notmuch mailing list, which allows for reliably
 429 # testing commands that need to operate on a not-totally-trivial
 430 # number of messages.
 431 add_email_corpus ()
 432 {
 433     local corpus
 434     corpus=${1:-default}
 435
 436     rm -rf ${MAIL_DIR}
 437     cp -a $NOTMUCH_SRCDIR/test/corpora/$corpus ${MAIL_DIR}
 438     notmuch new >/dev/null || die "'notmuch new' failed while adding email corpus"
 439 }
 440
 441 test_begin_subtest ()
 442 {
 443     if [ -n "$inside_subtest" ]; then
 444         exec 1>&6 2>&7          # Restore stdout and stderr
 445         error "bug in test script: Missing test_expect_equal in ${BASH_SOURCE[1]}:${BASH_LINENO[0]}"
 446     fi
 447     test_subtest_name="$1"
 448     test_reset_state_
 449     # Redirect test output to the previously prepared file descriptors
 450     # 3 and 4 (see below)
 451     if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
 452     exec >&3 2>&4
 453     inside_subtest=t
 454 }
 455
 456 # Pass test if two arguments match
 457 #
 458 # Note: Unlike all other test_expect_* functions, this function does
 459 # not accept a test name. Instead, the caller should call
 460 # test_begin_subtest before calling this function in order to set the
 461 # name.
 462 test_expect_equal ()
 463 {
 464         local output expected testname
 465         exec 1>&6 2>&7          # Restore stdout and stderr
 466         if [ -z "$inside_subtest" ]; then
 467                 error "bug in the test script: test_expect_equal without test_begin_subtest"
 468         fi
 469         inside_subtest=
 470         test "$#" = 2 ||
 471         error "bug in the test script: not 2 parameters to test_expect_equal"
 472
 473         output="$1"
 474         expected="$2"
 475         if ! test_skip "$test_subtest_name"
 476         then
 477                 if [ "$output" = "$expected" ]; then
 478                         test_ok_
 479                 else
 480                         testname=$this_test.$test_count
 481                         echo "$expected" > $testname.expected
 482                         echo "$output" > $testname.output
 483                         test_failure_ "$(diff -u $testname.expected $testname.output)"
 484                 fi
 485     fi
 486 }
 487
 488 # Like test_expect_equal, but takes two filenames.
 489 test_expect_equal_file ()
 490 {
 491         local file1 file2 testname basename1 basename2
 492         exec 1>&6 2>&7          # Restore stdout and stderr
 493         if [ -z "$inside_subtest" ]; then
 494                 error "bug in the test script: test_expect_equal_file without test_begin_subtest"
 495         fi
 496         inside_subtest=
 497         test "$#" = 2 ||
 498         error "bug in the test script: not 2 parameters to test_expect_equal_file"
 499
 500         file1="$1"
 501         file2="$2"
 502         if ! test_skip "$test_subtest_name"
 503         then
 504                 if diff -q "$file1" "$file2" >/dev/null ; then
 505                         test_ok_
 506                 else
 507                         testname=$this_test.$test_count
 508                         basename1=`basename "$file1"`
 509                         basename2=`basename "$file2"`
 510                         cp "$file1" "$testname.$basename1"
 511                         cp "$file2" "$testname.$basename2"
 512                         test_failure_ "$(diff -u "$testname.$basename1" "$testname.$basename2")"
 513                 fi
 514     fi
 515 }
 516
 517 # Like test_expect_equal, but arguments are JSON expressions to be
 518 # canonicalized before diff'ing.  If an argument cannot be parsed, it
 519 # is used unchanged so that there's something to diff against.
 520 test_expect_equal_json () {
 521     local script output expected
 522     # The test suite forces LC_ALL=C, but this causes Python 3 to
 523     # decode stdin as ASCII.  We need to read JSON in UTF-8, so
 524     # override Python's stdio encoding defaults.
 525     script='import json, sys; json.dump(json.load(sys.stdin), sys.stdout, sort_keys=True, indent=4)'
 526     output=$(echo "$1" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
 527         || echo "$1")
 528     expected=$(echo "$2" | PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "$script" \
 529         || echo "$2")
 530     shift 2
 531     test_expect_equal "$output" "$expected" "$@"
 532 }
 533
 534 # Ensure that the argument is valid JSON data.
 535 test_valid_json () {
 536     PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c "import sys, json; json.load(sys.stdin)" <<<"$1"
 537     test_expect_equal "$?" 0
 538 }
 539
 540 # Sort the top-level list of JSON data from stdin.
 541 test_sort_json () {
 542     PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -c \
 543         "import sys, json; json.dump(sorted(json.load(sys.stdin)),sys.stdout)"
 544 }
 545
 546 # test for json objects:
 547 # read the source of test/json_check_nodes.py (or the output when
 548 # invoking it without arguments) for an explanation of the syntax.
 549 test_json_nodes () {
 550         local output
 551         exec 1>&6 2>&7          # Restore stdout and stderr
 552         if [ -z "$inside_subtest" ]; then
 553                 error "bug in the test script: test_json_eval without test_begin_subtest"
 554         fi
 555         inside_subtest=
 556         test "$#" > 0 ||
 557             error "bug in the test script: test_json_nodes needs at least 1 parameter"
 558
 559         if ! test_skip "$test_subtest_name"
 560         then
 561             output=$(PYTHONIOENCODING=utf-8 $NOTMUCH_PYTHON -B "$NOTMUCH_SRCDIR"/test/json_check_nodes.py "$@")
 562                 if [ "$?" = 0 ]
 563                 then
 564                         test_ok_
 565                 else
 566                         test_failure_ "$output"
 567                 fi
 568         fi
 569 }
 570
 571 test_emacs_expect_t () {
 572         local result
 573         test "$#" = 1 ||
 574         error "bug in the test script: not 1 parameter to test_emacs_expect_t"
 575         if [ -z "$inside_subtest" ]; then
 576                 error "bug in the test script: test_emacs_expect_t without test_begin_subtest"
 577         fi
 578
 579         # Run the test.
 580         if ! test_skip "$test_subtest_name"
 581         then
 582                 test_emacs "(notmuch-test-run $1)" >/dev/null
 583
 584                 # Restore state after the test.
 585                 exec 1>&6 2>&7          # Restore stdout and stderr
 586                 inside_subtest=
 587
 588                 # Report success/failure.
 589                 result=$(cat OUTPUT)
 590                 if [ "$result" = t ]
 591                 then
 592                         test_ok_
 593                 else
 594                         test_failure_ "${result}"
 595                 fi
 596         else
 597                 # Restore state after the (non) test.
 598                 exec 1>&6 2>&7          # Restore stdout and stderr
 599                 inside_subtest=
 600         fi
 601 }
 602
 603 NOTMUCH_NEW ()
 604 {
 605     notmuch new "${@}" | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
 606 }
 607
 608 NOTMUCH_DUMP_TAGS ()
 609 {
 610     # this relies on the default format being batch-tag, otherwise some tests will break
 611     notmuch dump --include=tags "${@}" | sed '/^#/d' | sort
 612 }
 613
 614 notmuch_drop_mail_headers ()
 615 {
 616     $NOTMUCH_PYTHON -c '
 617 import email, sys
 618 msg = email.message_from_file(sys.stdin)
 619 for hdr in sys.argv[1:]: del msg[hdr]
 620 print(msg.as_string(False))
 621 ' "$@"
 622 }
 623
 624 notmuch_exception_sanitize ()
 625 {
 626     perl -pe 's/(A Xapian exception occurred at .*[.]cc?):([0-9]*)/\1:XXX/'
 627 }
 628
 629 notmuch_search_sanitize ()
 630 {
 631     perl -pe 's/("?thread"?: ?)("?)................("?)/\1\2XXX\3/'
 632 }
 633
 634 notmuch_search_files_sanitize ()
 635 {
 636     notmuch_dir_sanitize
 637 }
 638
 639 notmuch_dir_sanitize ()
 640 {
 641     sed -e "s,$MAIL_DIR,MAIL_DIR," -e "s,${PWD},CWD,g" "$@"
 642 }
 643
 644 NOTMUCH_SHOW_FILENAME_SQUELCH='s,filename:.*/mail,filename:/XXX/mail,'
 645 notmuch_show_sanitize ()
 646 {
 647     sed -e "$NOTMUCH_SHOW_FILENAME_SQUELCH"
 648 }
 649 notmuch_show_sanitize_all ()
 650 {
 651     sed \
 652         -e 's| filename:.*| filename:XXXXX|' \
 653         -e 's| id:[^ ]* | id:XXXXX |' | \
 654         notmuch_date_sanitize
 655 }
 656
 657 notmuch_json_show_sanitize ()
 658 {
 659     sed \
 660         -e 's|"id": "[^"]*",|"id": "XXXXX",|g' \
 661         -e 's|"Date": "Fri, 05 Jan 2001 [^"]*0000"|"Date": "GENERATED_DATE"|g' \
 662         -e 's|"filename": "signature.asc",||g' \
 663         -e 's|"filename": \["/[^"]*"\],|"filename": \["YYYYY"\],|g' \
 664         -e 's|"timestamp": 97.......|"timestamp": 42|g' \
 665         -e 's|"content-length": [1-9][0-9]*|"content-length": "NONZERO"|g'
 666 }
 667
 668 notmuch_emacs_error_sanitize ()
 669 {
 670     local command
 671     command=$1
 672     shift
 673     for file in "$@"; do
 674         echo "=== $file ==="
 675         cat "$file"
 676     done | sed \
 677         -e 's/^\[.*\]$/[XXX]/' \
 678         -e "s|^\(command: \)\{0,1\}/.*/$command|\1YYY/$command|"
 679 }
 680
 681 notmuch_date_sanitize ()
 682 {
 683     sed \
 684         -e 's/^Date: Fri, 05 Jan 2001 .*0000/Date: GENERATED_DATE/'
 685 }
 686
 687 notmuch_uuid_sanitize ()
 688 {
 689     sed 's/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/UUID/g'
 690 }
 691
 692 notmuch_built_with_sanitize ()
 693 {
 694     sed 's/^built_with[.]\(.*\)=.*$/built_with.\1=something/'
 695 }
 696
 697 notmuch_passwd_sanitize ()
 698 {
 699     local user=$(id -un)
 700     local full_name=$(getent passwd $user | cut -d: -f 5 | cut -d, -f1)
 701     sed "s/$full_name/USER_FULL_NAME/"
 702 }
 703
 704 notmuch_config_sanitize ()
 705 {
 706     notmuch_dir_sanitize | notmuch_built_with_sanitize
 707 }
 708
 709 notmuch_show_part ()
 710 {
 711     awk '/^\014part}/{ f=0 }; { if (f) { print $0 } } /^\014part{ ID: '"$1"'/{ f=1 }'
 712 }
 713
 714 # End of notmuch helper functions
 715
 716 # Use test_set_prereq to tell that a particular prerequisite is available.
 717 #
 718 # The prerequisite can later be checked for by using test_have_prereq.
 719 #
 720 # The single parameter is the prerequisite tag (a simple word, in all
 721 # capital letters by convention).
 722
 723 test_set_prereq () {
 724         satisfied="$satisfied$1 "
 725 }
 726 satisfied=" "
 727
 728 test_have_prereq () {
 729         case $satisfied in
 730         *" $1 "*)
 731                 : yes, have it ;;
 732         *)
 733                 ! : nope ;;
 734         esac
 735 }
 736
 737 declare -A test_missing_external_prereq_
 738 declare -A test_subtest_missing_external_prereq_
 739
 740 # declare prerequisite for the given external binary
 741 test_declare_external_prereq () {
 742         local binary
 743         binary="$1"
 744         test "$#" = 2 && name=$2 || name="$binary(1)"
 745
 746         if ! hash $binary 2>/dev/null; then
 747                 test_missing_external_prereq_["${binary}"]=t
 748                 eval "
 749 $binary () {
 750         test_subtest_missing_external_prereq_[\"${name}\"]=t
 751         false
 752 }"
 753         fi
 754 }
 755
 756 # Explicitly require external prerequisite.  Useful when binary is
 757 # called indirectly (e.g. from emacs).
 758 # Returns success if dependency is available, failure otherwise.
 759 test_require_external_prereq () {
 760         local binary
 761         binary="$1"
 762         if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then
 763                 # dependency is missing, call the replacement function to note it
 764                 eval "$binary"
 765         else
 766                 true
 767         fi
 768 }
 769
 770 # You are not expected to call test_ok_ and test_failure_ directly, use
 771 # the text_expect_* functions instead.
 772
 773 test_ok_ () {
 774         if test "$test_subtest_known_broken_" = "t"; then
 775                 test_known_broken_ok_
 776                 return
 777         fi
 778         test_success=$(($test_success + 1))
 779         if test -n "$NOTMUCH_TEST_QUIET"; then
 780                 return 0
 781         fi
 782         say_color pass "%-6s" "PASS"
 783         echo " $test_subtest_name"
 784 }
 785
 786 test_failure_ () {
 787         print_test_description
 788         if test "$test_subtest_known_broken_" = "t"; then
 789                 test_known_broken_failure_ "$@"
 790                 return
 791         fi
 792         test_failure=$(($test_failure + 1))
 793         test_failure_message_ "FAIL" "$test_subtest_name" "$@"
 794         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 795         return 1
 796 }
 797
 798 test_failure_message_ () {
 799         say_color error "%-6s" "$1"
 800         echo " $2"
 801         shift 2
 802         if [ "$#" != "0" ]; then
 803                 echo "$@" | sed -e 's/^/        /'
 804         fi
 805         if test "$verbose" != "t"; then cat test.output; fi
 806 }
 807
 808 test_known_broken_ok_ () {
 809         test_reset_state_
 810         test_fixed=$(($test_fixed+1))
 811         say_color pass "%-6s" "FIXED"
 812         echo " $test_subtest_name"
 813 }
 814
 815 test_known_broken_failure_ () {
 816         test_reset_state_
 817         test_broken=$(($test_broken+1))
 818         if [ -z "$NOTMUCH_TEST_QUIET" ]; then
 819                 test_failure_message_ "BROKEN" "$test_subtest_name" "$@"
 820         else
 821                 test_failure_message_ "BROKEN" "$test_subtest_name"
 822         fi
 823         return 1
 824 }
 825
 826 test_debug () {
 827         test "$debug" = "" || eval "$1"
 828 }
 829
 830 test_run_ () {
 831         test_cleanup=:
 832         if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
 833         eval >&3 2>&4 "$1"
 834         eval_ret=$?
 835         eval >&3 2>&4 "$test_cleanup"
 836         return 0
 837 }
 838
 839 test_skip () {
 840         test_count=$(($test_count+1))
 841         to_skip=
 842         for skp in $NOTMUCH_SKIP_TESTS
 843         do
 844                 case $this_test.$test_count in
 845                 $skp)
 846                         to_skip=t
 847                         break
 848                 esac
 849                 case $this_test_bare.$test_count in
 850                 $skp)
 851                         to_skip=t
 852                         break
 853                 esac
 854         done
 855         case "$to_skip" in
 856         t)
 857                 test_report_skip_ "$@"
 858                 ;;
 859         *)
 860                 test_check_missing_external_prereqs_ "$@"
 861                 ;;
 862         esac
 863 }
 864
 865 test_check_missing_external_prereqs_ () {
 866         if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then
 867                 say_color skip >&1 "missing prerequisites: "
 868                 echo ${!test_subtest_missing_external_prereq_[@]} >&1
 869                 test_report_skip_ "$@"
 870         else
 871                 false
 872         fi
 873 }
 874
 875 test_report_skip_ () {
 876         test_reset_state_
 877         say_color skip >&3 "skipping test:"
 878         echo " $@" >&3
 879         say_color skip "%-6s" "SKIP"
 880         echo " $1"
 881 }
 882
 883 test_subtest_known_broken () {
 884         test_subtest_known_broken_=t
 885 }
 886
 887 test_expect_success () {
 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_success without test_begin_subtest"
 891         fi
 892         inside_subtest=
 893         test "$#" = 1 ||
 894         error "bug in the test script: not 1 parameters to test_expect_success"
 895
 896         if ! test_skip "$test_subtest_name"
 897         then
 898                 test_run_ "$1"
 899                 run_ret="$?"
 900                 # test_run_ may update missing external prerequisites
 901                 test_check_missing_external_prereqs_ "$@" ||
 902                 if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]
 903                 then
 904                         test_ok_
 905                 else
 906                         test_failure_ "$1"
 907                 fi
 908         fi
 909 }
 910
 911 test_expect_code () {
 912         exec 1>&6 2>&7          # Restore stdout and stderr
 913         if [ -z "$inside_subtest" ]; then
 914                 error "bug in the test script: test_expect_code without test_begin_subtest"
 915         fi
 916         inside_subtest=
 917         test "$#" = 2 ||
 918         error "bug in the test script: not 2 parameters to test_expect_code"
 919
 920         if ! test_skip "$test_subtest_name"
 921         then
 922                 test_run_ "$2"
 923                 run_ret="$?"
 924                 # test_run_ may update missing external prerequisites,
 925                 test_check_missing_external_prereqs_ "$@" ||
 926                 if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]
 927                 then
 928                         test_ok_
 929                 else
 930                         test_failure_ "exit code $eval_ret, expected $1" "$2"
 931                 fi
 932         fi
 933 }
 934
 935 # This is not among top-level (test_expect_success)
 936 # but is a prefix that can be used in the test script, like:
 937 #
 938 #       test_expect_success 'complain and die' '
 939 #           do something &&
 940 #           do something else &&
 941 #           test_must_fail git checkout ../outerspace
 942 #       '
 943 #
 944 # Writing this as "! git checkout ../outerspace" is wrong, because
 945 # the failure could be due to a segv.  We want a controlled failure.
 946
 947 test_must_fail () {
 948         "$@"
 949         test $? -gt 0 -a $? -le 129 -o $? -gt 192
 950 }
 951
 952 # test_cmp is a helper function to compare actual and expected output.
 953 # You can use it like:
 954 #
 955 #       test_expect_success 'foo works' '
 956 #               echo expected >expected &&
 957 #               foo >actual &&
 958 #               test_cmp expected actual
 959 #       '
 960 #
 961 # This could be written as either "cmp" or "diff -u", but:
 962 # - cmp's output is not nearly as easy to read as diff -u
 963 # - not all diff versions understand "-u"
 964
 965 test_cmp() {
 966         $GIT_TEST_CMP "$@"
 967 }
 968
 969 # This function can be used to schedule some commands to be run
 970 # unconditionally at the end of the test to restore sanity:
 971 #
 972 #       test_expect_success 'test core.capslock' '
 973 #               git config core.capslock true &&
 974 #               test_when_finished "git config --unset core.capslock" &&
 975 #               hello world
 976 #       '
 977 #
 978 # That would be roughly equivalent to
 979 #
 980 #       test_expect_success 'test core.capslock' '
 981 #               git config core.capslock true &&
 982 #               hello world
 983 #               git config --unset core.capslock
 984 #       '
 985 #
 986 # except that the greeting and config --unset must both succeed for
 987 # the test to pass.
 988
 989 test_when_finished () {
 990         test_cleanup="{ $*
 991                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
 992 }
 993
 994 test_done () {
 995         GIT_EXIT_OK=t
 996         test_results_dir="$TEST_DIRECTORY/test-results"
 997         mkdir -p "$test_results_dir"
 998         test_results_path="$test_results_dir/$this_test"
 999
1000         echo "total $test_count" >> $test_results_path
1001         echo "success $test_success" >> $test_results_path
1002         echo "fixed $test_fixed" >> $test_results_path
1003         echo "broken $test_broken" >> $test_results_path
1004         echo "failed $test_failure" >> $test_results_path
1005         echo "" >> $test_results_path
1006
1007         [ -n "$EMACS_SERVER" ] && test_emacs '(kill-emacs)'
1008
1009         if [ "$test_failure" = "0" ]; then
1010             if [ "$test_broken" = "0" ]; then
1011                 rm -rf "$remove_tmp"
1012             fi
1013             exit 0
1014         else
1015             exit 1
1016         fi
1017 }
1018
1019 emacs_generate_script () {
1020         # Construct a little test script here for the benefit of the user,
1021         # (who can easily run "run_emacs" to get the same emacs environment
1022         # for investigating any failures).
1023         cat <<EOF >"$TMP_DIRECTORY/run_emacs"
1024 #!/bin/sh
1025 export PATH=$PATH
1026 export NOTMUCH_CONFIG=$NOTMUCH_CONFIG
1027
1028 # Here's what we are using here:
1029 #
1030 # --quick               Use minimal customization. This implies --no-init-file,
1031 #                       --no-site-file and (emacs 24) --no-site-lisp
1032 #
1033 # --directory           Ensure that the local elisp sources are found
1034 #
1035 # --load                Force loading of notmuch.el and test-lib.el
1036
1037 exec ${TEST_EMACS} --quick \
1038         --directory "$NOTMUCH_BUILDDIR/emacs" --load notmuch.el \
1039         --directory "$NOTMUCH_SRCDIR/test" --load test-lib.el \
1040         "\$@"
1041 EOF
1042         chmod a+x "$TMP_DIRECTORY/run_emacs"
1043 }
1044
1045 test_emacs () {
1046         # test dependencies beforehand to avoid the waiting loop below
1047         missing_dependencies=
1048         test_require_external_prereq dtach || missing_dependencies=1
1049         test_require_external_prereq emacs || missing_dependencies=1
1050         test_require_external_prereq ${TEST_EMACSCLIENT} || missing_dependencies=1
1051         test -z "$missing_dependencies" || return
1052
1053         if [ -z "$EMACS_SERVER" ]; then
1054                 emacs_tests="$NOTMUCH_SRCDIR/test/${this_test_bare}.el"
1055                 if [ -f "$emacs_tests" ]; then
1056                         load_emacs_tests="--eval '(load \"$emacs_tests\")'"
1057                 else
1058                         load_emacs_tests=
1059                 fi
1060                 server_name="notmuch-test-suite-$$"
1061                 # start a detached session with an emacs server
1062                 # user's TERM (or 'vt100' in case user's TERM is known dumb
1063                 # or unknown) is given to dtach which assumes a minimally
1064                 # VT100-compatible terminal -- and emacs inherits that
1065                 TERM=$SMART_TERM dtach -n "$TEST_TMPDIR/emacs-dtach-socket.$$" \
1066                         sh -c "stty rows 24 cols 80; exec '$TMP_DIRECTORY/run_emacs' \
1067                                 --no-window-system \
1068                                 $load_emacs_tests \
1069                                 --eval '(setq server-name \"$server_name\")' \
1070                                 --eval '(server-start)' \
1071                                 --eval '(orphan-watchdog $$)'" || return
1072                 EMACS_SERVER="$server_name"
1073                 # wait until the emacs server is up
1074                 until test_emacs '()' >/dev/null 2>/dev/null; do
1075                         sleep 1
1076                 done
1077         fi
1078
1079         # Clear test-output output file.  Most Emacs tests end with a
1080         # call to (test-output).  If the test code fails with an
1081         # exception before this call, the output file won't get
1082         # updated.  Since we don't want to compare against an output
1083         # file from another test, so start out with an empty file.
1084         rm -f OUTPUT
1085         touch OUTPUT
1086
1087         ${TEST_EMACSCLIENT} --socket-name="$EMACS_SERVER" --eval "(notmuch-test-progn $*)"
1088 }
1089
1090 test_python() {
1091     # Note: if there is need to print debug information from python program,
1092     # use stdout = os.fdopen(6, 'w') or stderr = os.fdopen(7, 'w')
1093     PYTHONPATH="$NOTMUCH_SRCDIR/bindings/python${PYTHONPATH:+:$PYTHONPATH}" \
1094         $NOTMUCH_PYTHON -B - > OUTPUT
1095 }
1096
1097 test_ruby() {
1098     MAIL_DIR=$MAIL_DIR $NOTMUCH_RUBY -I "$NOTMUCH_BUILDDIR/bindings/ruby"> OUTPUT
1099 }
1100
1101 test_C () {
1102     local exec_file test_file
1103     exec_file="test${test_count}"
1104     test_file="${exec_file}.c"
1105     cat > ${test_file}
1106     ${TEST_CC} ${TEST_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${exec_file} ${test_file} -L${NOTMUCH_BUILDDIR}/lib/ -lnotmuch -ltalloc
1107     echo "== stdout ==" > OUTPUT.stdout
1108     echo "== stderr ==" > OUTPUT.stderr
1109     ./${exec_file} "$@" 1>>OUTPUT.stdout 2>>OUTPUT.stderr
1110     notmuch_dir_sanitize OUTPUT.stdout OUTPUT.stderr | notmuch_exception_sanitize > OUTPUT
1111 }
1112
1113 make_shim () {
1114     local base_name test_file shim_file
1115     base_name="$1"
1116     test_file="${base_name}.c"
1117     shim_file="${base_name}.so"
1118     cat > ${test_file}
1119     ${TEST_CC} ${TEST_CFLAGS} ${TEST_SHIM_CFLAGS} -I${NOTMUCH_SRCDIR}/test -I${NOTMUCH_SRCDIR}/lib -o ${shim_file} ${test_file} ${TEST_SHIM_LDFLAGS}
1120 }
1121
1122 notmuch_with_shim () {
1123     local base_name shim_file
1124     base_name="$1"
1125     shift
1126     shim_file="${base_name}.so"
1127     LD_PRELOAD=./${shim_file}${LD_PRELOAD:+:$LD_PRELOAD} notmuch-shared "$@"
1128 }
1129
1130 # Creates a script that counts how much time it is executed and calls
1131 # notmuch.  $notmuch_counter_command is set to the path to the
1132 # generated script.  Use notmuch_counter_value() function to get the
1133 # current counter value.
1134 notmuch_counter_reset () {
1135         notmuch_counter_command="$TMP_DIRECTORY/notmuch_counter"
1136         if [ ! -x "$notmuch_counter_command" ]; then
1137                 notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
1138                 cat >"$notmuch_counter_command" <<EOF || return
1139 #!/bin/sh
1140
1141 read count < "$notmuch_counter_state_path"
1142 echo \$((count + 1)) > "$notmuch_counter_state_path"
1143
1144 exec notmuch "\$@"
1145 EOF
1146                 chmod +x "$notmuch_counter_command" || return
1147         fi
1148
1149         echo 0 > "$notmuch_counter_state_path"
1150 }
1151
1152 # Returns the current notmuch counter value.
1153 notmuch_counter_value () {
1154         if [ -r "$notmuch_counter_state_path" ]; then
1155                 read count < "$notmuch_counter_state_path"
1156         else
1157                 count=0
1158         fi
1159         echo $count
1160 }
1161
1162 test_reset_state_ () {
1163         test -z "$test_init_done_" && test_init_
1164
1165         test_subtest_known_broken_=
1166         test_subtest_missing_external_prereq_=()
1167 }
1168
1169 # called once before the first subtest
1170 test_init_ () {
1171         test_init_done_=t
1172
1173         # skip all tests if there were external prerequisites missing during init
1174         test_check_missing_external_prereqs_ "all tests in $this_test" && test_done
1175 }
1176
1177
1178 # Where to run the tests
1179 TEST_DIRECTORY=$NOTMUCH_BUILDDIR/test
1180
1181 . "$NOTMUCH_SRCDIR/test/test-lib-common.sh" || exit 1
1182
1183 emacs_generate_script
1184
1185
1186 # Use -P to resolve symlinks in our working directory so that the cwd
1187 # in subprocesses like git equals our $PWD (for pathname comparisons).
1188 cd -P "$TMP_DIRECTORY" || error "Cannot set up test environment"
1189
1190 if test "$verbose" = "t"
1191 then
1192         exec 4>&2 3>&1
1193 else
1194         exec 4>test.output 3>&4
1195 fi
1196
1197 for skp in $NOTMUCH_SKIP_TESTS
1198 do
1199         to_skip=
1200         for skp in $NOTMUCH_SKIP_TESTS
1201         do
1202                 case "$this_test" in
1203                 $skp)
1204                         to_skip=t
1205                         break
1206                 esac
1207                 case "$this_test_bare" in
1208                 $skp)
1209                         to_skip=t
1210                         break
1211                 esac
1212         done
1213         case "$to_skip" in
1214         t)
1215                 say_color skip >&3 "skipping test $this_test altogether"
1216                 say_color skip "skip all tests in $this_test"
1217                 test_done
1218         esac
1219 done
1220
1221 # Provide an implementation of the 'yes' utility
1222 yes () {
1223         if test $# = 0
1224         then
1225                 y=y
1226         else
1227                 y="$*"
1228         fi
1229
1230         while echo "$y"
1231         do
1232                 :
1233         done
1234 }
1235
1236 # Fix some commands on Windows
1237 case $(uname -s) in
1238 *MINGW*)
1239         # Windows has its own (incompatible) sort and find
1240         sort () {
1241                 /usr/bin/sort "$@"
1242         }
1243         find () {
1244                 /usr/bin/find "$@"
1245         }
1246         sum () {
1247                 md5sum "$@"
1248         }
1249         # git sees Windows-style pwd
1250         pwd () {
1251                 builtin pwd -W
1252         }
1253         # no POSIX permissions
1254         # backslashes in pathspec are converted to '/'
1255         # exec does not inherit the PID
1256         ;;
1257 *)
1258         test_set_prereq POSIXPERM
1259         test_set_prereq BSLASHPSPEC
1260         test_set_prereq EXECKEEPSPID
1261         ;;
1262 esac
1263
1264 test -z "$NO_PERL" && test_set_prereq PERL
1265 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1266
1267 # test whether the filesystem supports symbolic links
1268 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1269 rm -f y
1270
1271 # declare prerequisites for external binaries used in tests
1272 test_declare_external_prereq dtach
1273 test_declare_external_prereq emacs
1274 test_declare_external_prereq ${TEST_EMACSCLIENT}
1275 test_declare_external_prereq ${TEST_GDB}
1276 test_declare_external_prereq gpg
1277 test_declare_external_prereq openssl
1278 test_declare_external_prereq gpgsm
1279 test_declare_external_prereq ${NOTMUCH_PYTHON}
1280 test_declare_external_prereq xapian-metadata
1281 test_declare_external_prereq xapian-delve