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
|
#!/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.
# Test the nbdkit <plugin> --help output matches the associated POD
# documentation.
source ./functions.sh
set -e
# This test fails for some plugins which on Windows have reduced
# functionality (eg. nbdkit-file-plugin lacks fd, dirfd, etc.). Since
# the test doesn't parse the man page looking for "not Windows"
# annotations it doesn't work right. Anyway it is fine to skip the
# test on Windows as we only care about man pages matching the plugin
# --help output on Linux.
if is_windows; then
echo "$0: this test needs to be revised to work on Windows"
exit 77
fi
# There's no point doing this test under valgrind.
skip_if_valgrind
rm -f plugin-keys.txt pod-keys.txt
cleanup_fn rm -f plugin-keys.txt pod-keys.txt
errors=0
run_test ()
{
plugin="$1"
pod=$srcdir/../plugins/$plugin/nbdkit-$plugin-plugin.pod
test -f "$pod"
# Get the key=value lines from the help output.
nbdkit $plugin --help |
grep -Eo '^[-_A-Za-z0-9]+=|^\[[-_A-Za-z0-9]+=\]' |
$SED -e 's/\[//' -e 's/\]//' > plugin-keys.txt
# Get the key=value lines from the POD documentation.
cat "$pod" |
grep -Eo '^=item B<[-_A-Za-z0-9]+=|^=item \[B<[-_A-Za-z0-9]+=' |
$SED -e 's/=item //' -e 's/B<//' -e 's/\[//' > pod-keys.txt
# Check each plugin --help key is mentioned in the POD
# documentation.
for key in `cat plugin-keys.txt`; do
if ! grep -sq "^$key" pod-keys.txt; then
echo "error: $pod: documentation does not mention '$key...'" >&2
((errors++)) ||:
fi
done
# Check each POD documentation key is mentioned in plugin --help.
for key in `cat pod-keys.txt`; do
if ! grep -sq "^$key" plugin-keys.txt; then
echo -n "error: nbdkit-$plugin-plugin: " >&2
echo "--help output does not mention '$key...'" >&2
((errors++)) ||:
fi
done
}
do_test ()
{
case "$1" in
cc|eval|golang|lua|ocaml|perl|python|rust|sh|tcl)
# Skip all language plugins as this test doesn't
# make sense for these.
;;
S3|gcs|example4)
# The --help output is for the language plugin (like
# perl or python) not the actual plugin. This is
# really a bug in how we do --help output, for now
# ignore.
;;
blkio)
# The --help output describes the generic PROPERTY= which
# breaks the test. Ignore it.
;;
example2|example3)
# The example documentation doesn't list options.
# Should it? Possibly, but ignore for now.
;;
nbd)
# Because of macOS SIP misfeature the DYLD_* environment
# variable added by libnbd/run is filtered out and the
# test won't work. Skip it entirely on Macs.
if test "$(uname)" != "Darwin"; then run_test $1; fi
;;
vddk)
# This plugin has many parameters and the --help output
# directs you to the manual. Ignore it.
;;
*)
run_test $1
;;
esac
}
foreach_plugin do_test
if [ "$errors" -ge 1 ]; then exit 1; fi
|
