3 # Copyright (c) 2012 Felipe Contreras
6 test_description
='test bash completion'
16 # Be careful when updating this list:
18 # (1) The build tree may have build artifact from different branch, or
19 # the user's $PATH may have a random executable that may begin
20 # with "git-check" that are not part of the subcommands this build
21 # will ship, e.g. "check-ignore". The tests for completion for
22 # subcommand names tests how "check" is expanded; we limit the
23 # possible candidates to "checkout" and "check-attr" to make sure
24 # "check-attr", which is known by the filter function as a
25 # subcommand to be thrown out, while excluding other random files
26 # that happen to begin with "check" to avoid letting them get in
29 # (2) A test makes sure that common subcommands are included in the
30 # completion for "git <TAB>", and a plumbing is excluded. "add",
31 # "filter-branch" and "ls-files" are listed for this.
33 GIT_TESTING_COMMAND_COMPLETION
='add checkout check-attr filter-branch ls-files'
35 .
"$GIT_BUILD_DIR/contrib/completion/git-completion.bash"
37 # We don't need this function to actually join words or do anything special.
38 # Also, it's cleaner to avoid touching bash's internal completion variables.
39 # So let's override it with a minimal version for testing purposes.
40 _get_comp_words_by_ref
()
42 while [ $# -gt 0 ]; do
48 prev
=${_words[_cword-1]}
51 words
=("${_words[@]}")
64 echo "${COMPREPLY[*]}" > out
69 local -a COMPREPLY _words
72 test "${1: -1}" = ' ' && _words
[${#_words[@]}+1]=''
73 (( _cword
= ${#_words[@]} - 1 ))
74 __git_wrap__git_main
&& print_comp
77 # Test high-level completion
79 # 1: typed text so far (cur)
80 # 2: expected completion
85 printf '%s\n' "$2" >expected
87 sed -e 's/Z$//' >expected
89 run_completion
"$1" &&
94 # The first argument is the typed text so far (cur); the rest are
95 # passed to __gitcomp. Expected output comes is read from the
96 # standard input, like test_completion().
100 sed -e 's/Z$//' >expected
&&
105 test_cmp expected out
110 # 1: current word (cur)
111 # -: the rest are passed to __gitcomp_nl
114 local -a COMPREPLY
&&
115 sed -e 's/Z$//' >expected
&&
120 test_cmp expected out
123 invalid_variable_name
='${foo.bar}'
125 actual
="$TRASH_DIRECTORY/actual"
127 if test_have_prereq MINGW
134 test_expect_success
'setup for __gitdir tests' '
135 mkdir -p subdir/subsubdir &&
139 test_expect_success
'__gitdir - from command line (through $__git_dir)' '
140 echo "$ROOT/otherrepo/.git" >expected &&
142 __git_dir="$ROOT/otherrepo/.git" &&
145 test_cmp expected "$actual"
148 test_expect_success
'__gitdir - repo as argument' '
149 echo "otherrepo/.git" >expected &&
150 __gitdir "otherrepo" >"$actual" &&
151 test_cmp expected "$actual"
154 test_expect_success
'__gitdir - remote as argument' '
155 echo "remote" >expected &&
156 __gitdir "remote" >"$actual" &&
157 test_cmp expected "$actual"
160 test_expect_success
'__gitdir - .git directory in cwd' '
161 echo ".git" >expected &&
162 __gitdir >"$actual" &&
163 test_cmp expected "$actual"
166 test_expect_success
'__gitdir - .git directory in parent' '
167 echo "$ROOT/.git" >expected &&
169 cd subdir/subsubdir &&
172 test_cmp expected "$actual"
175 test_expect_success
'__gitdir - cwd is a .git directory' '
176 echo "." >expected &&
181 test_cmp expected "$actual"
184 test_expect_success
'__gitdir - parent is a .git directory' '
185 echo "$ROOT/.git" >expected &&
187 cd .git/refs/heads &&
190 test_cmp expected "$actual"
193 test_expect_success
'__gitdir - $GIT_DIR set while .git directory in cwd' '
194 echo "$ROOT/otherrepo/.git" >expected &&
196 GIT_DIR="$ROOT/otherrepo/.git" &&
200 test_cmp expected "$actual"
203 test_expect_success
'__gitdir - $GIT_DIR set while .git directory in parent' '
204 echo "$ROOT/otherrepo/.git" >expected &&
206 GIT_DIR="$ROOT/otherrepo/.git" &&
211 test_cmp expected "$actual"
214 test_expect_success
'__gitdir - non-existing path in $__git_dir' '
216 __git_dir="non-existing" &&
217 test_must_fail __gitdir >"$actual"
219 test_must_be_empty "$actual"
222 test_expect_success
'__gitdir - non-existing $GIT_DIR' '
224 GIT_DIR="$ROOT/non-existing" &&
226 test_must_fail __gitdir >"$actual"
228 test_must_be_empty "$actual"
231 test_expect_success
'__gitdir - gitfile in cwd' '
232 echo "$ROOT/otherrepo/.git" >expected &&
233 echo "gitdir: $ROOT/otherrepo/.git" >subdir/.git &&
234 test_when_finished "rm -f subdir/.git" &&
239 test_cmp expected "$actual"
242 test_expect_success
'__gitdir - gitfile in parent' '
243 echo "$ROOT/otherrepo/.git" >expected &&
244 echo "gitdir: $ROOT/otherrepo/.git" >subdir/.git &&
245 test_when_finished "rm -f subdir/.git" &&
247 cd subdir/subsubdir &&
250 test_cmp expected "$actual"
253 test_expect_success SYMLINKS
'__gitdir - resulting path avoids symlinks' '
254 echo "$ROOT/otherrepo/.git" >expected &&
255 mkdir otherrepo/dir &&
256 test_when_finished "rm -rf otherrepo/dir" &&
257 ln -s otherrepo/dir link &&
258 test_when_finished "rm -f link" &&
263 test_cmp expected "$actual"
266 test_expect_success
'__gitdir - not a git repository' '
267 nongit test_must_fail __gitdir >"$actual" &&
268 test_must_be_empty "$actual"
271 test_expect_success
'__gitcomp - trailing space - options' '
272 test_gitcomp "--re" "--dry-run --reuse-message= --reedit-message=
273 --reset-author" <<-EOF
280 test_expect_success
'__gitcomp - trailing space - config keys' '
281 test_gitcomp "br" "branch. branch.autosetupmerge
282 branch.autosetuprebase browser." <<-\EOF
284 branch.autosetupmerge Z
285 branch.autosetuprebase Z
290 test_expect_success
'__gitcomp - option parameter' '
291 test_gitcomp "--strategy=re" "octopus ours recursive resolve subtree" \
298 test_expect_success
'__gitcomp - prefix' '
299 test_gitcomp "branch.me" "remote merge mergeoptions rebase" \
300 "branch.maint." "me" <<-\EOF
302 branch.maint.mergeoptions Z
306 test_expect_success
'__gitcomp - suffix' '
307 test_gitcomp "branch.me" "master maint next pu" "branch." \
314 test_expect_success
'__gitcomp - doesnt fail because of invalid variable name' '
315 __gitcomp "$invalid_variable_name"
318 read -r -d "" refs
<<-\EOF
325 test_expect_success '__gitcomp_nl - trailing space
' '
326 test_gitcomp_nl
"m" "$refs" <<-EOF
332 test_expect_success '__gitcomp_nl
- prefix
' '
333 test_gitcomp_nl
"--fixup=m" "$refs" "--fixup=" "m" <<-EOF
339 test_expect_success '__gitcomp_nl
- suffix
' '
340 test_gitcomp_nl
"branch.ma" "$refs" "branch." "ma" "." <<-\EOF
346 test_expect_success '__gitcomp_nl - no suffix
' '
347 test_gitcomp_nl
"ma" "$refs" "" "ma" "" <<-\EOF
353 test_expect_success '__gitcomp_nl - doesnt fail because of invalid variable name
' '
354 __gitcomp_nl
"$invalid_variable_name"
357 test_expect_success '__git_remotes
- list remotes from
$GIT_DIR/remotes and from config
file' '
358 cat >expect
<<-EOF &&
364 test_when_finished
"rm -rf .git/remotes" &&
365 mkdir
-p .git
/remotes
&&
366 >.git
/remotes
/remote_from_file_1
&&
367 >.git
/remotes
/remote_from_file_2
&&
368 test_when_finished
"git remote remove remote_in_config_1" &&
369 git remote add remote_in_config_1 git
://remote_1
&&
370 test_when_finished
"git remote remove remote_in_config_2" &&
371 git remote add remote_in_config_2 git
://remote_2
&&
372 __git_remotes
>actual
&&
373 test_cmp expect actual
376 test_expect_success 'setup
for ref completion
' '
377 git commit
--allow-empty -m initial
&&
378 git branch matching-branch
&&
379 git tag matching-tag
&&
382 git commit
--allow-empty -m initial
&&
383 git branch
-m master master-in-other
&&
384 git branch branch-in-other
&&
387 git remote add other
"$ROOT/otherrepo/.git" &&
388 git fetch
--no-tags other
&&
389 rm -f .git
/FETCH_HEAD
&&
393 test_expect_success '__git_refs
- simple
' '
394 cat >expected
<<-EOF &&
398 other/branch-in-other
399 other/master-in-other
404 __git_refs
>"$actual"
406 test_cmp expected
"$actual"
409 test_expect_success '__git_refs
- full refs
' '
410 cat >expected
<<-EOF &&
412 refs/heads/matching-branch
416 __git_refs
>"$actual"
418 test_cmp expected
"$actual"
421 test_expect_success '__git_refs
- repo given on the
command line
' '
422 cat >expected
<<-EOF &&
429 __git_dir
="$ROOT/otherrepo/.git" &&
431 __git_refs
>"$actual"
433 test_cmp expected
"$actual"
436 test_expect_success '__git_refs
- remote on
local file system
' '
437 cat >expected
<<-EOF &&
445 __git_refs otherrepo
>"$actual"
447 test_cmp expected
"$actual"
450 test_expect_success '__git_refs
- remote on
local file system
- full refs
' '
451 cat >expected
<<-EOF &&
452 refs/heads/branch-in-other
453 refs/heads/master-in-other
454 refs/tags/tag-in-other
458 __git_refs otherrepo
>"$actual"
460 test_cmp expected
"$actual"
463 test_expect_success '__git_refs
- configured remote
' '
464 cat >expected
<<-EOF &&
471 __git_refs other
>"$actual"
473 test_cmp expected
"$actual"
476 test_expect_success '__git_refs
- configured remote
- full refs
' '
477 cat >expected
<<-EOF &&
478 refs/heads/branch-in-other
479 refs/heads/master-in-other
480 refs/tags/tag-in-other
484 __git_refs other
>"$actual"
486 test_cmp expected
"$actual"
489 test_expect_success '__git_refs
- configured remote
- repo given on the
command line
' '
490 cat >expected
<<-EOF &&
497 __git_dir
="$ROOT/.git" &&
499 __git_refs other
>"$actual"
501 test_cmp expected
"$actual"
504 test_expect_success '__git_refs
- configured remote
- full refs
- repo given on the
command line
' '
505 cat >expected
<<-EOF &&
506 refs/heads/branch-in-other
507 refs/heads/master-in-other
508 refs/tags/tag-in-other
512 __git_dir
="$ROOT/.git" &&
514 __git_refs other
>"$actual"
516 test_cmp expected
"$actual"
519 test_expect_failure '__git_refs
- configured remote
- remote name matches a directory
' '
520 cat >expected
<<-EOF &&
526 test_when_finished
"rm -rf other" &&
529 __git_refs other
>"$actual"
531 test_cmp expected
"$actual"
534 test_expect_failure '__git_refs
- URL remote
' '
535 cat >expected
<<-EOF &&
543 __git_refs
"file://$ROOT/otherrepo/.git" >"$actual"
545 test_cmp expected
"$actual"
548 test_expect_success '__git_refs
- URL remote
- full refs
' '
549 cat >expected
<<-EOF &&
550 refs/heads/branch-in-other
551 refs/heads/master-in-other
552 refs/tags/tag-in-other
556 __git_refs
"file://$ROOT/otherrepo/.git" >"$actual"
558 test_cmp expected
"$actual"
561 test_expect_failure '__git_refs
- non-existing remote
' '
564 __git_refs non-existing
>"$actual"
566 test_must_be_empty
"$actual"
569 test_expect_success '__git_refs
- non-existing remote
- full refs
' '
572 __git_refs non-existing
>"$actual"
574 test_must_be_empty
"$actual"
577 test_expect_failure '__git_refs
- non-existing URL remote
' '
580 __git_refs
"file://$ROOT/non-existing" >"$actual"
582 test_must_be_empty
"$actual"
585 test_expect_success '__git_refs
- non-existing URL remote
- full refs
' '
588 __git_refs
"file://$ROOT/non-existing" >"$actual"
590 test_must_be_empty
"$actual"
593 test_expect_failure '__git_refs
- not
in a git repository
' '
595 GIT_CEILING_DIRECTORIES
="$ROOT" &&
596 export GIT_CEILING_DIRECTORIES
&&
599 __git_refs
>"$actual"
601 test_must_be_empty
"$actual"
604 test_expect_success '__git_refs
- unique remote branches
for git checkout DWIMery
' '
605 cat >expected
<<-EOF &&
610 other/branch-in-other
611 other/master-in-other
613 remote/branch-in-remote
619 for remote_ref
in refs
/remotes
/other
/ambiguous \
620 refs
/remotes
/remote
/ambiguous \
621 refs
/remotes
/remote
/branch-in-remote
623 git update-ref
$remote_ref master
&&
624 test_when_finished
"git update-ref -d $remote_ref"
628 __git_refs
"" 1 >"$actual"
630 test_cmp expected
"$actual"
633 test_expect_success 'teardown after ref completion
' '
634 git branch
-d matching-branch
&&
635 git tag
-d matching-tag
&&
636 git remote remove other
639 test_expect_success '__git_get_config_variables
' '
640 cat >expect
<<-EOF &&
644 test_config interesting.name-1 good
&&
645 test_config interesting.name-2 good
&&
646 test_config subsection.interesting.name-3 bad
&&
647 __git_get_config_variables interesting
>actual
&&
648 test_cmp expect actual
651 test_expect_success '__git_pretty_aliases
' '
652 cat >expect
<<-EOF &&
656 test_config pretty.author
"%an %ae" &&
657 test_config pretty.
hash %H
&&
658 __git_pretty_aliases
>actual
&&
659 test_cmp expect actual
662 test_expect_success '__git_aliases
' '
663 cat >expect
<<-EOF &&
667 test_config
alias.ci commit
&&
668 test_config
alias.co checkout
&&
669 __git_aliases
>actual
&&
670 test_cmp expect actual
673 test_expect_success 'basic
' '
674 run_completion
"git " &&
676 grep -q "^add \$" out
&&
678 grep -q "^filter-branch \$" out
&&
680 ! grep -q "^ls-files \$" out
&&
682 run_completion
"git f" &&
683 ! grep -q -v "^f" out
686 test_expect_success 'double dash
"git" itself
' '
687 test_completion
"git --" <<-\EOF
700 --no-replace-objects Z
705 test_expect_success 'double dash "git checkout"' '
706 test_completion "git checkout --" <<-\
EOF
719 test_expect_success 'general options' '
720 test_completion "git --ver" "--version " &&
721 test_completion "git --hel" "--help " &&
722 test_completion "git --exe" <<-\EOF &&
726 test_completion "git --htm" "--html-path " &&
727 test_completion "git --pag" "--paginate " &&
728 test_completion "git --no-p" "--no-pager " &&
729 test_completion "git --git" "--git-dir=" &&
730 test_completion "git --wor" "--work-tree=" &&
731 test_completion "git --nam" "--namespace=" &&
732 test_completion "git --bar" "--bare " &&
733 test_completion "git --inf" "--info-path " &&
734 test_completion "git --no-r" "--no-replace-objects "
737 test_expect_success 'general options plus command' '
738 test_completion "git --version check" "checkout " &&
739 test_completion "git --paginate check" "checkout " &&
740 test_completion "git --git-dir=foo check" "checkout " &&
741 test_completion "git --bare check" "checkout " &&
742 test_completion "git --exec-path=foo check" "checkout " &&
743 test_completion "git --html-path check" "checkout " &&
744 test_completion "git --no-pager check" "checkout " &&
745 test_completion "git --work-tree=foo check" "checkout " &&
746 test_completion "git --namespace=foo check" "checkout " &&
747 test_completion "git --paginate check" "checkout " &&
748 test_completion "git --info-path check" "checkout " &&
749 test_completion "git --no-replace-objects check" "checkout "
752 test_expect_success 'git --help completion' '
753 test_completion "git --help ad" "add " &&
754 test_completion "git --help core" "core-tutorial "
757 test_expect_success 'setup for integration tests' '
758 echo content >file1 &&
760 git add file1 file2 &&
762 git branch mybranch &&
766 test_expect_success 'checkout completes ref names' '
767 test_completion "git checkout m" <<-\EOF
774 test_expect_success 'show completes all refs' '
775 test_completion "git show m" <<-\EOF
782 test_expect_success '<ref>: completes paths' '
783 test_completion "git show mytag:f" <<-\EOF
789 test_expect_success 'complete tree filename with spaces' '
790 echo content >"name with spaces" &&
791 git add "name with spaces" &&
792 git commit -m spaces &&
793 test_completion "git show HEAD:nam" <<-\EOF
798 test_expect_success 'complete tree filename with metacharacters' '
799 echo content >"name with \${meta}" &&
800 git add "name with \${meta}" &&
801 git commit -m meta &&
802 test_completion "git show HEAD:nam" <<-\EOF
808 test_expect_success 'send-email' '
809 test_completion "git send-email --cov" "--cover-letter " &&
810 test_completion "git send-email ma" "master "
813 test_expect_success 'complete files' '
814 git init tmp && cd tmp &&
815 test_when_finished "cd .. && rm -rf tmp" &&
817 echo "expected" > .gitignore &&
818 echo "out" >> .gitignore &&
820 git add .gitignore &&
821 test_completion "git commit " ".gitignore" &&
823 git commit -m ignore &&
826 test_completion "git add " "new" &&
829 git commit -a -m new &&
830 test_completion "git add " "" &&
832 git mv new modified &&
833 echo modify > modified &&
834 test_completion "git add " "modified" &&
838 : TODO .gitignore should not be here &&
839 test_completion "git rm " <<-\EOF &&
844 test_completion "git clean " "untracked" &&
846 : TODO .gitignore should not be here &&
847 test_completion "git mv " <<-\EOF &&
853 touch dir/file-in-dir &&
854 git add dir/file-in-dir &&
857 mkdir untracked-dir &&
859 : TODO .gitignore should not be here &&
860 test_completion "git mv modified " <<-\EOF &&
868 test_completion "git commit " "modified" &&
870 : TODO .gitignore should not be here &&
871 test_completion "git ls-files " <<-\EOF &&
878 test_completion "git add mom" "momified"
881 test_expect_success "completion uses <cmd> completion for alias: !sh -c 'git <cmd> ...'" '
882 test_config alias.co "!sh -c '"'"'git checkout ...'"'"'" &&
883 test_completion "git co m" <<-\EOF
890 test_expect_success 'completion uses <cmd> completion for alias: !f () { VAR=val git <cmd> ... }' '
891 test_config alias.co "!f () { VAR=val git checkout ... ; } f" &&
892 test_completion "git co m" <<-\EOF
899 test_expect_success 'completion used <cmd> completion for alias: !f() { : git <cmd> ; ... }' '
900 test_config alias.co "!f() { : git checkout ; if ... } f" &&
901 test_completion "git co m" <<-\EOF
908 test_expect_failure 'complete with tilde expansion' '
909 git init tmp && cd tmp &&
910 test_when_finished "cd .. && rm -rf tmp" &&
914 test_completion "git add ~/tmp/" "~/tmp/file"