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