3 # Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
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.
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.
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.
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.
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
29 # Whenever possible, informational messages are written to stdout and
30 # error messages to stderr. They're separated out by the build farm
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.
38 # For other configured settings we read ./config.sh, which tells us
39 # about shell commands on this machine and similar things.
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.
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
50 # This script must be invoked from the build directory.
52 # A scratch directory, 'testtmp', is created in the build directory to
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.
61 # NOTES FOR TEST CASES:
63 # Each test case runs in its own shell.
65 # Exit codes from tests:
68 # 2 error in starting tests
69 # 77 this test skipped (random value unlikely to happen by chance, same as
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.
76 # rsync.fns contains some general setup functions and definitions.
79 # NOTES ON PORTABILITY:
81 # Both this script and the Makefile have to be pretty conservative
82 # about which Unix features they use.
84 # We cannot count on Make exporting variables to commands, unless
85 # they're explicitly given on the command line.
87 # Also, we can't count on 'cp -a' or 'mkdir -p', although they're
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.
95 # You cannot use "function foo {" syntax, but must instead say "foo()
96 # {", or it breaks on FreeBSD.
98 # BSD machines tend not to have "head" or "seq".
100 # You cannot do "export VAR=VALUE" all on one line; the export must be
101 # separate from the assignment. (SCO SysV)
107 # We need a good protection against tests that hang indefinitely.
108 # Perhaps some combination of starting them in the background, wait,
111 # Perhaps we need a common way to cleanup tests. At the moment just
112 # clobbering the directory when we're done should be enough.
114 # If any of the targets fail, then (GNU?) Make returns 2, instead of
115 # the return code from the failing command. This is fine, but it
116 # means that the build farm just shows "2" for failed tests, not the
117 # number of tests that actually failed. For more details we might
118 # need to grovel through the log files to find a line saying how many
129 PATH="/usr/xpg4/bin/:$PATH"
131 if [ -n "$loglevel" ] && [ "$loglevel" -gt 8 ]
135 # If it doesn't work the first time, don't keep trying.
136 RUNSHFLAGS="$RUNSHFLAGS -x"
140 echo "============================================================"
141 echo "$0 running in `pwd`"
142 echo " rsync_bin=$rsync_bin"
143 echo " srcdir=$srcdir"
145 testuser=`id -un || whoami || echo UNKNOWN`
147 echo " testuser=$testuser"
148 echo " os=`uname -a`"
150 # It must be "yes", not just nonnull
151 if test "x$preserve_scratch" = xyes
153 echo " preserve_scratch=yes"
155 echo " preserve_scratch=no"
159 if test ! -f $rsync_bin
161 echo "rsync_bin $rsync_bin is not a file" >&2
167 echo "srcdir $srcdir is not a directory" >&2
172 #RSYNC="valgrind --tool=addrcheck $rsync_bin"
174 export rsync_bin RSYNC
181 # Prefix for scratch directory. We create separate directories for
182 # each test case, so that they can be left behind in case of failure
183 # to aid investigation.
184 scratchbase="`pwd`"/testtmp
185 echo " scratchbase=$scratchbase"
187 suitedir="$srcdir/testsuite"
189 export scratchdir suitedir
192 [ -d "$scratchdir" ] && rm -rf "$scratchdir"
197 maybe_discard_scratch() {
198 [ x"$preserve_scratch" != xyes ] && [ -d "$scratchdir" ] && rm -rf "$scratchdir"
202 if [ "x$whichtests" = x ]
207 for testscript in $suitedir/$whichtests
209 testbase=`echo $testscript | sed -e 's!.*/!!' -e 's/.test\$//'`
210 scratchdir="$scratchbase.$testbase"
215 sh $RUNSHFLAGS "$testscript" >"$scratchdir/test.log" 2>&1
219 if [ "x$always_log" = xyes -o \( $result != 0 -a $result != 77 -a $result != 78 \) ]
221 echo "----- $testbase log follows"
222 cat "$scratchdir/test.log"
223 echo "----- $testbase log ends"
224 if [ -f "$scratchdir/rsyncd.log" ]; then
225 echo "----- $testbase rsyncd.log follows"
226 cat "$scratchdir/rsyncd.log"
227 echo "----- $testbase rsyncd.log ends"
233 echo "PASS $testbase"
234 passed=`expr $passed + 1`
235 maybe_discard_scratch
238 # backticks will fill the whole file onto one line, which is a feature
239 whyskipped=`cat "$scratchdir/whyskipped"`
240 echo "SKIP $testbase ($whyskipped)"
241 skipped=`expr $skipped + 1`
242 maybe_discard_scratch
245 # It failed, but we expected that. don't dump out error logs,
246 # because most users won't want to see them. But do leave
247 # the working directory around.
248 echo "XFAIL $testbase"
249 failed=`expr $failed + 1`
252 echo "FAIL $testbase"
253 failed=`expr $failed + 1`
254 if [ "x$nopersist" = "xyes" ]
261 echo '------------------------------------------------------------'
262 echo "----- overall results:"
263 echo " $passed passed"
264 [ "$failed" -gt 0 ] && echo " $failed failed"
265 [ "$skipped" -gt 0 ] && echo " $skipped skipped"
266 [ "$missing" -gt 0 ] && echo " $missing missing"
267 echo '------------------------------------------------------------'
269 # OK, so expr exits with 0 if the result is neither null nor zero; and
270 # 1 if the expression is null or zero. This is the opposite of what
271 # we want, and if we just call expr then this script will always fail,
274 result=`expr $failed + $missing || true`
275 echo "overall result is $result"