1 #!/bin/sh
3 test_description='Test automatic use of a pager.'
5 . ./test-lib.sh
7 cleanup_fail() {
8 echo >&2 cleanup failed
9 (exit 1)
10 }
12 test_expect_success 'set up terminal for tests' '
13 rm -f stdout_is_tty ||
14 cleanup_fail &&
16 if test -t 1
17 then
18 >stdout_is_tty
19 elif
20 test_have_prereq PERL &&
21 "$PERL_PATH" "$TEST_DIRECTORY"/t7006/test-terminal.perl \
22 sh -c "test -t 1"
23 then
24 >test_terminal_works
25 fi
26 '
28 if test -e stdout_is_tty
29 then
30 test_terminal() { "$@"; }
31 test_set_prereq TTY
32 elif test -e test_terminal_works
33 then
34 test_terminal() {
35 "$PERL_PATH" "$TEST_DIRECTORY"/t7006/test-terminal.perl "$@"
36 }
37 test_set_prereq TTY
38 else
39 say no usable terminal, so skipping some tests
40 fi
42 test_expect_success 'setup' '
43 unset GIT_PAGER GIT_PAGER_IN_USE;
44 test_might_fail git config --unset core.pager &&
46 PAGER="cat >paginated.out" &&
47 export PAGER &&
49 test_commit initial
50 '
52 test_expect_success TTY 'some commands use a pager' '
53 rm -f paginated.out ||
54 cleanup_fail &&
56 test_terminal git log &&
57 test -e paginated.out
58 '
60 test_expect_success TTY 'some commands do not use a pager' '
61 rm -f paginated.out ||
62 cleanup_fail &&
64 test_terminal git rev-list HEAD &&
65 ! test -e paginated.out
66 '
68 test_expect_success 'no pager when stdout is a pipe' '
69 rm -f paginated.out ||
70 cleanup_fail &&
72 git log | cat &&
73 ! test -e paginated.out
74 '
76 test_expect_success 'no pager when stdout is a regular file' '
77 rm -f paginated.out ||
78 cleanup_fail &&
80 git log >file &&
81 ! test -e paginated.out
82 '
84 test_expect_success TTY 'git --paginate rev-list uses a pager' '
85 rm -f paginated.out ||
86 cleanup_fail &&
88 test_terminal git --paginate rev-list HEAD &&
89 test -e paginated.out
90 '
92 test_expect_success 'no pager even with --paginate when stdout is a pipe' '
93 rm -f file paginated.out ||
94 cleanup_fail &&
96 git --paginate log | cat &&
97 ! test -e paginated.out
98 '
100 test_expect_success TTY 'no pager with --no-pager' '
101 rm -f paginated.out ||
102 cleanup_fail &&
104 test_terminal git --no-pager log &&
105 ! test -e paginated.out
106 '
108 # A colored commit log will begin with an appropriate ANSI escape
109 # for the first color; the text "commit" comes later.
110 colorful() {
111 read firstline <$1
112 ! expr "$firstline" : "[a-zA-Z]" >/dev/null
113 }
115 test_expect_success 'tests can detect color' '
116 rm -f colorful.log colorless.log ||
117 cleanup_fail &&
119 git log --no-color >colorless.log &&
120 git log --color >colorful.log &&
121 ! colorful colorless.log &&
122 colorful colorful.log
123 '
125 test_expect_success 'no color when stdout is a regular file' '
126 rm -f colorless.log &&
127 git config color.ui auto ||
128 cleanup_fail &&
130 git log >colorless.log &&
131 ! colorful colorless.log
132 '
134 test_expect_success TTY 'color when writing to a pager' '
135 rm -f paginated.out &&
136 git config color.ui auto ||
137 cleanup_fail &&
139 (
140 TERM=vt100 &&
141 export TERM &&
142 test_terminal git log
143 ) &&
144 colorful paginated.out
145 '
147 test_expect_success 'color when writing to a file intended for a pager' '
148 rm -f colorful.log &&
149 git config color.ui auto ||
150 cleanup_fail &&
152 (
153 TERM=vt100 &&
154 GIT_PAGER_IN_USE=true &&
155 export TERM GIT_PAGER_IN_USE &&
156 git log >colorful.log
157 ) &&
158 colorful colorful.log
159 '
161 test_expect_success 'determine default pager' '
162 unset PAGER GIT_PAGER;
163 test_might_fail git config --unset core.pager ||
164 cleanup_fail &&
166 less=$(git var GIT_PAGER) &&
167 test -n "$less"
168 '
170 if expr "$less" : '[a-z][a-z]*$' >/dev/null && test_have_prereq TTY
171 then
172 test_set_prereq SIMPLEPAGER
173 fi
175 # Use this helper to make it easy for the caller of your
176 # terminal-using function to specify whether it should fail.
177 # If you write
178 #
179 # your_test() {
180 # parse_args "$@"
181 #
182 # $test_expectation "$cmd - behaves well" "
183 # ...
184 # $full_command &&
185 # ...
186 # "
187 # }
188 #
189 # then your test can be used like this:
190 #
191 # your_test expect_(success|failure) [test_must_fail] 'git foo'
192 #
193 parse_args() {
194 test_expectation="test_$1"
195 shift
196 if test "$1" = test_must_fail
197 then
198 full_command="test_must_fail test_terminal "
199 shift
200 else
201 full_command="test_terminal "
202 fi
203 cmd=$1
204 full_command="$full_command $1"
205 }
207 test_default_pager() {
208 parse_args "$@"
210 $test_expectation SIMPLEPAGER "$cmd - default pager is used by default" "
211 unset PAGER GIT_PAGER;
212 test_might_fail git config --unset core.pager &&
213 rm -f default_pager_used ||
214 cleanup_fail &&
216 cat >\$less <<-\EOF &&
217 #!/bin/sh
218 wc >default_pager_used
219 EOF
220 chmod +x \$less &&
221 (
222 PATH=.:\$PATH &&
223 export PATH &&
224 $full_command
225 ) &&
226 test -e default_pager_used
227 "
228 }
230 test_PAGER_overrides() {
231 parse_args "$@"
233 $test_expectation TTY "$cmd - PAGER overrides default pager" "
234 unset GIT_PAGER;
235 test_might_fail git config --unset core.pager &&
236 rm -f PAGER_used ||
237 cleanup_fail &&
239 PAGER='wc >PAGER_used' &&
240 export PAGER &&
241 $full_command &&
242 test -e PAGER_used
243 "
244 }
246 test_core_pager_overrides() {
247 parse_args "$@"
249 $test_expectation TTY "$cmd - core.pager overrides PAGER" "
250 unset GIT_PAGER;
251 rm -f core.pager_used ||
252 cleanup_fail &&
254 PAGER=wc &&
255 export PAGER &&
256 git config core.pager 'wc >core.pager_used' &&
257 $full_command &&
258 test -e core.pager_used
259 "
260 }
262 test_core_pager_subdir() {
263 parse_args "$@"
265 $test_expectation TTY "$cmd - core.pager from subdirectory" "
266 unset GIT_PAGER;
267 rm -f core.pager_used &&
268 rm -fr sub ||
269 cleanup_fail &&
271 PAGER=wc &&
272 stampname=\$(pwd)/core.pager_used &&
273 export PAGER stampname &&
274 git config core.pager 'wc >\"\$stampname\"' &&
275 mkdir sub &&
276 (
277 cd sub &&
278 $full_command
279 ) &&
280 test -e core.pager_used
281 "
282 }
284 test_GIT_PAGER_overrides() {
285 parse_args "$@"
287 $test_expectation TTY "$cmd - GIT_PAGER overrides core.pager" "
288 rm -f GIT_PAGER_used ||
289 cleanup_fail &&
291 git config core.pager wc &&
292 GIT_PAGER='wc >GIT_PAGER_used' &&
293 export GIT_PAGER &&
294 $full_command &&
295 test -e GIT_PAGER_used
296 "
297 }
299 test_default_pager expect_success 'git log'
300 test_PAGER_overrides expect_success 'git log'
301 test_core_pager_overrides expect_success 'git log'
302 test_core_pager_subdir expect_success 'git log'
303 test_GIT_PAGER_overrides expect_success 'git log'
305 test_default_pager expect_success 'git -p log'
306 test_PAGER_overrides expect_success 'git -p log'
307 test_core_pager_overrides expect_success 'git -p log'
308 test_core_pager_subdir expect_failure 'git -p log'
309 test_GIT_PAGER_overrides expect_success 'git -p log'
311 test_default_pager expect_success test_must_fail 'git -p'
312 test_PAGER_overrides expect_success test_must_fail 'git -p'
313 test_core_pager_overrides expect_success test_must_fail 'git -p'
314 test_core_pager_subdir expect_failure test_must_fail 'git -p'
315 test_GIT_PAGER_overrides expect_success test_must_fail 'git -p'
317 test_default_pager expect_success test_must_fail 'git -p nonsense'
318 test_PAGER_overrides expect_success test_must_fail 'git -p nonsense'
319 test_core_pager_overrides expect_success test_must_fail 'git -p nonsense'
320 test_core_pager_subdir expect_failure test_must_fail 'git -p nonsense'
321 test_GIT_PAGER_overrides expect_success test_must_fail 'git -p nonsense'
323 test_done