tests/test-flush.sh

   1 #!/usr/bin/env bash
   2 # nbdkit
   3 # Copyright (C) 2019-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 -x
  35
  36 requires_single_mode
  37 requires nbdsh --version
  38
  39 plugin=.libs/test-flush-plugin.$SOEXT
  40 requires test -f $plugin
  41
  42 files="test-flush.err"
  43 rm -f $files
  44 cleanup_fn rm -f $files
  45
  46 marker() {
  47     echo " ** $@" >>test-flush.err
  48 }
  49
  50 marker "Test what happens when a plugin fails .can_flush"
  51 nbdsh -c '
  52 try:
  53     h.connect_command(["nbdkit", "-s", "-v", "'$plugin'"])
  54     # If we got here, things are broken
  55     exit(1)
  56 except nbd.Error:
  57     pass
  58 ' 2>>test-flush.err
  59
  60 marker "A read-only server still triggers .can_flush, which still fails"
  61 nbdsh -c '
  62 try:
  63     h.connect_command(["nbdkit", "-s", "-r", "-v", "'$plugin'"])
  64     # If we got here, things are broken
  65     exit(1)
  66 except nbd.Error:
  67     pass
  68 ' 2>>test-flush.err
  69
  70 marker "Disable flush and FUA"
  71 nbdsh -c '
  72 h.connect_command(["nbdkit", "-s", "-v", "'$plugin'", "0"])
  73 assert h.is_read_only() == 0
  74 assert h.can_flush() == 0
  75 assert h.can_fua() == 0
  76 ' 2>>test-flush.err
  77
  78 marker "Normal flush, emulated FUA"
  79 nbdsh -c '
  80 h.connect_command(["nbdkit", "-s", "-v", "'$plugin'", "1"])
  81 assert h.is_read_only() == 0
  82 assert h.can_flush() == 1
  83 assert h.can_fua() == 1
  84 h.flush() # expect "handling flush"
  85 h.pwrite(bytearray(512), 0, nbd.CMD_FLAG_FUA) # expect "handling flush"
  86 ' 2>>test-flush.err
  87
  88 marker "Normal flush, .can_fua is not consulted or advertised when read-only"
  89 nbdsh -c '
  90 h.connect_command(["nbdkit", "-s", "-r", "-v", "'$plugin'", "1"])
  91 assert h.is_read_only() == 1
  92 assert h.can_flush() == 1
  93 assert h.can_fua() == 0
  94 h.flush() # expect "handling flush"
  95 ' 2>>test-flush.err
  96
  97 marker "Unusual return value for .can_flush, native FUA"
  98 nbdsh -c '
  99 h.connect_command(["nbdkit", "-s", "-v", "'$plugin'", "2"])
 100 assert h.is_read_only() == 0
 101 assert h.can_flush() == 1
 102 assert h.can_fua() == 1
 103 h.flush() # expect "handling flush"
 104 h.pwrite(bytearray(512), 0, nbd.CMD_FLAG_FUA) # expect "handling native FUA"
 105 ' 2>>test-flush.err
 106
 107 marker "Unusual return value for .can_flush, bogus for .can_fua"
 108 nbdsh -c '
 109 h.connect_command(["nbdkit", "-s", "-v", "'$plugin'", "3"])
 110 try:
 111     h.connect_command(["nbdkit", "-s", "-r", "-v", "'$plugin'"])
 112     # If we got here, things are broken
 113     exit(1)
 114 except nbd.Error:
 115     pass
 116 ' 2>>test-flush.err
 117
 118 marker "Unusual return value for .can_flush, -r means .can_fua unused"
 119 nbdsh -c '
 120 h.connect_command(["nbdkit", "-s", "-r", "-v", "'$plugin'", "3"])
 121 assert h.is_read_only() == 1
 122 assert h.can_flush() == 1
 123 assert h.can_fua() == 0
 124 h.flush() # expect "handling flush"
 125 ' 2>>test-flush.err
 126
 127 cat test-flush.err
 128 diff -u - <($SED -n 's/.*\( \*\*\(handling.*\)\?\).*/\1/p' test-flush.err) <<EOF
 129  **
 130  **
 131  **
 132  **
 133  **handling flush
 134  **handling flush
 135  **
 136  **handling flush
 137  **
 138  **handling flush
 139  **handling native FUA
 140  **
 141  **
 142  **handling flush
 143 EOF