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 "optionflag"
   8
   9 # The "testing" function must have the following environment variable set:
  10 #    COMMAND = command to execute
  11 #
  12 # The following environment variables may be set to enable optional behavior
  13 # in "testing":
  14 #    VERBOSE - Print the diff -u of each failed test case.
  15 #    DEBUG - Enable command tracing.
  16 #    SKIP - do not perform this test (this is set by "optionflag")
  17 #
  18 # The "testing" function takes five arguments:
  19 #       $1) Description to display when running command
  20 #       $2) Command line arguments to command"
  21 #       $3) Expected result (on stdout)"
  22 #       $4) Data written to file "input"
  23 #       $5) Data written to stdin
  24 #
  25 # The exit value of testing is the exit value of the command it ran.
  26 #
  27 # The environment variable "FAILCOUNT" contains a cumulative total of the
  28 # number of failed tests.
  29
  30 # The "optional" function is used to skip certain tests, ala:
  31 #   optionflag CONFIG_FEATURE_THINGY
  32 #
  33 # The "optional" function checks the environment variable "OPTIONFLAGS",
  34 # which is either empty (in which case it always clears SKIP) or
  35 # else contains a colon-separated list of features (in which case the function
  36 # clears SKIP if the flag was found, or sets it to 1 if the flag was not found).
  37
  38 export FAILCOUNT=0
  39 export SKIP=
  40
  41 # Helper functions
  42
  43 optional()
  44 {
  45   option="$OPTIONFLAGS" | egrep "(^|:)$1(:|\$)"
  46   # Not set?
  47   if [[ -z "$1" || -z "$OPTIONFLAGS" || ${#option} -ne 0 ]]
  48   then
  49     SKIP=""
  50     return
  51   fi
  52   SKIP=1
  53 }
  54
  55 # The testing function
  56
  57 testing ()
  58 {
  59   if [ $# -ne 5 ]
  60   then
  61     echo "Test $1 has the wrong number of arguments" >&2
  62     exit
  63   fi
  64
  65   if [ -n "$DEBUG" ] ; then
  66     set -x
  67   fi
  68
  69   if [ -n "$SKIP" ]
  70   then
  71     echo "SKIPPED: $1"
  72     return 0
  73   fi
  74
  75   echo -ne "$3" > expected
  76   echo -ne "$4" > input
  77   echo -n -e "$5" | eval "$COMMAND $2" > actual
  78   RETVAL=$?
  79
  80   cmp expected actual > /dev/null
  81   if [ $? -ne 0 ]
  82   then
  83     FAILCOUNT=$[$FAILCOUNT+1]
  84     echo "FAIL: $1"
  85     if [ -n "$VERBOSE" ]
  86     then
  87       diff -u expected actual
  88     fi
  89   else
  90     echo "PASS: $1"
  91   fi
  92   rm -f input expected actual
  93
  94   if [ -n "$DEBUG" ]
  95   then
  96     set +x
  97   fi
  98
  99   return $RETVAL
 100 }