path: root/ctdb/tests/scripts/run_tests

#!/bin/bash

usage() {
    cat <<EOF
Usage: run_tests [OPTIONS] [TESTS]

Options:
  -s		Print a summary of tests results after running all tests
  -l		Use local daemons for integration tests
  -e		Exit on the first test failure
  -V <dir>	Use <dir> as $TEST_VAR_DIR
  -C		Clean up - kill daemons and remove $TEST_VAR_DIR when done
  -v		Verbose - print test output for non-failures (only some tests)
  -A		Use "cat -A" to print test output (only some tests)
  -D		Show diff between failed/expected test output (some tests only)
  -X		Trace certain scripts run by tests using -x (only some tests)
  -d		Print descriptions of tests instead of filenames (dodgy!)
  -H		No headers - for running single test with other wrapper
  -q		Quiet - don't show tests being run (hint: use with -s)
  -x		Trace this script with the -x option
EOF
    exit 1
}

# Print a message and exit.
die ()
{
    echo "$1" >&2 ; exit ${2:-1}
}

######################################################################

with_summary=false
with_desc=false
quiet=false
exit_on_fail=false
no_header=false

export TEST_VERBOSE=false
export TEST_COMMAND_TRACE=false
export TEST_CAT_RESULTS_OPTS=""
export TEST_DIFF_RESULTS=false
export TEST_LOCAL_DAEMONS  # No default, developer can "override"!
export TEST_VAR_DIR=""
export TEST_CLEANUP=false

temp=$(getopt -n "$prog" -o "xdehlqsvV:XACDH" -l help -- "$@")

[ $? != 0 ] && usage

eval set -- "$temp"

while true ; do
    case "$1" in
	-x) set -x; shift ;;
	-d) with_desc=true ; shift ;;  # 4th line of output is description
	-e) exit_on_fail=true ; shift ;;
	-l) TEST_LOCAL_DAEMONS="3" ; shift ;;
	-q) quiet=true ; shift ;;
	-s) with_summary=true ; shift ;;
	-v) TEST_VERBOSE=true ; shift ;;
	-V) TEST_VAR_DIR="$2" ; shift 2 ;;
	-X) TEST_COMMAND_TRACE=true ; shift ;;
	-A) TEST_CAT_RESULTS_OPTS="-A" ; shift ;;
	-C) TEST_CLEANUP=true ; shift ;;
	-D) TEST_DIFF_RESULTS=true ; shift ;;
	-H) no_header=true ; shift ;;
	--) shift ; break ;;
	*) usage ;;
    esac
done

if $quiet ; then
    show_progress() { cat >/dev/null ; }
else
    show_progress() { cat ; }
fi

######################################################################

ctdb_test_begin ()
{
    local name="$1"

    teststarttime=$(date '+%s')
    testduration=0

    echo "--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--"
    echo "Running test $name ($(date '+%T'))"
    echo "--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--"
}

ctdb_test_end ()
{
    local name="$1" ; shift
    local status="$1" ; shift
    # "$@" is command-line

    local interp="SKIPPED"
    local statstr=" (reason $*)"
    if [ -n "$status" ] ; then
	if [ $status -eq 0 ] ; then
	    interp="PASSED"
	    statstr=""
	    echo "ALL OK: $*"
	else
	    interp="FAILED"
	    statstr=" (status $status)"
	fi
    fi

    testduration=$(($(date +%s)-$teststarttime))

    echo "=========================================================================="
    echo "TEST ${interp}: ${name}${statstr} (duration: ${testduration}s)"
    echo "=========================================================================="

}

ctdb_test_run ()
{
    local name="$1" ; shift

    [ -n "$1" ] || set -- "$name"

    $no_header || ctdb_test_begin "$name"

    local status=0
    "$@" || status=$?

    $no_header || ctdb_test_end "$name" "$status" "$*"

    return $status
}

######################################################################

tests_total=0
tests_passed=0
tests_failed=0
summary=""

rows=$(if tty -s ; then stty size ; else echo x 80 ; fi | sed -e 's@.* @@' -e 's@^0$@80@')
ww=$((rows - 7))

tf=$(mktemp)
sf=$(mktemp)

set -o pipefail

run_one_test ()
{
    _f="$1"

    [ -x "$_f" ] || die "test \"$_f\" is not executable"
    tests_total=$(($tests_total + 1))

    ctdb_test_run "$_f" | tee "$tf" | show_progress
    status=$?
    if $with_summary ; then
	if [ $status -eq 0 ] ; then
	    tests_passed=$(($tests_passed + 1))
	    _t=" PASSED "
	else
	    _t="*FAILED*"
	    tests_failed=$(($tests_failed + 1))
	fi
	if $with_desc ; then
	    desc=$(tail -n +4 $tf | head -n 1)
	    _f="$desc"
	fi
	echo "$_t $_f" >>"$sf"
    fi
}

find_and_run_one_test ()
{
    _t="$1"
    _dir="$2"

    _f="${_dir}${_dir:+/}${_t}"

    if [ -d "$_f" ] ; then
	for _i in $(ls "${_f%/}/"*".sh" 2>/dev/null) ; do
	    run_one_test "$_i"
	    if $exit_on_fail && [ $status -ne 0 ] ; then
		break
	    fi
	done
    elif [ -f "$_f" ] ; then
	run_one_test "$_f"
    else
	status=127
    fi
}

[ -n "$TEST_VAR_DIR" ] || TEST_VAR_DIR=$(mktemp -d)
mkdir -p "$TEST_VAR_DIR"
# Must be absolute
TEST_VAR_DIR=$(cd "$TEST_VAR_DIR"; echo "$PWD")
echo "TEST_VAR_DIR=$TEST_VAR_DIR"

export TEST_SCRIPTS_DIR=$(dirname "$0")

for f ; do
    find_and_run_one_test "$f"

    if [ $status -eq 127 ] ; then
	# Find the the top-level tests directory
	tests_dir=$(dirname $(cd $TEST_SCRIPTS_DIR; echo $PWD))
	# Strip off current directory from beginning, if there, just
	# to make paths more friendly.
	tests_dir=${tests_dir#$PWD/}
	find_and_run_one_test "$f" "$tests_dir"
    fi

    if [ $status -eq 127 ] ; then
	    die "test \"$f\" is not recognised"
    fi

    if $exit_on_fail && [ $status -ne 0 ] ; then
	    break
    fi
done

rm -f "$tf"

if $with_summary ; then
    echo
    cat "$sf"
    echo
    echo "${tests_passed}/${tests_total} tests passed"
fi

rm -f "$sf"

echo

if $TEST_CLEANUP ; then
    echo "Removing TEST_VAR_DIR=$TEST_VAR_DIR"
    rm -rf "$TEST_VAR_DIR"
else
    echo "Not cleaning up TEST_VAR_DIR=$TEST_VAR_DIR"
fi

if [ $tests_failed -gt 0 ] ; then
    if $no_header ; then
	exit $status
    else
	exit 1
    fi
fi