validation/test-suite

   1 #!/bin/sh
   2
   3 #set -x
   4
   5 default_path=".."
   6 default_cmd="sparse \$file"
   7 tests_list=`find . -name '*.c' | sed -e 's#^\./\(.*\)#\1#' | sort`
   8 prog_name=`basename $0`
   9
  10 # counts:
  11 #       - tests that have not been converted to test-suite format
  12 #       - tests that passed
  13 #       - tests that failed
  14 #       - tests that failed but are known to fail
  15 unhandled_tests=0
  16 ok_tests=0
  17 ko_tests=0
  18 known_ko_tests=0
  19
  20 # defaults to not verbose
  21 [ -z "$V" ] && V=0
  22
  23 ##
  24 # get_value(key, file) - gets the value of a (key, value) pair in file.
  25 #
  26 # returns 0 on success, 1 if the file does not have the key
  27 get_value()
  28 {
  29         last_result=`grep $1: $2 | sed -e "s/^.*$1:\(.*\)$/\1/"`
  30         [ -z "$last_result" ] && return 1
  31         return 0
  32 }
  33
  34 ##
  35 # get_tag(key, file) - does file has the tag key in it ?
  36 #
  37 # returns 0 if present, 1 otherwise
  38 get_tag()
  39 {
  40         last_result=`grep $1 $2`
  41         return $?
  42 }
  43
  44 ##
  45 # verbose(string) - prints string if we are in verbose mode
  46 verbose()
  47 {
  48         [ "$V" -eq "1" ] && echo "        $1"
  49         return 0
  50 }
  51
  52 ##
  53 # error(string[, die]) - prints an error and exits with value die if given
  54 error()
  55 {
  56         echo "error: $1"
  57         [ -n "$2" ] && exit $2
  58         return 0
  59 }
  60
  61 do_usage()
  62 {
  63 echo "$prog_name - a tiny automatic testing script"
  64 echo "Usage: $prog_name [command] [command arguments]"
  65 echo
  66 echo "commands:"
  67 echo "    none                       runs the whole test suite"
  68 echo "    single file                runs the test in 'file'"
  69 echo "    format file [name [cmd]]   helps writing a new test case using cmd"
  70 echo
  71 echo "    help                       prints usage"
  72 }
  73
  74 ##
  75 # do_test(file) - tries to validate a test case
  76 #
  77 # it "parses" file, looking for check-* tags and tries to validate
  78 # the test against an expected result
  79 # returns:
  80 #       - 0 if the test passed,
  81 #       - 1 if it failed,
  82 #       - 2 if it is not a "test-suite" test.
  83 do_test()
  84 {
  85         test_failed=0
  86         file="$1"
  87
  88         # can this test be handled by test-suite ?
  89         # (it has to have a check-name key in it)
  90         get_value "check-name" $file
  91         if [ "$?" -eq 1 ]; then
  92                 echo "warning: test '$file' unhandled"
  93                 unhandled_tests=`expr $unhandled_tests + 1`
  94                 return 2
  95         fi
  96         test_name=$last_result
  97
  98         echo "     TEST    $test_name ($file)"
  99
 100         # does the test provide a specific command ?
 101         cmd=`eval echo $default_path/$default_cmd`
 102         get_value "check-command" $file
 103         if [ "$?" -eq "0" ]; then
 104                 last_result=`echo $last_result | sed -e 's/^ *//'`
 105                 cmd=`eval echo $default_path/$last_result`
 106         fi
 107         verbose "Using command       : $cmd"
 108
 109         # grab the expected exit value
 110         get_value "check-exit-value" $file
 111         if [ "$?" -eq "0" ]; then
 112                 expected_exit_value=`echo $last_result | tr -d ' '`
 113         else
 114                 expected_exit_value=0
 115         fi
 116         verbose "Expecting exit value: $expected_exit_value"
 117
 118         # grab the expected output
 119         sed -n '/check-output-start/,/check-output-end/p' $file \
 120                 | grep -v check-output > "$file".output.expected
 121         sed -n '/check-error-start/,/check-error-end/p' $file \
 122                 | grep -v check-error > "$file".error.expected
 123
 124         # grab the actual output & exit value
 125         $cmd 1> $file.output.got 2> $file.error.got
 126         actual_exit_value=$?
 127
 128         for stream in output error; do
 129                 diff -u "$file".$stream.expected "$file".$stream.got > "$file".$stream.diff
 130                 if [ "$?" -ne "0" ]; then
 131                         error "actual $stream text does not match expected $stream text."
 132                         error  "see $file.$stream.* for further investigation."
 133                         cat "$file".$stream.diff
 134                         test_failed=1
 135                 fi
 136         done
 137
 138         if [ "$actual_exit_value" -ne "$expected_exit_value" ]; then
 139                 error "Actual exit value does not match the expected one."
 140                 error "expected $expected_exit_value, got $actual_exit_value."
 141                 test_failed=1
 142         fi
 143
 144         if [ "$test_failed" -eq "1" ]; then
 145                 ko_tests=`expr $ko_tests + 1`
 146                 get_tag "check-known-to-fail" $file
 147                 if [ "$?" -eq "0" ]; then
 148                         echo "info: test '$file' is known to fail"
 149                         known_ko_tests=`expr $known_ko_tests + 1`
 150                 fi
 151                 return 1
 152         else
 153                 ok_tests=`expr $ok_tests + 1`
 154                 return 0
 155         fi
 156 }
 157
 158 do_test_suite()
 159 {
 160         for i in $tests_list; do
 161                 do_test "$i"
 162         done
 163
 164         # prints some numbers
 165         tests_nr=`expr $ok_tests + $ko_tests`
 166         echo -n "Out of $tests_nr tests, $ok_tests passed, $ko_tests failed"
 167         echo " ($known_ko_tests of them are known to fail)"
 168         if [ "$unhandled_tests" -ne "0" ]; then
 169                 echo "$unhandled_tests tests could not be handled by $prog_name"
 170         fi
 171 }
 172
 173 ##
 174 # do_format(file[, name[, cmd]]) - helps a test writer to format test-suite tags
 175 do_format()
 176 {
 177         if [ -z "$2" ]; then
 178                 fname="$1"
 179                 fcmd=$default_cmd
 180         elif [ -z "$3" ]; then
 181                 fname="$2"
 182                 fcmd=$default_cmd
 183         else
 184                 fname="$2"
 185                 fcmd="$3"
 186         fi
 187         file="$1"
 188         cmd=`eval echo $default_path/$fcmd`
 189         $cmd 1> $file.output.got 2> $file.error.got
 190         fexit_value=$?
 191         cat <<_EOF
 192 /*
 193  * check-name: $fname
 194 _EOF
 195         if [ "$fcmd" != "$default_cmd" ]; then
 196                 echo " * check-command: $fcmd"
 197         fi
 198         if [ "$fexit_value" -ne "0" ]; then
 199                 echo " * check-exit-value: $fexit_value"
 200         fi
 201         for stream in output error; do
 202                 if [ -s "$file.$stream.got" ]; then
 203                         echo " *"
 204                         echo " * check-$stream-start"
 205                         cat "$file.$stream.got"
 206                         echo " * check-$stream-end"
 207                 fi
 208         done
 209         echo " */"
 210         return 0
 211 }
 212
 213 ##
 214 # arg_file(filename) - checks if filename exists
 215 arg_file()
 216 {
 217         [ -z "$1" ] && {
 218                 do_usage
 219                 exit 1
 220         }
 221         [ -e "$1" ] || {
 222                 error "Can't open file $1"
 223                 exit 1
 224         }
 225         return 0
 226 }
 227
 228 case "$1" in
 229         '')
 230                 do_test_suite
 231                 ;;
 232         single)
 233                 arg_file "$2"
 234                 do_test "$2"
 235                 case "$?" in
 236                         0) echo "$2 passed !";;
 237                         1) echo "$2 failed !";;
 238                         2) echo "$2 can't be handled by $prog_name";;
 239                 esac
 240                 ;;
 241         format)
 242                 arg_file "$2"
 243                 do_format "$2" "$3" "$4"
 244                 ;;
 245         help | *)
 246                 do_usage
 247                 exit 1
 248                 ;;
 249 esac
 250
 251 exit 0
 252