Merge branch 'cp/am-patch-format-doc'
[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 # String "added" in German
13 # (translated with Google Translate),
14 # encoded in UTF-8, used as a commit log message below.
15 added=$(printf "added (hinzugef\303\274gt) foo")
16 added_iso88591=$(echo "$added" | iconv -f utf-8 -t iso8859-1)
17 # same but "changed"
18 changed=$(printf "changed (ge\303\244ndert) foo")
19 changed_iso88591=$(echo "$changed" | iconv -f utf-8 -t iso8859-1)
20
21 test_expect_success 'setup' '
22         : >foo &&
23         git add foo &&
24         git config i18n.commitEncoding iso8859-1 &&
25         git commit -m "$added_iso88591" &&
26         head1=$(git rev-parse --verify HEAD) &&
27         head1_short=$(git rev-parse --verify --short $head1) &&
28         tree1=$(git rev-parse --verify HEAD:) &&
29         tree1_short=$(git rev-parse --verify --short $tree1) &&
30         echo "$changed" > foo &&
31         git commit -a -m "$changed_iso88591" &&
32         head2=$(git rev-parse --verify HEAD) &&
33         head2_short=$(git rev-parse --verify --short $head2) &&
34         tree2=$(git rev-parse --verify HEAD:) &&
35         tree2_short=$(git rev-parse --verify --short $tree2)
36         git config --unset i18n.commitEncoding
37 '
38
39 # usage: test_format name format_string [failure] <expected_output
40 test_format () {
41         cat >expect.$1
42         test_expect_${3:-success} "format $1" "
43                 git rev-list --pretty=format:'$2' master >output.$1 &&
44                 test_cmp expect.$1 output.$1
45         "
46 }
47
48 # Feed to --format to provide predictable colored sequences.
49 AUTO_COLOR='%C(auto,red)foo%C(auto,reset)'
50 has_color () {
51         printf '\033[31mfoo\033[m\n' >expect &&
52         test_cmp expect "$1"
53 }
54
55 has_no_color () {
56         echo foo >expect &&
57         test_cmp expect "$1"
58 }
59
60 test_format percent %%h <<EOF
61 commit $head2
62 %h
63 commit $head1
64 %h
65 EOF
66
67 test_format hash %H%n%h <<EOF
68 commit $head2
69 $head2
70 $head2_short
71 commit $head1
72 $head1
73 $head1_short
74 EOF
75
76 test_format tree %T%n%t <<EOF
77 commit $head2
78 $tree2
79 $tree2_short
80 commit $head1
81 $tree1
82 $tree1_short
83 EOF
84
85 test_format parents %P%n%p <<EOF
86 commit $head2
87 $head1
88 $head1_short
89 commit $head1
90
91
92 EOF
93
94 # we don't test relative here
95 test_format author %an%n%ae%n%ad%n%aD%n%at <<EOF
96 commit $head2
97 A U Thor
98 author@example.com
99 Thu Apr 7 15:13:13 2005 -0700
100 Thu, 7 Apr 2005 15:13:13 -0700
101 1112911993
102 commit $head1
103 A U Thor
104 author@example.com
105 Thu Apr 7 15:13:13 2005 -0700
106 Thu, 7 Apr 2005 15:13:13 -0700
107 1112911993
108 EOF
109
110 test_format committer %cn%n%ce%n%cd%n%cD%n%ct <<EOF
111 commit $head2
112 C O Mitter
113 committer@example.com
114 Thu Apr 7 15:13:13 2005 -0700
115 Thu, 7 Apr 2005 15:13:13 -0700
116 1112911993
117 commit $head1
118 C O Mitter
119 committer@example.com
120 Thu Apr 7 15:13:13 2005 -0700
121 Thu, 7 Apr 2005 15:13:13 -0700
122 1112911993
123 EOF
124
125 test_format encoding %e <<EOF
126 commit $head2
127 iso8859-1
128 commit $head1
129 iso8859-1
130 EOF
131
132 test_format subject %s <<EOF
133 commit $head2
134 $changed
135 commit $head1
136 $added
137 EOF
138
139 test_format body %b <<EOF
140 commit $head2
141 commit $head1
142 EOF
143
144 test_format raw-body %B <<EOF
145 commit $head2
146 $changed
147
148 commit $head1
149 $added
150
151 EOF
152
153 test_format colors %Credfoo%Cgreenbar%Cbluebaz%Cresetxyzzy <<EOF
154 commit $head2
155 \e[31mfoo\e[32mbar\e[34mbaz\e[mxyzzy
156 commit $head1
157 \e[31mfoo\e[32mbar\e[34mbaz\e[mxyzzy
158 EOF
159
160 test_format advanced-colors '%C(red yellow bold)foo%C(reset)' <<EOF
161 commit $head2
162 \e[1;31;43mfoo\e[m
163 commit $head1
164 \e[1;31;43mfoo\e[m
165 EOF
166
167 test_expect_success '%C(auto) does not enable color by default' '
168         git log --format=$AUTO_COLOR -1 >actual &&
169         has_no_color actual
170 '
171
172 test_expect_success '%C(auto) enables colors for color.diff' '
173         git -c color.diff=always log --format=$AUTO_COLOR -1 >actual &&
174         has_color actual
175 '
176
177 test_expect_success '%C(auto) enables colors for color.ui' '
178         git -c color.ui=always log --format=$AUTO_COLOR -1 >actual &&
179         has_color actual
180 '
181
182 test_expect_success '%C(auto) respects --color' '
183         git log --format=$AUTO_COLOR -1 --color >actual &&
184         has_color actual
185 '
186
187 test_expect_success '%C(auto) respects --no-color' '
188         git -c color.ui=always log --format=$AUTO_COLOR -1 --no-color >actual &&
189         has_no_color actual
190 '
191
192 test_expect_success TTY '%C(auto) respects --color=auto (stdout is tty)' '
193         (
194                 TERM=vt100 && export TERM &&
195                 test_terminal \
196                         git log --format=$AUTO_COLOR -1 --color=auto >actual &&
197                 has_color actual
198         )
199 '
200
201 test_expect_success '%C(auto) respects --color=auto (stdout not tty)' '
202         (
203                 TERM=vt100 && export TERM &&
204                 git log --format=$AUTO_COLOR -1 --color=auto >actual &&
205                 has_no_color actual
206         )
207 '
208
209 iconv -f utf-8 -t iso8859-1 > commit-msg <<EOF
210 Test printing of complex bodies
211
212 This commit message is much longer than the others,
213 and it will be encoded in iso8859-1. We should therefore
214 include an iso8859 character: ¡bueno!
215 EOF
216
217 test_expect_success 'setup complex body' '
218         git config i18n.commitencoding iso8859-1 &&
219         echo change2 >foo && git commit -a -F commit-msg &&
220         head3=$(git rev-parse --verify HEAD) &&
221         head3_short=$(git rev-parse --short $head3)
222 '
223
224 test_format complex-encoding %e <<EOF
225 commit $head3
226 iso8859-1
227 commit $head2
228 iso8859-1
229 commit $head1
230 iso8859-1
231 EOF
232
233 test_format complex-subject %s <<EOF
234 commit $head3
235 Test printing of complex bodies
236 commit $head2
237 $changed_iso88591
238 commit $head1
239 $added_iso88591
240 EOF
241
242 test_expect_success 'prepare expected messages (for test %b)' '
243         cat <<-EOF >expected.utf-8 &&
244         commit $head3
245         This commit message is much longer than the others,
246         and it will be encoded in iso8859-1. We should therefore
247         include an iso8859 character: ¡bueno!
248
249         commit $head2
250         commit $head1
251         EOF
252         iconv -f utf-8 -t iso8859-1 expected.utf-8 >expected.iso8859-1
253 '
254
255 test_format complex-body %b <expected.iso8859-1
256
257 # Git uses i18n.commitEncoding if no i18n.logOutputEncoding set
258 # so unset i18n.commitEncoding to test encoding conversion
259 git config --unset i18n.commitEncoding
260
261 test_format complex-subject-commitencoding-unset %s <<EOF
262 commit $head3
263 Test printing of complex bodies
264 commit $head2
265 $changed
266 commit $head1
267 $added
268 EOF
269
270 test_format complex-body-commitencoding-unset %b <expected.utf-8
271
272 test_expect_success '%x00 shows NUL' '
273         echo  >expect commit $head3 &&
274         echo >>expect fooQbar &&
275         git rev-list -1 --format=foo%x00bar HEAD >actual.nul &&
276         nul_to_q <actual.nul >actual &&
277         test_cmp expect actual
278 '
279
280 test_expect_success '%ad respects --date=' '
281         echo 2005-04-07 >expect.ad-short &&
282         git log -1 --date=short --pretty=tformat:%ad >output.ad-short master &&
283         test_cmp expect.ad-short output.ad-short
284 '
285
286 test_expect_success 'empty email' '
287         test_tick &&
288         C=$(GIT_AUTHOR_EMAIL= git commit-tree HEAD^{tree} </dev/null) &&
289         A=$(git show --pretty=format:%an,%ae,%ad%n -s $C) &&
290         test "$A" = "A U Thor,,Thu Apr 7 15:14:13 2005 -0700" || {
291                 echo "Eh? $A" >failure
292                 false
293         }
294 '
295
296 test_expect_success 'del LF before empty (1)' '
297         git show -s --pretty=format:"%s%n%-b%nThanks%n" HEAD^^ >actual &&
298         test_line_count = 2 actual
299 '
300
301 test_expect_success 'del LF before empty (2)' '
302         git show -s --pretty=format:"%s%n%-b%nThanks%n" HEAD >actual &&
303         test_line_count = 6 actual &&
304         grep "^$" actual
305 '
306
307 test_expect_success 'add LF before non-empty (1)' '
308         git show -s --pretty=format:"%s%+b%nThanks%n" HEAD^^ >actual &&
309         test_line_count = 2 actual
310 '
311
312 test_expect_success 'add LF before non-empty (2)' '
313         git show -s --pretty=format:"%s%+b%nThanks%n" HEAD >actual &&
314         test_line_count = 6 actual &&
315         grep "^$" actual
316 '
317
318 test_expect_success 'add SP before non-empty (1)' '
319         git show -s --pretty=format:"%s% bThanks" HEAD^^ >actual &&
320         test $(wc -w <actual) = 3
321 '
322
323 test_expect_success 'add SP before non-empty (2)' '
324         git show -s --pretty=format:"%s% sThanks" HEAD^^ >actual &&
325         test $(wc -w <actual) = 6
326 '
327
328 test_expect_success '--abbrev' '
329         echo SHORT SHORT SHORT >expect2 &&
330         echo LONG LONG LONG >expect3 &&
331         git log -1 --format="%h %h %h" HEAD >actual1 &&
332         git log -1 --abbrev=5 --format="%h %h %h" HEAD >actual2 &&
333         git log -1 --abbrev=5 --format="%H %H %H" HEAD >actual3 &&
334         sed -e "s/$_x40/LONG/g" -e "s/$_x05/SHORT/g" <actual2 >fuzzy2 &&
335         sed -e "s/$_x40/LONG/g" -e "s/$_x05/SHORT/g" <actual3 >fuzzy3 &&
336         test_cmp expect2 fuzzy2 &&
337         test_cmp expect3 fuzzy3 &&
338         ! test_cmp actual1 actual2
339 '
340
341 test_expect_success '%H is not affected by --abbrev-commit' '
342         git log -1 --format=%H --abbrev-commit --abbrev=20 HEAD >actual &&
343         len=$(wc -c <actual) &&
344         test $len = 41
345 '
346
347 test_expect_success '%h is not affected by --abbrev-commit' '
348         git log -1 --format=%h --abbrev-commit --abbrev=20 HEAD >actual &&
349         len=$(wc -c <actual) &&
350         test $len = 21
351 '
352
353 test_expect_success '"%h %gD: %gs" is same as git-reflog' '
354         git reflog >expect &&
355         git log -g --format="%h %gD: %gs" >actual &&
356         test_cmp expect actual
357 '
358
359 test_expect_success '"%h %gD: %gs" is same as git-reflog (with date)' '
360         git reflog --date=raw >expect &&
361         git log -g --format="%h %gD: %gs" --date=raw >actual &&
362         test_cmp expect actual
363 '
364
365 test_expect_success '"%h %gD: %gs" is same as git-reflog (with --abbrev)' '
366         git reflog --abbrev=13 --date=raw >expect &&
367         git log -g --abbrev=13 --format="%h %gD: %gs" --date=raw >actual &&
368         test_cmp expect actual
369 '
370
371 test_expect_success '%gd shortens ref name' '
372         echo "master@{0}" >expect.gd-short &&
373         git log -g -1 --format=%gd refs/heads/master >actual.gd-short &&
374         test_cmp expect.gd-short actual.gd-short
375 '
376
377 test_expect_success 'reflog identity' '
378         echo "C O Mitter:committer@example.com" >expect &&
379         git log -g -1 --format="%gn:%ge" >actual &&
380         test_cmp expect actual
381 '
382
383 test_expect_success 'oneline with empty message' '
384         git commit -m "dummy" --allow-empty &&
385         git commit -m "dummy" --allow-empty &&
386         git filter-branch --msg-filter "sed -e s/dummy//" HEAD^^.. &&
387         git rev-list --oneline HEAD >test.txt &&
388         test_line_count = 5 test.txt &&
389         git rev-list --oneline --graph HEAD >testg.txt &&
390         test_line_count = 5 testg.txt
391 '
392
393 test_expect_success 'single-character name is parsed correctly' '
394         git commit --author="a <a@example.com>" --allow-empty -m foo &&
395         echo "a <a@example.com>" >expect &&
396         git log -1 --format="%an <%ae>" >actual &&
397         test_cmp expect actual
398 '
399
400 test_done