README.md: don't take 'commandname' literally
[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 AUTO_COLOR='%C(auto,red)foo%C(auto,reset)'
63 has_color () {
64         printf '\033[31mfoo\033[m\n' >expect &&
65         test_cmp expect "$1"
66 }
67
68 has_no_color () {
69         echo foo >expect &&
70         test_cmp expect "$1"
71 }
72
73 test_format percent %%h <<EOF
74 commit $head2
75 %h
76 commit $head1
77 %h
78 EOF
79
80 test_format hash %H%n%h <<EOF
81 commit $head2
82 $head2
83 $head2_short
84 commit $head1
85 $head1
86 $head1_short
87 EOF
88
89 test_format tree %T%n%t <<EOF
90 commit $head2
91 $tree2
92 $tree2_short
93 commit $head1
94 $tree1
95 $tree1_short
96 EOF
97
98 test_format parents %P%n%p <<EOF
99 commit $head2
100 $head1
101 $head1_short
102 commit $head1
103
104
105 EOF
106
107 # we don't test relative here
108 test_format author %an%n%ae%n%ad%n%aD%n%at <<EOF
109 commit $head2
110 A U Thor
111 author@example.com
112 Thu Apr 7 15:13:13 2005 -0700
113 Thu, 7 Apr 2005 15:13:13 -0700
114 1112911993
115 commit $head1
116 A U Thor
117 author@example.com
118 Thu Apr 7 15:13:13 2005 -0700
119 Thu, 7 Apr 2005 15:13:13 -0700
120 1112911993
121 EOF
122
123 test_format committer %cn%n%ce%n%cd%n%cD%n%ct <<EOF
124 commit $head2
125 C O Mitter
126 committer@example.com
127 Thu Apr 7 15:13:13 2005 -0700
128 Thu, 7 Apr 2005 15:13:13 -0700
129 1112911993
130 commit $head1
131 C O Mitter
132 committer@example.com
133 Thu Apr 7 15:13:13 2005 -0700
134 Thu, 7 Apr 2005 15:13:13 -0700
135 1112911993
136 EOF
137
138 test_format encoding %e <<EOF
139 commit $head2
140 $test_encoding
141 commit $head1
142 $test_encoding
143 EOF
144
145 test_format subject %s <<EOF
146 commit $head2
147 $changed
148 commit $head1
149 $added
150 EOF
151
152 test_format subject-truncated "%<($truncate_count,trunc)%s" <<EOF
153 commit $head2
154 changed (ge${changed_utf8_part}ndert)..
155 commit $head1
156 added (hinzugef${added_utf8_part}gt..
157 EOF
158
159 test_format body %b <<EOF
160 commit $head2
161 commit $head1
162 EOF
163
164 test_format raw-body %B <<EOF
165 commit $head2
166 $changed
167
168 commit $head1
169 $added
170
171 EOF
172
173 test_format colors %Credfoo%Cgreenbar%Cbluebaz%Cresetxyzzy <<EOF
174 commit $head2
175 \e[31mfoo\e[32mbar\e[34mbaz\e[mxyzzy
176 commit $head1
177 \e[31mfoo\e[32mbar\e[34mbaz\e[mxyzzy
178 EOF
179
180 test_format advanced-colors '%C(red yellow bold)foo%C(reset)' <<EOF
181 commit $head2
182 \e[1;31;43mfoo\e[m
183 commit $head1
184 \e[1;31;43mfoo\e[m
185 EOF
186
187 test_expect_success '%C(auto) does not enable color by default' '
188         git log --format=$AUTO_COLOR -1 >actual &&
189         has_no_color actual
190 '
191
192 test_expect_success '%C(auto) enables colors for color.diff' '
193         git -c color.diff=always log --format=$AUTO_COLOR -1 >actual &&
194         has_color actual
195 '
196
197 test_expect_success '%C(auto) enables colors for color.ui' '
198         git -c color.ui=always log --format=$AUTO_COLOR -1 >actual &&
199         has_color actual
200 '
201
202 test_expect_success '%C(auto) respects --color' '
203         git log --format=$AUTO_COLOR -1 --color >actual &&
204         has_color actual
205 '
206
207 test_expect_success '%C(auto) respects --no-color' '
208         git -c color.ui=always log --format=$AUTO_COLOR -1 --no-color >actual &&
209         has_no_color actual
210 '
211
212 test_expect_success TTY '%C(auto) respects --color=auto (stdout is tty)' '
213         test_terminal env TERM=vt100 \
214                 git log --format=$AUTO_COLOR -1 --color=auto >actual &&
215         has_color actual
216 '
217
218 test_expect_success '%C(auto) respects --color=auto (stdout not tty)' '
219         (
220                 TERM=vt100 && export TERM &&
221                 git log --format=$AUTO_COLOR -1 --color=auto >actual &&
222                 has_no_color actual
223         )
224 '
225
226 iconv -f utf-8 -t $test_encoding > commit-msg <<EOF
227 Test printing of complex bodies
228
229 This commit message is much longer than the others,
230 and it will be encoded in $test_encoding. We should therefore
231 include an ISO8859 character: ¡bueno!
232 EOF
233
234 test_expect_success 'setup complex body' '
235         git config i18n.commitencoding $test_encoding &&
236         echo change2 >foo && git commit -a -F commit-msg &&
237         head3=$(git rev-parse --verify HEAD) &&
238         head3_short=$(git rev-parse --short $head3)
239 '
240
241 test_format complex-encoding %e <<EOF
242 commit $head3
243 $test_encoding
244 commit $head2
245 $test_encoding
246 commit $head1
247 $test_encoding
248 EOF
249
250 test_format complex-subject %s <<EOF
251 commit $head3
252 Test printing of complex bodies
253 commit $head2
254 $changed_iso88591
255 commit $head1
256 $added_iso88591
257 EOF
258
259 test_format complex-subject-trunc "%<($truncate_count,trunc)%s" <<EOF
260 commit $head3
261 Test printing of c..
262 commit $head2
263 changed (ge${changed_utf8_part_iso88591}ndert)..
264 commit $head1
265 added (hinzugef${added_utf8_part_iso88591}gt..
266 EOF
267
268 test_format complex-subject-mtrunc "%<($truncate_count,mtrunc)%s" <<EOF
269 commit $head3
270 Test prin..ex bodies
271 commit $head2
272 changed (..dert) foo
273 commit $head1
274 added (hi..f${added_utf8_part_iso88591}gt) foo
275 EOF
276
277 test_format complex-subject-ltrunc "%<($truncate_count,ltrunc)%s" <<EOF
278 commit $head3
279 .. of complex bodies
280 commit $head2
281 ..ged (ge${changed_utf8_part_iso88591}ndert) foo
282 commit $head1
283 .. (hinzugef${added_utf8_part_iso88591}gt) foo
284 EOF
285
286 test_expect_success 'prepare expected messages (for test %b)' '
287         cat <<-EOF >expected.utf-8 &&
288         commit $head3
289         This commit message is much longer than the others,
290         and it will be encoded in $test_encoding. We should therefore
291         include an ISO8859 character: ¡bueno!
292
293         commit $head2
294         commit $head1
295         EOF
296         iconv -f utf-8 -t $test_encoding expected.utf-8 >expected.ISO8859-1
297 '
298
299 test_format complex-body %b <expected.ISO8859-1
300
301 # Git uses i18n.commitEncoding if no i18n.logOutputEncoding set
302 # so unset i18n.commitEncoding to test encoding conversion
303 git config --unset i18n.commitEncoding
304
305 test_format complex-subject-commitencoding-unset %s <<EOF
306 commit $head3
307 Test printing of complex bodies
308 commit $head2
309 $changed
310 commit $head1
311 $added
312 EOF
313
314 test_format complex-subject-commitencoding-unset-trunc "%<($truncate_count,trunc)%s" <<EOF
315 commit $head3
316 Test printing of c..
317 commit $head2
318 changed (ge${changed_utf8_part}ndert)..
319 commit $head1
320 added (hinzugef${added_utf8_part}gt..
321 EOF
322
323 test_format complex-subject-commitencoding-unset-mtrunc "%<($truncate_count,mtrunc)%s" <<EOF
324 commit $head3
325 Test prin..ex bodies
326 commit $head2
327 changed (..dert) foo
328 commit $head1
329 added (hi..f${added_utf8_part}gt) foo
330 EOF
331
332 test_format complex-subject-commitencoding-unset-ltrunc "%<($truncate_count,ltrunc)%s" <<EOF
333 commit $head3
334 .. of complex bodies
335 commit $head2
336 ..ged (ge${changed_utf8_part}ndert) foo
337 commit $head1
338 .. (hinzugef${added_utf8_part}gt) foo
339 EOF
340
341 test_format complex-body-commitencoding-unset %b <expected.utf-8
342
343 test_expect_success '%x00 shows NUL' '
344         echo  >expect commit $head3 &&
345         echo >>expect fooQbar &&
346         git rev-list -1 --format=foo%x00bar HEAD >actual.nul &&
347         nul_to_q <actual.nul >actual &&
348         test_cmp expect actual
349 '
350
351 test_expect_success '%ad respects --date=' '
352         echo 2005-04-07 >expect.ad-short &&
353         git log -1 --date=short --pretty=tformat:%ad >output.ad-short master &&
354         test_cmp expect.ad-short output.ad-short
355 '
356
357 test_expect_success 'empty email' '
358         test_tick &&
359         C=$(GIT_AUTHOR_EMAIL= git commit-tree HEAD^{tree} </dev/null) &&
360         A=$(git show --pretty=format:%an,%ae,%ad%n -s $C) &&
361         verbose test "$A" = "A U Thor,,Thu Apr 7 15:14:13 2005 -0700"
362 '
363
364 test_expect_success 'del LF before empty (1)' '
365         git show -s --pretty=format:"%s%n%-b%nThanks%n" HEAD^^ >actual &&
366         test_line_count = 2 actual
367 '
368
369 test_expect_success 'del LF before empty (2)' '
370         git show -s --pretty=format:"%s%n%-b%nThanks%n" HEAD >actual &&
371         test_line_count = 6 actual &&
372         grep "^$" actual
373 '
374
375 test_expect_success 'add LF before non-empty (1)' '
376         git show -s --pretty=format:"%s%+b%nThanks%n" HEAD^^ >actual &&
377         test_line_count = 2 actual
378 '
379
380 test_expect_success 'add LF before non-empty (2)' '
381         git show -s --pretty=format:"%s%+b%nThanks%n" HEAD >actual &&
382         test_line_count = 6 actual &&
383         grep "^$" actual
384 '
385
386 test_expect_success 'add SP before non-empty (1)' '
387         git show -s --pretty=format:"%s% bThanks" HEAD^^ >actual &&
388         test $(wc -w <actual) = 3
389 '
390
391 test_expect_success 'add SP before non-empty (2)' '
392         git show -s --pretty=format:"%s% sThanks" HEAD^^ >actual &&
393         test $(wc -w <actual) = 6
394 '
395
396 test_expect_success '--abbrev' '
397         echo SHORT SHORT SHORT >expect2 &&
398         echo LONG LONG LONG >expect3 &&
399         git log -1 --format="%h %h %h" HEAD >actual1 &&
400         git log -1 --abbrev=5 --format="%h %h %h" HEAD >actual2 &&
401         git log -1 --abbrev=5 --format="%H %H %H" HEAD >actual3 &&
402         sed -e "s/$_x40/LONG/g" -e "s/$_x05/SHORT/g" <actual2 >fuzzy2 &&
403         sed -e "s/$_x40/LONG/g" -e "s/$_x05/SHORT/g" <actual3 >fuzzy3 &&
404         test_cmp expect2 fuzzy2 &&
405         test_cmp expect3 fuzzy3 &&
406         ! test_cmp actual1 actual2
407 '
408
409 test_expect_success '%H is not affected by --abbrev-commit' '
410         git log -1 --format=%H --abbrev-commit --abbrev=20 HEAD >actual &&
411         len=$(wc -c <actual) &&
412         test $len = 41
413 '
414
415 test_expect_success '%h is not affected by --abbrev-commit' '
416         git log -1 --format=%h --abbrev-commit --abbrev=20 HEAD >actual &&
417         len=$(wc -c <actual) &&
418         test $len = 21
419 '
420
421 test_expect_success '"%h %gD: %gs" is same as git-reflog' '
422         git reflog >expect &&
423         git log -g --format="%h %gD: %gs" >actual &&
424         test_cmp expect actual
425 '
426
427 test_expect_success '"%h %gD: %gs" is same as git-reflog (with date)' '
428         git reflog --date=raw >expect &&
429         git log -g --format="%h %gD: %gs" --date=raw >actual &&
430         test_cmp expect actual
431 '
432
433 test_expect_success '"%h %gD: %gs" is same as git-reflog (with --abbrev)' '
434         git reflog --abbrev=13 --date=raw >expect &&
435         git log -g --abbrev=13 --format="%h %gD: %gs" --date=raw >actual &&
436         test_cmp expect actual
437 '
438
439 test_expect_success '%gd shortens ref name' '
440         echo "master@{0}" >expect.gd-short &&
441         git log -g -1 --format=%gd refs/heads/master >actual.gd-short &&
442         test_cmp expect.gd-short actual.gd-short
443 '
444
445 test_expect_success 'reflog identity' '
446         echo "C O Mitter:committer@example.com" >expect &&
447         git log -g -1 --format="%gn:%ge" >actual &&
448         test_cmp expect actual
449 '
450
451 test_expect_success 'oneline with empty message' '
452         git commit -m "dummy" --allow-empty &&
453         git commit -m "dummy" --allow-empty &&
454         git filter-branch --msg-filter "sed -e s/dummy//" HEAD^^.. &&
455         git rev-list --oneline HEAD >test.txt &&
456         test_line_count = 5 test.txt &&
457         git rev-list --oneline --graph HEAD >testg.txt &&
458         test_line_count = 5 testg.txt
459 '
460
461 test_expect_success 'single-character name is parsed correctly' '
462         git commit --author="a <a@example.com>" --allow-empty -m foo &&
463         echo "a <a@example.com>" >expect &&
464         git log -1 --format="%an <%ae>" >actual &&
465         test_cmp expect actual
466 '
467
468 test_expect_success 'unused %G placeholders are passed through' '
469         echo "%GX %G" >expect &&
470         git log -1 --format="%GX %G" >actual &&
471         test_cmp expect actual
472 '
473
474 test_done