blob: e07c6a2eec71570d69958207832f1d417dd7ddfb [file] [log] [blame]
# Simple test harness infrastructure
#
# Copyright 2005 by Rob Landley
# This file defines two main functions, "testcmd" and "optional". The
# first performs a test, the second enables/disables tests based on
# configuration options.
# The following environment variables enable optional behavior in "testing":
# DEBUG - Show every command run by test script.
# VERBOSE - Print the diff -u of each failed test case.
# If equal to "fail", stop after first failed test.
#
# The "testcmd" function takes five arguments:
# $1) Description to display when running command
# $2) Command line arguments to command
# $3) Expected result (on stdout)
# $4) Data written to file "input"
# $5) Data written to stdin
#
# The "testing" function is like testcmd but takes a complete command line
# (I.E. you have to include the command name.) The variable $C is an absolute
# path to the command being tested, which can bypass shell builtins.
#
# The exit value of testcmd is the exit value of the command it ran.
#
# The environment variable "FAILCOUNT" contains a cumulative total of the
# number of failed tests.
#
# The "optional" function is used to skip certain tests (by setting the
# environment variable SKIP), ala:
# optional CFG_THINGY
#
# The "optional" function checks the environment variable "OPTIONFLAGS",
# which is either empty (in which case it always clears SKIP) or
# else contains a colon-separated list of features (in which case the function
# clears SKIP if the flag was found, or sets it to 1 if the flag was not found).
export FAILCOUNT=0
export SKIP=
# Helper functions
# Check config to see if option is enabled, set SKIP if not.
SHOWPASS=PASS
SHOWFAIL=FAIL
SHOWSKIP=SKIP
if tty -s <&1
then
SHOWPASS="$(echo -e "\033[1;32m${SHOWPASS}\033[0m")"
SHOWFAIL="$(echo -e "\033[1;31m${SHOWFAIL}\033[0m")"
SHOWSKIP="$(echo -e "\033[1;33m${SHOWSKIP}\033[0m")"
fi
optional()
{
option=`echo "$OPTIONFLAGS" | egrep "(^|:)$1(:|\$)"`
# Not set?
if [ -z "$1" ] || [ -z "$OPTIONFLAGS" ] || [ ${#option} -ne 0 ]
then
SKIP=""
return
fi
SKIP=1
}
wrong_args()
{
if [ $# -ne 5 ]
then
echo "Test $NAME has the wrong number of arguments ($# $*)" >&2
exit
fi
}
# The testing function
testing()
{
wrong_args "$@"
NAME="$CMDNAME $1"
[ -z "$1" ] && NAME=$2
[ -n "$DEBUG" ] && set -x
if [ -n "$SKIP" ] || ( [ -n "$SKIP_HOST" ] && [ -n "$TEST_HOST" ])
then
[ ! -z "$VERBOSE" ] && echo "$SHOWSKIP: $NAME"
return 0
fi
echo -ne "$3" > expected
echo -ne "$4" > input
echo -ne "$5" | ${EVAL:-eval} "$2" > actual
RETVAL=$?
# Catch segfaults
[ $RETVAL -gt 128 ] && [ $RETVAL -lt 255 ] &&
echo "exited with signal (or returned $RETVAL)" >> actual
DIFF="$(diff -au${NOSPACE:+b} expected actual)"
if [ ! -z "$DIFF" ]
then
FAILCOUNT=$[$FAILCOUNT+1]
echo "$SHOWFAIL: $NAME"
if [ -n "$VERBOSE" ]
then
[ ! -z "$4" ] && echo "echo -ne \"$4\" > input"
echo "echo -ne '$5' |$EVAL $2"
echo "$DIFF"
[ "$VERBOSE" == fail ] && exit 1
fi
else
echo "$SHOWPASS: $NAME"
fi
rm -f input expected actual
[ -n "$DEBUG" ] && set +x
return 0
}
testcmd()
{
wrong_args "$@"
testing "$1" "$C $2" "$3" "$4" "$5"
}
# Recursively grab an executable and all the libraries needed to run it.
# Source paths beginning with / will be copied into destpath, otherwise
# the file is assumed to already be there and only its library dependencies
# are copied.
mkchroot()
{
[ $# -lt 2 ] && return
echo -n .
dest=$1
shift
for i in "$@"
do
[ "${i:0:1}" == "/" ] || i=$(which $i)
[ -f "$dest/$i" ] && continue
if [ -e "$i" ]
then
d=`echo "$i" | grep -o '.*/'` &&
mkdir -p "$dest/$d" &&
cat "$i" > "$dest/$i" &&
chmod +x "$dest/$i"
else
echo "Not found: $i"
fi
mkchroot "$dest" $(ldd "$i" | egrep -o '/.* ')
done
}
# Set up a chroot environment and run commands within it.
# Needed commands listed on command line
# Script fed to stdin.
dochroot()
{
mkdir tmpdir4chroot
mount -t ramfs tmpdir4chroot tmpdir4chroot
mkdir -p tmpdir4chroot/{etc,sys,proc,tmp,dev}
cp -L testing.sh tmpdir4chroot
# Copy utilities from command line arguments
echo -n "Setup chroot"
mkchroot tmpdir4chroot $*
echo
mknod tmpdir4chroot/dev/tty c 5 0
mknod tmpdir4chroot/dev/null c 1 3
mknod tmpdir4chroot/dev/zero c 1 5
# Copy script from stdin
cat > tmpdir4chroot/test.sh
chmod +x tmpdir4chroot/test.sh
chroot tmpdir4chroot /test.sh
umount -l tmpdir4chroot
rmdir tmpdir4chroot
}