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