#!/bin/bash

# When running with "-v", the test itself runs in a pipeline with tee, and
# without pipefail we get the exit value from tee instead of from the test.
set -o pipefail

# The linuxcnc starter script sometimes tries to display X windows if
# DISPLAY is set.  We never want that while running tests, so unset it.
unset DISPLAY

# Some of our tests emit locale-sensitive strings, so reset the locale
# to a sane default.
export LC_ALL=C
export LANGUAGES=


case "$0" in
	*/*) MYDIR="${0%/*}" ;;
	*) MYDIR="`type -path $0`"; MYDIR="${MYDIR%/*}"
esac
MYDIR=$(cd $MYDIR; pwd);
TOPDIR=$(cd $MYDIR/..; pwd)

prefix=@prefix@
if test @RUN_IN_PLACE@ = yes; then
    . $TOPDIR/scripts/rip-environment >&/dev/null
    export HEADERS=@EMC2_HOME@/include
    export LIBDIR=${TOPDIR}/lib
    export REALTIME=realtime
else
    # Set $EMC2_HOME to $prefix for tests that depend on it
    export SYSTEM_BUILD=1
    export EMC2_HOME=@EMC2_HOME@
    export HEADERS=@includedir@/linuxcnc
    export LIBDIR=@EMC2_HOME@/lib
    export LINUXCNC_EMCSH=@WISH@
    export REALTIME=@REALTIME@
    export SUDO=sudo
fi
export PYTHON_CPPFLAGS="@PYTHON_CPPFLAGS@"
export PYTHON_EXTRA_LIBS="@PYTHON_EXTRA_LIBS@"
export PYTHON_EXTRA_LDFLAGS="@PYTHON_EXTRA_LDFLAGS@"
export PYTHON_LIBS="@PYTHON_EXTRA_LIBS@"

export RUNTESTS="$(readlink -f $0)"

NUM=0
FAIL=0; FAIL_NAMES=""
XFAIL=0
SKIP=0
VERBOSE=0

clean () {
    find $* \( -name "stderr" -or -name "result" \
	-or -name "*.var" -or -name "*.var.bak" \) \
	-print0 | xargs -0 rm -f
}

wait_for_result_close() {
    # Test for the 'result' and 'stderr' files in the current testdir to be
    # closed. The 'checkresult' script cannot be run if these files are still
    # in use and would cause a race condition.
    # This function should be called with the test's directory as CWD.
    presult="$(realpath -e -q "./result")"
    pstderr="$(realpath -e -q "./stderr")"
    if [ -z "$presult" ] || [ -z "$pstderr" ]; then
        echo "Internal error: Missing 'result' or 'stderr' in wait_for_result_close()"
        exit 2
    fi
    timeoutcnt=0
    while true; do
        lsof -- "$presult" > /dev/null 2>&1; resresult=$?
        lsof -- "$pstderr" > /dev/null 2>&1; resstderr=$?
        if [ $resresult -ne 0 ] && [ $resstderr -ne 0 ]; then
            # Neither 'result' nor 'stderr' are open anymore
            break
        fi
        if [ $timeoutcnt -ge 30 ]; then
            if [ $resresult -eq 0 ]; then
                echo "*** Timeout waiting for 'result' file to close"
            fi
            if [ $resstderr -eq 0 ]; then
                echo "*** Timeout waiting for 'stderr' file to close"
            fi
            echo "*** Test results may be invalid when checked."
            return 1
        fi
        sleep 1
        timeoutcnt=$((timeoutcnt + 1))
    done
    return 0
}

run_shell_script () {
    testname=$(basename $1)
    testdir=$(dirname $1)

    pushd $testdir > /dev/null
    if [ $VERBOSE -eq 1 ]; then
        (bash -x $testname | tee result) 3>&1 1>&2 2>&3 | tee stderr
    else
        bash -x $testname > result 2> stderr
    fi
    exitcode=$?
    wait_for_result_close
    popd > /dev/null || exit 2
    return "$exitcode"
}

run_executable () {
    testname=$(basename $1)
    testdir=$(dirname $1)

    pushd $testdir > /dev/null
    if [ $VERBOSE -eq 1 ]; then
        (./$testname | tee result) 3>&1 1>&2 2>&3 | tee stderr
    else
        ./$testname > result 2> stderr
    fi
    exitcode=$?
    wait_for_result_close
    popd > /dev/null || exit 2
    return "$exitcode"
}

run_without_overruns () {
    testname=$(basename $1)
    testdir=$(dirname $1)
    for i in $(seq 10); do
        if [ $i != 1 ]; then echo "--- $testdir: overrun detected in sampler, re-running test" 1>&2 ; fi

        pushd $testdir > /dev/null
        if [ $VERBOSE -eq 1 ]; then
            (halrun -f $testname | tee result) 3>&1 1>&2 2>&3 | tee stderr
        else
            halrun -f $testname > result 2> stderr
        fi
        exitcode=$?
        wait_for_result_close
        popd > /dev/null || exit 2

        if ! grep -q '^overrun$' $testdir/result; then return $exitcode; fi
    done
    echo "--- $testdir: $i overruns detected, giving up" 1>&2
    return 1
}

run_test() {
    testname=$1
    case $testname in
        *.hal) run_without_overruns $testname ;;
        *.sh) run_shell_script $testname ;;
        *) run_executable $testname ;;
    esac
}

TMPDIR=`mktemp -d /tmp/runtest.XXXXXX`
trap "rm -rf $TMPDIR" 0 1 2 3 9 15


run_tests () {
    find $@ -name test.hal -or -name test.sh -or -name test \
	| sort > $TMPDIR/alltests

    while read testname; do
	testdir=$(dirname $testname)
	if [ -e $testdir/skip ]; then
	    if ! [ -x $testdir/skip ] || ! $testdir/skip; then
		echo "Skipping disabled test: $testdir" 1>&2
		SKIP=$(($SKIP+1))
		continue
	    fi
	fi
	if $NOSUDO && [ -e $testdir/control ] && \
		grep Restrictions: $testdir/control | grep -q sudo; then
	    if ! [ -x $testdir/skip ] || ! $testdir/skip; then
		echo "Skipping sudo test: $testdir" 1>&2
		SKIP=$(($SKIP+1))
		continue
	    fi
	fi
	NUM=$(($NUM+1))
	export TEST_DIR=$(readlink -f $testdir)
	echo "Running test: $testdir" 1>&2
        if test -n "$SYSTEM_BUILD"; then
            # Tell `halcompile` where to install comps
            USER_MODULE_DIR=$(readlink -f $testdir) \
                PATH=$(readlink -f $testdir):$PATH \
                run_test $testname
        else
            run_test $testname
        fi
	exitcode=$?
	if [ $exitcode -ne 0 ]; then
	    reason="test run exited with $exitcode"
	else
	    if [ -e $testdir/checkresult ]; then
		$testdir/checkresult $testdir/result
		exitcode=$?
		reason="checkresult exited with $exitcode"
	    elif [ -f $testdir/expected ]; then
		cmp -s $testdir/expected $testdir/result
		exitcode=$?
		reason="result differed from expected"
		if [ $exitcode -ne 0 ]; then
		    diff -u $testdir/expected $testdir/result > $TMPDIR/diff
		    SIZE=$(wc -l < $TMPDIR/diff)
		    if [ $SIZE -lt 40 ]; then
			cat $TMPDIR/diff
		    else
			OMIT=$((SIZE-40))
			head -40 $TMPDIR/diff
			echo "($OMIT more lines omitted)"
		    fi
		fi
	    else
		exitcode=1
		reason="Neither expected nor checkresult existed"
	    fi
	fi
	if [ $exitcode -ne 0 ]; then
	    echo "*** $testdir: XFAIL: $reason"
            if test $PRINT = 1; then
                echo "************** result:"
                tail -500 $testdir/result | sed 's/^/        /'
                echo "************** stderr:"
                tail -500 $testdir/stderr | sed 's/^/        /'
                echo "**************"
            fi
	    if [ -f $testdir/xfail ]; then
		XFAIL=$(($XFAIL+1))
		if [ $NOCLEAN -eq 0 ]; then
		    rm -f $testdir/stderr $testdir/result \
			$testdir/*.var $testdir/*.var.bak
		fi
	    else
		FAIL=$(($FAIL+1))
		FAIL_NAMES="$FAIL_NAMES
	$testdir"
	    fi
            if test $STOP = 1; then
	        break
	    fi
	else
	    if [ -f $testdir/xfail ]; then
		echo "*** $testdir: XPASS: Passed, but was expected to fail"
	    else
		if [ $NOCLEAN -eq 0 ]; then
		    rm -f $testdir/stderr $testdir/result \
			$testdir/*.var $testdir/*.var.bak
		fi
	    fi
	fi
    done < $TMPDIR/alltests

    SUCC=$((NUM-FAIL-XFAIL))
    echo "Runtest: $NUM tests run, $SUCC successful, $FAIL failed + $XFAIL expected, $SKIP skipped"
    if [ $FAIL -ne 0 ]; then
	echo "Failed: $FAIL_NAMES"
	exit 1;
    else
	exit 0;
    fi
}

usage () {
    P=${0##*/}
    cat <<EOF
$P: Run HAL test suite items

Usage:
    $P [-n] [-s] [-p] tests
	Run tests.  With '-n', do not remove temporary files for successful
	tests.  With '-s', stop after any failed test.  With '-p', print
        stderr and result files.

    $P -c tests
	Remove temporary files from an earlier test run.

    $P -u
        Only run tests that require normal user access.  Skip tests
        requiring root or sudo.

    $P -v
        Show stdout and stderr (normally it's hidden).
EOF
}

CLEAN_ONLY=0
NOCLEAN=0
NOSUDO=false
STOP=0
PRINT=0
while getopts cnuvsph opt; do
    case "$opt" in
    c) CLEAN_ONLY=1 ;;
    n) NOCLEAN=1 ;;
    u) NOSUDO=true ;;
    v) VERBOSE=1 ;;
    s) STOP=1 ;;
    p) PRINT=1 ;;
    h|?) usage; exit 0 ;;
    *) usage; exit 1 ;;
    esac
done
shift $((OPTIND-1))

if [ $# -eq 0 ]; then
    if [ -f test.hal -o -f test.sh ]; then
        set -- .
    else
        set -- $TOPDIR/tests
    fi
fi

if [ $CLEAN_ONLY -eq 1 ]; then
    clean "$@"
else
    run_tests "$@"
fi