Merge branch 'jk/proto-v2-ref-prefix-fix'
[git] / t / t7502-commit-porcelain.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 diff.noprefix true &&
175         git status -v >actual &&
176         grep "diff --git negative negative" 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 'message shows date when it is explicitly set' '
370         git commit --allow-empty -e -m foo --date="2010-01-02T03:04:05" &&
371         test_i18ngrep \
372           "^# Date: *Sat Jan 2 03:04:05 2010 +0000" \
373           .git/COMMIT_EDITMSG
374 '
375
376 test_expect_success AUTOIDENT 'message shows committer when it is automatic' '
377
378         echo >>negative &&
379         (
380                 sane_unset GIT_COMMITTER_EMAIL &&
381                 sane_unset GIT_COMMITTER_NAME &&
382                 git commit -e -m "sample" -a
383         ) &&
384         # the ident is calculated from the system, so we cannot
385         # check the actual value, only that it is there
386         test_i18ngrep "^# Committer: " .git/COMMIT_EDITMSG
387 '
388
389 write_script .git/FAKE_EDITOR <<EOF
390 echo editor started > "$(pwd)/.git/result"
391 exit 0
392 EOF
393
394 test_expect_success !AUTOIDENT 'do not fire editor when committer is bogus' '
395         >.git/result &&
396
397         echo >>negative &&
398         (
399                 sane_unset GIT_COMMITTER_EMAIL &&
400                 sane_unset GIT_COMMITTER_NAME &&
401                 GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
402                 export GIT_EDITOR &&
403                 test_must_fail git commit -e -m sample -a
404         ) &&
405         test_must_be_empty .git/result
406 '
407
408 test_expect_success 'do not fire editor if -m <msg> was given' '
409         echo tick >file &&
410         git add file &&
411         echo "editor not started" >.git/result &&
412         (GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" git commit -m tick) &&
413         test "$(cat .git/result)" = "editor not started"
414 '
415
416 test_expect_success 'do not fire editor if -m "" was given' '
417         echo tock >file &&
418         git add file &&
419         echo "editor not started" >.git/result &&
420         (GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" \
421          git commit -m "" --allow-empty-message) &&
422         test "$(cat .git/result)" = "editor not started"
423 '
424
425 test_expect_success 'do not fire editor in the presence of conflicts' '
426
427         git clean -f &&
428         echo f >g &&
429         git add g &&
430         git commit -m "add g" &&
431         git branch second &&
432         echo master >g &&
433         echo g >h &&
434         git add g h &&
435         git commit -m "modify g and add h" &&
436         git checkout second &&
437         echo second >g &&
438         git add g &&
439         git commit -m second &&
440         # Must fail due to conflict
441         test_must_fail git cherry-pick -n master &&
442         echo "editor not started" >.git/result &&
443         (
444                 GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
445                 export GIT_EDITOR &&
446                 test_must_fail git commit
447         ) &&
448         test "$(cat .git/result)" = "editor not started"
449 '
450
451 write_script .git/FAKE_EDITOR <<EOF
452 # kill -TERM command added below.
453 EOF
454
455 test_expect_success EXECKEEPSPID 'a SIGTERM should break locks' '
456         echo >>negative &&
457         ! "$SHELL_PATH" -c '\''
458           echo kill -TERM $$ >> .git/FAKE_EDITOR
459           GIT_EDITOR=.git/FAKE_EDITOR
460           export GIT_EDITOR
461           exec git commit -a'\'' &&
462         test ! -f .git/index.lock
463 '
464
465 rm -f .git/MERGE_MSG .git/COMMIT_EDITMSG
466 git reset -q --hard
467
468 test_expect_success 'Hand committing of a redundant merge removes dups' '
469
470         git rev-parse second master >expect &&
471         test_must_fail git merge second master &&
472         git checkout master g &&
473         EDITOR=: git commit -a &&
474         git cat-file commit HEAD | sed -n -e "s/^parent //p" -e "/^$/q" >actual &&
475         test_cmp expect actual
476
477 '
478
479 test_expect_success 'A single-liner subject with a token plus colon is not a footer' '
480
481         git reset --hard &&
482         git commit -s -m "hello: kitty" --allow-empty &&
483         git cat-file commit HEAD | sed -e "1,/^$/d" >actual &&
484         test_line_count = 3 actual
485
486 '
487
488 test_expect_success 'commit -s places sob on third line after two empty lines' '
489         git commit -s --allow-empty --allow-empty-message &&
490         cat <<-EOF >expect &&
491
492
493         Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>
494
495         EOF
496         sed -e "/^#/d" -e "s/^:.*//" .git/COMMIT_EDITMSG >actual &&
497         test_cmp expect actual
498 '
499
500 write_script .git/FAKE_EDITOR <<\EOF
501 mv "$1" "$1.orig"
502 (
503         echo message
504         cat "$1.orig"
505 ) >"$1"
506 EOF
507
508 echo '## Custom template' >template
509
510 try_commit () {
511         git reset --hard &&
512         echo >>negative &&
513         GIT_EDITOR=.git/FAKE_EDITOR git commit -a $* $use_template &&
514         case "$use_template" in
515         '')
516                 test_i18ngrep ! "^## Custom template" .git/COMMIT_EDITMSG ;;
517         *)
518                 test_i18ngrep "^## Custom template" .git/COMMIT_EDITMSG ;;
519         esac
520 }
521
522 try_commit_status_combo () {
523
524         test_expect_success 'commit' '
525                 try_commit "" &&
526                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
527         '
528
529         test_expect_success 'commit --status' '
530                 try_commit --status &&
531                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
532         '
533
534         test_expect_success 'commit --no-status' '
535                 try_commit --no-status &&
536                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
537         '
538
539         test_expect_success 'commit with commit.status = yes' '
540                 test_config commit.status yes &&
541                 try_commit "" &&
542                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
543         '
544
545         test_expect_success 'commit with commit.status = no' '
546                 test_config commit.status no &&
547                 try_commit "" &&
548                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
549         '
550
551         test_expect_success 'commit --status with commit.status = yes' '
552                 test_config commit.status yes &&
553                 try_commit --status &&
554                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
555         '
556
557         test_expect_success 'commit --no-status with commit.status = yes' '
558                 test_config commit.status yes &&
559                 try_commit --no-status &&
560                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
561         '
562
563         test_expect_success 'commit --status with commit.status = no' '
564                 test_config commit.status no &&
565                 try_commit --status &&
566                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
567         '
568
569         test_expect_success 'commit --no-status with commit.status = no' '
570                 test_config commit.status no &&
571                 try_commit --no-status &&
572                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
573         '
574
575 }
576
577 try_commit_status_combo
578
579 use_template="-t template"
580
581 try_commit_status_combo
582
583 test_expect_success 'commit --status with custom comment character' '
584         test_config core.commentchar ";" &&
585         try_commit --status &&
586         test_i18ngrep "^; Changes to be committed:" .git/COMMIT_EDITMSG
587 '
588
589 test_expect_success 'switch core.commentchar' '
590         test_commit "#foo" foo &&
591         GIT_EDITOR=.git/FAKE_EDITOR git -c core.commentChar=auto commit --amend &&
592         test_i18ngrep "^; Changes to be committed:" .git/COMMIT_EDITMSG
593 '
594
595 test_expect_success 'switch core.commentchar but out of options' '
596         cat >text <<\EOF &&
597 # 1
598 ; 2
599 @ 3
600 ! 4
601 $ 5
602 % 6
603 ^ 7
604 & 8
605 | 9
606 : 10
607 EOF
608         git commit --amend -F text &&
609         (
610                 test_set_editor .git/FAKE_EDITOR &&
611                 test_must_fail git -c core.commentChar=auto commit --amend
612         )
613 '
614
615 test_done