kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 1 | #! /bin/sh |
| 2 | # vim:et:ft=sh:sts=2:sw=2 |
| 3 | # |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 4 | # shFlags unit test for the public functions |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 5 | |
| 6 | # load test helpers |
| 7 | . ./shflags_test_helpers |
| 8 | |
| 9 | #------------------------------------------------------------------------------ |
| 10 | # suite tests |
| 11 | # |
| 12 | |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 13 | testHelp() |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 14 | { |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 15 | _testHelp '-h' |
| 16 | flags_getoptIsEnh || return |
| 17 | _testHelp '--help' |
| 18 | } |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 19 | |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 20 | _testHelp() |
| 21 | { |
| 22 | flag=$1 |
| 23 | |
| 24 | # test default help output |
| 25 | th_clearReturn |
| 26 | ( |
| 27 | FLAGS ${flag} >"${stdoutF}" 2>"${stderrF}" |
| 28 | echo $? >"${returnF}" |
| 29 | ) |
| 30 | th_queryReturn |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 31 | assertTrue \ |
| 32 | 'short help request should have returned a true exit code.' \ |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 33 | ${th_return} |
| 34 | grep 'show this help' "${stderrF}" >/dev/null |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 35 | grepped=$? |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 36 | assertTrue \ |
| 37 | 'short request for help should have produced some help output.' \ |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 38 | ${grepped} |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 39 | [ ${grepped} -ne ${FLAGS_TRUE} ] && th_showOutput |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 40 | |
| 41 | # test proper output when FLAGS_HELP set |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 42 | ( |
| 43 | FLAGS_HELP='this is a test' |
| 44 | FLAGS ${flag} >"${stdoutF}" 2>"${stderrF}" |
| 45 | ) |
| 46 | grep 'this is a test' "${stderrF}" >/dev/null |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 47 | grepped=$? |
| 48 | assertTrue 'setting FLAGS_HELP did not produce expected result' ${grepped} |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 49 | [ ${grepped} -ne ${FLAGS_TRUE} ] && th_showOutput |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 50 | |
| 51 | # test that "'" chars work in help string |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 52 | ( |
| 53 | DEFINE_boolean b false "help string containing a ' char" b |
| 54 | FLAGS ${flag} >"${stdoutF}" 2>"${stderrF}" |
| 55 | ) |
| 56 | grep "help string containing a ' char" "${stderrF}" >/dev/null |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 57 | grepped=$? |
| 58 | assertTrue "help strings containing apostrophes don't work" ${grepped} |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 59 | [ ${grepped} -ne ${FLAGS_TRUE} ] && th_showOutput |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 60 | } |
| 61 | |
kate.ward | 1ee8856 | 2013-01-01 22:08:05 +0000 | [diff] [blame] | 62 | mock_flags_columns() |
| 63 | { |
| 64 | echo 80 |
| 65 | } |
| 66 | |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 67 | testStandardHelpOutput() |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 68 | { |
kate.ward | dd6c913 | 2008-11-13 00:47:53 +0000 | [diff] [blame] | 69 | flags_getoptIsStd || startSkipping |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 70 | |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 71 | DEFINE_boolean test_bool false 'test boolean' b |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 72 | DEFINE_integer test_int 0 'test integer' i |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 73 | DEFINE_string test_str '' 'test string' s |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 74 | DEFINE_string long_desc 'blah' \ |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 75 | 'testing of a long description to force wrap of default value' D |
| 76 | DEFINE_string long_default \ |
kate.ward | 90681c3 | 2008-11-17 17:39:14 +0000 | [diff] [blame] | 77 | 'this_is_a_long_default_value_to_force_alternate_indentation' \ |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 78 | 'testing of long default value' F |
kate.ward | f08c5b6 | 2008-07-11 20:32:11 +0000 | [diff] [blame] | 79 | help='USAGE: standard [flags] args' |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 80 | |
| 81 | cat >"${expectedF}" <<EOF |
kate.ward | 3a67497 | 2009-04-01 03:44:44 +0000 | [diff] [blame] | 82 | ${help} |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 83 | flags: |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 84 | -b test boolean (default: false) |
| 85 | -i test integer (default: 0) |
| 86 | -s test string (default: '') |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 87 | -D testing of a long description to force wrap of default value |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 88 | (default: 'blah') |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 89 | -F testing of long default value |
kate.ward | 90681c3 | 2008-11-17 17:39:14 +0000 | [diff] [blame] | 90 | (default: 'this_is_a_long_default_value_to_force_alternate_indentation') |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 91 | -h show this help (default: false) |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 92 | EOF |
kate.ward | 1ee8856 | 2013-01-01 22:08:05 +0000 | [diff] [blame] | 93 | ( |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 94 | _flags_columns() { mock_flags_columns; } |
kate.ward | 1ee8856 | 2013-01-01 22:08:05 +0000 | [diff] [blame] | 95 | FLAGS_HELP=${help}; |
| 96 | FLAGS -h >"${stdoutF}" 2>"${stderrF}" |
| 97 | ) |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 98 | r3turn=$? |
| 99 | assertTrue 'a call for help should not return an error' ${r3turn} |
kate.ward | e10dd53 | 2013-01-04 21:52:23 +0000 | [diff] [blame] | 100 | |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 101 | diff "${expectedF}" "${stderrF}" >/dev/null |
kate.ward | e10dd53 | 2013-01-04 21:52:23 +0000 | [diff] [blame] | 102 | r3turn=$? |
| 103 | assertTrue 'unexpected help output' ${r3turn} |
| 104 | th_showOutput ${r3turn} "${stdoutF}" "${stderrF}" |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | testEnhancedHelpOutput() |
| 108 | { |
| 109 | flags_getoptIsEnh || startSkipping |
| 110 | |
| 111 | DEFINE_boolean test_bool false 'test boolean' b |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 112 | DEFINE_integer test_int 0 'test integer' i |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 113 | DEFINE_string test_str '' 'test string' s |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 114 | DEFINE_string long_desc 'blah' \ |
kate.ward | de77c87 | 2008-11-17 17:40:04 +0000 | [diff] [blame] | 115 | 'testing of a long description to force wrap of default value' D |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 116 | DEFINE_string long_default \ |
kate.ward | 90681c3 | 2008-11-17 17:39:14 +0000 | [diff] [blame] | 117 | 'this_is_a_long_default_value_to_force_alternate_indentation' \ |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 118 | 'testing of long default value' F |
kate.ward | 42cb23b | 2008-07-11 20:42:58 +0000 | [diff] [blame] | 119 | help='USAGE: enhanced [flags] args' |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 120 | |
| 121 | cat >"${expectedF}" <<EOF |
kate.ward | 3a67497 | 2009-04-01 03:44:44 +0000 | [diff] [blame] | 122 | ${help} |
kate.ward | dc10fe9 | 2008-07-10 19:37:16 +0000 | [diff] [blame] | 123 | flags: |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 124 | -b,--[no]test_bool: test boolean (default: false) |
| 125 | -i,--test_int: test integer (default: 0) |
| 126 | -s,--test_str: test string (default: '') |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 127 | -D,--long_desc: testing of a long description to force wrap of default value |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 128 | (default: 'blah') |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 129 | -F,--long_default: testing of long default value |
kate.ward | 90681c3 | 2008-11-17 17:39:14 +0000 | [diff] [blame] | 130 | (default: 'this_is_a_long_default_value_to_force_alternate_indentation') |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 131 | -h,--help: show this help (default: false) |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 132 | EOF |
kate.ward | e10dd53 | 2013-01-04 21:52:23 +0000 | [diff] [blame] | 133 | ( |
kate.ward | a2adce1 | 2013-01-15 00:00:39 +0000 | [diff] [blame] | 134 | _flags_columns() { mock_flags_columns; } |
kate.ward | e10dd53 | 2013-01-04 21:52:23 +0000 | [diff] [blame] | 135 | FLAGS_HELP=${help}; |
| 136 | FLAGS -h >"${stdoutF}" 2>"${stderrF}" |
| 137 | ) |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 138 | r3turn=$? |
| 139 | assertTrue 'a call for help should not return an error' ${r3turn} |
kate.ward | e10dd53 | 2013-01-04 21:52:23 +0000 | [diff] [blame] | 140 | |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 141 | diff "${expectedF}" "${stderrF}" >/dev/null |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 142 | differed=$? |
| 143 | assertTrue 'unexpected help output' ${differed} |
| 144 | th_showOutput ${differed} "${stdoutF}" "${stderrF}" |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 145 | } |
| 146 | |
kate.ward | 5b48fc1 | 2008-11-13 00:42:43 +0000 | [diff] [blame] | 147 | testNoHelp() |
| 148 | { |
| 149 | flags_getoptIsEnh || startSkipping |
| 150 | |
| 151 | ( FLAGS --nohelp >"${stdoutF}" 2>"${stderrF}" ) |
kate.ward | 1cb7960 | 2011-06-10 11:15:49 +0000 | [diff] [blame] | 152 | r3turn=$? |
| 153 | assertTrue "FLAGS returned a non-zero result (${r3turn})" ${r3turn} |
kate.ward | 5b48fc1 | 2008-11-13 00:42:43 +0000 | [diff] [blame] | 154 | assertFalse 'expected no output to STDOUT' "[ -s '${stdoutF}' ]" |
| 155 | assertFalse 'expected no output to STDERR' "[ -s '${stderrF}' ]" |
| 156 | } |
| 157 | |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 158 | #------------------------------------------------------------------------------ |
| 159 | # suite functions |
| 160 | # |
| 161 | |
| 162 | oneTimeSetUp() |
| 163 | { |
kate.ward | 1b600c5 | 2008-11-12 21:26:05 +0000 | [diff] [blame] | 164 | th_oneTimeSetUp |
kate.ward | 709c134 | 2008-11-14 18:23:03 +0000 | [diff] [blame] | 165 | |
kate.ward | b0aaccf | 2008-11-15 17:16:55 +0000 | [diff] [blame] | 166 | if flags_getoptIsStd; then |
| 167 | th_warn 'Standard version of getopt found. Enhanced tests will be skipped.' |
| 168 | else |
| 169 | th_warn 'Enhanced version of getopt found. Standard tests will be skipped.' |
kate.ward | 709c134 | 2008-11-14 18:23:03 +0000 | [diff] [blame] | 170 | fi |
kate.ward | 2fb41e3 | 2008-07-10 18:42:46 +0000 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | setUp() |
| 174 | { |
| 175 | flags_reset |
| 176 | } |
| 177 | |
| 178 | # load and run shUnit2 |
| 179 | [ -n "${ZSH_VERSION:-}" ] && SHUNIT_PARENT=$0 |
| 180 | . ${TH_SHUNIT} |