Merge branch 'ph/push-doc-cas' into maint
[git] / t / t4205-log-pretty-formats.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2010, Will Palmer
4 # Copyright (c) 2011, Alexey Shumkin (+ non-UTF-8 commit encoding tests)
5 #
6
7 test_description='Test pretty formats'
8 . ./test-lib.sh
9
10 # Tested non-UTF-8 encoding
11 test_encoding="ISO8859-1"
12
13 sample_utf8_part=$(printf "f\303\244ng")
14
15 commit_msg () {
16         # String "initial. initial" partly in German
17         # (translated with Google Translate),
18         # encoded in UTF-8, used as a commit log message below.
19         msg="initial. an${sample_utf8_part}lich\n"
20         if test -n "$1"
21         then
22                 printf "$msg" | iconv -f utf-8 -t "$1"
23         else
24                 printf "$msg"
25         fi
26 }
27
28 test_expect_success 'set up basic repos' '
29         >foo &&
30         >bar &&
31         git add foo &&
32         test_tick &&
33         git config i18n.commitEncoding $test_encoding &&
34         commit_msg $test_encoding | git commit -F - &&
35         git add bar &&
36         test_tick &&
37         git commit -m "add bar" &&
38         git config --unset i18n.commitEncoding
39 '
40
41 test_expect_success 'alias builtin format' '
42         git log --pretty=oneline >expected &&
43         git config pretty.test-alias oneline &&
44         git log --pretty=test-alias >actual &&
45         test_cmp expected actual
46 '
47
48 test_expect_success 'alias masking builtin format' '
49         git log --pretty=oneline >expected &&
50         git config pretty.oneline "%H" &&
51         git log --pretty=oneline >actual &&
52         test_cmp expected actual
53 '
54
55 test_expect_success 'alias user-defined format' '
56         git log --pretty="format:%h" >expected &&
57         git config pretty.test-alias "format:%h" &&
58         git log --pretty=test-alias >actual &&
59         test_cmp expected actual
60 '
61
62 test_expect_success 'alias user-defined tformat with %s (ISO8859-1 encoding)' '
63         git config i18n.logOutputEncoding $test_encoding &&
64         git log --oneline >expected-s &&
65         git log --pretty="tformat:%h %s" >actual-s &&
66         git config --unset i18n.logOutputEncoding &&
67         test_cmp expected-s actual-s
68 '
69
70 test_expect_success 'alias user-defined tformat with %s (utf-8 encoding)' '
71         git log --oneline >expected-s &&
72         git log --pretty="tformat:%h %s" >actual-s &&
73         test_cmp expected-s actual-s
74 '
75
76 test_expect_success 'alias user-defined tformat' '
77         git log --pretty="tformat:%h" >expected &&
78         git config pretty.test-alias "tformat:%h" &&
79         git log --pretty=test-alias >actual &&
80         test_cmp expected actual
81 '
82
83 test_expect_success 'alias non-existent format' '
84         git config pretty.test-alias format-that-will-never-exist &&
85         test_must_fail git log --pretty=test-alias
86 '
87
88 test_expect_success 'alias of an alias' '
89         git log --pretty="tformat:%h" >expected &&
90         git config pretty.test-foo "tformat:%h" &&
91         git config pretty.test-bar test-foo &&
92         git log --pretty=test-bar >actual && test_cmp expected actual
93 '
94
95 test_expect_success 'alias masking an alias' '
96         git log --pretty=format:"Two %H" >expected &&
97         git config pretty.duplicate "format:One %H" &&
98         git config --add pretty.duplicate "format:Two %H" &&
99         git log --pretty=duplicate >actual &&
100         test_cmp expected actual
101 '
102
103 test_expect_success 'alias loop' '
104         git config pretty.test-foo test-bar &&
105         git config pretty.test-bar test-foo &&
106         test_must_fail git log --pretty=test-foo
107 '
108
109 test_expect_success 'NUL separation' '
110         printf "add bar\0$(commit_msg)" >expected &&
111         git log -z --pretty="format:%s" >actual &&
112         test_cmp expected actual
113 '
114
115 test_expect_success 'NUL termination' '
116         printf "add bar\0$(commit_msg)\0" >expected &&
117         git log -z --pretty="tformat:%s" >actual &&
118         test_cmp expected actual
119 '
120
121 test_expect_success 'NUL separation with --stat' '
122         stat0_part=$(git diff --stat HEAD^ HEAD) &&
123         stat1_part=$(git diff-tree --no-commit-id --stat --root HEAD^) &&
124         printf "add bar\n$stat0_part\n\0$(commit_msg)\n$stat1_part\n" >expected &&
125         git log -z --stat --pretty="format:%s" >actual &&
126         test_i18ncmp expected actual
127 '
128
129 test_expect_failure 'NUL termination with --stat' '
130         stat0_part=$(git diff --stat HEAD^ HEAD) &&
131         stat1_part=$(git diff-tree --no-commit-id --stat --root HEAD^) &&
132         printf "add bar\n$stat0_part\n\0$(commit_msg)\n$stat1_part\n0" >expected &&
133         git log -z --stat --pretty="tformat:%s" >actual &&
134         test_i18ncmp expected actual
135 '
136
137 test_expect_success 'setup more commits' '
138         test_commit "message one" one one message-one &&
139         test_commit "message two" two two message-two &&
140         head1=$(git rev-parse --verify --short HEAD~0) &&
141         head2=$(git rev-parse --verify --short HEAD~1) &&
142         head3=$(git rev-parse --verify --short HEAD~2) &&
143         head4=$(git rev-parse --verify --short HEAD~3)
144 '
145
146 test_expect_success 'left alignment formatting' '
147         git log --pretty="tformat:%<(40)%s" >actual &&
148         qz_to_tab_space <<EOF >expected &&
149 message two                            Z
150 message one                            Z
151 add bar                                Z
152 $(commit_msg)                    Z
153 EOF
154         test_cmp expected actual
155 '
156
157 test_expect_success 'left alignment formatting. i18n.logOutputEncoding' '
158         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(40)%s" >actual &&
159         qz_to_tab_space <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
160 message two                            Z
161 message one                            Z
162 add bar                                Z
163 $(commit_msg)                    Z
164 EOF
165         test_cmp expected actual
166 '
167
168 test_expect_success 'left alignment formatting at the nth column' '
169         git log --pretty="tformat:%h %<|(40)%s" >actual &&
170         qz_to_tab_space <<EOF >expected &&
171 $head1 message two                    Z
172 $head2 message one                    Z
173 $head3 add bar                        Z
174 $head4 $(commit_msg)            Z
175 EOF
176         test_cmp expected actual
177 '
178
179 test_expect_success 'left alignment formatting at the nth column. i18n.logOutputEncoding' '
180         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%h %<|(40)%s" >actual &&
181         qz_to_tab_space <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
182 $head1 message two                    Z
183 $head2 message one                    Z
184 $head3 add bar                        Z
185 $head4 $(commit_msg)            Z
186 EOF
187         test_cmp expected actual
188 '
189
190 test_expect_success 'left alignment formatting with no padding' '
191         git log --pretty="tformat:%<(1)%s" >actual &&
192         cat <<EOF >expected &&
193 message two
194 message one
195 add bar
196 $(commit_msg)
197 EOF
198         test_cmp expected actual
199 '
200
201 test_expect_success 'left alignment formatting with no padding. i18n.logOutputEncoding' '
202         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(1)%s" >actual &&
203         cat <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
204 message two
205 message one
206 add bar
207 $(commit_msg)
208 EOF
209         test_cmp expected actual
210 '
211
212 test_expect_success 'left alignment formatting with trunc' '
213         git log --pretty="tformat:%<(10,trunc)%s" >actual &&
214         qz_to_tab_space <<EOF >expected &&
215 message ..
216 message ..
217 add bar  Z
218 initial...
219 EOF
220         test_cmp expected actual
221 '
222
223 test_expect_success 'left alignment formatting with trunc. i18n.logOutputEncoding' '
224         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,trunc)%s" >actual &&
225         qz_to_tab_space <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
226 message ..
227 message ..
228 add bar  Z
229 initial...
230 EOF
231         test_cmp expected actual
232 '
233
234 test_expect_success 'left alignment formatting with ltrunc' '
235         git log --pretty="tformat:%<(10,ltrunc)%s" >actual &&
236         qz_to_tab_space <<EOF >expected &&
237 ..sage two
238 ..sage one
239 add bar  Z
240 ..${sample_utf8_part}lich
241 EOF
242         test_cmp expected actual
243 '
244
245 test_expect_success 'left alignment formatting with ltrunc. i18n.logOutputEncoding' '
246         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,ltrunc)%s" >actual &&
247         qz_to_tab_space <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
248 ..sage two
249 ..sage one
250 add bar  Z
251 ..${sample_utf8_part}lich
252 EOF
253         test_cmp expected actual
254 '
255
256 test_expect_success 'left alignment formatting with mtrunc' '
257         git log --pretty="tformat:%<(10,mtrunc)%s" >actual &&
258         qz_to_tab_space <<EOF >expected &&
259 mess.. two
260 mess.. one
261 add bar  Z
262 init..lich
263 EOF
264         test_cmp expected actual
265 '
266
267 test_expect_success 'left alignment formatting with mtrunc. i18n.logOutputEncoding' '
268         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,mtrunc)%s" >actual &&
269         qz_to_tab_space <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
270 mess.. two
271 mess.. one
272 add bar  Z
273 init..lich
274 EOF
275         test_cmp expected actual
276 '
277
278 test_expect_success 'right alignment formatting' '
279         git log --pretty="tformat:%>(40)%s" >actual &&
280         qz_to_tab_space <<EOF >expected &&
281 Z                            message two
282 Z                            message one
283 Z                                add bar
284 Z                    $(commit_msg)
285 EOF
286         test_cmp expected actual
287 '
288
289 test_expect_success 'right alignment formatting. i18n.logOutputEncoding' '
290         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%>(40)%s" >actual &&
291         qz_to_tab_space <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
292 Z                            message two
293 Z                            message one
294 Z                                add bar
295 Z                    $(commit_msg)
296 EOF
297         test_cmp expected actual
298 '
299
300 test_expect_success 'right alignment formatting at the nth column' '
301         git log --pretty="tformat:%h %>|(40)%s" >actual &&
302         qz_to_tab_space <<EOF >expected &&
303 $head1                      message two
304 $head2                      message one
305 $head3                          add bar
306 $head4              $(commit_msg)
307 EOF
308         test_cmp expected actual
309 '
310
311 test_expect_success 'right alignment formatting at the nth column. i18n.logOutputEncoding' '
312         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%h %>|(40)%s" >actual &&
313         qz_to_tab_space <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
314 $head1                      message two
315 $head2                      message one
316 $head3                          add bar
317 $head4              $(commit_msg)
318 EOF
319         test_cmp expected actual
320 '
321
322 test_expect_success 'right alignment formatting with no padding' '
323         git log --pretty="tformat:%>(1)%s" >actual &&
324         cat <<EOF >expected &&
325 message two
326 message one
327 add bar
328 $(commit_msg)
329 EOF
330         test_cmp expected actual
331 '
332
333 test_expect_success 'right alignment formatting with no padding. i18n.logOutputEncoding' '
334         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%>(1)%s" >actual &&
335         cat <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
336 message two
337 message one
338 add bar
339 $(commit_msg)
340 EOF
341         test_cmp expected actual
342 '
343
344 test_expect_success 'center alignment formatting' '
345         git log --pretty="tformat:%><(40)%s" >actual &&
346         qz_to_tab_space <<EOF >expected &&
347 Z             message two              Z
348 Z             message one              Z
349 Z               add bar                Z
350 Z         $(commit_msg)          Z
351 EOF
352         test_cmp expected actual
353 '
354
355 test_expect_success 'center alignment formatting. i18n.logOutputEncoding' '
356         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%><(40)%s" >actual &&
357         qz_to_tab_space <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
358 Z             message two              Z
359 Z             message one              Z
360 Z               add bar                Z
361 Z         $(commit_msg)          Z
362 EOF
363         test_cmp expected actual
364 '
365 test_expect_success 'center alignment formatting at the nth column' '
366         git log --pretty="tformat:%h %><|(40)%s" >actual &&
367         qz_to_tab_space <<EOF >expected &&
368 $head1           message two          Z
369 $head2           message one          Z
370 $head3             add bar            Z
371 $head4       $(commit_msg)      Z
372 EOF
373         test_cmp expected actual
374 '
375
376 test_expect_success 'center alignment formatting at the nth column. i18n.logOutputEncoding' '
377         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%h %><|(40)%s" >actual &&
378         qz_to_tab_space <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
379 $head1           message two          Z
380 $head2           message one          Z
381 $head3             add bar            Z
382 $head4       $(commit_msg)      Z
383 EOF
384         test_cmp expected actual
385 '
386
387 test_expect_success 'center alignment formatting with no padding' '
388         git log --pretty="tformat:%><(1)%s" >actual &&
389         cat <<EOF >expected &&
390 message two
391 message one
392 add bar
393 $(commit_msg)
394 EOF
395         test_cmp expected actual
396 '
397
398 # save HEAD's SHA-1 digest (with no abbreviations) to use it below
399 # as far as the next test amends HEAD
400 old_head1=$(git rev-parse --verify HEAD~0)
401 test_expect_success 'center alignment formatting with no padding. i18n.logOutputEncoding' '
402         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%><(1)%s" >actual &&
403         cat <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
404 message two
405 message one
406 add bar
407 $(commit_msg)
408 EOF
409         test_cmp expected actual
410 '
411
412 test_expect_success 'left/right alignment formatting with stealing' '
413         git commit --amend -m short --author "long long long <long@me.com>" &&
414         git log --pretty="tformat:%<(10,trunc)%s%>>(10,ltrunc)% an" >actual &&
415         cat <<EOF >expected &&
416 short long  long long
417 message ..   A U Thor
418 add bar      A U Thor
419 initial...   A U Thor
420 EOF
421         test_cmp expected actual
422 '
423 test_expect_success 'left/right alignment formatting with stealing. i18n.logOutputEncoding' '
424         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,trunc)%s%>>(10,ltrunc)% an" >actual &&
425         cat <<EOF | iconv -f utf-8 -t $test_encoding >expected &&
426 short long  long long
427 message ..   A U Thor
428 add bar      A U Thor
429 initial...   A U Thor
430 EOF
431         test_cmp expected actual
432 '
433
434 test_expect_success 'strbuf_utf8_replace() not producing NUL' '
435         git log --color --pretty="tformat:%<(10,trunc)%s%>>(10,ltrunc)%C(auto)%d" |
436                 test_decode_color |
437                 nul_to_q >actual &&
438         ! grep Q actual
439 '
440
441 # ISO strict date format
442 test_expect_success 'ISO and ISO-strict date formats display the same values' '
443         git log --format=%ai%n%ci |
444         sed -e "s/ /T/; s/ //; s/..\$/:&/" >expected &&
445         git log --format=%aI%n%cI >actual &&
446         test_cmp expected actual
447 '
448
449 # get new digests (with no abbreviations)
450 head1=$(git rev-parse --verify HEAD~0) &&
451 head2=$(git rev-parse --verify HEAD~1) &&
452
453 test_expect_success 'log decoration properly follows tag chain' '
454         git tag -a tag1 -m tag1 &&
455         git tag -a tag2 -m tag2 tag1 &&
456         git tag -d tag1 &&
457         git commit --amend -m shorter &&
458         git log --no-walk --tags --pretty="%H %d" --decorate=full >actual &&
459         cat <<EOF >expected &&
460 $head1  (tag: refs/tags/tag2)
461 $head2  (tag: refs/tags/message-one)
462 $old_head1  (tag: refs/tags/message-two)
463 EOF
464         sort actual >actual1 &&
465         test_cmp expected actual1
466 '
467
468 test_expect_success 'clean log decoration' '
469         git log --no-walk --tags --pretty="%H %D" --decorate=full >actual &&
470         cat >expected <<EOF &&
471 $head1 tag: refs/tags/tag2
472 $head2 tag: refs/tags/message-one
473 $old_head1 tag: refs/tags/message-two
474 EOF
475         sort actual >actual1 &&
476         test_cmp expected actual1
477 '
478
479 test_done