Merge branch 'jk/ui-color-always-to-auto-maint' (early part) into jk/ref-filter-color...
[git] / t / t6006-rev-list-format.sh
1 #!/bin/sh
2
3 # Copyright (c) 2009 Jens Lehmann
4 # Copyright (c) 2011 Alexey Shumkin (+ non-UTF-8 commit encoding tests)
5
6 test_description='git rev-list --pretty=format test'
7
8 . ./test-lib.sh
9 . "$TEST_DIRECTORY"/lib-terminal.sh
10
11 test_tick
12 # Tested non-UTF-8 encoding
13 test_encoding="ISO8859-1"
14
15 # String "added" in German
16 # (translated with Google Translate),
17 # encoded in UTF-8, used as a commit log message below.
18 added_utf8_part=$(printf "\303\274")
19 added_utf8_part_iso88591=$(echo "$added_utf8_part" | iconv -f utf-8 -t $test_encoding)
20 added=$(printf "added (hinzugef${added_utf8_part}gt) foo")
21 added_iso88591=$(echo "$added" | iconv -f utf-8 -t $test_encoding)
22 # same but "changed"
23 changed_utf8_part=$(printf "\303\244")
24 changed_utf8_part_iso88591=$(echo "$changed_utf8_part" | iconv -f utf-8 -t $test_encoding)
25 changed=$(printf "changed (ge${changed_utf8_part}ndert) foo")
26 changed_iso88591=$(echo "$changed" | iconv -f utf-8 -t $test_encoding)
27
28 # Count of char to truncate
29 # Number is chosen so, that non-ACSII characters
30 # (see $added_utf8_part and $changed_utf8_part)
31 # fall into truncated parts of appropriate words both from left and right
32 truncate_count=20
33
34 test_expect_success 'setup' '
35         : >foo &&
36         git add foo &&
37         git config i18n.commitEncoding $test_encoding &&
38         echo "$added_iso88591" | git commit -F - &&
39         head1=$(git rev-parse --verify HEAD) &&
40         head1_short=$(git rev-parse --verify --short $head1) &&
41         tree1=$(git rev-parse --verify HEAD:) &&
42         tree1_short=$(git rev-parse --verify --short $tree1) &&
43         echo "$changed" > foo &&
44         echo "$changed_iso88591" | git commit -a -F - &&
45         head2=$(git rev-parse --verify HEAD) &&
46         head2_short=$(git rev-parse --verify --short $head2) &&
47         tree2=$(git rev-parse --verify HEAD:) &&
48         tree2_short=$(git rev-parse --verify --short $tree2) &&
49         git config --unset i18n.commitEncoding
50 '
51
52 # usage: test_format name format_string [failure] <expected_output
53 test_format () {
54         cat >expect.$1
55         test_expect_${3:-success} "format $1" "
56                 git rev-list --pretty=format:'$2' master >output.$1 &&
57                 test_cmp expect.$1 output.$1
58         "
59 }
60
61 # Feed to --format to provide predictable colored sequences.
62 BASIC_COLOR='%Credfoo%Creset'
63 COLOR='%C(red)foo%C(reset)'
64 AUTO_COLOR='%C(auto,red)foo%C(auto,reset)'
65 ALWAYS_COLOR='%C(always,red)foo%C(always,reset)'
66 has_color () {
67         test_decode_color <"$1" >decoded &&
68         echo "<RED>foo<RESET>" >expect &&
69         test_cmp expect decoded
70 }
71
72 has_no_color () {
73         echo foo >expect &&
74         test_cmp expect "$1"
75 }
76
77 test_format percent %%h <<EOF
78 commit $head2
79 %h
80 commit $head1
81 %h
82 EOF
83
84 test_format hash %H%n%h <<EOF
85 commit $head2
86 $head2
87 $head2_short
88 commit $head1
89 $head1
90 $head1_short
91 EOF
92
93 test_format tree %T%n%t <<EOF
94 commit $head2
95 $tree2
96 $tree2_short
97 commit $head1
98 $tree1
99 $tree1_short
100 EOF
101
102 test_format parents %P%n%p <<EOF
103 commit $head2
104 $head1
105 $head1_short
106 commit $head1
107
108
109 EOF
110
111 # we don't test relative here
112 test_format author %an%n%ae%n%ad%n%aD%n%at <<EOF
113 commit $head2
114 A U Thor
115 author@example.com
116 Thu Apr 7 15:13:13 2005 -0700
117 Thu, 7 Apr 2005 15:13:13 -0700
118 1112911993
119 commit $head1
120 A U Thor
121 author@example.com
122 Thu Apr 7 15:13:13 2005 -0700
123 Thu, 7 Apr 2005 15:13:13 -0700
124 1112911993
125 EOF
126
127 test_format committer %cn%n%ce%n%cd%n%cD%n%ct <<EOF
128 commit $head2
129 C O Mitter
130 committer@example.com
131 Thu Apr 7 15:13:13 2005 -0700
132 Thu, 7 Apr 2005 15:13:13 -0700
133 1112911993
134 commit $head1
135 C O Mitter
136 committer@example.com
137 Thu Apr 7 15:13:13 2005 -0700
138 Thu, 7 Apr 2005 15:13:13 -0700
139 1112911993
140 EOF
141
142 test_format encoding %e <<EOF
143 commit $head2
144 $test_encoding
145 commit $head1
146 $test_encoding
147 EOF
148
149 test_format subject %s <<EOF
150 commit $head2
151 $changed
152 commit $head1
153 $added
154 EOF
155
156 test_format subject-truncated "%<($truncate_count,trunc)%s" <<EOF
157 commit $head2
158 changed (ge${changed_utf8_part}ndert)..
159 commit $head1
160 added (hinzugef${added_utf8_part}gt..
161 EOF
162
163 test_format body %b <<EOF
164 commit $head2
165 commit $head1
166 EOF
167
168 test_format raw-body %B <<EOF
169 commit $head2
170 $changed
171
172 commit $head1
173 $added
174
175 EOF
176
177 test_expect_success 'basic colors' '
178         cat >expect <<-EOF &&
179         commit $head2
180         <RED>foo<GREEN>bar<BLUE>baz<RESET>xyzzy
181         EOF
182         format="%Credfoo%Cgreenbar%Cbluebaz%Cresetxyzzy" &&
183         git rev-list --color --format="$format" -1 master >actual.raw &&
184         test_decode_color <actual.raw >actual &&
185         test_cmp expect actual
186 '
187
188 test_expect_success 'advanced colors' '
189         cat >expect <<-EOF &&
190         commit $head2
191         <BOLD;RED;BYELLOW>foo<RESET>
192         EOF
193         format="%C(red yellow bold)foo%C(reset)" &&
194         git rev-list --color --format="$format" -1 master >actual.raw &&
195         test_decode_color <actual.raw >actual &&
196         test_cmp expect actual
197 '
198
199 for spec in \
200         "%Cred:$BASIC_COLOR" \
201         "%C(...):$COLOR" \
202         "%C(auto,...):$AUTO_COLOR"
203 do
204         desc=${spec%%:*}
205         color=${spec#*:}
206         test_expect_success "$desc does not enable color by default" '
207                 git log --format=$color -1 >actual &&
208                 has_no_color actual
209         '
210
211         test_expect_success "$desc respects --color" '
212                 git log --format=$color -1 --color >actual &&
213                 has_color actual
214         '
215
216         test_expect_success TTY "$desc respects --color=auto (stdout is tty)" '
217                 test_terminal git log --format=$color -1 --color=auto >actual &&
218                 has_color actual
219         '
220
221         test_expect_success "$desc respects --color=auto (stdout not tty)" '
222                 (
223                         TERM=vt100 && export TERM &&
224                         git log --format=$color -1 --color=auto >actual &&
225                         has_no_color actual
226                 )
227         '
228
229         test_expect_success TTY "$desc respects --no-color" '
230                 test_terminal git log --format=$color -1 --no-color >actual &&
231                 has_no_color actual
232         '
233 done
234
235 test_expect_success '%C(always,...) enables color even without tty' '
236         git log --format=$ALWAYS_COLOR -1 >actual &&
237         has_color actual
238 '
239
240 test_expect_success '%C(auto) respects --color' '
241         git log --color --format="%C(auto)%H" -1 >actual.raw &&
242         test_decode_color <actual.raw >actual &&
243         echo "<YELLOW>$(git rev-parse HEAD)<RESET>" >expect &&
244         test_cmp expect actual
245 '
246
247 test_expect_success '%C(auto) respects --no-color' '
248         git log --no-color --format="%C(auto)%H" -1 >actual &&
249         git rev-parse HEAD >expect &&
250         test_cmp expect actual
251 '
252
253 test_expect_success 'rev-list %C(auto,...) respects --color' '
254         git rev-list --color --format="%C(auto,green)foo%C(auto,reset)" \
255                 -1 HEAD >actual.raw &&
256         test_decode_color <actual.raw >actual &&
257         cat >expect <<-EOF &&
258         commit $(git rev-parse HEAD)
259         <GREEN>foo<RESET>
260         EOF
261         test_cmp expect actual
262 '
263
264 iconv -f utf-8 -t $test_encoding > commit-msg <<EOF
265 Test printing of complex bodies
266
267 This commit message is much longer than the others,
268 and it will be encoded in $test_encoding. We should therefore
269 include an ISO8859 character: ¡bueno!
270 EOF
271
272 test_expect_success 'setup complex body' '
273         git config i18n.commitencoding $test_encoding &&
274         echo change2 >foo && git commit -a -F commit-msg &&
275         head3=$(git rev-parse --verify HEAD) &&
276         head3_short=$(git rev-parse --short $head3)
277 '
278
279 test_format complex-encoding %e <<EOF
280 commit $head3
281 $test_encoding
282 commit $head2
283 $test_encoding
284 commit $head1
285 $test_encoding
286 EOF
287
288 test_format complex-subject %s <<EOF
289 commit $head3
290 Test printing of complex bodies
291 commit $head2
292 $changed_iso88591
293 commit $head1
294 $added_iso88591
295 EOF
296
297 test_format complex-subject-trunc "%<($truncate_count,trunc)%s" <<EOF
298 commit $head3
299 Test printing of c..
300 commit $head2
301 changed (ge${changed_utf8_part_iso88591}ndert)..
302 commit $head1
303 added (hinzugef${added_utf8_part_iso88591}gt..
304 EOF
305
306 test_format complex-subject-mtrunc "%<($truncate_count,mtrunc)%s" <<EOF
307 commit $head3
308 Test prin..ex bodies
309 commit $head2
310 changed (..dert) foo
311 commit $head1
312 added (hi..f${added_utf8_part_iso88591}gt) foo
313 EOF
314
315 test_format complex-subject-ltrunc "%<($truncate_count,ltrunc)%s" <<EOF
316 commit $head3
317 .. of complex bodies
318 commit $head2
319 ..ged (ge${changed_utf8_part_iso88591}ndert) foo
320 commit $head1
321 .. (hinzugef${added_utf8_part_iso88591}gt) foo
322 EOF
323
324 test_expect_success 'prepare expected messages (for test %b)' '
325         cat <<-EOF >expected.utf-8 &&
326         commit $head3
327         This commit message is much longer than the others,
328         and it will be encoded in $test_encoding. We should therefore
329         include an ISO8859 character: ¡bueno!
330
331         commit $head2
332         commit $head1
333         EOF
334         iconv -f utf-8 -t $test_encoding expected.utf-8 >expected.ISO8859-1
335 '
336
337 test_format complex-body %b <expected.ISO8859-1
338
339 # Git uses i18n.commitEncoding if no i18n.logOutputEncoding set
340 # so unset i18n.commitEncoding to test encoding conversion
341 git config --unset i18n.commitEncoding
342
343 test_format complex-subject-commitencoding-unset %s <<EOF
344 commit $head3
345 Test printing of complex bodies
346 commit $head2
347 $changed
348 commit $head1
349 $added
350 EOF
351
352 test_format complex-subject-commitencoding-unset-trunc "%<($truncate_count,trunc)%s" <<EOF
353 commit $head3
354 Test printing of c..
355 commit $head2
356 changed (ge${changed_utf8_part}ndert)..
357 commit $head1
358 added (hinzugef${added_utf8_part}gt..
359 EOF
360
361 test_format complex-subject-commitencoding-unset-mtrunc "%<($truncate_count,mtrunc)%s" <<EOF
362 commit $head3
363 Test prin..ex bodies
364 commit $head2
365 changed (..dert) foo
366 commit $head1
367 added (hi..f${added_utf8_part}gt) foo
368 EOF
369
370 test_format complex-subject-commitencoding-unset-ltrunc "%<($truncate_count,ltrunc)%s" <<EOF
371 commit $head3
372 .. of complex bodies
373 commit $head2
374 ..ged (ge${changed_utf8_part}ndert) foo
375 commit $head1
376 .. (hinzugef${added_utf8_part}gt) foo
377 EOF
378
379 test_format complex-body-commitencoding-unset %b <expected.utf-8
380
381 test_expect_success '%x00 shows NUL' '
382         echo  >expect commit $head3 &&
383         echo >>expect fooQbar &&
384         git rev-list -1 --format=foo%x00bar HEAD >actual.nul &&
385         nul_to_q <actual.nul >actual &&
386         test_cmp expect actual
387 '
388
389 test_expect_success '%ad respects --date=' '
390         echo 2005-04-07 >expect.ad-short &&
391         git log -1 --date=short --pretty=tformat:%ad >output.ad-short master &&
392         test_cmp expect.ad-short output.ad-short
393 '
394
395 test_expect_success 'empty email' '
396         test_tick &&
397         C=$(GIT_AUTHOR_EMAIL= git commit-tree HEAD^{tree} </dev/null) &&
398         A=$(git show --pretty=format:%an,%ae,%ad%n -s $C) &&
399         verbose test "$A" = "A U Thor,,Thu Apr 7 15:14:13 2005 -0700"
400 '
401
402 test_expect_success 'del LF before empty (1)' '
403         git show -s --pretty=format:"%s%n%-b%nThanks%n" HEAD^^ >actual &&
404         test_line_count = 2 actual
405 '
406
407 test_expect_success 'del LF before empty (2)' '
408         git show -s --pretty=format:"%s%n%-b%nThanks%n" HEAD >actual &&
409         test_line_count = 6 actual &&
410         grep "^$" actual
411 '
412
413 test_expect_success 'add LF before non-empty (1)' '
414         git show -s --pretty=format:"%s%+b%nThanks%n" HEAD^^ >actual &&
415         test_line_count = 2 actual
416 '
417
418 test_expect_success 'add LF before non-empty (2)' '
419         git show -s --pretty=format:"%s%+b%nThanks%n" HEAD >actual &&
420         test_line_count = 6 actual &&
421         grep "^$" actual
422 '
423
424 test_expect_success 'add SP before non-empty (1)' '
425         git show -s --pretty=format:"%s% bThanks" HEAD^^ >actual &&
426         test $(wc -w <actual) = 3
427 '
428
429 test_expect_success 'add SP before non-empty (2)' '
430         git show -s --pretty=format:"%s% sThanks" HEAD^^ >actual &&
431         test $(wc -w <actual) = 6
432 '
433
434 test_expect_success '--abbrev' '
435         echo SHORT SHORT SHORT >expect2 &&
436         echo LONG LONG LONG >expect3 &&
437         git log -1 --format="%h %h %h" HEAD >actual1 &&
438         git log -1 --abbrev=5 --format="%h %h %h" HEAD >actual2 &&
439         git log -1 --abbrev=5 --format="%H %H %H" HEAD >actual3 &&
440         sed -e "s/$_x40/LONG/g" -e "s/$_x05/SHORT/g" <actual2 >fuzzy2 &&
441         sed -e "s/$_x40/LONG/g" -e "s/$_x05/SHORT/g" <actual3 >fuzzy3 &&
442         test_cmp expect2 fuzzy2 &&
443         test_cmp expect3 fuzzy3 &&
444         ! test_cmp actual1 actual2
445 '
446
447 test_expect_success '%H is not affected by --abbrev-commit' '
448         git log -1 --format=%H --abbrev-commit --abbrev=20 HEAD >actual &&
449         len=$(wc -c <actual) &&
450         test $len = 41
451 '
452
453 test_expect_success '%h is not affected by --abbrev-commit' '
454         git log -1 --format=%h --abbrev-commit --abbrev=20 HEAD >actual &&
455         len=$(wc -c <actual) &&
456         test $len = 21
457 '
458
459 test_expect_success '"%h %gD: %gs" is same as git-reflog' '
460         git reflog >expect &&
461         git log -g --format="%h %gD: %gs" >actual &&
462         test_cmp expect actual
463 '
464
465 test_expect_success '"%h %gD: %gs" is same as git-reflog (with date)' '
466         git reflog --date=raw >expect &&
467         git log -g --format="%h %gD: %gs" --date=raw >actual &&
468         test_cmp expect actual
469 '
470
471 test_expect_success '"%h %gD: %gs" is same as git-reflog (with --abbrev)' '
472         git reflog --abbrev=13 --date=raw >expect &&
473         git log -g --abbrev=13 --format="%h %gD: %gs" --date=raw >actual &&
474         test_cmp expect actual
475 '
476
477 test_expect_success '%gd shortens ref name' '
478         echo "master@{0}" >expect.gd-short &&
479         git log -g -1 --format=%gd refs/heads/master >actual.gd-short &&
480         test_cmp expect.gd-short actual.gd-short
481 '
482
483 test_expect_success 'reflog identity' '
484         echo "C O Mitter:committer@example.com" >expect &&
485         git log -g -1 --format="%gn:%ge" >actual &&
486         test_cmp expect actual
487 '
488
489 test_expect_success 'oneline with empty message' '
490         git commit -m "dummy" --allow-empty &&
491         git commit -m "dummy" --allow-empty &&
492         git filter-branch --msg-filter "sed -e s/dummy//" HEAD^^.. &&
493         git rev-list --oneline HEAD >test.txt &&
494         test_line_count = 5 test.txt &&
495         git rev-list --oneline --graph HEAD >testg.txt &&
496         test_line_count = 5 testg.txt
497 '
498
499 test_expect_success 'single-character name is parsed correctly' '
500         git commit --author="a <a@example.com>" --allow-empty -m foo &&
501         echo "a <a@example.com>" >expect &&
502         git log -1 --format="%an <%ae>" >actual &&
503         test_cmp expect actual
504 '
505
506 test_expect_success 'unused %G placeholders are passed through' '
507         echo "%GX %G" >expect &&
508         git log -1 --format="%GX %G" >actual &&
509         test_cmp expect actual
510 '
511
512 test_done