@matheusbsbs / matheus-bagliano / commits / f221861e49

t1502: demonstrate rev-parse --parseopt option mis-parsing

Since commit 2d893df rev-parse will scan forward from the beginning of the option string looking for a flag character. If there are no flag characters then the scan will spill over into the help text and will interpret the characters preceding the "flag" as part of the option-spec i.e. the long option name. For example, the following option spec: exclame this does something! will produce this 'set' expression when --exclame is specified: set -- --exclame this does something -- which will be interpreted as four separate parameters by the shell. And will produce a help string that looks like: --exclame this does something this does something! git-rebase.sh has such an option (--autosquash), and so will add extra parameters to the 'set' expression when --autosquash is used. git-rebase continues to work correctly though because when it parses the arguments, it ignores ones that it does not recognize. Also, rev-parse --parseopt does not currently interpret a tab character as a delimiter between the option spec and the help text. If a tab is used at the end of the option spec, before the help text, and before a space has been specified, then rev-parse will interpret the tab as part of the preceding component (either the long name or the arg hint). For example, the following option spec (note: there is a <tab> between "frotz" and "enable"): frotz enable frotzing will produce this 'set' expression when --frotz is specified: set -- --frotz enable -- which will be interpreted as 2 separate arguments by the shell. git-rebase.sh has one of these too (--keep-empty). In this case the tab is immediately followed by spaces so there are no additional parameters produced on the command line. The only side-effect is misalignment in the help text. Signed-off-by: Brandon Casey <drafnel@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Brandon Casey committed Sep 17, 2017 at 15:28 UTC f221861e490d2c57b960cf86c5bc37279a3ebc2b

1 file changed +12 -6

t/t1502-rev-parse-parseopt.sh

+12 -6

@@ -28,6 +28,9 @@ test_expect_success 'setup optionspec' '

28 |g,fluf?path short and long option optional argument

29 |longest=very-long-argument-hint a very long argument hint

30 |pair=key=value with an equals sign in the hint

31 +|aswitch help te=t contains? fl*g characters!`

32 +|bswitch=hint hint has trailing tab character

33 +|cswitch switch has trailing tab character

34 |short-hint=a with a one symbol hint

35 |

36 |Extras

@@ -35,7 +38,7 @@ test_expect_success 'setup optionspec' '

38 EOF

39 '

38 -test_expect_success 'test --parseopt help output' '

41 +test_expect_failure 'test --parseopt help output' '

42 sed -e "s/^|//" >expect <<\END_EXPECT &&

43 |cat <<\EOF

44 |usage: some-command [options] <args>...

@@ -62,6 +65,9 @@ test_expect_success 'test --parseopt help output' '

65 | --longest <very-long-argument-hint>

66 | a very long argument hint

67 | --pair <key=value> with an equals sign in the hint

68 +| --aswitch help te=t contains? fl*g characters!`

69 +| --bswitch <hint> hint has trailing tab character

70 +| --cswitch switch has trailing tab character

71 | --short-hint <a> with a one symbol hint

72 |

73 |Extras

@@ -75,17 +81,17 @@ END_EXPECT

82 test_expect_success 'setup expect.1' "

83 cat > expect <<EOF

78 -set -- --foo --bar 'ham' -b -- 'arg'

84 +set -- --foo --bar 'ham' -b --aswitch -- 'arg'

85 EOF

86 "

82 -test_expect_success 'test --parseopt' '

83 - git rev-parse --parseopt -- --foo --bar=ham --baz arg < optionspec > output &&

88 +test_expect_failure 'test --parseopt' '

89 + git rev-parse --parseopt -- --foo --bar=ham --baz --aswitch arg < optionspec > output &&

90 test_cmp expect output

91 '

87 -test_expect_success 'test --parseopt with mixed options and arguments' '

88 - git rev-parse --parseopt -- --foo arg --bar=ham --baz < optionspec > output &&

93 +test_expect_failure 'test --parseopt with mixed options and arguments' '

94 + git rev-parse --parseopt -- --foo arg --bar=ham --baz --aswitch < optionspec > output &&

95 test_cmp expect output

96 '