testsuite/testing.sh

   1 # Simple test harness infrastructurei for BusyBox
   2 #
   3 # Copyright 2005 by Rob Landley
   4 #
   5 # License is GPLv2, see LICENSE in the busybox tarball for full license text.
   6
   7 # This file defines two functions, "testing" and "optional"
   8 # and a couple more...
   9
  10 # The following environment variables may be set to enable optional behavior
  11 # in "testing":
  12 #    VERBOSE - Print the diff -u of each failed test case.
  13 #    DEBUG - Enable command tracing.
  14 #    SKIP - do not perform this test (this is set by "optional")
  15 #
  16 # The "testing" function takes five arguments:
  17 #       $1) Test description
  18 #       $2) Command(s) to run. May have pipes, redirects, etc
  19 #       $3) Expected result on stdout
  20 #       $4) Data to be written to file "input"
  21 #       $5) Data to be written to stdin
  22 #
  23 # The exit value of testing is the exit value of $2 it ran.
  24 #
  25 # The environment variable "FAILCOUNT" contains a cumulative total of the
  26 # number of failed tests.
  27
  28 # The "optional" function is used to skip certain tests, ala:
  29 #   optional CONFIG_FEATURE_THINGY
  30 #
  31 # The "optional" function checks the environment variable "OPTIONFLAGS",
  32 # which is either empty (in which case it always clears SKIP) or
  33 # else contains a colon-separated list of features (in which case the function
  34 # clears SKIP if the flag was found, or sets it to 1 if the flag was not found).
  35
  36 export FAILCOUNT=0
  37 export SKIP=
  38
  39 # Helper for helpers. Oh my...
  40 test x"$ECHO" != x"" || {
  41         ECHO="echo"
  42         test x"`echo -ne`" = x"" || {
  43                 # Compile and use a replacement 'echo' which understands -e -n
  44                 ECHO="$PWD/echo-ne"
  45                 test -x "$ECHO" || {
  46                         gcc -Os -o "$ECHO" ../scripts/echo.c || exit 1
  47                 }
  48         }
  49         export ECHO
  50 }
  51
  52 # Helper functions
  53
  54 optional()
  55 {
  56   option=`echo ":$OPTIONFLAGS:" | grep ":$1:"`
  57   # Not set?
  58   if [ -z "$1" ] || [ -z "$OPTIONFLAGS" ] || [ ${#option} -ne 0 ]
  59   then
  60     SKIP=
  61     return
  62   fi
  63   SKIP=1
  64 }
  65
  66 # The testing function
  67
  68 testing()
  69 {
  70   NAME="$1"
  71   [ -n "$1" ] || NAME="$2"
  72
  73   if [ $# -ne 5 ]
  74   then
  75     echo "Test $NAME has wrong number of arguments (must be 5) ($# $*)" >&2
  76     exit 1
  77   fi
  78
  79   [ -z "$DEBUG" ] || set -x
  80
  81   if [ -n "$SKIP" ]
  82   then
  83     echo "SKIPPED: $NAME"
  84     return 0
  85   fi
  86
  87   $ECHO -ne "$3" > expected
  88   $ECHO -ne "$4" > input
  89   [ -z "$VERBOSE" ] || echo "echo '$5' | $2"
  90   $ECHO -ne "$5" | eval "$2" > actual
  91   RETVAL=$?
  92
  93   if cmp expected actual >/dev/null 2>/dev/null
  94   then
  95     echo "PASS: $NAME"
  96   else
  97     FAILCOUNT=$(($FAILCOUNT + 1))
  98     echo "FAIL: $NAME"
  99     [ -z "$VERBOSE" ] || diff -u expected actual
 100   fi
 101   rm -f input expected actual
 102
 103   [ -z "$DEBUG" ] || set +x
 104
 105   return $RETVAL
 106 }
 107
 108 # Recursively grab an executable and all the libraries needed to run it.
 109 # Source paths beginning with / will be copied into destpath, otherwise
 110 # the file is assumed to already be there and only its library dependencies
 111 # are copied.
 112
 113 mkchroot()
 114 {
 115   [ $# -lt 2 ] && return
 116
 117   $ECHO -n .
 118
 119   dest=$1
 120   shift
 121   for i in "$@"
 122   do
 123     #bashism: [ "${i:0:1}" == "/" ] || i=$(which $i)
 124     i=$(which $i) # no-op for /bin/prog
 125     [ -f "$dest/$i" ] && continue
 126     if [ -e "$i" ]
 127     then
 128       d=`echo "$i" | grep -o '.*/'` &&
 129       mkdir -p "$dest/$d" &&
 130       cat "$i" > "$dest/$i" &&
 131       chmod +x "$dest/$i"
 132     else
 133       echo "Not found: $i"
 134     fi
 135     mkchroot "$dest" $(ldd "$i" | egrep -o '/.* ')
 136   done
 137 }
 138
 139 # Set up a chroot environment and run commands within it.
 140 # Needed commands listed on command line
 141 # Script fed to stdin.
 142
 143 dochroot()
 144 {
 145   mkdir tmpdir4chroot
 146   mount -t ramfs tmpdir4chroot tmpdir4chroot
 147   mkdir -p tmpdir4chroot/{etc,sys,proc,tmp,dev}
 148   cp -L testing.sh tmpdir4chroot
 149
 150   # Copy utilities from command line arguments
 151
 152   $ECHO -n "Setup chroot"
 153   mkchroot tmpdir4chroot $*
 154   echo
 155
 156   mknod tmpdir4chroot/dev/tty c 5 0
 157   mknod tmpdir4chroot/dev/null c 1 3
 158   mknod tmpdir4chroot/dev/zero c 1 5
 159
 160   # Copy script from stdin
 161
 162   cat > tmpdir4chroot/test.sh
 163   chmod +x tmpdir4chroot/test.sh
 164   chroot tmpdir4chroot /test.sh
 165   umount -l tmpdir4chroot
 166   rmdir tmpdir4chroot
 167 }