tests/test-info-base64.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 # Test the info plugin with base64-encoded export name.
  34
  35 source ./functions.sh
  36 set -e
  37 set -x
  38
  39 requires nbdsh -c 'import base64'
  40
  41 # Test if mode=base64exportname is supported in this build.
  42 if ! nbdkit info --dump-plugin | grep -sq "info_base64=yes"; then
  43     echo "$0: mode=base64exportname is not supported in this build"
  44     exit 77
  45 fi
  46
  47 sock=$(mktemp -u /tmp/nbdkit-test-sock.XXXXXX)
  48 files="info-base64.out info-base64.pid $sock"
  49 rm -f $files
  50 cleanup_fn rm -f $files
  51
  52 # Run nbdkit.
  53 start_nbdkit -P info-base64.pid -U $sock \
  54        info mode=base64exportname
  55
  56 export e sock
  57 for e in "" "test" "/" "//" " " "/ " "?" "テスト" "-n" '\\' $'\n' "%%" \
  58          "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  59 do
  60     nbdsh -c '
  61 import os
  62 import base64
  63
  64 e = os.environ["e"]
  65 b = base64.b64encode(e.encode("utf-8")).decode("utf-8")
  66 print("e = %r, b = %r" % (e,b))
  67 h.set_export_name(b)
  68 h.connect_unix(os.environ["sock"])
  69
  70 size = h.get_size()
  71 assert size == len(e.encode("utf-8"))
  72
  73 # Zero-sized reads are not defined in the NBD protocol.
  74 if size > 0:
  75    buf = h.pread(size, 0)
  76    assert buf == e.encode("utf-8")
  77 '
  78 done
  79
  80 # Test that it fails if the caller passes in non-base64 data.  The
  81 # server drops the connection in this case so it's not very graceful
  82 # but we should at least get an nbd.Error and not something else.
  83 nbdsh -c '
  84 import os
  85 import sys
  86
  87 h.set_export_name("xyz")
  88 try:
  89     h.connect_unix(os.environ["sock"])
  90     # This should not happen.
  91     sys.exit(1)
  92 except nbd.Error:
  93     pass
  94 '