1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
#!/usr/bin/env bash
# nbdkit
# Copyright Red Hat
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# * Neither the name of Red Hat nor the names of its contributors may be
# used to endorse or promote products derived from this software without
# specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
# This is an example from the nbdkit-eval-plugin(1) manual page.
# Check here that it doesn't regress.
source ./functions.sh
set -e
set -x
set -u
requires_run
requires_plugin eval
requires_nbdinfo
requires_nbdsh_uri
requires nbdsh -c 'print(h.set_full_info)'
requires jq --version
sock=$(mktemp -u /tmp/nbdkit-test-sock.XXXXXX)
files="eval-exports.list eval-exports.out eval-exports.pid $sock"
rm -f $files
cleanup_fn rm -f $files
fail=0
# Control case: no .list_exports, which defaults to advertising ""
rm -f eval-exports.list
nbdkit -v eval \
open='[ "$3" = "" ] || { echo EINVAL wrong export >&2; exit 1; }' \
get_size='echo 0' --run 'nbdinfo --list --json "$uri"' > eval-exports.out
cat eval-exports.out
diff -u <(jq -c \
'[.exports[] | [."export-name", .description, ."export-size"]]' \
eval-exports.out) <(printf %s\\n '[["",null,0]]')
# Start a long-running server with .list_exports and .default_export
# set to varying contents
start_nbdkit -P eval-exports.pid -U $sock eval get_size='echo "$2"|wc -c' \
open='echo "$3"' list_exports="cat '$PWD/eval-exports.list'" \
default_export="cat '$PWD/eval-exports.list'"
# do_nbdkit EXPNAME EXPOUT
do_nbdkit ()
{
# Check how the default export name is handled
nbdinfo --no-content nbd+unix://\?socket=$sock >eval-exports.out
diff -u <($SED -n 's/export="\(.*\)":/\1/p' eval-exports.out) \
<(printf %s\\n "$1")
# Check what exports are listed
nbdinfo --list --json nbd+unix://\?socket=$sock >eval-exports.out
cat eval-exports.out
diff -u <(jq -c \
'[.exports[] | [."export-name", .description, ."export-size"]]' \
eval-exports.out) <(printf %s\\n "$2")
}
# With no file, .list_exports and .default_export both fail, preventing
# connection to the default export, but not other exports
nbdinfo --list --json nbd+unix://\?socket=$sock && fail=1
nbdsh -c '
import os
try:
h.connect_uri("nbd+unix://?socket='"$sock"'")
exit(1)
except nbd.Error:
pass
' || fail=1
nbdsh -u nbd+unix:///name\?socket=$sock -c 'quit()'
# Setting .default_export but not .list_exports advertises the canonical name
nbdkit eval default_export='echo hello' get_size='echo 0' \
--run 'nbdinfo --list "$uri"' >eval-exports.out
diff -u <(grep '^export=' eval-exports.out) <(echo 'export="hello":')
# Failing .default_export without .list_exports results in an empty list
nbdkit eval default_export='echo ENOENT >&2; exit 1' get_size='echo 0' \
--run 'nbdinfo --list "$uri"' >eval-exports.out
diff -u <(grep '^export=' eval-exports.out) /dev/null
# Various spellings of empty lists, producing 0 exports
for fmt in '' 'NAMES\n' 'INTERLEAVED\n' 'NAMES+DESCRIPTIONS\n'; do
printf "$fmt" >eval-exports.list
do_nbdkit '' '[]'
done
# Various spellings of explicit list for the default export, no description
for fmt in '\n' 'NAMES\n\n' 'INTERLEAVED\n\n' 'INTERLEAVED\n\n\n' \
'NAMES+DESCRIPTIONS\n\n' 'NAMES+DESCRIPTIONS\n\n\n'; do
printf "$fmt" >eval-exports.list
do_nbdkit '' '[["",null,1]]'
done
# A non-default name
for fmt in 'name\n' 'NAMES\nname\n'; do
printf "$fmt" >eval-exports.list
do_nbdkit name '[["name",null,5]]'
done
# One export with a description
for fmt in 'INTERLEAVED\nname\ndesc\n' 'NAMES+DESCRIPTIONS\nname\ndesc\n'; do
printf "$fmt" >eval-exports.list
do_nbdkit name '[["name","desc",5]]'
done
# Multiple exports, with correct number of lines
for fmt in 'INTERLEAVED\nname 1\ndesc 1\nname two\ndesc 2\n' \
'NAMES+DESCRIPTIONS\nname 1\nname two\ndesc 1\ndesc 2\n'; do
printf "$fmt" >eval-exports.list
do_nbdkit 'name 1' '[["name 1","desc 1",7],["name two","desc 2",9]]'
done
# Multiple exports, with final description line missing
for fmt in 'INTERLEAVED\nname 1\ndesc 1\nname two\n' \
'NAMES+DESCRIPTIONS\nname 1\nname two\ndesc 1\n'; do
printf "$fmt" >eval-exports.list
do_nbdkit 'name 1' '[["name 1","desc 1",7],["name two",null,9]]'
done
# Largest possible name and description
long=$(printf %04096d 1)
echo NAMES+DESCRIPTIONS >eval-exports.list
echo $long >>eval-exports.list
echo $long >>eval-exports.list
do_nbdkit $long "[[\"$long\",\"$long\",4097]]"
# Invalid name (too long) causes an error response to NBD_OPT_LIST
nbdkit -v eval list_exports="echo 2$long" \
get_size='echo 0' --run 'nbdinfo --list --json "$uri"' && fail=1
exit $fail
|
