test(bash): Add a bunch of tests for bash special characters. #25
Conversation
testprog was failing with "cannot execute: required file not found". Some Google sleuthing found that it was probably because libc6 was missing. Redhat has a similar error where it was complaining that glibc v2.32 was missing. ubi8 only seemed to be able to install v2.28, but ubi9 runs testprog without any other tweaks. Signed-off-by: Jeffrey Faer <[email protected]>
Signed-off-by: Jeffrey Faer <[email protected]>
JeffFaer
force-pushed
the
special_characters
branch
from
52254c1
to
dd845de
Compare
|
I’m trying to look into this one, but I’m having docker issues. Some update site is down right now. I’ll try again later on. |
Done! |
|
@JeffFaer Could you sign-ff the two last commits, or else the DCO check fails. |
| completions = []string{"bear\tan animal", "bearpaw\ta dessert", "dog", "unicorn\tmythical"} | ||
| specialCharComps = []string{"at@", "equal=", "slash/", "colon:", "period.", "comma,", "letter"} | ||
| completions = []string{"bear\tan animal", "bearpaw\ta dessert", "dog", "unicorn\tmythical"} | ||
| completionsWithSpecialCharacters = []string{"bash space", "bash\\escape", "bash\\ escaped\\ space", "bash>redirect", "bash#comment", "bash$var", "bash|pipe", "bash;semicolon"} |
There was a problem hiding this comment.
This is hard to test by hand because I cannot get the shell to finish the completion since they all have the same bash string right before the special character. Also, to avoid using double slashes, which I find confusing, can you use forward ticks as quotes?
So please change the above line to be:
completionsWithSpecialCharacters = []string{`bash1 space`, `bash2\escape`, `bash3\ escaped\ space`, `bash4>redirect`, `bash5#comment`, `bash6$var`, `bash7|pipe`, `bash8;semicolon`}
Then we can test by hand and do testprog prefix special-chars bash1[tab][tab]
| _completionTests_verifyCompletion "testprog prefix special-chars bash#c" "bash#comment" | ||
| _completionTests_verifyCompletion "testprog prefix special-chars bash\$v" 'bash$var' | ||
| _completionTests_verifyCompletion "testprog prefix special-chars bash|p" "bash|pipe" | ||
| _completionTests_verifyCompletion "testprog prefix special-chars bash;s" "bash;semicolon" |
There was a problem hiding this comment.
This does not seem right as a result for the completion.
The idea is that if the completion choice is bash>redirect then it must appear on the shell as bash\>redirect.
Shell completions should not insert special shell characters but should instead escape them.
So, when doing testprog prefix special-chars bash|p[tab][tab], we should get testprog prefix special-chars bash\|pipe.
I'm not sure that is even possible to achieve with bash, but at least, if there is only one completion choice and it is bash|pipe, then testprog prefix special-chars ba[tab][tab] should complete to testprog prefix special-chars bash|pipe
Same goes for the other special chars except #, which seems to be passed to the program without needing to be espcaped.
A good way to see how the completions should behave is to compare them with zsh.
zsh
$ source <(testprog completion zsh)
$ testprog prefix special-chars bash4<TAB>
# becomes
$ testprog prefix special-chars bash4\>redirect
| @@ -180,7 +180,7 @@ _completionTests_complete() { | |||
| COMP_CWORD=$((${#COMP_WORDS[@]}-1)) | |||
| # We must check for a space as the last character which will tell us | |||
| # that the previous word is complete and the cursor is on the next word. | |||
| [ "${cmdLine: -1}" = " " ] && COMP_CWORD=${#COMP_WORDS[@]} | |||
| [ "${cmdLine: -1}" = " " ] && COMP_CWORD=${#COMP_WORDS[@]} && COMP_WORDS[COMP_CWORD]='' | |||
| _completionTests_verifyCompletion "testprog prefix special-chars bash\\e" "bash\\escape" | ||
| # TODO: completionTests_verifyCompletion doesn't support testing something | ||
| # like this. | ||
| #_completionTests_verifyCompletion "testprog prefix special-chars bash\\ e" "bash\\ escaped\\ space" |
There was a problem hiding this comment.
Should we have a test for the bash space case provided by the completion logic?
Right now, these tests fail. They will pass after spf13/cobra#2126 has been merged.
This PR is based on top of #24