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