Merge branch 'bw/submodule-config-cleanup'
[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 enables colors for color.diff" '
212                 git -c color.diff=always log --format=$color -1 >actual &&
213                 has_color actual
214         '
215
216         test_expect_success "$desc enables colors for color.ui" '
217                 git -c color.ui=always log --format=$color -1 >actual &&
218                 has_color actual
219         '
220
221         test_expect_success "$desc respects --color" '
222                 git log --format=$color -1 --color >actual &&
223                 has_color actual
224         '
225
226         test_expect_success "$desc respects --no-color" '
227                 git -c color.ui=always log --format=$color -1 --no-color >actual &&
228                 has_no_color actual
229         '
230
231         test_expect_success TTY "$desc respects --color=auto (stdout is tty)" '
232                 test_terminal env TERM=vt100 \
233                         git log --format=$color -1 --color=auto >actual &&
234                 has_color actual
235         '
236
237         test_expect_success "$desc respects --color=auto (stdout not tty)" '
238                 (
239                         TERM=vt100 && export TERM &&
240                         git log --format=$color -1 --color=auto >actual &&
241                         has_no_color actual
242                 )
243         '
244 done
245
246 test_expect_success '%C(always,...) enables color even without tty' '
247         git log --format=$ALWAYS_COLOR -1 >actual &&
248         has_color actual
249 '
250
251 test_expect_success '%C(auto) respects --color' '
252         git log --color --format="%C(auto)%H" -1 >actual.raw &&
253         test_decode_color <actual.raw >actual &&
254         echo "<YELLOW>$(git rev-parse HEAD)<RESET>" >expect &&
255         test_cmp expect actual
256 '
257
258 test_expect_success '%C(auto) respects --no-color' '
259         git log --no-color --format="%C(auto)%H" -1 >actual &&
260         git rev-parse HEAD >expect &&
261         test_cmp expect actual
262 '
263
264 test_expect_success 'rev-list %C(auto,...) respects --color' '
265         git rev-list --color --format="%C(auto,green)foo%C(auto,reset)" \
266                 -1 HEAD >actual.raw &&
267         test_decode_color <actual.raw >actual &&
268         cat >expect <<-EOF &&
269         commit $(git rev-parse HEAD)
270         <GREEN>foo<RESET>
271         EOF
272         test_cmp expect actual
273 '
274
275 iconv -f utf-8 -t $test_encoding > commit-msg <<EOF
276 Test printing of complex bodies
277
278 This commit message is much longer than the others,
279 and it will be encoded in $test_encoding. We should therefore
280 include an ISO8859 character: ¡bueno!
281 EOF
282
283 test_expect_success 'setup complex body' '
284         git config i18n.commitencoding $test_encoding &&
285         echo change2 >foo && git commit -a -F commit-msg &&
286         head3=$(git rev-parse --verify HEAD) &&
287         head3_short=$(git rev-parse --short $head3)
288 '
289
290 test_format complex-encoding %e <<EOF
291 commit $head3
292 $test_encoding
293 commit $head2
294 $test_encoding
295 commit $head1
296 $test_encoding
297 EOF
298
299 test_format complex-subject %s <<EOF
300 commit $head3
301 Test printing of complex bodies
302 commit $head2
303 $changed_iso88591
304 commit $head1
305 $added_iso88591
306 EOF
307
308 test_format complex-subject-trunc "%<($truncate_count,trunc)%s" <<EOF
309 commit $head3
310 Test printing of c..
311 commit $head2
312 changed (ge${changed_utf8_part_iso88591}ndert)..
313 commit $head1
314 added (hinzugef${added_utf8_part_iso88591}gt..
315 EOF
316
317 test_format complex-subject-mtrunc "%<($truncate_count,mtrunc)%s" <<EOF
318 commit $head3
319 Test prin..ex bodies
320 commit $head2
321 changed (..dert) foo
322 commit $head1
323 added (hi..f${added_utf8_part_iso88591}gt) foo
324 EOF
325
326 test_format complex-subject-ltrunc "%<($truncate_count,ltrunc)%s" <<EOF
327 commit $head3
328 .. of complex bodies
329 commit $head2
330 ..ged (ge${changed_utf8_part_iso88591}ndert) foo
331 commit $head1
332 .. (hinzugef${added_utf8_part_iso88591}gt) foo
333 EOF
334
335 test_expect_success 'prepare expected messages (for test %b)' '
336         cat <<-EOF >expected.utf-8 &&
337         commit $head3
338         This commit message is much longer than the others,
339         and it will be encoded in $test_encoding. We should therefore
340         include an ISO8859 character: ¡bueno!
341
342         commit $head2
343         commit $head1
344         EOF
345         iconv -f utf-8 -t $test_encoding expected.utf-8 >expected.ISO8859-1
346 '
347
348 test_format complex-body %b <expected.ISO8859-1
349
350 # Git uses i18n.commitEncoding if no i18n.logOutputEncoding set
351 # so unset i18n.commitEncoding to test encoding conversion
352 git config --unset i18n.commitEncoding
353
354 test_format complex-subject-commitencoding-unset %s <<EOF
355 commit $head3
356 Test printing of complex bodies
357 commit $head2
358 $changed
359 commit $head1
360 $added
361 EOF
362
363 test_format complex-subject-commitencoding-unset-trunc "%<($truncate_count,trunc)%s" <<EOF
364 commit $head3
365 Test printing of c..
366 commit $head2
367 changed (ge${changed_utf8_part}ndert)..
368 commit $head1
369 added (hinzugef${added_utf8_part}gt..
370 EOF
371
372 test_format complex-subject-commitencoding-unset-mtrunc "%<($truncate_count,mtrunc)%s" <<EOF
373 commit $head3
374 Test prin..ex bodies
375 commit $head2
376 changed (..dert) foo
377 commit $head1
378 added (hi..f${added_utf8_part}gt) foo
379 EOF
380
381 test_format complex-subject-commitencoding-unset-ltrunc "%<($truncate_count,ltrunc)%s" <<EOF
382 commit $head3
383 .. of complex bodies
384 commit $head2
385 ..ged (ge${changed_utf8_part}ndert) foo
386 commit $head1
387 .. (hinzugef${added_utf8_part}gt) foo
388 EOF
389
390 test_format complex-body-commitencoding-unset %b <expected.utf-8
391
392 test_expect_success '%x00 shows NUL' '
393         echo  >expect commit $head3 &&
394         echo >>expect fooQbar &&
395         git rev-list -1 --format=foo%x00bar HEAD >actual.nul &&
396         nul_to_q <actual.nul >actual &&
397         test_cmp expect actual
398 '
399
400 test_expect_success '%ad respects --date=' '
401         echo 2005-04-07 >expect.ad-short &&
402         git log -1 --date=short --pretty=tformat:%ad >output.ad-short master &&
403         test_cmp expect.ad-short output.ad-short
404 '
405
406 test_expect_success 'empty email' '
407         test_tick &&
408         C=$(GIT_AUTHOR_EMAIL= git commit-tree HEAD^{tree} </dev/null) &&
409         A=$(git show --pretty=format:%an,%ae,%ad%n -s $C) &&
410         verbose test "$A" = "A U Thor,,Thu Apr 7 15:14:13 2005 -0700"
411 '
412
413 test_expect_success 'del LF before empty (1)' '
414         git show -s --pretty=format:"%s%n%-b%nThanks%n" HEAD^^ >actual &&
415         test_line_count = 2 actual
416 '
417
418 test_expect_success 'del LF before empty (2)' '
419         git show -s --pretty=format:"%s%n%-b%nThanks%n" HEAD >actual &&
420         test_line_count = 6 actual &&
421         grep "^$" actual
422 '
423
424 test_expect_success 'add LF before non-empty (1)' '
425         git show -s --pretty=format:"%s%+b%nThanks%n" HEAD^^ >actual &&
426         test_line_count = 2 actual
427 '
428
429 test_expect_success 'add LF before non-empty (2)' '
430         git show -s --pretty=format:"%s%+b%nThanks%n" HEAD >actual &&
431         test_line_count = 6 actual &&
432         grep "^$" actual
433 '
434
435 test_expect_success 'add SP before non-empty (1)' '
436         git show -s --pretty=format:"%s% bThanks" HEAD^^ >actual &&
437         test $(wc -w <actual) = 3
438 '
439
440 test_expect_success 'add SP before non-empty (2)' '
441         git show -s --pretty=format:"%s% sThanks" HEAD^^ >actual &&
442         test $(wc -w <actual) = 6
443 '
444
445 test_expect_success '--abbrev' '
446         echo SHORT SHORT SHORT >expect2 &&
447         echo LONG LONG LONG >expect3 &&
448         git log -1 --format="%h %h %h" HEAD >actual1 &&
449         git log -1 --abbrev=5 --format="%h %h %h" HEAD >actual2 &&
450         git log -1 --abbrev=5 --format="%H %H %H" HEAD >actual3 &&
451         sed -e "s/$_x40/LONG/g" -e "s/$_x05/SHORT/g" <actual2 >fuzzy2 &&
452         sed -e "s/$_x40/LONG/g" -e "s/$_x05/SHORT/g" <actual3 >fuzzy3 &&
453         test_cmp expect2 fuzzy2 &&
454         test_cmp expect3 fuzzy3 &&
455         ! test_cmp actual1 actual2
456 '
457
458 test_expect_success '%H is not affected by --abbrev-commit' '
459         git log -1 --format=%H --abbrev-commit --abbrev=20 HEAD >actual &&
460         len=$(wc -c <actual) &&
461         test $len = 41
462 '
463
464 test_expect_success '%h is not affected by --abbrev-commit' '
465         git log -1 --format=%h --abbrev-commit --abbrev=20 HEAD >actual &&
466         len=$(wc -c <actual) &&
467         test $len = 21
468 '
469
470 test_expect_success '"%h %gD: %gs" is same as git-reflog' '
471         git reflog >expect &&
472         git log -g --format="%h %gD: %gs" >actual &&
473         test_cmp expect actual
474 '
475
476 test_expect_success '"%h %gD: %gs" is same as git-reflog (with date)' '
477         git reflog --date=raw >expect &&
478         git log -g --format="%h %gD: %gs" --date=raw >actual &&
479         test_cmp expect actual
480 '
481
482 test_expect_success '"%h %gD: %gs" is same as git-reflog (with --abbrev)' '
483         git reflog --abbrev=13 --date=raw >expect &&
484         git log -g --abbrev=13 --format="%h %gD: %gs" --date=raw >actual &&
485         test_cmp expect actual
486 '
487
488 test_expect_success '%gd shortens ref name' '
489         echo "master@{0}" >expect.gd-short &&
490         git log -g -1 --format=%gd refs/heads/master >actual.gd-short &&
491         test_cmp expect.gd-short actual.gd-short
492 '
493
494 test_expect_success 'reflog identity' '
495         echo "C O Mitter:committer@example.com" >expect &&
496         git log -g -1 --format="%gn:%ge" >actual &&
497         test_cmp expect actual
498 '
499
500 test_expect_success 'oneline with empty message' '
501         git commit -m "dummy" --allow-empty &&
502         git commit -m "dummy" --allow-empty &&
503         git filter-branch --msg-filter "sed -e s/dummy//" HEAD^^.. &&
504         git rev-list --oneline HEAD >test.txt &&
505         test_line_count = 5 test.txt &&
506         git rev-list --oneline --graph HEAD >testg.txt &&
507         test_line_count = 5 testg.txt
508 '
509
510 test_expect_success 'single-character name is parsed correctly' '
511         git commit --author="a <a@example.com>" --allow-empty -m foo &&
512         echo "a <a@example.com>" >expect &&
513         git log -1 --format="%an <%ae>" >actual &&
514         test_cmp expect actual
515 '
516
517 test_expect_success 'unused %G placeholders are passed through' '
518         echo "%GX %G" >expect &&
519         git log -1 --format="%GX %G" >actual &&
520         test_cmp expect actual
521 '
522
523 test_done