]> git.notmuchmail.org Git - notmuch/blobdiff - test/test-lib.sh
test: Remove basic testing of broken, fixed, and skipped tests.
[notmuch] / test / test-lib.sh
index 7684c2e7ca03ed580fb00bab34d44e7157e441ee..152387051061f19a7e6670d70cfc0f2c01ea4256 100644 (file)
@@ -130,16 +130,17 @@ if test -n "$color"; then
                        *) test -n "$quiet" && return;;
                esac
                shift
-               printf "* %s" "$*"
+               printf " "
+                printf "$@"
                tput sgr0
-               echo
                )
        }
 else
        say_color() {
                test -z "$1" && test -n "$quiet" && return
                shift
-               echo "* $*"
+               printf " "
+                printf "$@"
        }
 fi
 
@@ -158,10 +159,12 @@ error "Test script did not set test_description."
 
 if test "$help" = "t"
 then
-       echo "$test_description"
+       echo "Tests ${test_description}"
        exit 0
 fi
 
+echo "Testing ${test_description}"
+
 exec 5>&1
 if test "$verbose" = "t"
 then
@@ -221,10 +224,10 @@ remove_cr () {
 increment_mtime_amount=0
 increment_mtime ()
 {
-    dir=$1
+    dir="$1"
 
     increment_mtime_amount=$((increment_mtime_amount + 1))
-    touch -d "+${increment_mtime_amount} seconds" $dir
+    touch -d "+${increment_mtime_amount} seconds" "$dir"
 }
 
 # Generate a new message in the mail directory, with a unique message
@@ -291,7 +294,7 @@ generate_message ()
        gen_msg_filename="${MAIL_DIR}/$gen_msg_name"
     else
        gen_msg_filename="${MAIL_DIR}/${template[dir]}/$gen_msg_name"
-       mkdir -p $(dirname $gen_msg_filename)
+       mkdir -p "$(dirname "$gen_msg_filename")"
     fi
 
     if [ -z "${template[body]}" ]; then
@@ -311,7 +314,7 @@ generate_message ()
     fi
 
     if [ -z "${template[date]}" ]; then
-       template[date]="Tue, 05 Jan 2001 15:43:57 -0800"
+       template[date]="Tue, 05 Jan 2001 15:43:57 -0000"
     fi
 
     additional_headers=""
@@ -346,7 +349,7 @@ ${additional_headers}"
     fi
 
 
-cat <<EOF >$gen_msg_filename
+cat <<EOF >"$gen_msg_filename"
 From: ${template[from]}
 To: ${template[to]}
 Message-Id: <${gen_msg_id}>
@@ -357,7 +360,7 @@ ${template[body]}
 EOF
 
     # Ensure that the mtime of the containing directory is updated
-    increment_mtime $(dirname ${gen_msg_filename})
+    increment_mtime "$(dirname "${gen_msg_filename}")"
 }
 
 # Generate a new message and add it to the index.
@@ -366,41 +369,52 @@ EOF
 # are also supported here, so see that function for details.
 add_message ()
 {
-    generate_message "$@"
-
-    $NOTMUCH new > /dev/null
+    generate_message "$@" &&
+    notmuch new > /dev/null
 }
 
-tests=0
-test_failures=0
-
-pass_if_equal ()
+test_begin_subtest ()
 {
-    output=$1
-    expected=$2
+    test_subtest_name="$1"
+}
 
-    tests=$((tests + 1))
+# Pass test if two arguments match
+#
+# Note: Unlike all other test_expect_* functions, this function does
+# not accept a test name. Instead, the caller should call
+# test_begin_subtest before calling this function in order to set the
+# name.
+test_expect_equal ()
+{
+       test "$#" = 3 && { prereq=$1; shift; } || prereq=
+       test "$#" = 2 ||
+       error "bug in the test script: not 2 or 3 parameters to test_expect_equal"
 
-    if [ "$output" = "$expected" ]; then
-       echo "  PASS"
-    else
-       echo "  FAIL"
-       testname=test-$(printf "%03d" $tests)
-       echo "$expected" > $testname.expected
-       echo "$output" > $testname.output
-       diff -u $testname.expected $testname.output || true
-       test_failures=$((test_failures + 1))
+       output="$1"
+       expected="$2"
+       if ! test_skip "$@"
+       then
+               say >&3 "expecting success: diff $output $expected"
+               if [ "$output" = "$expected" ]; then
+                       test_ok_ "$test_subtest_name"
+               else
+                       testname=$this_test.$test_count
+                       echo "$expected" > $testname.expected
+                       echo "$output" > $testname.output
+                       test_failure_ "$test_subtest_name" "$(diff -u $testname.expected $testname.output)"
+               fi
+               echo >&3 ""
     fi
 }
 
 TEST_DIR=$(pwd)/test.$$
 MAIL_DIR=${TEST_DIR}/mail
 export NOTMUCH_CONFIG=${TEST_DIR}/notmuch-config
-NOTMUCH=$(find_notmuch_binary $(pwd))
+NOTMUCH=notmuch
 
 NOTMUCH_NEW ()
 {
-    $NOTMUCH new | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
+    notmuch new | grep -v -E -e '^Processed [0-9]*( total)? file|Found [0-9]* total file'
 }
 
 notmuch_search_sanitize ()
@@ -446,12 +460,14 @@ test_have_prereq () {
 
 test_ok_ () {
        test_success=$(($test_success + 1))
-       say_color "" "  ok $test_count: $@"
+       say_color pass "%-6s" "PASS"
+       echo " $@"
 }
 
 test_failure_ () {
        test_failure=$(($test_failure + 1))
-       say_color error "FAIL $test_count: $1"
+       say_color error "%-6s" "FAIL"
+       echo " $1"
        shift
        echo "$@" | sed -e 's/^/        /'
        test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
@@ -459,12 +475,14 @@ test_failure_ () {
 
 test_known_broken_ok_ () {
        test_fixed=$(($test_fixed+1))
-       say_color "" "  FIXED $test_count: $@"
+       say_color pass "%-6s" "FIXED"
+       echo " $@"
 }
 
 test_known_broken_failure_ () {
        test_broken=$(($test_broken+1))
-       say_color skip "  still broken $test_count: $@"
+       say_color pass "%-6s" "BROKEN"
+       echo " $@"
 }
 
 test_debug () {
@@ -497,7 +515,8 @@ test_skip () {
        case "$to_skip" in
        t)
                say_color skip >&3 "skipping test: $@"
-               say_color skip "skip $test_count: $1"
+               say_color skip "%-6s" "SKIP"
+               echo " $1"
                : true
                ;;
        *)
@@ -691,32 +710,14 @@ test_done () {
        echo "failed $test_failure" >> $test_results_path
        echo "" >> $test_results_path
 
-       if test "$test_fixed" != 0
-       then
-               say_color pass "fixed $test_fixed known breakage(s)"
-       fi
-       if test "$test_broken" != 0
-       then
-               say_color error "still have $test_broken known breakage(s)"
-               msg="remaining $(($test_count-$test_broken)) test(s)"
+       echo
+
+       if [ "$test_failure" = "0" ]; then
+           rm -rf "$remove_tmp"
+           exit 0
        else
-               msg="$test_count test(s)"
+           exit 1
        fi
-       case "$test_failure" in
-       0)
-               say_color pass "passed all $msg"
-
-               test -d "$remove_trash" &&
-               cd "$(dirname "$remove_trash")" &&
-               rm -rf "$(basename "$remove_trash")"
-
-               exit 0 ;;
-
-       *)
-               say_color error "failed $test_failure among $msg"
-               exit 1 ;;
-
-       esac
 }
 
 find_notmuch_path ()
@@ -815,21 +816,21 @@ fi
 export PATH
 
 # Test repository
-test="trash directory.$(basename "$0" .sh)"
+test="tmp.$(basename "$0" .sh)"
 test -n "$root" && test="$root/$test"
 case "$test" in
-/*) TRASH_DIRECTORY="$test" ;;
- *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
+/*) TMP_DIRECTORY="$test" ;;
+ *) TMP_DIRECTORY="$TEST_DIRECTORY/$test" ;;
 esac
-test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
+test ! -z "$debug" || remove_tmp=$TMP_DIRECTORY
 rm -fr "$test" || {
        GIT_EXIT_OK=t
        echo >&5 "FATAL: Cannot prepare test area"
        exit 1
 }
 
-MAIL_DIR="${TRASH_DIRECTORY}/mail"
-export NOTMUCH_CONFIG="${TRASH_DIRECTORY}/notmuch-config"
+MAIL_DIR="${TMP_DIRECTORY}/mail"
+export NOTMUCH_CONFIG="${TMP_DIRECTORY}/notmuch-config"
 
 mkdir -p "${test}"
 mkdir "$MAIL_DIR"