testsuite/rsync.fns

   1 #! /bin/sh
   2
   3 # Copyright (C) 2001 by Martin Pool <mbp@samba.org>
   4
   5 # General-purpose test functions for rsync.
   6
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License version
   9 # 2 as published by the Free Software Foundation.
  10 #
  11 # This program is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # Lesser General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU Lesser General Public
  17 # License along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20
  21 tmpdir="$scratchdir"
  22 fromdir="$tmpdir/from"
  23 todir="$tmpdir/to"
  24 chkdir="$tmpdir/chk"
  25
  26 # Berkley's nice.
  27 PATH="$PATH:/usr/ucb"
  28
  29 if diff -u "$srcdir/testsuite/rsync.fns" "$srcdir/testsuite/rsync.fns" >/dev/null 2>&1; then
  30     diffopt="-u"
  31 else
  32     diffopt="-c"
  33 fi
  34
  35 runtest() {
  36     echo $ECHO_N "Test $1: $ECHO_C"
  37     if eval "$2"
  38     then
  39         echo "$ECHO_T   done."
  40         return 0
  41     else
  42         echo "$ECHO_T failed!"
  43         return 1
  44     fi
  45 }
  46
  47 printmsg() {
  48     echo "$1"
  49 }
  50
  51
  52 rsync_ls_lR() {
  53     find "$@" -print | sort | xargs "$TOOLDIR/tls"
  54 }
  55
  56 rsync_getgroups() {
  57     "$TOOLDIR/getgroups"
  58 }
  59
  60
  61 ####################
  62 # Build test directories $todir and $fromdir, with $fromdir full of files.
  63
  64 hands_setup() {
  65     # Clean before creation
  66     rm -rf "$fromdir"
  67     rm -rf "$todir"
  68
  69     [ -d "$tmpdir" ] || mkdir "$tmpdir"
  70     [ -d "$fromdir" ] || mkdir "$fromdir"
  71     [ -d "$todir" ] || mkdir "$todir"
  72
  73     # On some BSD systems, the umask affects the mode of created
  74     # symlinks, even though the mode apparently has no effect on how
  75     # the links behave in the future, and it cannot be changed using
  76     # chmod!  rsync always sets its umask to 000 so that it can
  77     # accurately recreate permissions, but this script is probably run
  78     # with a different umask.
  79
  80     # This causes a little problem that "ls -l" of the two will not be
  81     # the same.  So, we need to set our umask before doing any creations.
  82
  83     # set up test data
  84     touch "$fromdir/empty"
  85     mkdir "$fromdir/emptydir"
  86
  87     # a hundred lines of text or so
  88     rsync_ls_lR "$srcdir" > "$fromdir/filelist"
  89
  90     echo $ECHO_N "This file has no trailing lf$ECHO_C" > "$fromdir/nolf"
  91     umask 0
  92     ln -s nolf "$fromdir/nolf-symlink"
  93     umask 022
  94
  95     cat $srcdir/*.c > "$fromdir/text"
  96     mkdir "$fromdir/dir"
  97     cp "$fromdir/text" "$fromdir/dir"
  98     mkdir "$fromdir/dir/subdir"
  99     echo some data > "$fromdir/dir/subdir/foobar.baz"
 100     mkdir "$fromdir/dir/subdir/subsubdir"
 101     if [ -r /etc ]; then
 102         ls -ltr /etc > "$fromdir/dir/subdir/subsubdir/etc-ltr-list"
 103     else
 104         ls -ltr / > "$fromdir/dir/subdir/subsubdir/etc-ltr-list"
 105     fi
 106     mkdir "$fromdir/dir/subdir/subsubdir2"
 107     if [ -r /bin ]; then
 108         ls -lt /bin > "$fromdir/dir/subdir/subsubdir2/bin-lt-list"
 109     else
 110         ls -lt / > "$fromdir/dir/subdir/subsubdir2/bin-lt-list"
 111     fi
 112
 113 #      echo testing head:
 114 #      ls -lR "$srcdir" | head -10 || echo failed
 115 }
 116
 117
 118 ####################
 119 # Many machines do not have "mkdir -p", so we have to build up long paths.
 120 # How boring.
 121 makepath () {
 122     echo "        makepath $1"
 123     p="$1"
 124     (
 125         # Absolut Unix.
 126         if echo $p | grep '^/' >/dev/null
 127         then
 128             cd /
 129         fi
 130
 131         # This will break if $1 contains a space.
 132         for c in `echo $p | tr '/' ' '`
 133         do
 134             if [ -d "$c" ] || mkdir "$c"
 135             then
 136                 cd "$c" || return $?
 137             else
 138                 echo "failed to create $c" >&2; return $?
 139             fi
 140         done
 141     )
 142 }
 143
 144
 145
 146 ###########################
 147 # Run a test (in '$1') then compare directories $2 and $3 to see if
 148 # there are any difference.  If there are, explain them.
 149
 150 # So normally basically $1 should be an rsync command, and $2 and $3
 151 # the source and destination directories.  This is only good when you
 152 # expect to transfer the whole directory exactly as is.  If some files
 153 # should be excluded, you might need to use something else.
 154
 155 checkit() {
 156     failed=
 157
 158     # We can just write everything to stdout/stderr, because the
 159     # wrapper hides it unless there is a problem.
 160
 161     echo "Running: \"$1\""
 162     eval "$1"
 163     status=$?
 164     if [ $status != 0 ]; then
 165         failed="YES";
 166     fi
 167
 168     echo "-------------"
 169     echo "check how the files compare with diff:"
 170     echo ""
 171     for f in `cd "$2"; find . -type f -print `
 172     do
 173         diff $diffopt "$2"/"$f" "$3"/"$f" || failed=YES
 174     done
 175
 176     echo "-------------"
 177     echo "check how the directory listings compare with diff:"
 178     echo ""
 179     ( cd "$2" && rsync_ls_lR . ) > "$tmpdir/ls-from"
 180     ( cd "$3" && rsync_ls_lR . ) > "$tmpdir/ls-to"
 181     diff $diffopt "$tmpdir/ls-from" "$tmpdir/ls-to" || failed=YES
 182     if [ -z "$failed" ] ; then
 183         return 0
 184     else
 185         return 1
 186     fi
 187 }
 188
 189
 190 build_rsyncd_conf() {
 191     # Build an appropriate configuration file
 192     conf="$scratchdir/test-rsyncd.conf"
 193     echo "building configuration $conf"
 194
 195     port=2612
 196     pidfile="$scratchdir/rsyncd.pid"
 197     logfile="$scratchdir/rsyncd.log"
 198
 199     cat >"$conf" <<EOF
 200 # rsyncd configuration file autogenerated by $0
 201
 202 pid file = $pidfile
 203 use chroot = no
 204 hosts allow = localhost, 127.0.0.1
 205 log file = $logfile
 206 exclude = foobar.baz
 207 max verbosity = 9
 208
 209 uid = 0
 210 gid = 0
 211
 212 [test-from]
 213         path = $fromdir
 214         read only = yes
 215
 216 [test-to]
 217         path = $todir
 218         read only = no
 219 EOF
 220 }
 221
 222
 223 build_symlinks() {
 224     mkdir "$fromdir"
 225     date >"$fromdir/referent"
 226     ln -s referent "$fromdir/relative"
 227     ln -s "$fromdir/referent" "$fromdir/absolute"
 228     ln -s nonexistent "$fromdir/dangling"
 229     ln -s "$srcdir/rsync.c" "$fromdir/unsafe"
 230 }
 231
 232 test_fail() {
 233     echo "$@" >&2
 234     exit 1
 235 }
 236
 237 test_skipped() {
 238     echo "$@" >&2
 239     echo "$@" > "$tmpdir/whyskipped"
 240     exit 77
 241 }
 242
 243 # It failed, but we expected that.  don't dump out error logs,
 244 # because most users won't want to see them.  But do leave
 245 # the working directory around.
 246 test_xfail() {
 247     echo "$@" >&2
 248     exit 78
 249 }
 250
 251 # Determine what shell command will appropriately test for links.
 252 ln -s foo "$scratchdir/testlink"
 253 for cmd in test /bin/test /usr/bin/test /usr/ucb/bin/test /usr/ucb/test
 254 do
 255     for switch in -h -L
 256     do
 257         if $cmd $switch "$scratchdir/testlink" 2>/dev/null
 258         then
 259             # how nice
 260             TEST_SYMLINK_CMD="$cmd $switch"
 261             # i wonder if break 2 is portable?
 262             break 2
 263         fi
 264    done
 265 done
 266 # ok, now get rid of it
 267 rm "$scratchdir/testlink"
 268
 269
 270 if [ "x$TEST_SYMLINK_CMD" = 'x' ]
 271 then
 272     test_fail "Couldn't determine how to test for symlinks"
 273 else
 274     echo "Testing for symlinks using '$TEST_SYMLINK_CMD'"
 275 fi
 276
 277
 278 # Test whether something is a link, allowing for shell peculiarities
 279 is_a_link() {
 280     # note the variable contains the first option and therefore is not quoted
 281     $TEST_SYMLINK_CMD "$1"
 282 }
 283
 284
 285 # We need to set the umask to be reproducible.  Note also that when we
 286 # do some daemon tests as root, we will setuid() and therefore the
 287 # directory has to be writable by the nobody user in some cases.  The
 288 # best thing is probably to explicitly chmod those directories after
 289 # creation.
 290
 291 umask 022