t9902: protect test from stray build artifacts
When you have random build artifacts in your build directory, left behind by running "make" while on another branch, the "git help -a" command run by __git_list_all_commands in the completion script that is being tested does not have a way to know that they are not part of the subcommands this build will ship. Such extra subcommands may come from the user's $PATH. They will interfere with the tests that expect a certain prefix to uniquely expand to a known completion. Instrument the completion script and give it a way for us to tell what (subset of) subcommands we are going to ship. Also add a test to "git --help <prefix><TAB>" expansion. It needs to show not just commands but some selected documentation pages. Based on an idea by Jeff King. Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
b344bb1935
commit
5047822347
@ -531,10 +531,19 @@ __git_complete_strategy ()
|
||||
return 1
|
||||
}
|
||||
|
||||
__git_commands () {
|
||||
if test -n "${GIT_TESTING_COMMAND_COMPLETION:-}"
|
||||
then
|
||||
printf "%s" "${GIT_TESTING_COMMAND_COMPLETION}"
|
||||
else
|
||||
git help -a|egrep '^ [a-zA-Z0-9]'
|
||||
fi
|
||||
}
|
||||
|
||||
__git_list_all_commands ()
|
||||
{
|
||||
local i IFS=" "$'\n'
|
||||
for i in $(git help -a|egrep '^ [a-zA-Z0-9]')
|
||||
for i in $(__git_commands)
|
||||
do
|
||||
case $i in
|
||||
*--*) : helper pattern;;
|
||||
|
@ -13,6 +13,25 @@ complete ()
|
||||
return 0
|
||||
}
|
||||
|
||||
# Be careful when updating this list:
|
||||
#
|
||||
# (1) The build tree may have build artifact from different branch, or
|
||||
# the user's $PATH may have a random executable that may begin
|
||||
# with "git-check" that are not part of the subcommands this build
|
||||
# will ship, e.g. "check-ignore". The tests for completion for
|
||||
# subcommand names tests how "check" is expanded; we limit the
|
||||
# possible candidates to "checkout" and "check-attr" to make sure
|
||||
# "check-attr", which is known by the filter function as a
|
||||
# subcommand to be thrown out, while excluding other random files
|
||||
# that happen to begin with "check" to avoid letting them get in
|
||||
# the way.
|
||||
#
|
||||
# (2) A test makes sure that common subcommands are included in the
|
||||
# completion for "git <TAB>", and a plumbing is excluded. "add",
|
||||
# "filter-branch" and "ls-files" are listed for this.
|
||||
|
||||
GIT_TESTING_COMMAND_COMPLETION='add checkout check-attr filter-branch ls-files'
|
||||
|
||||
. "$GIT_BUILD_DIR/contrib/completion/git-completion.bash"
|
||||
|
||||
# We don't need this function to actually join words or do anything special.
|
||||
@ -196,7 +215,6 @@ test_expect_success 'general options plus command' '
|
||||
test_completion "git --paginate check" "checkout " &&
|
||||
test_completion "git --git-dir=foo check" "checkout " &&
|
||||
test_completion "git --bare check" "checkout " &&
|
||||
test_completion "git --help des" "describe " &&
|
||||
test_completion "git --exec-path=foo check" "checkout " &&
|
||||
test_completion "git --html-path check" "checkout " &&
|
||||
test_completion "git --no-pager check" "checkout " &&
|
||||
@ -207,6 +225,11 @@ test_expect_success 'general options plus command' '
|
||||
test_completion "git --no-replace-objects check" "checkout "
|
||||
'
|
||||
|
||||
test_expect_success 'git --help completion' '
|
||||
test_completion "git --help ad" "add " &&
|
||||
test_completion "git --help core" "core-tutorial "
|
||||
'
|
||||
|
||||
test_expect_success 'setup for ref completion' '
|
||||
echo content >file1 &&
|
||||
echo more >file2 &&
|
||||
|
Loading…
Reference in New Issue
Block a user