Allow custom "comment char"
[git/git.git] / t / t7502-commit.sh
CommitLineData
b468f0ce
JH
1#!/bin/sh
2
3test_description='git commit porcelain-ish'
4
5. ./test-lib.sh
6
cee9f2b3 7# Arguments: [<prefix] [<commit message>] [<commit options>]
fc6fa0d0
TRC
8check_summary_oneline() {
9 test_tick &&
cee9f2b3 10 git commit ${3+"$3"} -m "$2" | head -1 > act &&
fc6fa0d0
TRC
11
12 # branch name
13 SUMMARY_PREFIX="$(git name-rev --name-only HEAD)" &&
14
15 # append the "special" prefix, like "root-commit", "detached HEAD"
16 if test -n "$1"
17 then
18 SUMMARY_PREFIX="$SUMMARY_PREFIX ($1)"
19 fi
20
21 # abbrev SHA-1
22 SUMMARY_POSTFIX="$(git log -1 --pretty='format:%h')"
23 echo "[$SUMMARY_PREFIX $SUMMARY_POSTFIX] $2" >exp &&
24
f79ce8db 25 test_i18ncmp exp act
fc6fa0d0
TRC
26}
27
28test_expect_success 'output summary format' '
29
30 echo new >file1 &&
31 git add file1 &&
32 check_summary_oneline "root-commit" "initial" &&
33
34 echo change >>file1 &&
7f5673d7
ÆAB
35 git add file1
36'
37
38test_expect_success 'output summary format: root-commit' '
fc6fa0d0
TRC
39 check_summary_oneline "" "a change"
40'
41
a45e1a87 42test_expect_success 'output summary format for commit with an empty diff' '
cee9f2b3
TRC
43
44 check_summary_oneline "" "empty" "--allow-empty"
45'
46
a45e1a87 47test_expect_success 'output summary format for merges' '
cee9f2b3
TRC
48
49 git checkout -b recursive-base &&
50 test_commit base file1 &&
51
52 git checkout -b recursive-a recursive-base &&
53 test_commit commit-a file1 &&
54
55 git checkout -b recursive-b recursive-base &&
56 test_commit commit-b file1 &&
57
58 # conflict
59 git checkout recursive-a &&
60 test_must_fail git merge recursive-b &&
61 # resolve the conflict
62 echo commit-a > file1 &&
63 git add file1 &&
64 check_summary_oneline "" "Merge"
65'
66
fc6fa0d0
TRC
67output_tests_cleanup() {
68 # this is needed for "do not fire editor in the presence of conflicts"
69 git checkout master &&
70
71 # this is needed for the "partial removal" test to pass
72 git rm file1 &&
73 git commit -m "cleanup"
74}
75
b468f0ce
JH
76test_expect_success 'the basics' '
77
fc6fa0d0
TRC
78 output_tests_cleanup &&
79
b468f0ce
JH
80 echo doing partial >"commit is" &&
81 mkdir not &&
82 echo very much encouraged but we should >not/forbid &&
83 git add "commit is" not &&
84 echo update added "commit is" file >"commit is" &&
85 echo also update another >not/forbid &&
86 test_tick &&
87 git commit -a -m "initial with -a" &&
88
89 git cat-file blob HEAD:"commit is" >current.1 &&
90 git cat-file blob HEAD:not/forbid >current.2 &&
91
92 cmp current.1 "commit is" &&
93 cmp current.2 not/forbid
94
95'
96
97test_expect_success 'partial' '
98
99 echo another >"commit is" &&
100 echo another >not/forbid &&
101 test_tick &&
102 git commit -m "partial commit to handle a file" "commit is" &&
103
104 changed=$(git diff-tree --name-only HEAD^ HEAD) &&
105 test "$changed" = "commit is"
106
107'
108
e8f30160 109test_expect_success 'partial modification in a subdirectory' '
b468f0ce
JH
110
111 test_tick &&
112 git commit -m "partial commit to subdirectory" not &&
113
114 changed=$(git diff-tree -r --name-only HEAD^ HEAD) &&
115 test "$changed" = "not/forbid"
116
117'
118
119test_expect_success 'partial removal' '
120
121 git rm not/forbid &&
122 git commit -m "partial commit to remove not/forbid" not &&
123
124 changed=$(git diff-tree -r --name-only HEAD^ HEAD) &&
125 test "$changed" = "not/forbid" &&
126 remain=$(git ls-tree -r --name-only HEAD) &&
127 test "$remain" = "commit is"
128
129'
130
131test_expect_success 'sign off' '
132
133 >positive &&
134 git add positive &&
135 git commit -s -m "thank you" &&
136 actual=$(git cat-file commit HEAD | sed -ne "s/Signed-off-by: //p") &&
137 expected=$(git var GIT_COMMITTER_IDENT | sed -e "s/>.*/>/") &&
138 test "z$actual" = "z$expected"
139
140'
141
142test_expect_success 'multiple -m' '
143
144 >negative &&
145 git add negative &&
146 git commit -m "one" -m "two" -m "three" &&
147 actual=$(git cat-file commit HEAD | sed -e "1,/^\$/d") &&
148 expected=$(echo one; echo; echo two; echo; echo three) &&
149 test "z$actual" = "z$expected"
150
151'
152
153test_expect_success 'verbose' '
154
155 echo minus >negative &&
156 git add negative &&
157 git status -v | sed -ne "/^diff --git /p" >actual &&
158 echo "diff --git a/negative b/negative" >expect &&
82ebb0b6 159 test_cmp expect actual
b468f0ce
JH
160
161'
162
4f672ad6
JK
163test_expect_success 'verbose respects diff config' '
164
165 git config color.diff always &&
166 git status -v >actual &&
167 grep "\[1mdiff --git" actual &&
168 git config --unset color.diff
169'
170
5f065737
AR
171test_expect_success 'cleanup commit messages (verbatim,-t)' '
172
173 echo >>negative &&
174 { echo;echo "# text";echo; } >expect &&
175 git commit --cleanup=verbatim -t expect -a &&
176 git cat-file -p HEAD |sed -e "1,/^\$/d" |head -n 3 >actual &&
82ebb0b6 177 test_cmp expect actual
5f065737
AR
178
179'
180
181test_expect_success 'cleanup commit messages (verbatim,-F)' '
182
183 echo >>negative &&
184 git commit --cleanup=verbatim -F expect -a &&
185 git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
82ebb0b6 186 test_cmp expect actual
5f065737
AR
187
188'
189
190test_expect_success 'cleanup commit messages (verbatim,-m)' '
191
192 echo >>negative &&
193 git commit --cleanup=verbatim -m "$(cat expect)" -a &&
194 git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
82ebb0b6 195 test_cmp expect actual
5f065737
AR
196
197'
198
199test_expect_success 'cleanup commit messages (whitespace,-F)' '
200
201 echo >>negative &&
202 { echo;echo "# text";echo; } >text &&
203 echo "# text" >expect &&
204 git commit --cleanup=whitespace -F text -a &&
205 git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
82ebb0b6 206 test_cmp expect actual
5f065737
AR
207
208'
209
210test_expect_success 'cleanup commit messages (strip,-F)' '
211
212 echo >>negative &&
213 { echo;echo "# text";echo sample;echo; } >text &&
214 echo sample >expect &&
215 git commit --cleanup=strip -F text -a &&
216 git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
82ebb0b6 217 test_cmp expect actual
5f065737
AR
218
219'
220
5f065737
AR
221test_expect_success 'cleanup commit messages (strip,-F,-e)' '
222
223 echo >>negative &&
224 { echo;echo sample;echo; } >text &&
225 git commit -e -F text -a &&
0b430a17
ÆAB
226 head -n 4 .git/COMMIT_EDITMSG >actual
227'
228
229echo "sample
5f065737 230
0b430a17
ÆAB
231# Please enter the commit message for your changes. Lines starting
232# with '#' will be ignored, and an empty message aborts the commit." >expect
233
f79ce8db
JH
234test_expect_success 'cleanup commit messages (strip,-F,-e): output' '
235 test_i18ncmp expect actual
5f065737
AR
236'
237
1f4bf345 238test_expect_success 'message shows author when it is not equal to committer' '
e83dbe80 239 echo >>negative &&
ceacd91a 240 git commit -e -m "sample" -a &&
1f4bf345
JK
241 test_i18ngrep \
242 "^# Author: *A U Thor <author@example.com>\$" \
243 .git/COMMIT_EDITMSG
e83dbe80
SB
244'
245
1d7dc264 246test_expect_success AUTOIDENT 'message shows committer when it is automatic' '
bb1ae3f6
SB
247
248 echo >>negative &&
7845944c 249 (
00648ba0
EN
250 sane_unset GIT_COMMITTER_EMAIL &&
251 sane_unset GIT_COMMITTER_NAME &&
1d7dc264 252 git commit -e -m "sample" -a
7845944c 253 ) &&
1f4bf345
JK
254 # the ident is calculated from the system, so we cannot
255 # check the actual value, only that it is there
256 test_i18ngrep "^# Committer: " .git/COMMIT_EDITMSG
bb1ae3f6
SB
257'
258
a9ebc43b
JK
259write_script .git/FAKE_EDITOR <<EOF
260echo editor started > "$(pwd)/.git/result"
ec84bd00
PB
261exit 0
262EOF
ec84bd00 263
09feffb6 264test_expect_success !AUTOIDENT 'do not fire editor when committer is bogus' '
8c8b3bc3
JK
265 >.git/result
266 >expect &&
267
268 echo >>negative &&
269 (
270 sane_unset GIT_COMMITTER_EMAIL &&
271 sane_unset GIT_COMMITTER_NAME &&
272 GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
273 export GIT_EDITOR &&
274 test_must_fail git commit -e -m sample -a
275 ) &&
276 test_cmp expect .git/result
277'
278
ec84bd00
PB
279test_expect_success 'do not fire editor in the presence of conflicts' '
280
a3c91e08
JH
281 git clean -f &&
282 echo f >g &&
283 git add g &&
284 git commit -m "add g" &&
285 git branch second &&
286 echo master >g &&
287 echo g >h &&
288 git add g h &&
289 git commit -m "modify g and add h" &&
290 git checkout second &&
291 echo second >g &&
292 git add g &&
293 git commit -m second &&
294 # Must fail due to conflict
295 test_must_fail git cherry-pick -n master &&
296 echo "editor not started" >.git/result &&
e2007832 297 (
34565f27 298 GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
e2007832
BC
299 export GIT_EDITOR &&
300 test_must_fail git commit
301 ) &&
a3c91e08 302 test "$(cat .git/result)" = "editor not started"
ec84bd00
PB
303'
304
a9ebc43b 305write_script .git/FAKE_EDITOR <<EOF
ad5fa3cc
PB
306# kill -TERM command added below.
307EOF
308
fb9a2bea 309test_expect_success EXECKEEPSPID 'a SIGTERM should break locks' '
ad5fa3cc 310 echo >>negative &&
09b78bc1 311 ! "$SHELL_PATH" -c '\''
ad5fa3cc 312 echo kill -TERM $$ >> .git/FAKE_EDITOR
09b78bc1
BC
313 GIT_EDITOR=.git/FAKE_EDITOR
314 export GIT_EDITOR
315 exec git commit -a'\'' &&
316 test ! -f .git/index.lock
ad5fa3cc
PB
317'
318
67bfc030
JH
319rm -f .git/MERGE_MSG .git/COMMIT_EDITMSG
320git reset -q --hard
321
322test_expect_success 'Hand committing of a redundant merge removes dups' '
323
324 git rev-parse second master >expect &&
325 test_must_fail git merge second master &&
326 git checkout master g &&
327 EDITOR=: git commit -a &&
328 git cat-file commit HEAD | sed -n -e "s/^parent //p" -e "/^$/q" >actual &&
329 test_cmp expect actual
330
331'
332
e5138436
JH
333test_expect_success 'A single-liner subject with a token plus colon is not a footer' '
334
335 git reset --hard &&
336 git commit -s -m "hello: kitty" --allow-empty &&
337 git cat-file commit HEAD | sed -e "1,/^$/d" >actual &&
3fb0459b 338 test_line_count = 3 actual
e5138436
JH
339
340'
341
a9ebc43b
JK
342write_script .git/FAKE_EDITOR <<\EOF
343mv "$1" "$1.orig"
f9c01817
JH
344(
345 echo message
a9ebc43b
JK
346 cat "$1.orig"
347) >"$1"
f9c01817
JH
348EOF
349
350echo '## Custom template' >template
351
352clear_config () {
353 (
354 git config --unset-all "$1"
355 case $? in
356 0|5) exit 0 ;;
357 *) exit 1 ;;
358 esac
359 )
360}
361
362try_commit () {
363 git reset --hard &&
364 echo >>negative &&
365 GIT_EDITOR=.git/FAKE_EDITOR git commit -a $* $use_template &&
366 case "$use_template" in
367 '')
f79ce8db 368 test_i18ngrep ! "^## Custom template" .git/COMMIT_EDITMSG ;;
f9c01817 369 *)
f79ce8db 370 test_i18ngrep "^## Custom template" .git/COMMIT_EDITMSG ;;
f9c01817
JH
371 esac
372}
373
374try_commit_status_combo () {
375
f79ce8db 376 test_expect_success 'commit' '
f9c01817
JH
377 clear_config commit.status &&
378 try_commit "" &&
f79ce8db 379 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
380 '
381
f79ce8db 382 test_expect_success 'commit' '
f9c01817
JH
383 clear_config commit.status &&
384 try_commit "" &&
f79ce8db 385 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
386 '
387
f79ce8db 388 test_expect_success 'commit --status' '
f9c01817
JH
389 clear_config commit.status &&
390 try_commit --status &&
f79ce8db 391 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
392 '
393
f79ce8db 394 test_expect_success 'commit --no-status' '
f9c01817 395 clear_config commit.status &&
2dec68cf 396 try_commit --no-status &&
f79ce8db 397 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
398 '
399
f79ce8db 400 test_expect_success 'commit with commit.status = yes' '
f9c01817
JH
401 clear_config commit.status &&
402 git config commit.status yes &&
403 try_commit "" &&
f79ce8db 404 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
405 '
406
f79ce8db 407 test_expect_success 'commit with commit.status = no' '
f9c01817
JH
408 clear_config commit.status &&
409 git config commit.status no &&
410 try_commit "" &&
f79ce8db 411 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
412 '
413
f79ce8db 414 test_expect_success 'commit --status with commit.status = yes' '
f9c01817
JH
415 clear_config commit.status &&
416 git config commit.status yes &&
417 try_commit --status &&
f79ce8db 418 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
419 '
420
f79ce8db 421 test_expect_success 'commit --no-status with commit.status = yes' '
f9c01817
JH
422 clear_config commit.status &&
423 git config commit.status yes &&
424 try_commit --no-status &&
f79ce8db 425 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
426 '
427
f79ce8db 428 test_expect_success 'commit --status with commit.status = no' '
f9c01817
JH
429 clear_config commit.status &&
430 git config commit.status no &&
431 try_commit --status &&
f79ce8db 432 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
433 '
434
f79ce8db 435 test_expect_success 'commit --no-status with commit.status = no' '
f9c01817
JH
436 clear_config commit.status &&
437 git config commit.status no &&
438 try_commit --no-status &&
f79ce8db 439 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
f9c01817
JH
440 '
441
442}
443
444try_commit_status_combo
445
446use_template="-t template"
447
448try_commit_status_combo
449
eff80a9f
JH
450test_expect_success 'commit --status with custom comment character' '
451 test_when_finished "git config --unset core.commentchar" &&
452 git config core.commentchar ";" &&
453 try_commit --status &&
454 test_i18ngrep "^; Changes to be committed:" .git/COMMIT_EDITMSG
455'
456
b468f0ce 457test_done