tests/test-retry-zero-flags.sh

   1 #!/usr/bin/env bash
   2 # nbdkit
   3 # Copyright (C) 2018-2019 Red Hat Inc.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are
   7 # met:
   8 #
   9 # * Redistributions of source code must retain the above copyright
  10 # notice, this list of conditions and the following disclaimer.
  11 #
  12 # * Redistributions in binary form must reproduce the above copyright
  13 # notice, this list of conditions and the following disclaimer in the
  14 # documentation and/or other materials provided with the distribution.
  15 #
  16 # * Neither the name of Red Hat nor the names of its contributors may be
  17 # used to endorse or promote products derived from this software without
  18 # specific prior written permission.
  19 #
  20 # THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  21 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  22 # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  23 # PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  24 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  27 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  28 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 # OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 # SUCH DAMAGE.
  32
  33 source ./functions.sh
  34 set -e
  35 set -x
  36
  37 requires nbdsh -c 'i = nbd.CMD_FLAG_FAST_ZERO
  38 exit(not h.supports_uri())'
  39
  40 files="retry-zero-flags-count retry-zero-flags-open-count"
  41 rm -f $files
  42 cleanup_fn rm -f $files
  43
  44 touch retry-zero-flags-count retry-zero-flags-open-count
  45 start_t=$SECONDS
  46
  47 # Create a custom plugin which will test retrying.
  48 nbdkit -v -U - \
  49        sh - \
  50        --filter=retry retry-delay=1 \
  51        --run 'nbdsh --uri $uri -c "
  52 h.zero (512, 0)
  53 try:
  54     h.zero (512, 0,
  55             nbd.CMD_FLAG_FUA | nbd.CMD_FLAG_NO_HOLE | nbd.CMD_FLAG_FAST_ZERO)
  56 except nbd.Error as ex:
  57     assert ex.errno == \"ENOTSUP\"
  58 h.zero (512, 0, nbd.CMD_FLAG_FUA)
  59        "' <<'EOF'
  60 #!/usr/bin/env bash
  61 case "$1" in
  62     open)
  63         # Count how many times the connection is (re-)opened.
  64         read i < retry-zero-flags-open-count
  65         echo $((i+1)) > retry-zero-flags-open-count
  66         ;;
  67     can_write | can_zero) exit 0 ;;
  68     can_fua)
  69         # Drop FUA support on particular reopens
  70         read i < retry-zero-flags-open-count
  71         case $i in
  72             2 | 3) echo none ;;
  73             *) echo native ;;
  74         esac
  75         ;;
  76     can_fast_zero)
  77         # Drop fast zero support on particular reopens
  78         read i < retry-zero-flags-open-count
  79         case $i in
  80             3 | 4) exit 3 ;;
  81             *) exit 0 ;;
  82         esac
  83         ;;
  84     zero)
  85         # First zero fails, thereafter it works
  86         read i < retry-zero-flags-count
  87         ((i++))
  88         echo $i > retry-zero-flags-count
  89         if [ $i -le 1 ]; then
  90             echo "EIO zero failed" >&2
  91             exit 1
  92         fi
  93         ;;
  94
  95     get_size) echo 512 ;;
  96     *) exit 2 ;;
  97 esac
  98 EOF
  99
 100 # In this test we should see the following pattern:
 101 # open count 1: both fua and fast_zero supported
 102 # first zero FAILS
 103 # retry and wait 1 seconds
 104 # only fast_zero supported
 105 # first zero succeeds
 106 # second zero FAILS due to missing fua support
 107 # retry and wait 1 seconds
 108 # open count 2: neither fua nor fast_zero supported
 109 # second zero FAILS fast due to missing fast_zero support
 110 # third zero FAILS due to missing fua support
 111 # retry and wait 1 seconds
 112 # open count 3: only fua supported
 113 # third zero succeeds
 114
 115 # The minimum time for the test should be 1+1+1 = 3 seconds.
 116 end_t=$SECONDS
 117 if [ $((end_t - start_t)) -lt 3 ]; then
 118     echo "$0: test ran too quickly"
 119     exit 1
 120 fi
 121
 122 # Check the handle was opened 4 times (first open + one reopen for
 123 # each retry).
 124 read open_count < retry-zero-flags-open-count
 125 if [ $open_count -ne 4 ]; then
 126     echo "$0: open-count ($open_count) != 4"
 127     exit 1
 128 fi