tests/test-retry-zero-flags.sh

   1 #!/usr/bin/env bash
   2 # nbdkit
   3 # Copyright (C) 2018-2020 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_plugin sh
  38 requires_nbdsh_uri
  39 requires nbdsh -c 'i = nbd.CMD_FLAG_FAST_ZERO'
  40
  41 files="retry-zero-flags-count retry-zero-flags-open-count"
  42 rm -f $files
  43 cleanup_fn rm -f $files
  44
  45 touch retry-zero-flags-count retry-zero-flags-open-count
  46 start_t=$SECONDS
  47
  48 # Create a custom plugin which will test retrying.
  49 nbdkit -v -U - \
  50        sh - \
  51        --filter=retry retry-delay=1 \
  52        --run 'nbdsh --uri "$uri" -c "
  53 h.zero(512, 0)
  54 try:
  55     h.zero(512, 0,
  56            nbd.CMD_FLAG_FUA | nbd.CMD_FLAG_NO_HOLE | nbd.CMD_FLAG_FAST_ZERO)
  57 except nbd.Error as ex:
  58     assert ex.errno == \"ENOTSUP\"
  59 h.zero(512, 0, nbd.CMD_FLAG_FUA)
  60        "' <<'EOF'
  61 #!/usr/bin/env bash
  62 case "$1" in
  63     open)
  64         # Count how many times the connection is (re-)opened.
  65         read i < retry-zero-flags-open-count
  66         echo $((i+1)) > retry-zero-flags-open-count
  67         ;;
  68     can_write | can_zero) exit 0 ;;
  69     can_fua)
  70         # Drop FUA support on particular reopens
  71         read i < retry-zero-flags-open-count
  72         case $i in
  73             2 | 3) echo none ;;
  74             *) echo native ;;
  75         esac
  76         ;;
  77     can_fast_zero)
  78         # Drop fast zero support on particular reopens
  79         read i < retry-zero-flags-open-count
  80         case $i in
  81             3 | 4) exit 3 ;;
  82             *) exit 0 ;;
  83         esac
  84         ;;
  85     zero)
  86         # First zero fails, thereafter it works
  87         read i < retry-zero-flags-count
  88         ((i++))
  89         echo $i > retry-zero-flags-count
  90         if [ $i -le 1 ]; then
  91             echo "EIO zero failed" >&2
  92             exit 1
  93         fi
  94         ;;
  95
  96     get_size) echo 512 ;;
  97     *) exit 2 ;;
  98 esac
  99 EOF
 100
 101 # In this test we should see the following pattern:
 102 # open count 1: both fua and fast_zero supported
 103 # first zero FAILS
 104 # retry and wait 1 seconds
 105 # only fast_zero supported
 106 # first zero succeeds
 107 # second zero FAILS due to missing fua support
 108 # retry and wait 1 seconds
 109 # open count 2: neither fua nor fast_zero supported
 110 # second zero FAILS fast due to missing fast_zero support
 111 # third zero FAILS due to missing fua support
 112 # retry and wait 1 seconds
 113 # open count 3: only fua supported
 114 # third zero succeeds
 115
 116 # The minimum time for the test should be 1+1+1 = 3 seconds.
 117 end_t=$SECONDS
 118 if [ $((end_t - start_t)) -lt 3 ]; then
 119     echo "$0: test ran too quickly"
 120     exit 1
 121 fi
 122
 123 # Check the handle was opened 4 times (first open + one reopen for
 124 # each retry).
 125 read open_count < retry-zero-flags-open-count
 126 if [ $open_count -ne 4 ]; then
 127     echo "$0: open-count ($open_count) != 4"
 128     exit 1
 129 fi