tests/test-export-info.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 -e
  35 set -x
  36
  37 requires_plugin sh
  38 requires nbdsh -c 'print(h.set_full_info)'
  39
  40 export sock=$(mktemp -u /tmp/nbdkit-test-sock.XXXXXX)
  41 files="$sock export-info.pid"
  42 rm -f $files
  43 cleanup_fn rm -f $files
  44
  45 # Create an nbdkit sh plugin for checking NBD_INFO replies to NBD_OPT_GO.
  46 start_nbdkit -P export-info.pid -U $sock \
  47              sh - <<'EOF'
  48 case "$1" in
  49     default_export) echo hello ;;
  50     open) echo "$3" ;;
  51     export_description) echo "$2 world" ;;
  52     get_size) echo 0 ;;
  53     *) exit 2 ;;
  54 esac
  55 EOF
  56
  57 # Without client request, nothing is advertised
  58 nbdsh -c '
  59 import os
  60
  61 def must_fail(f, *args, **kwds):
  62   try:
  63     f(*args, **kwds)
  64     assert False
  65   except nbd.Error:
  66     pass
  67
  68 h.set_opt_mode(True)
  69 h.connect_unix(os.environ["sock"])
  70
  71 h.set_export_name("a")
  72 h.opt_info()
  73 must_fail(h.get_canonical_export_name)
  74 must_fail(h.get_export_description)
  75
  76 h.set_export_name("")
  77 h.opt_info()
  78 must_fail(h.get_canonical_export_name)
  79 must_fail(h.get_export_description)
  80
  81 h.opt_go()
  82 must_fail(h.get_canonical_export_name)
  83 must_fail(h.get_export_description)
  84
  85 h.shutdown()
  86 '
  87
  88 # With client request, reflect the export name and description back
  89 nbdsh -c '
  90 import os
  91
  92 h.set_opt_mode(True)
  93 h.set_full_info(True)
  94 h.connect_unix(os.environ["sock"])
  95
  96 h.set_export_name("a")
  97 h.opt_info()
  98 assert h.get_canonical_export_name() == "a"
  99 assert h.get_export_description() == "a world"
 100
 101 h.set_export_name("")
 102 h.opt_info()
 103 assert h.get_canonical_export_name() == "hello"
 104 assert h.get_export_description() == "hello world"
 105
 106 h.opt_go()
 107 assert h.get_canonical_export_name() == "hello"
 108 assert h.get_export_description() == "hello world"
 109
 110 h.shutdown()
 111 '