blob: 5efb43e9dd350c529938833635881f0fb600567c (
plain)
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
|
#! /bin/sh
# vim:et:ft=sh:sts=2:sw=2
#
# shFlags unit test for the public functions
# load test helpers
. ./shflags_test_helpers
#------------------------------------------------------------------------------
# suite tests
#
testHelp()
{
_testHelp '-h'
flags_getoptIsEnh || return
_testHelp '--help'
}
_testHelp()
{
flag=$1
# test default help output
th_clearReturn
(
FLAGS ${flag} >"${stdoutF}" 2>"${stderrF}"
echo $? >"${returnF}"
)
th_queryReturn
assertTrue \
'short help request should have returned a true exit code.' \
${th_return}
grep 'show this help' "${stderrF}" >/dev/null
grepped=$?
assertTrue \
'short request for help should have produced some help output.' \
${grepped}
[ ${grepped} -ne ${FLAGS_TRUE} ] && th_showOutput
# test proper output when FLAGS_HELP set
(
FLAGS_HELP='this is a test'
FLAGS ${flag} >"${stdoutF}" 2>"${stderrF}"
)
grep 'this is a test' "${stderrF}" >/dev/null
grepped=$?
assertTrue 'setting FLAGS_HELP did not produce expected result' ${grepped}
[ ${grepped} -ne ${FLAGS_TRUE} ] && th_showOutput
# test that "'" chars work in help string
(
DEFINE_boolean b false "help string containing a ' char" b
FLAGS ${flag} >"${stdoutF}" 2>"${stderrF}"
)
grep "help string containing a ' char" "${stderrF}" >/dev/null
grepped=$?
assertTrue "help strings containing apostrophes don't work" ${grepped}
[ ${grepped} -ne ${FLAGS_TRUE} ] && th_showOutput
}
mock_flags_columns()
{
echo 80
}
testStandardHelpOutput()
{
flags_getoptIsStd || startSkipping
DEFINE_boolean test_bool false 'test boolean' b
DEFINE_integer test_int 0 'test integer' i
DEFINE_string test_str '' 'test string' s
DEFINE_string long_desc 'blah' \
'testing of a long description to force wrap of default value' D
DEFINE_string long_default \
'this_is_a_long_default_value_to_force_alternate_indentation' \
'testing of long default value' F
help='USAGE: standard [flags] args'
cat >"${expectedF}" <<EOF
${help}
flags:
-b test boolean (default: false)
-i test integer (default: 0)
-s test string (default: '')
-D testing of a long description to force wrap of default value
(default: 'blah')
-F testing of long default value
(default: 'this_is_a_long_default_value_to_force_alternate_indentation')
-h show this help (default: false)
EOF
(
_flags_columns() { mock_flags_columns; }
FLAGS_HELP=${help};
FLAGS -h >"${stdoutF}" 2>"${stderrF}"
)
r3turn=$?
assertTrue 'a call for help should not return an error' ${r3turn}
diff "${expectedF}" "${stderrF}" >/dev/null
r3turn=$?
assertTrue 'unexpected help output' ${r3turn}
th_showOutput ${r3turn} "${stdoutF}" "${stderrF}"
}
testEnhancedHelpOutput()
{
flags_getoptIsEnh || startSkipping
DEFINE_boolean test_bool false 'test boolean' b
DEFINE_integer test_int 0 'test integer' i
DEFINE_string test_str '' 'test string' s
DEFINE_string long_desc 'blah' \
'testing of a long description to force wrap of default value' D
DEFINE_string long_default \
'this_is_a_long_default_value_to_force_alternate_indentation' \
'testing of long default value' F
help='USAGE: enhanced [flags] args'
cat >"${expectedF}" <<EOF
${help}
flags:
-b,--[no]test_bool: test boolean (default: false)
-i,--test_int: test integer (default: 0)
-s,--test_str: test string (default: '')
-D,--long_desc: testing of a long description to force wrap of default value
(default: 'blah')
-F,--long_default: testing of long default value
(default: 'this_is_a_long_default_value_to_force_alternate_indentation')
-h,--help: show this help (default: false)
EOF
(
_flags_columns() { mock_flags_columns; }
FLAGS_HELP=${help};
FLAGS -h >"${stdoutF}" 2>"${stderrF}"
)
r3turn=$?
assertTrue 'a call for help should not return an error' ${r3turn}
diff "${expectedF}" "${stderrF}" >/dev/null
differed=$?
assertTrue 'unexpected help output' ${differed}
th_showOutput ${differed} "${stdoutF}" "${stderrF}"
}
testNoHelp()
{
flags_getoptIsEnh || startSkipping
( FLAGS --nohelp >"${stdoutF}" 2>"${stderrF}" )
r3turn=$?
assertTrue "FLAGS returned a non-zero result (${r3turn})" ${r3turn}
assertFalse 'expected no output to STDOUT' "[ -s '${stdoutF}' ]"
assertFalse 'expected no output to STDERR' "[ -s '${stderrF}' ]"
}
#------------------------------------------------------------------------------
# suite functions
#
oneTimeSetUp()
{
th_oneTimeSetUp
if flags_getoptIsStd; then
th_warn 'Standard version of getopt found. Enhanced tests will be skipped.'
else
th_warn 'Enhanced version of getopt found. Standard tests will be skipped.'
fi
}
setUp()
{
flags_reset
}
# load and run shUnit2
[ -n "${ZSH_VERSION:-}" ] && SHUNIT_PARENT=$0
. ${TH_SHUNIT}
|
