tests/test-data-extents.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 # Unfortunately the output of this test depends on the PAGE_SIZE
  34 # defined in common/sparse/sparse.c and would change (breaking the
  35 # test) if we ever changed that definition.
  36
  37 source ./functions.sh
  38 set -e
  39 set -x
  40
  41 requires jq --version
  42 requires qemu-img --version
  43 requires qemu-img map --help
  44
  45 out="test-data-extents.out"
  46 expected="test-data-extents.expected"
  47 files="$out $expected"
  48 rm -f $files
  49 cleanup_fn rm -f $files
  50
  51 do_test ()
  52 {
  53     # We use jq to normalize the output and convert it to plain text.
  54     nbdkit -U - data data="$1" size="$2" \
  55            --run 'qemu-img map -f raw --output=json $nbd' |
  56         jq -c '.[] | {start:.start, length:.length, data:.data, zero:.zero}' \
  57            > $out
  58     if ! cmp $out $expected; then
  59         echo "$0: output did not match expected data"
  60         echo "expected:"
  61         cat $expected
  62         echo "output:"
  63         cat $out
  64         exit 1
  65     fi
  66 }
  67
  68 # Completely sparse disk.
  69 cat > $expected <<'EOF'
  70 {"start":0,"length":1048576,"data":false,"zero":true}
  71 EOF
  72 do_test "" 1M
  73
  74 # Completely allocated disk.
  75 cat > $expected <<'EOF'
  76 {"start":0,"length":32768,"data":true,"zero":false}
  77 EOF
  78 do_test "1" 32K
  79
  80 # Allocated data at the start of a 1M disk.
  81 cat > $expected <<'EOF'
  82 {"start":0,"length":32768,"data":true,"zero":false}
  83 {"start":32768,"length":1015808,"data":false,"zero":true}
  84 EOF
  85 do_test "1" 1M
  86
  87 # Allocated zeroes at the start of the disk.  This should create a
  88 # zero extent (data=true zero=true).
  89 cat > $expected <<'EOF'
  90 {"start":0,"length":32768,"data":true,"zero":true}
  91 {"start":32768,"length":1015808,"data":false,"zero":true}
  92 EOF
  93 do_test "0" 1M
  94
  95 # Completely zero disk.
  96 cat > $expected <<'EOF'
  97 {"start":0,"length":32768,"data":true,"zero":true}
  98 EOF
  99 do_test "0 0 0" 32K
 100
 101 # Allocated data and zero extents in a few places in the middle.
 102 cat > $expected <<'EOF'
 103 {"start":0,"length":32768,"data":false,"zero":true}
 104 {"start":32768,"length":32768,"data":true,"zero":false}
 105 {"start":65536,"length":32768,"data":true,"zero":true}
 106 {"start":98304,"length":32768,"data":false,"zero":true}
 107 {"start":131072,"length":32768,"data":true,"zero":false}
 108 {"start":163840,"length":98304,"data":false,"zero":true}
 109 {"start":262144,"length":32768,"data":true,"zero":true}
 110 {"start":294912,"length":32768,"data":true,"zero":false}
 111 {"start":327680,"length":720896,"data":false,"zero":true}
 112 EOF
 113 do_test "@32768 1 @65536 0 @131072 1 @262144 0 @294912 1" 1M
 114
 115 # This should test coalescing in the extents code.
 116 cat > $expected <<'EOF'
 117 {"start":0,"length":32768,"data":false,"zero":true}
 118 {"start":32768,"length":65536,"data":true,"zero":false}
 119 {"start":98304,"length":32768,"data":false,"zero":true}
 120 {"start":131072,"length":65536,"data":true,"zero":true}
 121 {"start":196608,"length":851968,"data":false,"zero":true}
 122 EOF
 123 do_test "@32768 1 @65536 1 @131072 0 @163840 0" 1M
 124
 125 # Zero-length plugin.  Unlike nbdkit-zero-plugin, the data plugin
 126 # advertises extents and so will behave differently.
 127 cat > $expected <<'EOF'
 128 {"start":0,"length":0,"data":false,"zero":false}
 129 EOF
 130 do_test "" 0