tests/test-dump-plugin.sh

   1 #!/usr/bin/env bash
   2 # nbdkit
   3 # Copyright (C) 2014-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 source ./functions.sh
  34 set -e
  35 set -x
  36
  37 # Basic check that the name field is present.
  38 output="$(nbdkit example1 --dump-plugin)"
  39 if [[ ! ( "$output" =~ name\=example1 ) ]]; then
  40     echo "$0: unexpected output from nbdkit example1 --dump-plugin"
  41     echo "$output"
  42     exit 1
  43 fi
  44
  45 # example2 overrides the --dump-plugin with extra data.
  46 output="$(nbdkit example2 --dump-plugin)"
  47 if [[ ! ( "$output" =~ example2_extra\=hello ) ]]; then
  48     echo "$0: unexpected output from nbdkit example2 --dump-plugin"
  49     echo "$output"
  50     exit 1
  51 fi
  52
  53 # Run nbdkit plugin --dump-plugin for each plugin.
  54 # However some of these tests are expected to fail.
  55 do_test ()
  56 {
  57     vg=; [ "$NBDKIT_VALGRIND" = "1" ] && vg="-valgrind"
  58     case "$1$vg" in
  59         vddk | vddk-valgrind)
  60             echo "$0: skipping $1$vg because VDDK cannot run without special environment variables"
  61             ;;
  62         python-valgrind | ruby-valgrind | tcl-valgrind)
  63             echo "$0: skipping $1$vg because this language doesn't support valgrind"
  64             ;;
  65         *)
  66             nbdkit $1 --dump-plugin
  67             ;;
  68     esac
  69 }
  70 foreach_plugin do_test
  71
  72 # Test that --dump-plugin can be used to introspect a resulting dynamic
  73 # thread model.  First, get a baseline (since a system without atomic
  74 # CLOEXEC can't do parallel). Then test various patterns with the sh plugin.
  75 max=$(nbdkit --dump-plugin file | sed -n '/^thread_model=/ s///p')
  76
  77 # With no script, thread_model matches the baseline
  78 out=$(nbdkit --dump-plugin sh | grep thread_model)
  79 exp="max_thread_model=parallel
  80 thread_model=$max
  81 has_thread_model=1"
  82 if [ "$out" != "$exp" ]; then
  83     echo "thread_model mismatch"; exit 1
  84 fi
  85
  86 # With a script that does not specify a model, historical back-compat
  87 # forces the model to serialized
  88 out=$(nbdkit --dump-plugin sh - <<\EOF | grep ^thread_model
  89 case $1 in
  90     get_size) echo 1M ;;
  91     *) exit 2 ;;
  92 esac
  93 EOF
  94 )
  95 if [ "$out" != "thread_model=serialize_all_requests" ]; then
  96     echo "thread_model mismatch"; exit 1
  97 fi
  98
  99 # A script can request the maximum, but will only get the baseline
 100 out=$(nbdkit --dump-plugin sh - <<\EOF | grep ^thread_model
 101 case $1 in
 102     thread_model) echo parallel ;;
 103     get_size) echo 1M ;;
 104     *) exit 2 ;;
 105 esac
 106 EOF
 107 )
 108 if [ "$out" != "thread_model=$max" ]; then
 109     echo "thread_model mismatch"; exit 1
 110 fi
 111
 112 # A script can request an even stricter model
 113 out=$(nbdkit --dump-plugin sh - <<\EOF | grep ^thread_model
 114 case $1 in
 115     thread_model) echo serialize_connections ;;
 116     get_size) echo 1M ;;
 117     *) exit 2 ;;
 118 esac
 119 EOF
 120 )
 121 if [ "$out" != "thread_model=serialize_connections" ]; then
 122     echo "thread_model mismatch"; exit 1
 123 fi
 124
 125 # Finally, a filter can restrict things
 126 out=$(nbdkit --dump-plugin --filter=noparallel sh - \
 127              serialize=connections <<\EOF | grep ^thread_model
 128 case $1 in
 129     get_size) echo 1M ;;
 130     *) exit 2 ;;
 131 esac
 132 EOF
 133 )
 134 if [ "$out" != "thread_model=serialize_connections" ]; then
 135     echo "thread_model mismatch"; exit 1
 136 fi