commit: cope with scissors lines in commit message
[git] / t / t7502-commit.sh
1 #!/bin/sh
2
3 test_description='git commit porcelain-ish'
4
5 . ./test-lib.sh
6
7 commit_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>]
17 check_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
37 test_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
47 test_expect_success 'output summary format: root-commit' '
48         check_summary_oneline "" "a change"
49 '
50
51 test_expect_success 'output summary format for commit with an empty diff' '
52
53         check_summary_oneline "" "empty" "--allow-empty"
54 '
55
56 test_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
76 output_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
85 test_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
106 test_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
118 test_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
128 test_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
140 test_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
151 test_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
162 test_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
172 test_expect_success 'verbose respects diff config' '
173
174         test_config color.diff always &&
175         git status -v >actual &&
176         grep "\[1mdiff --git" actual
177 '
178
179 mesg_with_comment_and_newlines='
180 # text
181
182 '
183
184 test_expect_success 'prepare file with comment line and trailing newlines'  '
185         printf "%s" "$mesg_with_comment_and_newlines" >expect
186 '
187
188 test_expect_success 'cleanup commit messages (verbatim option,-t)' '
189
190         echo >>negative &&
191         git commit --cleanup=verbatim --no-status -t expect -a &&
192         git cat-file -p HEAD |sed -e "1,/^\$/d" >actual &&
193         test_cmp expect actual
194
195 '
196
197 test_expect_success 'cleanup commit messages (verbatim option,-F)' '
198
199         echo >>negative &&
200         git commit --cleanup=verbatim -F expect -a &&
201         git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
202         test_cmp expect actual
203
204 '
205
206 test_expect_success 'cleanup commit messages (verbatim option,-m)' '
207
208         echo >>negative &&
209         git commit --cleanup=verbatim -m "$mesg_with_comment_and_newlines" -a &&
210         git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
211         test_cmp expect actual
212
213 '
214
215 test_expect_success 'cleanup commit messages (whitespace option,-F)' '
216
217         echo >>negative &&
218         { echo;echo "# text";echo; } >text &&
219         echo "# text" >expect &&
220         git commit --cleanup=whitespace -F text -a &&
221         git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
222         test_cmp expect actual
223
224 '
225
226 test_expect_success 'cleanup commit messages (scissors option,-F,-e)' '
227
228         echo >>negative &&
229         cat >text <<EOF &&
230
231 # to be kept
232
233   # ------------------------ >8 ------------------------
234 # to be kept, too
235 # ------------------------ >8 ------------------------
236 to be removed
237 # ------------------------ >8 ------------------------
238 to be removed, too
239 EOF
240
241         cat >expect <<EOF &&
242 # to be kept
243
244   # ------------------------ >8 ------------------------
245 # to be kept, too
246 EOF
247         git commit --cleanup=scissors -e -F text -a &&
248         git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
249         test_cmp expect actual
250 '
251
252 test_expect_success 'cleanup commit messages (scissors option,-F,-e, scissors on first line)' '
253
254         echo >>negative &&
255         cat >text <<EOF &&
256 # ------------------------ >8 ------------------------
257 to be removed
258 EOF
259         git commit --cleanup=scissors -e -F text -a --allow-empty-message &&
260         git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
261         test_must_be_empty actual
262 '
263
264 test_expect_success 'cleanup commit messages (strip option,-F)' '
265
266         echo >>negative &&
267         { echo;echo "# text";echo sample;echo; } >text &&
268         echo sample >expect &&
269         git commit --cleanup=strip -F text -a &&
270         git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
271         test_cmp expect actual
272
273 '
274
275 test_expect_success 'cleanup commit messages (strip option,-F,-e)' '
276
277         echo >>negative &&
278         { echo;echo sample;echo; } >text &&
279         git commit -e -F text -a &&
280         head -n 4 .git/COMMIT_EDITMSG >actual
281 '
282
283 echo "sample
284
285 # Please enter the commit message for your changes. Lines starting
286 # with '#' will be ignored, and an empty message aborts the commit." >expect
287
288 test_expect_success 'cleanup commit messages (strip option,-F,-e): output' '
289         test_i18ncmp expect actual
290 '
291
292 test_expect_success 'cleanup commit message (fail on invalid cleanup mode option)' '
293         test_must_fail git commit --cleanup=non-existent
294 '
295
296 test_expect_success 'cleanup commit message (fail on invalid cleanup mode configuration)' '
297         test_must_fail git -c commit.cleanup=non-existent commit
298 '
299
300 test_expect_success 'cleanup commit message (no config and no option uses default)' '
301         echo content >>file &&
302         git add file &&
303         (
304           test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
305           git commit --no-status
306         ) &&
307         commit_msg_is "commit message"
308 '
309
310 test_expect_success 'cleanup commit message (option overrides default)' '
311         echo content >>file &&
312         git add file &&
313         (
314           test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
315           git commit --cleanup=whitespace --no-status
316         ) &&
317         commit_msg_is "commit message # comment"
318 '
319
320 test_expect_success 'cleanup commit message (config overrides default)' '
321         echo content >>file &&
322         git add file &&
323         (
324           test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
325           git -c commit.cleanup=whitespace commit --no-status
326         ) &&
327         commit_msg_is "commit message # comment"
328 '
329
330 test_expect_success 'cleanup commit message (option overrides config)' '
331         echo content >>file &&
332         git add file &&
333         (
334           test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
335           git -c commit.cleanup=whitespace commit --cleanup=default
336         ) &&
337         commit_msg_is "commit message"
338 '
339
340 test_expect_success 'cleanup commit message (default, -m)' '
341         echo content >>file &&
342         git add file &&
343         git commit -m "message #comment " &&
344         commit_msg_is "message #comment"
345 '
346
347 test_expect_success 'cleanup commit message (whitespace option, -m)' '
348         echo content >>file &&
349         git add file &&
350         git commit --cleanup=whitespace --no-status -m "message #comment " &&
351         commit_msg_is "message #comment"
352 '
353
354 test_expect_success 'cleanup commit message (whitespace config, -m)' '
355         echo content >>file &&
356         git add file &&
357         git -c commit.cleanup=whitespace commit --no-status -m "message #comment " &&
358         commit_msg_is "message #comment"
359 '
360
361 test_expect_success 'message shows author when it is not equal to committer' '
362         echo >>negative &&
363         git commit -e -m "sample" -a &&
364         test_i18ngrep \
365           "^# Author: *A U Thor <author@example.com>\$" \
366           .git/COMMIT_EDITMSG
367 '
368
369 test_expect_success AUTOIDENT 'message shows committer when it is automatic' '
370
371         echo >>negative &&
372         (
373                 sane_unset GIT_COMMITTER_EMAIL &&
374                 sane_unset GIT_COMMITTER_NAME &&
375                 git commit -e -m "sample" -a
376         ) &&
377         # the ident is calculated from the system, so we cannot
378         # check the actual value, only that it is there
379         test_i18ngrep "^# Committer: " .git/COMMIT_EDITMSG
380 '
381
382 write_script .git/FAKE_EDITOR <<EOF
383 echo editor started > "$(pwd)/.git/result"
384 exit 0
385 EOF
386
387 test_expect_success !AUTOIDENT 'do not fire editor when committer is bogus' '
388         >.git/result
389         >expect &&
390
391         echo >>negative &&
392         (
393                 sane_unset GIT_COMMITTER_EMAIL &&
394                 sane_unset GIT_COMMITTER_NAME &&
395                 GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
396                 export GIT_EDITOR &&
397                 test_must_fail git commit -e -m sample -a
398         ) &&
399         test_cmp expect .git/result
400 '
401
402 test_expect_success 'do not fire editor if -m <msg> was given' '
403         echo tick >file &&
404         git add file &&
405         echo "editor not started" >.git/result &&
406         (GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" git commit -m tick) &&
407         test "$(cat .git/result)" = "editor not started"
408 '
409
410 test_expect_success 'do not fire editor if -m "" was given' '
411         echo tock >file &&
412         git add file &&
413         echo "editor not started" >.git/result &&
414         (GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" \
415          git commit -m "" --allow-empty-message) &&
416         test "$(cat .git/result)" = "editor not started"
417 '
418
419 test_expect_success 'do not fire editor in the presence of conflicts' '
420
421         git clean -f &&
422         echo f >g &&
423         git add g &&
424         git commit -m "add g" &&
425         git branch second &&
426         echo master >g &&
427         echo g >h &&
428         git add g h &&
429         git commit -m "modify g and add h" &&
430         git checkout second &&
431         echo second >g &&
432         git add g &&
433         git commit -m second &&
434         # Must fail due to conflict
435         test_must_fail git cherry-pick -n master &&
436         echo "editor not started" >.git/result &&
437         (
438                 GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
439                 export GIT_EDITOR &&
440                 test_must_fail git commit
441         ) &&
442         test "$(cat .git/result)" = "editor not started"
443 '
444
445 write_script .git/FAKE_EDITOR <<EOF
446 # kill -TERM command added below.
447 EOF
448
449 test_expect_success EXECKEEPSPID 'a SIGTERM should break locks' '
450         echo >>negative &&
451         ! "$SHELL_PATH" -c '\''
452           echo kill -TERM $$ >> .git/FAKE_EDITOR
453           GIT_EDITOR=.git/FAKE_EDITOR
454           export GIT_EDITOR
455           exec git commit -a'\'' &&
456         test ! -f .git/index.lock
457 '
458
459 rm -f .git/MERGE_MSG .git/COMMIT_EDITMSG
460 git reset -q --hard
461
462 test_expect_success 'Hand committing of a redundant merge removes dups' '
463
464         git rev-parse second master >expect &&
465         test_must_fail git merge second master &&
466         git checkout master g &&
467         EDITOR=: git commit -a &&
468         git cat-file commit HEAD | sed -n -e "s/^parent //p" -e "/^$/q" >actual &&
469         test_cmp expect actual
470
471 '
472
473 test_expect_success 'A single-liner subject with a token plus colon is not a footer' '
474
475         git reset --hard &&
476         git commit -s -m "hello: kitty" --allow-empty &&
477         git cat-file commit HEAD | sed -e "1,/^$/d" >actual &&
478         test_line_count = 3 actual
479
480 '
481
482 test_expect_success 'commit -s places sob on third line after two empty lines' '
483         git commit -s --allow-empty --allow-empty-message &&
484         cat <<-EOF >expect &&
485
486
487         Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>
488
489         EOF
490         sed -e "/^#/d" -e "s/^:.*//" .git/COMMIT_EDITMSG >actual &&
491         test_cmp expect actual
492 '
493
494 write_script .git/FAKE_EDITOR <<\EOF
495 mv "$1" "$1.orig"
496 (
497         echo message
498         cat "$1.orig"
499 ) >"$1"
500 EOF
501
502 echo '## Custom template' >template
503
504 try_commit () {
505         git reset --hard &&
506         echo >>negative &&
507         GIT_EDITOR=.git/FAKE_EDITOR git commit -a $* $use_template &&
508         case "$use_template" in
509         '')
510                 test_i18ngrep ! "^## Custom template" .git/COMMIT_EDITMSG ;;
511         *)
512                 test_i18ngrep "^## Custom template" .git/COMMIT_EDITMSG ;;
513         esac
514 }
515
516 try_commit_status_combo () {
517
518         test_expect_success 'commit' '
519                 try_commit "" &&
520                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
521         '
522
523         test_expect_success 'commit' '
524                 try_commit "" &&
525                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
526         '
527
528         test_expect_success 'commit --status' '
529                 try_commit --status &&
530                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
531         '
532
533         test_expect_success 'commit --no-status' '
534                 try_commit --no-status &&
535                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
536         '
537
538         test_expect_success 'commit with commit.status = yes' '
539                 test_config commit.status yes &&
540                 try_commit "" &&
541                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
542         '
543
544         test_expect_success 'commit with commit.status = no' '
545                 test_config commit.status no &&
546                 try_commit "" &&
547                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
548         '
549
550         test_expect_success 'commit --status with commit.status = yes' '
551                 test_config commit.status yes &&
552                 try_commit --status &&
553                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
554         '
555
556         test_expect_success 'commit --no-status with commit.status = yes' '
557                 test_config commit.status yes &&
558                 try_commit --no-status &&
559                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
560         '
561
562         test_expect_success 'commit --status with commit.status = no' '
563                 test_config commit.status no &&
564                 try_commit --status &&
565                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
566         '
567
568         test_expect_success 'commit --no-status with commit.status = no' '
569                 test_config commit.status no &&
570                 try_commit --no-status &&
571                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
572         '
573
574 }
575
576 try_commit_status_combo
577
578 use_template="-t template"
579
580 try_commit_status_combo
581
582 test_expect_success 'commit --status with custom comment character' '
583         test_config core.commentchar ";" &&
584         try_commit --status &&
585         test_i18ngrep "^; Changes to be committed:" .git/COMMIT_EDITMSG
586 '
587
588 test_done