3 test_description='Test automatic use of a pager.'
6 . "$TEST_DIRECTORY"/lib-pager.sh
7 . "$TEST_DIRECTORY"/lib-terminal.sh
9 test_expect_success 'setup' '
10 sane_unset GIT_PAGER GIT_PAGER_IN_USE &&
11 test_unconfig core.pager &&
13 PAGER="cat >paginated.out" &&
19 test_expect_success TTY 'some commands use a pager' '
20 rm -f paginated.out &&
21 test_terminal git log &&
22 test_path_is_file paginated.out
25 test_expect_failure TTY 'pager runs from subdir' '
26 echo subdir/paginated.out >expected &&
28 rm -f paginated.out subdir/paginated.out &&
34 ls paginated.out subdir/paginated.out ||
37 test_cmp expected actual
40 test_expect_success TTY 'LESS and LV envvars are set for pagination' '
43 PAGER="env >pager-env.out; wc" &&
48 grep ^LESS= pager-env.out &&
49 grep ^LV= pager-env.out
52 test_expect_success !MINGW,TTY 'LESS and LV envvars set by git-sh-setup' '
55 PAGER="env >pager-env.out; wc" &&
57 PATH="$(git --exec-path):$PATH" &&
59 test_terminal sh -c ". git-sh-setup && git_pager"
61 grep ^LESS= pager-env.out &&
62 grep ^LV= pager-env.out
65 test_expect_success TTY 'some commands do not use a pager' '
66 rm -f paginated.out &&
67 test_terminal git rev-list HEAD &&
68 test_path_is_missing paginated.out
71 test_expect_success 'no pager when stdout is a pipe' '
72 rm -f paginated.out &&
74 test_path_is_missing paginated.out
77 test_expect_success 'no pager when stdout is a regular file' '
78 rm -f paginated.out &&
80 test_path_is_missing paginated.out
83 test_expect_success TTY 'git --paginate rev-list uses a pager' '
84 rm -f paginated.out &&
85 test_terminal git --paginate rev-list HEAD &&
86 test_path_is_file paginated.out
89 test_expect_success 'no pager even with --paginate when stdout is a pipe' '
90 rm -f file paginated.out &&
91 git --paginate log | cat &&
92 test_path_is_missing paginated.out
95 test_expect_success TTY 'no pager with --no-pager' '
96 rm -f paginated.out &&
97 test_terminal git --no-pager log &&
98 test_path_is_missing paginated.out
101 test_expect_success TTY 'configuration can disable pager' '
102 rm -f paginated.out &&
103 test_unconfig pager.grep &&
104 test_terminal git grep initial &&
105 test_path_is_file paginated.out &&
107 rm -f paginated.out &&
108 test_config pager.grep false &&
109 test_terminal git grep initial &&
110 test_path_is_missing paginated.out
113 test_expect_success TTY 'configuration can enable pager (from subdir)' '
114 rm -f paginated.out &&
116 test_config pager.bundle true &&
118 git bundle create test.bundle --all &&
119 rm -f paginated.out subdir/paginated.out &&
122 test_terminal git bundle unbundle ../test.bundle
125 test_path_is_file paginated.out ||
126 test_path_is_file subdir/paginated.out
130 test_expect_success TTY 'git tag -l defaults to paging' '
131 rm -f paginated.out &&
132 test_terminal git tag -l &&
133 test_path_is_file paginated.out
136 test_expect_success TTY 'git tag -l respects pager.tag' '
137 rm -f paginated.out &&
138 test_terminal git -c pager.tag=false tag -l &&
139 test_path_is_missing paginated.out
142 test_expect_success TTY 'git tag -l respects --no-pager' '
143 rm -f paginated.out &&
144 test_terminal git -c pager.tag --no-pager tag -l &&
145 test_path_is_missing paginated.out
148 test_expect_success TTY 'git tag with no args defaults to paging' '
149 # no args implies -l so this should page like -l
150 rm -f paginated.out &&
151 test_terminal git tag &&
152 test_path_is_file paginated.out
155 test_expect_success TTY 'git tag with no args respects pager.tag' '
156 # no args implies -l so this should page like -l
157 rm -f paginated.out &&
158 test_terminal git -c pager.tag=false tag &&
159 test_path_is_missing paginated.out
162 test_expect_success TTY 'git tag --contains defaults to paging' '
163 # --contains implies -l so this should page like -l
164 rm -f paginated.out &&
165 test_terminal git tag --contains &&
166 test_path_is_file paginated.out
169 test_expect_success TTY 'git tag --contains respects pager.tag' '
170 # --contains implies -l so this should page like -l
171 rm -f paginated.out &&
172 test_terminal git -c pager.tag=false tag --contains &&
173 test_path_is_missing paginated.out
176 test_expect_success TTY 'git tag -a defaults to not paging' '
177 test_when_finished "git tag -d newtag" &&
178 rm -f paginated.out &&
179 test_terminal git tag -am message newtag &&
180 test_path_is_missing paginated.out
183 test_expect_success TTY 'git tag -a ignores pager.tag' '
184 test_when_finished "git tag -d newtag" &&
185 rm -f paginated.out &&
186 test_terminal git -c pager.tag tag -am message newtag &&
187 test_path_is_missing paginated.out
190 test_expect_success TTY 'git tag -a respects --paginate' '
191 test_when_finished "git tag -d newtag" &&
192 rm -f paginated.out &&
193 test_terminal git --paginate tag -am message newtag &&
194 test_path_is_file paginated.out
197 test_expect_success TTY 'git tag as alias ignores pager.tag with -a' '
198 test_when_finished "git tag -d newtag" &&
199 rm -f paginated.out &&
200 test_terminal git -c pager.tag -c alias.t=tag t -am message newtag &&
201 test_path_is_missing paginated.out
204 test_expect_success TTY 'git tag as alias respects pager.tag with -l' '
205 rm -f paginated.out &&
206 test_terminal git -c pager.tag=false -c alias.t=tag t -l &&
207 test_path_is_missing paginated.out
210 test_expect_success TTY 'git branch defaults to paging' '
211 rm -f paginated.out &&
212 test_terminal git branch &&
213 test_path_is_file paginated.out
216 test_expect_success TTY 'git branch respects pager.branch' '
217 rm -f paginated.out &&
218 test_terminal git -c pager.branch=false branch &&
219 test_path_is_missing paginated.out
222 test_expect_success TTY 'git branch respects --no-pager' '
223 rm -f paginated.out &&
224 test_terminal git --no-pager branch &&
225 test_path_is_missing paginated.out
228 test_expect_success TTY 'git branch --edit-description ignores pager.branch' '
229 rm -f paginated.out editor.used &&
230 write_script editor <<-\EOF &&
231 echo "New description" >"$1"
234 EDITOR=./editor test_terminal git -c pager.branch branch --edit-description &&
235 test_path_is_missing paginated.out &&
236 test_path_is_file editor.used
239 test_expect_success TTY 'git branch --set-upstream-to ignores pager.branch' '
240 rm -f paginated.out &&
242 test_when_finished "git branch -D other" &&
243 test_terminal git -c pager.branch branch --set-upstream-to=other &&
244 test_when_finished "git branch --unset-upstream" &&
245 test_path_is_missing paginated.out
248 test_expect_success TTY 'git config ignores pager.config when setting' '
249 rm -f paginated.out &&
250 test_terminal git -c pager.config config foo.bar bar &&
251 test_path_is_missing paginated.out
254 test_expect_success TTY 'git config --edit ignores pager.config' '
255 rm -f paginated.out editor.used &&
256 write_script editor <<-\EOF &&
259 EDITOR=./editor test_terminal git -c pager.config config --edit &&
260 test_path_is_missing paginated.out &&
261 test_path_is_file editor.used
264 test_expect_success TTY 'git config --get ignores pager.config' '
265 rm -f paginated.out &&
266 test_terminal git -c pager.config config --get foo.bar &&
267 test_path_is_missing paginated.out
270 test_expect_success TTY 'git config --get-urlmatch defaults to paging' '
271 rm -f paginated.out &&
272 test_terminal git -c http."https://foo.com/".bar=foo \
273 config --get-urlmatch http https://foo.com &&
274 test_path_is_file paginated.out
277 test_expect_success TTY 'git config --get-all respects pager.config' '
278 rm -f paginated.out &&
279 test_terminal git -c pager.config=false config --get-all foo.bar &&
280 test_path_is_missing paginated.out
283 test_expect_success TTY 'git config --list defaults to paging' '
284 rm -f paginated.out &&
285 test_terminal git config --list &&
286 test_path_is_file paginated.out
290 # A colored commit log will begin with an appropriate ANSI escape
291 # for the first color; the text "commit" comes later.
294 ! expr "$firstline" : "[a-zA-Z]" >/dev/null
297 test_expect_success 'tests can detect color' '
298 rm -f colorful.log colorless.log &&
299 git log --no-color >colorless.log &&
300 git log --color >colorful.log &&
301 ! colorful colorless.log &&
302 colorful colorful.log
305 test_expect_success 'no color when stdout is a regular file' '
306 rm -f colorless.log &&
307 test_config color.ui auto &&
308 git log >colorless.log &&
309 ! colorful colorless.log
312 test_expect_success TTY 'color when writing to a pager' '
313 rm -f paginated.out &&
314 test_config color.ui auto &&
315 test_terminal git log &&
316 colorful paginated.out
319 test_expect_success TTY 'colors are suppressed by color.pager' '
320 rm -f paginated.out &&
321 test_config color.ui auto &&
322 test_config color.pager false &&
323 test_terminal git log &&
324 ! colorful paginated.out
327 test_expect_success 'color when writing to a file intended for a pager' '
328 rm -f colorful.log &&
329 test_config color.ui auto &&
332 GIT_PAGER_IN_USE=true &&
333 export TERM GIT_PAGER_IN_USE &&
334 git log >colorful.log
336 colorful colorful.log
339 test_expect_success TTY 'colors are sent to pager for external commands' '
340 test_config alias.externallog "!git log" &&
341 test_config color.ui auto &&
342 test_terminal git -p externallog &&
343 colorful paginated.out
346 # Use this helper to make it easy for the caller of your
347 # terminal-using function to specify whether it should fail.
353 # $test_expectation "$cmd - behaves well" "
360 # then your test can be used like this:
362 # your_test expect_(success|failure) [test_must_fail] 'git foo'
365 test_expectation="test_$1"
367 if test "$1" = test_must_fail
369 full_command="test_must_fail test_terminal "
372 full_command="test_terminal "
375 full_command="$full_command $1"
378 test_default_pager() {
381 $test_expectation SIMPLEPAGER,TTY "$cmd - default pager is used by default" "
382 sane_unset PAGER GIT_PAGER &&
383 test_unconfig core.pager &&
384 rm -f default_pager_used &&
385 cat >\$less <<-\EOF &&
387 wc >default_pager_used
395 test_path_is_file default_pager_used
399 test_PAGER_overrides() {
402 $test_expectation TTY "$cmd - PAGER overrides default pager" "
403 sane_unset GIT_PAGER &&
404 test_unconfig core.pager &&
406 PAGER='wc >PAGER_used' &&
409 test_path_is_file PAGER_used
413 test_core_pager_overrides() {
415 used_if_wanted='overrides PAGER'
419 test_local_config_ignored() {
421 used_if_wanted='is not used'
428 $test_expectation TTY "$cmd - repository-local core.pager setting $used_if_wanted" "
429 sane_unset GIT_PAGER &&
430 rm -f core.pager_used &&
433 test_config core.pager 'wc >core.pager_used' &&
435 ${if_local_config}test_path_is_file core.pager_used
439 test_core_pager_subdir() {
441 used_if_wanted='overrides PAGER'
442 test_pager_subdir_helper "$@"
445 test_no_local_config_subdir() {
447 used_if_wanted='is not used'
448 test_pager_subdir_helper "$@"
451 test_pager_subdir_helper() {
454 $test_expectation TTY "$cmd - core.pager $used_if_wanted from subdirectory" "
455 sane_unset GIT_PAGER &&
456 rm -f core.pager_used &&
459 stampname=\$(pwd)/core.pager_used &&
460 export PAGER stampname &&
461 test_config core.pager 'wc >\"\$stampname\"' &&
467 ${if_local_config}test_path_is_file core.pager_used
471 test_GIT_PAGER_overrides() {
474 $test_expectation TTY "$cmd - GIT_PAGER overrides core.pager" "
475 rm -f GIT_PAGER_used &&
476 test_config core.pager wc &&
477 GIT_PAGER='wc >GIT_PAGER_used' &&
480 test_path_is_file GIT_PAGER_used
484 test_doesnt_paginate() {
487 $test_expectation TTY "no pager for '$cmd'" "
488 rm -f GIT_PAGER_used &&
489 GIT_PAGER='wc >GIT_PAGER_used' &&
492 test_path_is_missing GIT_PAGER_used
496 test_pager_choices() {
497 test_default_pager expect_success "$@"
498 test_PAGER_overrides expect_success "$@"
499 test_core_pager_overrides expect_success "$@"
500 test_core_pager_subdir expect_success "$@"
501 test_GIT_PAGER_overrides expect_success "$@"
504 test_expect_success 'setup: some aliases' '
505 git config alias.aliasedlog log &&
506 git config alias.true "!true"
509 test_pager_choices 'git log'
510 test_pager_choices 'git -p log'
511 test_pager_choices 'git aliasedlog'
513 test_default_pager expect_success 'git -p aliasedlog'
514 test_PAGER_overrides expect_success 'git -p aliasedlog'
515 test_core_pager_overrides expect_success 'git -p aliasedlog'
516 test_core_pager_subdir expect_success 'git -p aliasedlog'
517 test_GIT_PAGER_overrides expect_success 'git -p aliasedlog'
519 test_default_pager expect_success 'git -p true'
520 test_PAGER_overrides expect_success 'git -p true'
521 test_core_pager_overrides expect_success 'git -p true'
522 test_core_pager_subdir expect_success 'git -p true'
523 test_GIT_PAGER_overrides expect_success 'git -p true'
525 test_default_pager expect_success test_must_fail 'git -p request-pull'
526 test_PAGER_overrides expect_success test_must_fail 'git -p request-pull'
527 test_core_pager_overrides expect_success test_must_fail 'git -p request-pull'
528 test_core_pager_subdir expect_success test_must_fail 'git -p request-pull'
529 test_GIT_PAGER_overrides expect_success test_must_fail 'git -p request-pull'
531 test_default_pager expect_success test_must_fail 'git -p'
532 test_PAGER_overrides expect_success test_must_fail 'git -p'
533 test_local_config_ignored expect_failure test_must_fail 'git -p'
534 test_GIT_PAGER_overrides expect_success test_must_fail 'git -p'
536 test_expect_success TTY 'core.pager in repo config works and retains cwd' '
537 sane_unset GIT_PAGER &&
538 test_config core.pager "cat >cwd-retained" &&
541 rm -f cwd-retained &&
542 test_terminal git -p rev-parse HEAD &&
543 test_path_is_file cwd-retained
547 test_expect_success TTY 'core.pager is found via alias in subdirectory' '
548 sane_unset GIT_PAGER &&
549 test_config core.pager "cat >via-alias" &&
553 test_terminal git -c alias.r="-p rev-parse" r HEAD &&
554 test_path_is_file via-alias
558 test_doesnt_paginate expect_failure test_must_fail 'git -p nonsense'
560 test_pager_choices 'git shortlog'
561 test_expect_success 'setup: configure shortlog not to paginate' '
562 git config pager.shortlog false
564 test_doesnt_paginate expect_success 'git shortlog'
565 test_no_local_config_subdir expect_success 'git shortlog'
566 test_default_pager expect_success 'git -p shortlog'
567 test_core_pager_subdir expect_success 'git -p shortlog'
569 test_core_pager_subdir expect_success test_must_fail \
570 'git -p apply </dev/null'
572 test_expect_success TTY 'command-specific pager' '
573 sane_unset PAGER GIT_PAGER &&
574 echo "foo:initial" >expect &&
576 test_unconfig core.pager &&
577 test_config pager.log "sed s/^/foo:/ >actual" &&
578 test_terminal git log --format=%s -1 &&
579 test_cmp expect actual
582 test_expect_success TTY 'command-specific pager overrides core.pager' '
583 sane_unset PAGER GIT_PAGER &&
584 echo "foo:initial" >expect &&
586 test_config core.pager "exit 1" &&
587 test_config pager.log "sed s/^/foo:/ >actual" &&
588 test_terminal git log --format=%s -1 &&
589 test_cmp expect actual
592 test_expect_success TTY 'command-specific pager overridden by environment' '
593 GIT_PAGER="sed s/^/foo:/ >actual" && export GIT_PAGER &&
595 echo "foo:initial" >expect &&
596 test_config pager.log "exit 1" &&
597 test_terminal git log --format=%s -1 &&
598 test_cmp expect actual
601 test_expect_success 'setup external command' '
602 cat >git-external <<-\EOF &&
606 chmod +x git-external
609 test_expect_success TTY 'command-specific pager works for external commands' '
610 sane_unset PAGER GIT_PAGER &&
611 echo "foo:initial" >expect &&
613 test_config pager.external "sed s/^/foo:/ >actual" &&
614 test_terminal git --exec-path="$(pwd)" external log --format=%s -1 &&
615 test_cmp expect actual
618 test_expect_success TTY 'sub-commands of externals use their own pager' '
619 sane_unset PAGER GIT_PAGER &&
620 echo "foo:initial" >expect &&
622 test_config pager.log "sed s/^/foo:/ >actual" &&
623 test_terminal git --exec-path=. external log --format=%s -1 &&
624 test_cmp expect actual
627 test_expect_success TTY 'external command pagers override sub-commands' '
628 sane_unset PAGER GIT_PAGER &&
630 test_config pager.external false &&
631 test_config pager.log "sed s/^/log:/ >actual" &&
632 test_terminal git --exec-path=. external log --format=%s -1 &&
633 test_must_be_empty actual
636 test_expect_success 'command with underscores does not complain' '
637 write_script git-under_score <<-\EOF &&
640 git --exec-path=. under_score >actual 2>&1 &&
642 test_cmp expect actual
645 test_expect_success TTY 'git tag with auto-columns ' '
651 cat >expect <<-\EOF &&
652 initial one two three four five
654 test_terminal env PAGER="cat >actual" COLUMNS=80 \
655 git -c column.ui=auto tag --sort=authordate &&
656 test_cmp expect actual
659 test_expect_success 'setup trace2' '
660 GIT_TRACE2_BRIEF=1 &&
661 export GIT_TRACE2_BRIEF
664 test_expect_success TTY 'git returns SIGPIPE on early pager exit' '
665 test_when_finished "rm pager-used trace.normal" &&
666 test_config core.pager ">pager-used; head -n 1; exit 0" &&
667 GIT_TRACE2="$(pwd)/trace.normal" &&
669 test_when_finished "unset GIT_TRACE2" &&
671 if test_have_prereq !MINGW
673 OUT=$( ((test_terminal git log; echo $? 1>&3) | :) 3>&1 ) &&
674 test_match_signal 13 "$OUT"
676 test_terminal git log
679 grep child_exit trace.normal >child-exits &&
680 test_line_count = 1 child-exits &&
681 grep " code:0 " child-exits &&
682 test_path_is_file pager-used
685 test_expect_success TTY 'git returns SIGPIPE on early pager non-zero exit' '
686 test_when_finished "rm pager-used trace.normal" &&
687 test_config core.pager ">pager-used; head -n 1; exit 1" &&
688 GIT_TRACE2="$(pwd)/trace.normal" &&
690 test_when_finished "unset GIT_TRACE2" &&
692 if test_have_prereq !MINGW
694 OUT=$( ((test_terminal git log; echo $? 1>&3) | :) 3>&1 ) &&
695 test_match_signal 13 "$OUT"
697 test_terminal git log
700 grep child_exit trace.normal >child-exits &&
701 test_line_count = 1 child-exits &&
702 grep " code:1 " child-exits &&
703 test_path_is_file pager-used
706 test_expect_success TTY 'git discards pager non-zero exit without SIGPIPE' '
707 test_when_finished "rm pager-used trace.normal" &&
708 test_config core.pager "wc >pager-used; exit 1" &&
709 GIT_TRACE2="$(pwd)/trace.normal" &&
711 test_when_finished "unset GIT_TRACE2" &&
713 if test_have_prereq !MINGW
715 OUT=$( ((test_terminal git log; echo $? 1>&3) | :) 3>&1 ) &&
718 test_terminal git log
721 grep child_exit trace.normal >child-exits &&
722 test_line_count = 1 child-exits &&
723 grep " code:1 " child-exits &&
724 test_path_is_file pager-used
727 test_expect_success TTY 'git discards nonexisting pager without SIGPIPE' '
728 test_when_finished "rm pager-used trace.normal" &&
729 test_config core.pager "wc >pager-used; does-not-exist" &&
730 GIT_TRACE2="$(pwd)/trace.normal" &&
732 test_when_finished "unset GIT_TRACE2" &&
734 if test_have_prereq !MINGW
736 OUT=$( ((test_terminal git log; echo $? 1>&3) | :) 3>&1 ) &&
739 test_terminal git log
742 grep child_exit trace.normal >child-exits &&
743 test_line_count = 1 child-exits &&
744 grep " code:127 " child-exits &&
745 test_path_is_file pager-used
748 test_expect_success TTY 'git attempts to page to nonexisting pager command, gets SIGPIPE' '
749 test_when_finished "rm trace.normal" &&
750 test_config core.pager "does-not-exist" &&
751 GIT_TRACE2="$(pwd)/trace.normal" &&
753 test_when_finished "unset GIT_TRACE2" &&
755 if test_have_prereq !MINGW
757 OUT=$( ((test_terminal git log; echo $? 1>&3) | :) 3>&1 ) &&
758 test_match_signal 13 "$OUT"
760 test_terminal git log
763 grep child_exit trace.normal >child-exits &&
764 test_line_count = 1 child-exits &&
765 grep " code:-1 " child-exits
768 test_expect_success TTY 'git returns SIGPIPE on propagated signals from pager' '
769 test_when_finished "rm pager-used trace.normal" &&
770 test_config core.pager ">pager-used; test-tool sigchain" &&
771 GIT_TRACE2="$(pwd)/trace.normal" &&
773 test_when_finished "unset GIT_TRACE2" &&
775 if test_have_prereq !MINGW
777 OUT=$( ((test_terminal git log; echo $? 1>&3) | :) 3>&1 ) &&
778 test_match_signal 13 "$OUT"
780 test_terminal git log
783 grep child_exit trace.normal >child-exits &&
784 test_line_count = 1 child-exits &&
785 grep " code:143 " child-exits &&
786 test_path_is_file pager-used