3 # Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
4 # Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License version
8 # 2 as published by the Free Software Foundation.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
88 # pretty handy (see function makepath for the latter).
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)
103 # Don't rely on grep -q, as that doesn't work everywhere -- just redirect
104 # stdout to /dev/null to keep it quiet.
109 # We need a good protection against tests that hang indefinitely.
110 # Perhaps some combination of starting them in the background, wait,
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.
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
132 [ -d /usr/xpg4/bin ] && PATH="/usr/xpg4/bin/:$PATH"
134 if [ "x$loglevel" != x ] && [ "$loglevel" -gt 8 ]; then
136 # If it doesn't work the first time, don't keep trying.
137 RUNSHFLAGS="$RUNSHFLAGS -x"
142 if test x"$TOOLDIR" = x; then
146 if test x"$srcdir" = x -o x"$srcdir" = x.; then
149 if test x"$rsync_bin" = x; then
150 rsync_bin="$TOOLDIR/rsync"
153 # This allows the user to specify extra rsync options -- use carefully!
154 RSYNC="$rsync_bin $*"
155 #RSYNC="valgrind $rsync_bin $*"
157 export POSIXLY_CORRECT TOOLDIR srcdir RSYNC
159 echo "============================================================"
160 echo "$0 running in $TOOLDIR"
161 echo " rsync_bin=$RSYNC"
162 echo " srcdir=$srcdir"
164 if [ -f /usr/bin/whoami ]; then
165 testuser=`/usr/bin/whoami`
166 elif [ -f /usr/ucb/whoami ]; then
167 testuser=`/usr/ucb/whoami`
168 elif [ -f /bin/whoami ]; then
169 testuser=`/bin/whoami`
171 testuser=`id -un 2>/dev/null || echo ${LOGNAME:-${USERNAME:-${USER:-'UNKNOWN'}}}`
174 echo " testuser=$testuser"
175 echo " os=`uname -a`"
177 # It must be "yes", not just nonnull
178 if [ "x$preserve_scratch" = xyes ]; then
179 echo " preserve_scratch=yes"
181 echo " preserve_scratch=no"
184 # Check if setfacl is around and if it supports the -k or -s option.
185 if setfacl --help 2>&1 | grep ' -k,\|\[-[a-z]*k' >/dev/null; then
186 setfacl_nodef='setfacl -k'
187 elif setfacl -s u::7,g::5,o:5 testsuite 2>/dev/null; then
188 setfacl_nodef='setfacl -s u::7,g::5,o:5'
195 if [ ! -f "$rsync_bin" ]; then
196 echo "rsync_bin $rsync_bin is not a file" >&2
200 if [ ! -d "$srcdir" ]; then
201 echo "srcdir $srcdir is not a directory" >&2
210 # Prefix for scratch directory. We create separate directories for
211 # each test case, so that they can be left behind in case of failure
212 # to aid investigation.
213 scratchbase="$TOOLDIR"/testtmp
214 echo " scratchbase=$scratchbase"
216 suitedir="$srcdir/testsuite"
218 export scratchdir suitedir
221 [ -d "$scratchdir" ] && rm -rf "$scratchdir"
223 # Get rid of default ACLs and dir-setgid to avoid confusing some tests.
224 $setfacl_nodef "$scratchdir" || true
225 chmod g-s "$scratchdir"
229 maybe_discard_scratch() {
230 [ x"$preserve_scratch" != xyes ] && [ -d "$scratchdir" ] && rm -rf "$scratchdir"
234 if [ "x$whichtests" = x ]; then
238 for testscript in $suitedir/$whichtests
240 testbase=`echo $testscript | sed -e 's!.*/!!' -e 's/.test\$//'`
241 scratchdir="$scratchbase.$testbase"
246 sh $RUNSHFLAGS "$testscript" >"$scratchdir/test.log" 2>&1
250 if [ "x$always_log" = xyes -o \( $result != 0 -a $result != 77 -a $result != 78 \) ]
252 echo "----- $testbase log follows"
253 cat "$scratchdir/test.log"
254 echo "----- $testbase log ends"
255 if [ -f "$scratchdir/rsyncd.log" ]; then
256 echo "----- $testbase rsyncd.log follows"
257 cat "$scratchdir/rsyncd.log"
258 echo "----- $testbase rsyncd.log ends"
264 echo "PASS $testbase"
265 passed=`expr $passed + 1`
266 maybe_discard_scratch
269 # backticks will fill the whole file onto one line, which is a feature
270 whyskipped=`cat "$scratchdir/whyskipped"`
271 echo "SKIP $testbase ($whyskipped)"
272 skipped=`expr $skipped + 1`
273 maybe_discard_scratch
276 # It failed, but we expected that. don't dump out error logs,
277 # because most users won't want to see them. But do leave
278 # the working directory around.
279 echo "XFAIL $testbase"
280 failed=`expr $failed + 1`
283 echo "FAIL $testbase"
284 failed=`expr $failed + 1`
285 if [ "x$nopersist" = xyes ]; then
291 echo '------------------------------------------------------------'
292 echo "----- overall results:"
293 echo " $passed passed"
294 [ "$failed" -gt 0 ] && echo " $failed failed"
295 [ "$skipped" -gt 0 ] && echo " $skipped skipped"
296 [ "$missing" -gt 0 ] && echo " $missing missing"
297 echo '------------------------------------------------------------'
299 # OK, so expr exits with 0 if the result is neither null nor zero; and
300 # 1 if the expression is null or zero. This is the opposite of what
301 # we want, and if we just call expr then this script will always fail,
304 result=`expr $failed + $missing || true`
305 echo "overall result is $result"