runtests.sh

   1 #! /bin/sh
   2
   3 # Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
   4
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License version
   7 # 2 as published by the Free Software Foundation.
   8 #
   9 # This program is distributed in the hope that it will be useful, but
  10 # WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18
  19 # rsync top-level test script -- this invokes all the other more
  20 # detailed tests in order.  This script can either be called by `make
  21 # check' or `make installcheck'.  `check' runs against the copies of
  22 # the program and other files in the build directory, and
  23 # `installcheck' against the installed copy of the program.
  24
  25 # In either case we need to also be able to find the source directory,
  26 # since we read test scripts and possibly other information from
  27 # there.
  28
  29 # Whenever possible, informational messages are written to stdout and
  30 # error messages to stderr.  They're separated out by the build farm
  31 # display scripts.
  32
  33 # According to the GNU autoconf manual, the only valid place to set up
  34 # directory locations is through Make, since users are allowed to (try
  35 # to) change their mind on the Make command line.  So, Make has to
  36 # pass in all the values we need.
  37
  38 # For other configured settings we read ./config.sh, which tells us
  39 # about shell commands on this machine and similar things.
  40
  41 # rsync_bin gives the location of the rsync binary.  This is either
  42 # builddir/rsync if we're testing an uninstalled copy, or
  43 # install_prefix/bin/rsync if we're testing an installed copy.  On the
  44 # build farm rsync will be installed, but into a scratch /usr.
  45
  46 # srcdir gives the location of the source tree, which lets us find the
  47 # build scripts.  At the moment we assume we are invoked from the
  48 # source directory.
  49
  50 # This script must be invoked from the build directory.
  51
  52 # A scratch directory, 'testtmp', is created in the build directory to
  53 # hold working files.
  54
  55 # This script also uses the $loglevel environment variable.  1 is the
  56 # default value, and 10 the most verbose.  You can set this from the
  57 # Make command line.  It's also set by the build farm to give more
  58 # detail for failing builds.
  59
  60
  61 # NOTES FOR TEST CASES:
  62
  63 # Each test case runs in its own shell.
  64
  65 # Exit codes from tests:
  66
  67 #    1  tests failed
  68 #    2  error in starting tests
  69 #   77  this test skipped (random value unlikely to happen by chance, same as
  70 #       automake)
  71
  72 # HOWEVER, the overall exit code to the farm is different: we return
  73 # the *number of tests that failed*, so that it will show up nicely in
  74 # the overall summary.
  75
  76 # rsync.fns contains some general setup functions and definitions.
  77
  78
  79 # NOTES ON PORTABILITY:
  80
  81 # Both this script and the Makefile have to be pretty conservative
  82 # about which Unix features they use.
  83
  84 # We cannot count on Make exporting variables to commands, unless
  85 # they're explicitly given on the command line.
  86
  87 # Also, we can't count on 'cp -a' or 'mkdir -p', although they're
  88 # pretty handy (see function makepath for the latter).
  89
  90 # I think some of the GNU documentation suggests that we shouldn't
  91 # rely on shell functions.  However, the Bash manual seems to say that
  92 # they're in POSIX 1003.2, and since the build farm relies on them
  93 # they're probably working on most machines we really care about.
  94
  95 # You cannot use "function foo {" syntax, but must instead say "foo()
  96 # {", or it breaks on FreeBSD.
  97
  98 # BSD machines tend not to have "head" or "seq".
  99
 100 # You cannot do "export VAR=VALUE" all on one line; the export must be
 101 # separate from the assignment.  (SCO SysV)
 102
 103 # Don't rely on grep -q, as that doesn't work everywhere -- just redirect
 104 # stdout to /dev/null to keep it quiet.
 105
 106
 107 # STILL TO DO:
 108
 109 # We need a good protection against tests that hang indefinitely.
 110 # Perhaps some combination of starting them in the background, wait,
 111 # and kill?
 112
 113 # Perhaps we need a common way to cleanup tests.  At the moment just
 114 # clobbering the directory when we're done should be enough.
 115
 116 # If any of the targets fail, then (GNU?) Make returns 2, instead of
 117 # the return code from the failing command.  This is fine, but it
 118 # means that the build farm just shows "2" for failed tests, not the
 119 # number of tests that actually failed.  For more details we might
 120 # need to grovel through the log files to find a line saying how many
 121 # failed.
 122
 123
 124 set -e
 125
 126 . "./shconfig"
 127
 128 RUNSHFLAGS='-e'
 129 export RUNSHFLAGS
 130
 131 # for Solaris
 132 [ -d /usr/xpg4/bin ] && PATH="/usr/xpg4/bin/:$PATH"
 133
 134 if [ "x$loglevel" != x ] && [ "$loglevel" -gt 8 ]; then
 135     if set -x; then
 136         # If it doesn't work the first time, don't keep trying.
 137         RUNSHFLAGS="$RUNSHFLAGS -x"
 138     fi
 139 fi
 140
 141 echo "============================================================"
 142 echo "$0 running in `pwd`"
 143 echo "    rsync_bin=$rsync_bin"
 144 echo "    srcdir=$srcdir"
 145
 146 if [ -f /usr/bin/whoami ]; then
 147     testuser=`/usr/bin/whoami`
 148 elif [ -f /usr/ucb/whoami ]; then
 149     testuser=`/usr/ucb/whoami`
 150 elif [ -f /bin/whoami ]; then
 151     testuser=`/bin/whoami`
 152 else
 153     testuser=`id -un 2>/dev/null || echo ${LOGNAME:-${USERNAME:-${USER:-'UNKNOWN'}}}`
 154 fi
 155
 156 echo "    testuser=$testuser"
 157 echo "    os=`uname -a`"
 158
 159 # It must be "yes", not just nonnull
 160 if [ "x$preserve_scratch" = xyes ]; then
 161     echo "    preserve_scratch=yes"
 162 else
 163     echo "    preserve_scratch=no"
 164 fi
 165
 166 # We'll use setfacl if it's around and it supports the -k option.
 167 if setfacl --help 2>/dev/null | grep ' -k,' >/dev/null; then
 168     setfacl=setfacl
 169 else
 170     setfacl=true
 171 fi
 172
 173 if [ ! -f "$rsync_bin" ]; then
 174     echo "rsync_bin $rsync_bin is not a file" >&2
 175     exit 2
 176 fi
 177
 178 if [ ! -d "$srcdir" ]; then
 179     echo "srcdir $srcdir is not a directory" >&2
 180     exit 2
 181 fi
 182
 183 RSYNC="$rsync_bin"
 184 #RSYNC="valgrind --tool=addrcheck $rsync_bin"
 185
 186 export rsync_bin RSYNC
 187
 188 skipped=0
 189 missing=0
 190 passed=0
 191 failed=0
 192
 193 # Prefix for scratch directory.  We create separate directories for
 194 # each test case, so that they can be left behind in case of failure
 195 # to aid investigation.
 196 scratchbase="`pwd`"/testtmp
 197 echo "    scratchbase=$scratchbase"
 198
 199 suitedir="$srcdir/testsuite"
 200
 201 export scratchdir suitedir
 202
 203 prep_scratch() {
 204     [ -d "$scratchdir" ] && rm -rf "$scratchdir"
 205     mkdir "$scratchdir"
 206     # Get rid of default ACLs and dir-setgid to avoid confusing some tests.
 207     $setfacl -k "$scratchdir"
 208     chmod g-s "$scratchdir"
 209     return 0
 210 }
 211
 212 maybe_discard_scratch() {
 213     [ x"$preserve_scratch" != xyes ] && [ -d "$scratchdir" ] && rm -rf "$scratchdir"
 214     return 0
 215 }
 216
 217 if [ "x$whichtests" = x ]; then
 218     whichtests="*.test"
 219 fi
 220
 221 for testscript in $suitedir/$whichtests
 222 do
 223     testbase=`echo $testscript | sed -e 's!.*/!!' -e 's/.test\$//'`
 224     scratchdir="$scratchbase.$testbase"
 225
 226     prep_scratch
 227
 228     set +e
 229     sh $RUNSHFLAGS "$testscript" >"$scratchdir/test.log" 2>&1
 230     result=$?
 231     set -e
 232
 233     if [ "x$always_log" = xyes -o \( $result != 0 -a $result != 77 -a $result != 78 \) ]
 234     then
 235         echo "----- $testbase log follows"
 236         cat "$scratchdir/test.log"
 237         echo "----- $testbase log ends"
 238         if [ -f "$scratchdir/rsyncd.log" ]; then
 239             echo "----- $testbase rsyncd.log follows"
 240             cat "$scratchdir/rsyncd.log"
 241             echo "----- $testbase rsyncd.log ends"
 242         fi
 243     fi
 244
 245     case $result in
 246     0)
 247         echo "PASS    $testbase"
 248         passed=`expr $passed + 1`
 249         maybe_discard_scratch
 250         ;;
 251     77)
 252         # backticks will fill the whole file onto one line, which is a feature
 253         whyskipped=`cat "$scratchdir/whyskipped"`
 254         echo "SKIP    $testbase ($whyskipped)"
 255         skipped=`expr $skipped + 1`
 256         maybe_discard_scratch
 257         ;;
 258     78)
 259         # It failed, but we expected that.  don't dump out error logs,
 260         # because most users won't want to see them.  But do leave
 261         # the working directory around.
 262         echo "XFAIL   $testbase"
 263         failed=`expr $failed + 1`
 264         ;;
 265     *)
 266         echo "FAIL    $testbase"
 267         failed=`expr $failed + 1`
 268         if [ "x$nopersist" = xyes ]; then
 269             exit 1
 270         fi
 271     esac
 272 done
 273
 274 echo '------------------------------------------------------------'
 275 echo "----- overall results:"
 276 echo "      $passed passed"
 277 [ "$failed" -gt 0 ]  && echo "      $failed failed"
 278 [ "$skipped" -gt 0 ] && echo "      $skipped skipped"
 279 [ "$missing" -gt 0 ] && echo "      $missing missing"
 280 echo '------------------------------------------------------------'
 281
 282 # OK, so expr exits with 0 if the result is neither null nor zero; and
 283 # 1 if the expression is null or zero.  This is the opposite of what
 284 # we want, and if we just call expr then this script will always fail,
 285 # because -e is set.
 286
 287 result=`expr $failed + $missing || true`
 288 echo "overall result is $result"
 289 exit $result