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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
#!/bin/bash
## This script is potentially dangerous! Don't run it on
## arbitrary commands.
export LC_ALL=C
if [ "$#" -lt 1 ]; then
echo "usage: $0 program..." >&2
echo " or try 'make checkusage' to check all built programs" >&2
exit 1
fi
top_srcdir="$(realpath -qLs "${1:-.}")"
if [ -d "${top_srcdir}" ]; then
shift 1
else
echo "directory '${top_srcdir}' not found" >&2
exit 1
fi
builddir="."
cmds=$(echo $@ | tr ' ' '\n' | sort)
# set env to dump all output to files
test -z "$CU_DUMP" || rm -f /tmp/checkusage--{help,version,unknownopt}
## Set alternative options for --help, --version
## or --unknownopt. "x" means "not implemented".
##
## Examples:
## alt_whereis__help="-h" # in past whereis(1) had no longopt for --help
## alt_more__help="x" # more(1) had neither --help nor -h
alt_fsck__unknownopt="x" # fsck passes unknown opts to fsck.ext4, etc.
alt_mkfs__unknownopt="x" # dito
alt_kill__unknownopt="inval pids" # trick, kill does not use errtryhelp()
if [ $(id -ru) -eq 0 ]; then
alt_sulogin__unknownopt="x" # would hang at pwd prompt
fi
function exec_option {
local cmdb=$1
local cmd=$2
opt=$3
local tofile="/tmp/checkusage$opt"
local alt="alt_${cmdb}${opt}"
alt=${alt//-/_}
alt=${alt//./_}
alt=$(eval printf -- \"\$${alt}\")
if test -n "$alt"; then
if test "$alt" = "x"; then
return 1
fi
opt=$alt
fi
test -z "$CU_DUMP" || {
echo "##########################################################"
echo "#### $cmdb"
$cmd $opt
} >> "$tofile" 2>&1
out=$("$cmd" $opt 2>/dev/null)
err=$("$cmd" $opt 2>&1 >/dev/null)
ret=$?
# hardcoded ... nologin should always return false
if test "$cmdb" = "nologin" &&
test "$opt" = "--help" -o "$opt" = "--version"; then
if test "$ret" -eq 0 -o "$ret" -ge 128; then
echo "$cmdb, $opt, should return false: $ret"
fi
ret=0
fi
return 0
}
function check_help {
local cb=$1
local c=$2
if ! exec_option "$cb" "$c" --help; then
return 1
fi
if test $ret != 0; then
echo "$cb: $opt, returns error"
else
if test -z "$out"; then
echo "$cb: $opt, no stdout"
fi
if test -n "$err"; then
echo "$cb: $opt, non-empty stderr"
fi
fi
return 0
}
function check_version {
local cb=$1
local c=$2
if ! exec_option "$cb" "$c" --version; then
return 1
fi
if test $ret != 0; then
echo "$cb: $opt, returns error"
else
if test -z "$out"; then
echo "$cb: $opt, no stdout"
fi
if test -n "$err"; then
echo "$cb: $opt, non-empty stderr"
fi
fi
}
function check_unknownopt {
local cb=$1
local c=$2
local nohelp=$3
if ! exec_option "$cb" "$c" --unknownopt; then
return 1
fi
if test $ret = 0; then
echo "$cb: $opt, returns no error"
elif test $ret -ge 128; then
echo "$cb: $opt, abnormal exit: $ret"
fi
if test -n "$out"; then
echo "$cb: $opt, non-empty stdout"
fi
if test -z "$err"; then
echo "$cb: $opt, no stderr"
elif test -z "$nohelp" -o "$nohelp" != "yes"; then
out_len=$(echo "$out" | wc -l)
err_len=$(echo "$err" | wc -l)
if test "$err_len" -gt 2; then
echo "$cb: $opt, stderr too long: $err_len"
elif test "$err_len" -lt 2; then
echo "$cb: $opt, stderr too short: $err_len"
fi
fi
}
function check_usage_long_options_completeness {
local prog="$1"
prog_long_opts="$( TOP_SRCDIR="${top_srcdir}" "${top_srcdir}"/tools/get-options.sh "$prog" \
| sed -e 's/^$//' -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')"
if [[ "$?" != "0" || -z "$prog_long_opts" ]]; then
echo "Failed to get long options for $prog"
return 1
fi
if [ "$prog_long_opts" == "ENOTSUP" ]; then
return 0
fi
usage_long_opts="$( "${builddir}"/"$prog" --help \
| grep -o -P '^.*[[:space:]]*--(?![^[:alnum:]])[A-Za-z-.0-9_]*' \
| grep -o -P '[[:space:]]*--(?![^[:alnum:]])[A-Za-z-.0-9_]*' \
| sed -e 's/^$//' -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' \
| sort \
| uniq \
)"
res="$( comm -23 <(echo "${prog_long_opts}") <(echo "${usage_long_opts}") )"
if [ -n "$res" ]; then
printf "%s\n%s\n" "${prog} (missing/extraneous option(s) in usage):" "$res"
return 1
fi
return 0
}
rc=0
for cb in $cmds; do
c="$builddir/$cb"
if ! type "$c" &>/dev/null; then
echo "$cb: does not exist"
continue
fi
nohelp="no"
if ! check_help "$cb" "$c"; then
nohelp="yes"
fi
check_version "$cb" "$c"
check_unknownopt "$cb" "$c" "$nohelp"
check_usage_long_options_completeness "$cb" || ((rc++))
done
exit $rc
|
