Rewrote most of run-test, and gave variables clearer names
This commit is contained in:
Andrew Wood
+114
-54
@@ -1,73 +1,133 @@
|
||||
#!/bin/sh
|
||||
#
|
||||
# Run a test. Parameters are program name and source directory; if
|
||||
# additional parameters are given, they are the tests to run, otherwise all
|
||||
# tests are run.
|
||||
# Parameters: testSubject sourcePath [testScript...]
|
||||
#
|
||||
# Test scripts should exit 0 if the test passed.
|
||||
# Run one or more test scripts. The ${testSubject} is the path of the test
|
||||
# subject program, and the ${sourcePath} is the path to the top level of the
|
||||
# source directory. If any ${testScript} parameters are given, they are the
|
||||
# tests to run (each one being either the full path to a script, or the base
|
||||
# filename of the script in the test directory). If no test scripts are
|
||||
# listed, then all tests directly under "${sourcePath}/tests/" are run.
|
||||
#
|
||||
# If a test exits with status 2, it is listed as being skipped.
|
||||
# Test scripts should be written to exit 0 if the test passed, 2 if the test
|
||||
# is to be skipped, or any other exit status to indicate failure.
|
||||
#
|
||||
# Anything output by a test script on stdout or stderr is captured and shown
|
||||
# after the "OK"/"FAILED"/"skipped" status.
|
||||
# after the "OK" / "FAILED" / "skipped" result description.
|
||||
#
|
||||
# The exit status of this script will be 1 if any test failed, 0 otherwise.
|
||||
# A skipped test is not counted as a failure.
|
||||
#
|
||||
|
||||
PROG="$1"
|
||||
SRCDIR="$2"
|
||||
testSubject="$1"
|
||||
sourcePath="$2"
|
||||
shift
|
||||
shift
|
||||
TESTS="$*"
|
||||
selectedTests="$*"
|
||||
|
||||
# Temporary working files
|
||||
# Temporary working files, for the test scripts to use.
|
||||
workFile1=$(mktemp 2>/dev/null) || workFile1="./.tmp1"
|
||||
workFile2=$(mktemp 2>/dev/null) || workFile2="./.tmp2"
|
||||
workFile3=$(mktemp 2>/dev/null) || workFile3="./.tmp3"
|
||||
workFile4=$(mktemp 2>/dev/null) || workFile4="./.tmp4"
|
||||
|
||||
# Clean up the temporary files on exit, in case we are interrupted.
|
||||
trap 'rm -f "${workFile1}" "${workFile2}" "${workFile3}" "${workFile4}"' EXIT
|
||||
|
||||
# Variables used by the test scripts.
|
||||
export testSubject workFile1 workFile2 workFile3 workFile4
|
||||
|
||||
# If no tests were specified, list all test scripts under the source path.
|
||||
test -n "${selectedTests}" || selectedTests=$(find "${sourcePath}/tests" -maxdepth 1 -type f | sort -n)
|
||||
|
||||
# Initial pass to count the number of tests and find the length of the
|
||||
# longest test name, to use when formatting the output.
|
||||
#
|
||||
TMP1=$(mktemp 2>/dev/null) || TMP1=.tmp1
|
||||
TMP2=$(mktemp 2>/dev/null) || TMP2=.tmp2
|
||||
TMP3=$(mktemp 2>/dev/null) || TMP3=.tmp3
|
||||
TMP4=$(mktemp 2>/dev/null) || TMP4=.tmp4
|
||||
numberOfTests=0
|
||||
maxTestNameLength=0
|
||||
for testScript in ${selectedTests}; do
|
||||
# Find the test script, make sure it exists.
|
||||
test -f "${testScript}" || testScript="${sourcePath}/tests/${testScript}"
|
||||
test -f "${testScript}" || testScript=$(find "${sourcePath}/tests" -maxdepth 1 -type f -name "${testScript}*" | sed -n '1p')
|
||||
test -f "${testScript}" || continue
|
||||
|
||||
trap "rm -f ${TMP1} ${TMP2} ${TMP3} ${TMP4}" EXIT
|
||||
numberOfTests=$((1+numberOfTests))
|
||||
|
||||
export PROG TMP1 TMP2 TMP3 TMP4 # variables used by test scripts
|
||||
|
||||
FAIL=0
|
||||
|
||||
test -n "$TESTS" || TESTS=$(ls "$SRCDIR/tests" | sort -n)
|
||||
|
||||
MAXNAMESIZE=$(echo "$TESTS" | tr ' ' '\n' | sed 's,^.*/,,;s/-/ - /' | awk 'BEGIN{m=0} {n=length($0);if (n>m) m=n} END{print m}')
|
||||
test -n "$MAXNAMESIZE" || MAXNAMESIZE=1
|
||||
test "$MAXNAMESIZE" -lt 10 && MAXNAMESIZE=10
|
||||
test "$MAXNAMESIZE" -gt 60 && MAXNAMESIZE=60
|
||||
|
||||
for SCRIPT in $TESTS; do
|
||||
test -f "$SCRIPT" || SCRIPT="$SRCDIR/tests/$SCRIPT"
|
||||
test -f "$SCRIPT" || SCRIPT=$(ls "$SRCDIR/tests/$SCRIPT"*)
|
||||
test -f "$SCRIPT" || continue
|
||||
|
||||
printf "%-${MAXNAMESIZE}.${MAXNAMESIZE}s " "$(echo "${SCRIPT}" | sed 's,^.*/,,;s/-/ - /')"
|
||||
|
||||
TESTEXITSTATUS=0
|
||||
TESTOUTPUT=""
|
||||
TESTOUTPUT=$(sh -e "$SCRIPT" 2>&1)
|
||||
TESTEXITSTATUS=$?
|
||||
|
||||
TESTRESULT=""
|
||||
if test $TESTEXITSTATUS -eq 0; then
|
||||
TESTRESULT="OK"
|
||||
elif test $TESTEXITSTATUS -eq 2; then
|
||||
TESTRESULT="skipped"
|
||||
else
|
||||
TESTRESULT="FAILED"
|
||||
FAIL=1
|
||||
fi
|
||||
|
||||
test -n "${TESTOUTPUT}" && TESTOUTPUT=" - ${TESTOUTPUT}"
|
||||
|
||||
printf "%s%s\n" "${TESTRESULT}" "${TESTOUTPUT}"
|
||||
testScriptLeaf="${testScript##*/}"
|
||||
testName="$(echo "${testScriptLeaf}" | sed 's/-/ - /' | tr '_' ' ')"
|
||||
testNameLength=${#testName}
|
||||
test "${testNameLength}" -gt "${maxTestNameLength}" && maxTestNameLength="${testNameLength}"
|
||||
done
|
||||
|
||||
rm -f "$TMP1" "$TMP2" "$TMP3" "$TMP4"
|
||||
trap "" EXIT
|
||||
# Set a minimum and maximum test name length.
|
||||
test "${maxTestNameLength}" -lt 10 && maxTestNameLength=10
|
||||
test "${maxTestNameLength}" -gt 60 && maxTestNameLength=60
|
||||
|
||||
exit $FAIL
|
||||
# Count the number of digits in the number of tests so we know how wide the
|
||||
# column for the test count should be.
|
||||
testCountWidth=${#numberOfTests}
|
||||
|
||||
# The exit status - 0 means all tests that were run have passed, 1 means
|
||||
# that at least one test failed.
|
||||
overallExitStatus=0
|
||||
|
||||
# Run all of the selected test scripts, formatting the output.
|
||||
#
|
||||
testNumber=0
|
||||
for testScript in ${selectedTests}; do
|
||||
# Find the test script, make sure it exists.
|
||||
test -f "${testScript}" || testScript="${sourcePath}/tests/${testScript}"
|
||||
test -f "${testScript}" || testScript=$(find "${sourcePath}/tests" -maxdepth 1 -type f -name "${testScript}*" | sed -n '1p')
|
||||
test -f "${testScript}" || continue
|
||||
|
||||
testNumber=$((1+testNumber))
|
||||
|
||||
testScriptLeaf="${testScript##*/}"
|
||||
testName="$(echo "${testScriptLeaf}" | sed 's/-/ - /' | tr '_' ' ')"
|
||||
printf "%${testCountWidth}d/%d: %-${maxTestNameLength}.${maxTestNameLength}s " "${testNumber}" "${numberOfTests}" "${testName}"
|
||||
|
||||
# Run the test script, capturing the output and the exit status.
|
||||
testExitStatus=0
|
||||
testOutput=""
|
||||
testOutput=$(sh -e "${testScript}" 2>&1)
|
||||
testExitStatus=$?
|
||||
|
||||
# Work out what we're going to say about this test result.
|
||||
testResultDescription=""
|
||||
resultFormatCodes=""
|
||||
if test ${testExitStatus} -eq 0; then
|
||||
resultFormatCodes="setaf 2;bold"
|
||||
testResultDescription="OK"
|
||||
elif test ${testExitStatus} -eq 2; then
|
||||
resultFormatCodes="setaf 3"
|
||||
testResultDescription="skipped"
|
||||
else
|
||||
resultFormatCodes="setaf 1;bold"
|
||||
testResultDescription="FAILED"
|
||||
overallExitStatus=1
|
||||
fi
|
||||
|
||||
# If there was any output from the test, prefix it with " - " to
|
||||
# separate it from the test result description.
|
||||
test -n "${testOutput}" && testOutput=" - ${testOutput}"
|
||||
|
||||
# If stdout is not a terminal, don't use terminal format codes.
|
||||
test -t 1 || resultFormatCodes=""
|
||||
|
||||
# Show the description of the test result.
|
||||
test -n "${resultFormatCodes}" && command -v tput >/dev/null 2>&1 && echo "${resultFormatCodes}" | tr ';' '\n' | tput -S 2>/dev/null
|
||||
printf "%s" "${testResultDescription}"
|
||||
test -n "${resultFormatCodes}" && command -v tput >/dev/null 2>&1 && tput sgr0 2>/dev/null
|
||||
|
||||
# Show any output from the test, and start a new line.
|
||||
printf "%s\n" "${testOutput}"
|
||||
done
|
||||
|
||||
# Clean up.
|
||||
rm -f "${workFile1}" "${workFile2}" "${workFile3}" "${workFile4}"
|
||||
trap '' EXIT
|
||||
|
||||
# Exit with status 1 if any test failed outright, 0 otherwise.
|
||||
exit ${overallExitStatus}
|
||||
|
||||
# EOF
|
||||
|
||||
Reference in New Issue
Block a user