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 '__git_is_configured_remote' '
377 test_when_finished "git remote remove remote_1" &&
378 git remote add remote_1 git://remote_1 &&
379 test_when_finished "git remote remove remote_2" &&
380 git remote add remote_2 git://remote_2 &&
381 verbose __git_is_configured_remote remote_2 &&
382 test_must_fail __git_is_configured_remote non-existent
385 test_expect_success 'setup for ref completion' '
386 git commit --allow-empty -m initial &&
387 git branch matching-branch &&
388 git tag matching-tag &&
391 git commit --allow-empty -m initial &&
392 git branch -m master master-in-other &&
393 git branch branch-in-other &&
396 git remote add other "$ROOT/otherrepo/.git" &&
397 git fetch --no-tags other &&
398 rm -f .git/FETCH_HEAD &&
402 test_expect_success '__git_refs - simple' '
403 cat >expected <<-EOF &&
407 other/branch-in-other
408 other/master-in-other
413 __git_refs >"$actual"
415 test_cmp expected "$actual"
418 test_expect_success '__git_refs - full refs' '
419 cat >expected <<-EOF &&
421 refs/heads/matching-branch
425 __git_refs >"$actual"
427 test_cmp expected "$actual"
430 test_expect_success '__git_refs - repo given on the command line' '
431 cat >expected <<-EOF &&
438 __git_dir="$ROOT/otherrepo/.git" &&
440 __git_refs >"$actual"
442 test_cmp expected "$actual"
445 test_expect_success '__git_refs - remote on local file system' '
446 cat >expected <<-EOF &&
454 __git_refs otherrepo >"$actual"
456 test_cmp expected "$actual"
459 test_expect_success '__git_refs - remote on local file system - full refs' '
460 cat >expected <<-EOF &&
461 refs/heads/branch-in-other
462 refs/heads/master-in-other
463 refs/tags/tag-in-other
467 __git_refs otherrepo >"$actual"
469 test_cmp expected "$actual"
472 test_expect_success '__git_refs - configured remote' '
473 cat >expected <<-EOF &&
480 __git_refs other >"$actual"
482 test_cmp expected "$actual"
485 test_expect_success '__git_refs - configured remote - full refs' '
486 cat >expected <<-EOF &&
487 refs/heads/branch-in-other
488 refs/heads/master-in-other
489 refs/tags/tag-in-other
493 __git_refs other >"$actual"
495 test_cmp expected "$actual"
498 test_expect_success '__git_refs - configured remote - repo given on the command line' '
499 cat >expected <<-EOF &&
506 __git_dir="$ROOT/.git" &&
508 __git_refs other >"$actual"
510 test_cmp expected "$actual"
513 test_expect_success '__git_refs - configured remote - full refs - repo given on the command line' '
514 cat >expected <<-EOF &&
515 refs/heads/branch-in-other
516 refs/heads/master-in-other
517 refs/tags/tag-in-other
521 __git_dir="$ROOT/.git" &&
523 __git_refs other >"$actual"
525 test_cmp expected "$actual"
528 test_expect_success '__git_refs - configured remote - remote name matches a directory' '
529 cat >expected <<-EOF &&
535 test_when_finished "rm -rf other" &&
538 __git_refs other >"$actual"
540 test_cmp expected "$actual"
543 test_expect_failure '__git_refs - URL remote' '
544 cat >expected <<-EOF &&
552 __git_refs "file://$ROOT/otherrepo/.git" >"$actual"
554 test_cmp expected "$actual"
557 test_expect_success '__git_refs - URL remote - full refs' '
558 cat >expected <<-EOF &&
559 refs/heads/branch-in-other
560 refs/heads/master-in-other
561 refs/tags/tag-in-other
565 __git_refs "file://$ROOT/otherrepo/.git" >"$actual"
567 test_cmp expected "$actual"
570 test_expect_failure '__git_refs - non-existing remote' '
573 __git_refs non-existing >"$actual"
575 test_must_be_empty "$actual"
578 test_expect_success '__git_refs - non-existing remote - full refs' '
581 __git_refs non-existing >"$actual"
583 test_must_be_empty "$actual"
586 test_expect_failure '__git_refs - non-existing URL remote' '
589 __git_refs "file://$ROOT/non-existing" >"$actual"
591 test_must_be_empty "$actual"
594 test_expect_success '__git_refs - non-existing URL remote - full refs' '
597 __git_refs "file://$ROOT/non-existing" >"$actual"
599 test_must_be_empty "$actual"
602 test_expect_failure '__git_refs - not in a git repository' '
604 GIT_CEILING_DIRECTORIES="$ROOT" &&
605 export GIT_CEILING_DIRECTORIES &&
608 __git_refs >"$actual"
610 test_must_be_empty "$actual"
613 test_expect_success '__git_refs - unique remote branches for git checkout DWIMery' '
614 cat >expected <<-EOF &&
619 other/branch-in-other
620 other/master-in-other
622 remote/branch-in-remote
628 for remote_ref in refs/remotes/other/ambiguous \
629 refs/remotes/remote/ambiguous \
630 refs/remotes/remote/branch-in-remote
632 git update-ref $remote_ref master &&
633 test_when_finished "git update-ref -d $remote_ref"
637 __git_refs "" 1 >"$actual"
639 test_cmp expected "$actual"
642 test_expect_success 'teardown after ref completion' '
643 git branch -d matching-branch &&
644 git tag -d matching-tag &&
645 git remote remove other
648 test_expect_success '__git_get_config_variables' '
649 cat >expect <<-EOF &&
653 test_config interesting.name-1 good &&
654 test_config interesting.name-2 good &&
655 test_config subsection.interesting.name-3 bad &&
656 __git_get_config_variables interesting >actual &&
657 test_cmp expect actual
660 test_expect_success '__git_pretty_aliases' '
661 cat >expect <<-EOF &&
665 test_config pretty.author "%an %ae" &&
666 test_config pretty.hash %H &&
667 __git_pretty_aliases >actual &&
668 test_cmp expect actual
671 test_expect_success '__git_aliases' '
672 cat >expect <<-EOF &&
676 test_config alias.ci commit &&
677 test_config alias.co checkout &&
678 __git_aliases >actual &&
679 test_cmp expect actual
682 test_expect_success 'basic' '
683 run_completion "git " &&
685 grep -q "^add \$" out &&
687 grep -q "^filter-branch \$" out &&
689 ! grep -q "^ls-files \$" out &&
691 run_completion "git f" &&
692 ! grep -q -v "^f" out
695 test_expect_success 'double dash "git" itself' '
696 test_completion "git --" <<-\EOF
709 --no-replace-objects Z
714 test_expect_success 'double dash "git checkout"' '
715 test_completion "git checkout --" <<-\EOF
728 test_expect_success 'general options' '
729 test_completion "git --ver" "--version " &&
730 test_completion "git --hel" "--help " &&
731 test_completion "git --exe" <<-\EOF &&
735 test_completion "git --htm" "--html-path " &&
736 test_completion "git --pag" "--paginate " &&
737 test_completion "git --no-p" "--no-pager " &&
738 test_completion "git --git" "--git-dir=" &&
739 test_completion "git --wor" "--work-tree=" &&
740 test_completion "git --nam" "--namespace=" &&
741 test_completion "git --bar" "--bare " &&
742 test_completion "git --inf" "--info-path " &&
743 test_completion "git --no-r" "--no-replace-objects "
746 test_expect_success 'general options plus command' '
747 test_completion "git --version check" "checkout " &&
748 test_completion "git --paginate check" "checkout " &&
749 test_completion "git --git-dir=foo check" "checkout " &&
750 test_completion "git --bare check" "checkout " &&
751 test_completion "git --exec-path=foo check" "checkout " &&
752 test_completion "git --html-path check" "checkout " &&
753 test_completion "git --no-pager check" "checkout " &&
754 test_completion "git --work-tree=foo check" "checkout " &&
755 test_completion "git --namespace=foo check" "checkout " &&
756 test_completion "git --paginate check" "checkout " &&
757 test_completion "git --info-path check" "checkout " &&
758 test_completion "git --no-replace-objects check" "checkout "
761 test_expect_success 'git --help completion' '
762 test_completion "git --help ad" "add " &&
763 test_completion "git --help core" "core-tutorial "
766 test_expect_success 'setup for integration tests' '
767 echo content >file1 &&
769 git add file1 file2 &&
771 git branch mybranch &&
775 test_expect_success 'checkout completes ref names' '
776 test_completion "git checkout m" <<-\EOF
783 test_expect_success 'show completes all refs' '
784 test_completion "git show m" <<-\EOF
791 test_expect_success '<ref>: completes paths' '
792 test_completion "git show mytag:f" <<-\EOF
798 test_expect_success 'complete tree filename with spaces' '
799 echo content >"name with spaces" &&
800 git add "name with spaces" &&
801 git commit -m spaces &&
802 test_completion "git show HEAD:nam" <<-\EOF
807 test_expect_success 'complete tree filename with metacharacters' '
808 echo content >"name with \${meta}" &&
809 git add "name with \${meta}" &&
810 git commit -m meta &&
811 test_completion "git show HEAD:nam" <<-\EOF
817 test_expect_success 'send-email' '
818 test_completion "git send-email --cov" "--cover-letter " &&
819 test_completion "git send-email ma" "master "
822 test_expect_success 'complete files' '
823 git init tmp && cd tmp &&
824 test_when_finished "cd .. && rm -rf tmp" &&
826 echo "expected" > .gitignore &&
827 echo "out" >> .gitignore &&
829 git add .gitignore &&
830 test_completion "git commit " ".gitignore" &&
832 git commit -m ignore &&
835 test_completion "git add " "new" &&
838 git commit -a -m new &&
839 test_completion "git add " "" &&
841 git mv new modified &&
842 echo modify > modified &&
843 test_completion "git add " "modified" &&
847 : TODO .gitignore should not be here &&
848 test_completion "git rm " <<-\EOF &&
853 test_completion "git clean " "untracked" &&
855 : TODO .gitignore should not be here &&
856 test_completion "git mv " <<-\EOF &&
862 touch dir/file-in-dir &&
863 git add dir/file-in-dir &&
866 mkdir untracked-dir &&
868 : TODO .gitignore should not be here &&
869 test_completion "git mv modified " <<-\EOF &&
877 test_completion "git commit " "modified" &&
879 : TODO .gitignore should not be here &&
880 test_completion "git ls-files " <<-\EOF &&
887 test_completion "git add mom" "momified"
890 test_expect_success "completion uses <cmd> completion for alias: !sh -c 'git <cmd> ...'" '
891 test_config alias.co "!sh -c '"'"'git checkout ...'"'"'" &&
892 test_completion "git co m" <<-\EOF
899 test_expect_success 'completion uses <cmd> completion for alias: !f () { VAR=val git <cmd> ... }' '
900 test_config alias.co "!f () { VAR=val git checkout ... ; } f" &&
901 test_completion "git co m" <<-\EOF
908 test_expect_success 'completion used <cmd> completion for alias: !f() { : git <cmd> ; ... }' '
909 test_config alias.co "!f() { : git checkout ; if ... } f" &&
910 test_completion "git co m" <<-\EOF
917 test_expect_failure 'complete with tilde expansion' '
918 git init tmp && cd tmp &&
919 test_when_finished "cd .. && rm -rf tmp" &&
923 test_completion "git add ~/tmp/" "~/tmp/file"