support pager.* for external commands
[git/git.git] / t / t7006-pager.sh
CommitLineData
60b6e220
JN
1#!/bin/sh
2
3test_description='Test automatic use of a pager.'
4
5. ./test-lib.sh
678e484b 6. "$TEST_DIRECTORY"/lib-pager.sh
cc4e48fc 7. "$TEST_DIRECTORY"/lib-terminal.sh
60b6e220 8
fdf1bc48
JN
9cleanup_fail() {
10 echo >&2 cleanup failed
11 (exit 1)
12}
13
60b6e220 14test_expect_success 'setup' '
00648ba0 15 sane_unset GIT_PAGER GIT_PAGER_IN_USE &&
8d68a6d5 16 test_unconfig core.pager &&
fdf1bc48
JN
17
18 PAGER="cat >paginated.out" &&
19 export PAGER &&
20
60b6e220
JN
21 test_commit initial
22'
23
60b6e220 24test_expect_success TTY 'some commands use a pager' '
fdf1bc48
JN
25 rm -f paginated.out ||
26 cleanup_fail &&
27
2d3ca216 28 test_terminal git log &&
60b6e220
JN
29 test -e paginated.out
30'
31
2cb60093
NTND
32test_expect_failure TTY 'pager runs from subdir' '
33 echo subdir/paginated.out >expected &&
34 mkdir -p subdir &&
35 rm -f paginated.out subdir/paginated.out &&
36 (
37 cd subdir &&
38 test_terminal git log
39 ) &&
40 {
41 ls paginated.out subdir/paginated.out ||
42 :
43 } >actual &&
44 test_cmp expected actual
45'
46
60b6e220 47test_expect_success TTY 'some commands do not use a pager' '
fdf1bc48
JN
48 rm -f paginated.out ||
49 cleanup_fail &&
50
2d3ca216 51 test_terminal git rev-list HEAD &&
60b6e220
JN
52 ! test -e paginated.out
53'
54
60b6e220 55test_expect_success 'no pager when stdout is a pipe' '
fdf1bc48
JN
56 rm -f paginated.out ||
57 cleanup_fail &&
58
60b6e220
JN
59 git log | cat &&
60 ! test -e paginated.out
61'
62
60b6e220 63test_expect_success 'no pager when stdout is a regular file' '
fdf1bc48
JN
64 rm -f paginated.out ||
65 cleanup_fail &&
66
67 git log >file &&
60b6e220
JN
68 ! test -e paginated.out
69'
70
60b6e220 71test_expect_success TTY 'git --paginate rev-list uses a pager' '
fdf1bc48
JN
72 rm -f paginated.out ||
73 cleanup_fail &&
74
2d3ca216 75 test_terminal git --paginate rev-list HEAD &&
60b6e220
JN
76 test -e paginated.out
77'
78
60b6e220 79test_expect_success 'no pager even with --paginate when stdout is a pipe' '
fdf1bc48
JN
80 rm -f file paginated.out ||
81 cleanup_fail &&
82
60b6e220
JN
83 git --paginate log | cat &&
84 ! test -e paginated.out
85'
86
60b6e220 87test_expect_success TTY 'no pager with --no-pager' '
fdf1bc48
JN
88 rm -f paginated.out ||
89 cleanup_fail &&
90
2d3ca216 91 test_terminal git --no-pager log &&
60b6e220
JN
92 ! test -e paginated.out
93'
94
ff38d1a9
NTND
95test_expect_success TTY 'configuration can disable pager' '
96 rm -f paginated.out &&
8d68a6d5 97 test_unconfig pager.grep &&
ff38d1a9
NTND
98 test_terminal git grep initial &&
99 test -e paginated.out &&
100
101 rm -f paginated.out &&
8d68a6d5 102 test_config pager.grep false &&
ff38d1a9
NTND
103 test_terminal git grep initial &&
104 ! test -e paginated.out
105'
106
41bf3bc2 107test_expect_success TTY 'git config uses a pager if configured to' '
3ba7e6e2 108 rm -f paginated.out &&
8d68a6d5 109 test_config pager.config true &&
3ba7e6e2
NTND
110 test_terminal git config --list &&
111 test -e paginated.out
112'
113
41bf3bc2 114test_expect_success TTY 'configuration can enable pager (from subdir)' '
2cb60093
NTND
115 rm -f paginated.out &&
116 mkdir -p subdir &&
8d68a6d5 117 test_config pager.bundle true &&
2cb60093
NTND
118
119 git bundle create test.bundle --all &&
120 rm -f paginated.out subdir/paginated.out &&
121 (
122 cd subdir &&
123 test_terminal git bundle unbundle ../test.bundle
124 ) &&
125 {
126 test -e paginated.out ||
127 test -e subdir/paginated.out
128 }
129'
130
60b6e220
JN
131# A colored commit log will begin with an appropriate ANSI escape
132# for the first color; the text "commit" comes later.
133colorful() {
fdf1bc48 134 read firstline <$1
e0ae1e6f 135 ! expr "$firstline" : "[a-zA-Z]" >/dev/null
60b6e220
JN
136}
137
60b6e220 138test_expect_success 'tests can detect color' '
fdf1bc48
JN
139 rm -f colorful.log colorless.log ||
140 cleanup_fail &&
141
142 git log --no-color >colorless.log &&
143 git log --color >colorful.log &&
60b6e220
JN
144 ! colorful colorless.log &&
145 colorful colorful.log
146'
147
60b6e220 148test_expect_success 'no color when stdout is a regular file' '
fdf1bc48 149 rm -f colorless.log &&
8d68a6d5 150 test_config color.ui auto ||
fdf1bc48
JN
151 cleanup_fail &&
152
153 git log >colorless.log &&
60b6e220
JN
154 ! colorful colorless.log
155'
156
60b6e220 157test_expect_success TTY 'color when writing to a pager' '
fdf1bc48 158 rm -f paginated.out &&
8d68a6d5 159 test_config color.ui auto ||
fdf1bc48
JN
160 cleanup_fail &&
161
162 (
163 TERM=vt100 &&
164 export TERM &&
165 test_terminal git log
166 ) &&
60b6e220
JN
167 colorful paginated.out
168'
169
daa0c3d9
JK
170test_expect_success TTY 'colors are suppressed by color.pager' '
171 rm -f paginated.out &&
172 test_config color.ui auto &&
173 test_config color.pager false &&
174 (
175 TERM=vt100 &&
176 export TERM &&
177 test_terminal git log
178 ) &&
179 ! colorful paginated.out
180'
181
60b6e220 182test_expect_success 'color when writing to a file intended for a pager' '
fdf1bc48 183 rm -f colorful.log &&
8d68a6d5 184 test_config color.ui auto ||
fdf1bc48
JN
185 cleanup_fail &&
186
187 (
188 TERM=vt100 &&
189 GIT_PAGER_IN_USE=true &&
190 export TERM GIT_PAGER_IN_USE &&
191 git log >colorful.log
192 ) &&
60b6e220
JN
193 colorful colorful.log
194'
195
2e6c012e
JK
196test_expect_success TTY 'colors are sent to pager for external commands' '
197 test_config alias.externallog "!git log" &&
198 test_config color.ui auto &&
199 (
200 TERM=vt100 &&
201 export TERM &&
202 test_terminal git -p externallog
203 ) &&
204 colorful paginated.out
205'
206
3c7406d4
JN
207# Use this helper to make it easy for the caller of your
208# terminal-using function to specify whether it should fail.
209# If you write
210#
211# your_test() {
212# parse_args "$@"
213#
214# $test_expectation "$cmd - behaves well" "
215# ...
216# $full_command &&
217# ...
218# "
219# }
220#
221# then your test can be used like this:
222#
223# your_test expect_(success|failure) [test_must_fail] 'git foo'
224#
225parse_args() {
226 test_expectation="test_$1"
227 shift
228 if test "$1" = test_must_fail
229 then
230 full_command="test_must_fail test_terminal "
231 shift
232 else
233 full_command="test_terminal "
234 fi
235 cmd=$1
236 full_command="$full_command $1"
237}
fdf1bc48 238
8f81449e
JN
239test_default_pager() {
240 parse_args "$@"
241
996621eb 242 $test_expectation SIMPLEPAGER,TTY "$cmd - default pager is used by default" "
00648ba0 243 sane_unset PAGER GIT_PAGER &&
8d68a6d5 244 test_unconfig core.pager &&
8f81449e
JN
245 rm -f default_pager_used ||
246 cleanup_fail &&
247
248 cat >\$less <<-\EOF &&
249 #!/bin/sh
250 wc >default_pager_used
251 EOF
252 chmod +x \$less &&
253 (
254 PATH=.:\$PATH &&
255 export PATH &&
256 $full_command
257 ) &&
258 test -e default_pager_used
259 "
260}
60b6e220 261
8f81449e
JN
262test_PAGER_overrides() {
263 parse_args "$@"
fdf1bc48 264
8f81449e 265 $test_expectation TTY "$cmd - PAGER overrides default pager" "
00648ba0 266 sane_unset GIT_PAGER &&
8d68a6d5 267 test_unconfig core.pager &&
8f81449e
JN
268 rm -f PAGER_used ||
269 cleanup_fail &&
60b6e220 270
8f81449e
JN
271 PAGER='wc >PAGER_used' &&
272 export PAGER &&
273 $full_command &&
274 test -e PAGER_used
275 "
276}
fdf1bc48 277
8f81449e 278test_core_pager_overrides() {
73e25e7c
NTND
279 if_local_config=
280 used_if_wanted='overrides PAGER'
281 test_core_pager "$@"
282}
60b6e220 283
73e25e7c
NTND
284test_local_config_ignored() {
285 if_local_config='! '
286 used_if_wanted='is not used'
287 test_core_pager "$@"
288}
fdf1bc48 289
73e25e7c 290test_core_pager() {
8f81449e
JN
291 parse_args "$@"
292
73e25e7c 293 $test_expectation TTY "$cmd - repository-local core.pager setting $used_if_wanted" "
00648ba0 294 sane_unset GIT_PAGER &&
8f81449e
JN
295 rm -f core.pager_used ||
296 cleanup_fail &&
297
298 PAGER=wc &&
299 export PAGER &&
8d68a6d5 300 test_config core.pager 'wc >core.pager_used' &&
8f81449e 301 $full_command &&
73e25e7c 302 ${if_local_config}test -e core.pager_used
8f81449e
JN
303 "
304}
305
bce2c9ae 306test_core_pager_subdir() {
73e25e7c
NTND
307 if_local_config=
308 used_if_wanted='overrides PAGER'
309 test_pager_subdir_helper "$@"
310}
311
312test_no_local_config_subdir() {
313 if_local_config='! '
314 used_if_wanted='is not used'
315 test_pager_subdir_helper "$@"
316}
317
318test_pager_subdir_helper() {
bce2c9ae
JN
319 parse_args "$@"
320
73e25e7c 321 $test_expectation TTY "$cmd - core.pager $used_if_wanted from subdirectory" "
00648ba0 322 sane_unset GIT_PAGER &&
bce2c9ae
JN
323 rm -f core.pager_used &&
324 rm -fr sub ||
325 cleanup_fail &&
326
327 PAGER=wc &&
328 stampname=\$(pwd)/core.pager_used &&
329 export PAGER stampname &&
8d68a6d5 330 test_config core.pager 'wc >\"\$stampname\"' &&
bce2c9ae
JN
331 mkdir sub &&
332 (
333 cd sub &&
334 $full_command
335 ) &&
73e25e7c 336 ${if_local_config}test -e core.pager_used
bce2c9ae
JN
337 "
338}
339
8f81449e
JN
340test_GIT_PAGER_overrides() {
341 parse_args "$@"
342
343 $test_expectation TTY "$cmd - GIT_PAGER overrides core.pager" "
344 rm -f GIT_PAGER_used ||
345 cleanup_fail &&
346
8d68a6d5 347 test_config core.pager wc &&
8f81449e
JN
348 GIT_PAGER='wc >GIT_PAGER_used' &&
349 export GIT_PAGER &&
350 $full_command &&
351 test -e GIT_PAGER_used
352 "
353}
fdf1bc48 354
73e25e7c
NTND
355test_doesnt_paginate() {
356 parse_args "$@"
357
358 $test_expectation TTY "no pager for '$cmd'" "
359 rm -f GIT_PAGER_used ||
360 cleanup_fail &&
361
362 GIT_PAGER='wc >GIT_PAGER_used' &&
363 export GIT_PAGER &&
364 $full_command &&
365 ! test -e GIT_PAGER_used
366 "
367}
368
030149a4
JN
369test_pager_choices() {
370 test_default_pager expect_success "$@"
371 test_PAGER_overrides expect_success "$@"
372 test_core_pager_overrides expect_success "$@"
373 test_core_pager_subdir expect_success "$@"
374 test_GIT_PAGER_overrides expect_success "$@"
375}
376
377test_expect_success 'setup: some aliases' '
378 git config alias.aliasedlog log &&
379 git config alias.true "!true"
60b6e220
JN
380'
381
030149a4
JN
382test_pager_choices 'git log'
383test_pager_choices 'git -p log'
384test_pager_choices 'git aliasedlog'
385
386test_default_pager expect_success 'git -p aliasedlog'
387test_PAGER_overrides expect_success 'git -p aliasedlog'
388test_core_pager_overrides expect_success 'git -p aliasedlog'
389test_core_pager_subdir expect_failure 'git -p aliasedlog'
390test_GIT_PAGER_overrides expect_success 'git -p aliasedlog'
391
392test_default_pager expect_success 'git -p true'
393test_PAGER_overrides expect_success 'git -p true'
394test_core_pager_overrides expect_success 'git -p true'
395test_core_pager_subdir expect_failure 'git -p true'
396test_GIT_PAGER_overrides expect_success 'git -p true'
397
398test_default_pager expect_success test_must_fail 'git -p request-pull'
399test_PAGER_overrides expect_success test_must_fail 'git -p request-pull'
400test_core_pager_overrides expect_success test_must_fail 'git -p request-pull'
401test_core_pager_subdir expect_failure test_must_fail 'git -p request-pull'
402test_GIT_PAGER_overrides expect_success test_must_fail 'git -p request-pull'
8f81449e
JN
403
404test_default_pager expect_success test_must_fail 'git -p'
405test_PAGER_overrides expect_success test_must_fail 'git -p'
73e25e7c
NTND
406test_local_config_ignored expect_failure test_must_fail 'git -p'
407test_no_local_config_subdir expect_success test_must_fail 'git -p'
8f81449e
JN
408test_GIT_PAGER_overrides expect_success test_must_fail 'git -p'
409
030149a4 410test_doesnt_paginate expect_failure test_must_fail 'git -p nonsense'
60b6e220 411
773b69bf
NTND
412test_pager_choices 'git shortlog'
413test_expect_success 'setup: configure shortlog not to paginate' '
414 git config pager.shortlog false
415'
416test_doesnt_paginate expect_success 'git shortlog'
417test_no_local_config_subdir expect_success 'git shortlog'
418test_default_pager expect_success 'git -p shortlog'
419test_core_pager_subdir expect_success 'git -p shortlog'
420
d1ea8962
NTND
421test_core_pager_subdir expect_success test_must_fail \
422 'git -p apply </dev/null'
423
9bad7233 424test_expect_success TTY 'command-specific pager' '
212ad944 425 sane_unset PAGER GIT_PAGER &&
9bad7233
JK
426 echo "foo:initial" >expect &&
427 >actual &&
8d68a6d5
JK
428 test_unconfig core.pager &&
429 test_config pager.log "sed s/^/foo:/ >actual" &&
9bad7233
JK
430 test_terminal git log --format=%s -1 &&
431 test_cmp expect actual
432'
433
434test_expect_success TTY 'command-specific pager overrides core.pager' '
212ad944 435 sane_unset PAGER GIT_PAGER &&
9bad7233
JK
436 echo "foo:initial" >expect &&
437 >actual &&
8d68a6d5
JK
438 test_config core.pager "exit 1"
439 test_config pager.log "sed s/^/foo:/ >actual" &&
9bad7233
JK
440 test_terminal git log --format=%s -1 &&
441 test_cmp expect actual
442'
443
444test_expect_success TTY 'command-specific pager overridden by environment' '
445 GIT_PAGER="sed s/^/foo:/ >actual" && export GIT_PAGER &&
446 >actual &&
447 echo "foo:initial" >expect &&
8d68a6d5 448 test_config pager.log "exit 1" &&
9bad7233
JK
449 test_terminal git log --format=%s -1 &&
450 test_cmp expect actual
451'
452
92058e4d
JK
453test_expect_success 'setup external command' '
454 cat >git-external <<-\EOF &&
455 #!/bin/sh
456 git "$@"
457 EOF
458 chmod +x git-external
459'
460
461test_expect_success TTY 'command-specific pager works for external commands' '
462 sane_unset PAGER GIT_PAGER &&
463 echo "foo:initial" >expect &&
464 >actual &&
465 test_config pager.external "sed s/^/foo:/ >actual" &&
466 test_terminal git --exec-path="`pwd`" external log --format=%s -1 &&
467 test_cmp expect actual
468'
469
470test_expect_success TTY 'sub-commands of externals use their own pager' '
471 sane_unset PAGER GIT_PAGER &&
472 echo "foo:initial" >expect &&
473 >actual &&
474 test_config pager.log "sed s/^/foo:/ >actual" &&
475 test_terminal git --exec-path=. external log --format=%s -1 &&
476 test_cmp expect actual
477'
478
479test_expect_success TTY 'external command pagers override sub-commands' '
480 sane_unset PAGER GIT_PAGER &&
481 >expect &&
482 >actual &&
483 test_config pager.external false &&
484 test_config pager.log "sed s/^/log:/ >actual" &&
485 test_terminal git --exec-path=. external log --format=%s -1 &&
486 test_cmp expect actual
487'
488
60b6e220 489test_done