Merge branch 'mn/doc-pack-heu-remove-dead-pastebin'
[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 (strip option,-F)' '
227
228         echo >>negative &&
229         { echo;echo "# text";echo sample;echo; } >text &&
230         echo sample >expect &&
231         git commit --cleanup=strip -F text -a &&
232         git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
233         test_cmp expect actual
234
235 '
236
237 test_expect_success 'cleanup commit messages (strip option,-F,-e)' '
238
239         echo >>negative &&
240         { echo;echo sample;echo; } >text &&
241         git commit -e -F text -a &&
242         head -n 4 .git/COMMIT_EDITMSG >actual
243 '
244
245 echo "sample
246
247 # Please enter the commit message for your changes. Lines starting
248 # with '#' will be ignored, and an empty message aborts the commit." >expect
249
250 test_expect_success 'cleanup commit messages (strip option,-F,-e): output' '
251         test_i18ncmp expect actual
252 '
253
254 test_expect_success 'cleanup commit message (fail on invalid cleanup mode option)' '
255         test_must_fail git commit --cleanup=non-existent
256 '
257
258 test_expect_success 'cleanup commit message (fail on invalid cleanup mode configuration)' '
259         test_must_fail git -c commit.cleanup=non-existent commit
260 '
261
262 test_expect_success 'cleanup commit message (no config and no option uses default)' '
263         echo content >>file &&
264         git add file &&
265         (
266           test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
267           git commit --no-status
268         ) &&
269         commit_msg_is "commit message"
270 '
271
272 test_expect_success 'cleanup commit message (option overrides default)' '
273         echo content >>file &&
274         git add file &&
275         (
276           test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
277           git commit --cleanup=whitespace --no-status
278         ) &&
279         commit_msg_is "commit message # comment"
280 '
281
282 test_expect_success 'cleanup commit message (config overrides default)' '
283         echo content >>file &&
284         git add file &&
285         (
286           test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
287           git -c commit.cleanup=whitespace commit --no-status
288         ) &&
289         commit_msg_is "commit message # comment"
290 '
291
292 test_expect_success 'cleanup commit message (option overrides config)' '
293         echo content >>file &&
294         git add file &&
295         (
296           test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
297           git -c commit.cleanup=whitespace commit --cleanup=default
298         ) &&
299         commit_msg_is "commit message"
300 '
301
302 test_expect_success 'cleanup commit message (default, -m)' '
303         echo content >>file &&
304         git add file &&
305         git commit -m "message #comment " &&
306         commit_msg_is "message #comment"
307 '
308
309 test_expect_success 'cleanup commit message (whitespace option, -m)' '
310         echo content >>file &&
311         git add file &&
312         git commit --cleanup=whitespace --no-status -m "message #comment " &&
313         commit_msg_is "message #comment"
314 '
315
316 test_expect_success 'cleanup commit message (whitespace config, -m)' '
317         echo content >>file &&
318         git add file &&
319         git -c commit.cleanup=whitespace commit --no-status -m "message #comment " &&
320         commit_msg_is "message #comment"
321 '
322
323 test_expect_success 'message shows author when it is not equal to committer' '
324         echo >>negative &&
325         git commit -e -m "sample" -a &&
326         test_i18ngrep \
327           "^# Author: *A U Thor <author@example.com>\$" \
328           .git/COMMIT_EDITMSG
329 '
330
331 test_expect_success AUTOIDENT 'message shows committer when it is automatic' '
332
333         echo >>negative &&
334         (
335                 sane_unset GIT_COMMITTER_EMAIL &&
336                 sane_unset GIT_COMMITTER_NAME &&
337                 git commit -e -m "sample" -a
338         ) &&
339         # the ident is calculated from the system, so we cannot
340         # check the actual value, only that it is there
341         test_i18ngrep "^# Committer: " .git/COMMIT_EDITMSG
342 '
343
344 write_script .git/FAKE_EDITOR <<EOF
345 echo editor started > "$(pwd)/.git/result"
346 exit 0
347 EOF
348
349 test_expect_success !AUTOIDENT 'do not fire editor when committer is bogus' '
350         >.git/result
351         >expect &&
352
353         echo >>negative &&
354         (
355                 sane_unset GIT_COMMITTER_EMAIL &&
356                 sane_unset GIT_COMMITTER_NAME &&
357                 GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
358                 export GIT_EDITOR &&
359                 test_must_fail git commit -e -m sample -a
360         ) &&
361         test_cmp expect .git/result
362 '
363
364 test_expect_success 'do not fire editor if -m <msg> was given' '
365         echo tick >file &&
366         git add file &&
367         echo "editor not started" >.git/result &&
368         (GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" git commit -m tick) &&
369         test "$(cat .git/result)" = "editor not started"
370 '
371
372 test_expect_success 'do not fire editor if -m "" was given' '
373         echo tock >file &&
374         git add file &&
375         echo "editor not started" >.git/result &&
376         (GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" \
377          git commit -m "" --allow-empty-message) &&
378         test "$(cat .git/result)" = "editor not started"
379 '
380
381 test_expect_success 'do not fire editor in the presence of conflicts' '
382
383         git clean -f &&
384         echo f >g &&
385         git add g &&
386         git commit -m "add g" &&
387         git branch second &&
388         echo master >g &&
389         echo g >h &&
390         git add g h &&
391         git commit -m "modify g and add h" &&
392         git checkout second &&
393         echo second >g &&
394         git add g &&
395         git commit -m second &&
396         # Must fail due to conflict
397         test_must_fail git cherry-pick -n master &&
398         echo "editor not started" >.git/result &&
399         (
400                 GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
401                 export GIT_EDITOR &&
402                 test_must_fail git commit
403         ) &&
404         test "$(cat .git/result)" = "editor not started"
405 '
406
407 write_script .git/FAKE_EDITOR <<EOF
408 # kill -TERM command added below.
409 EOF
410
411 test_expect_success EXECKEEPSPID 'a SIGTERM should break locks' '
412         echo >>negative &&
413         ! "$SHELL_PATH" -c '\''
414           echo kill -TERM $$ >> .git/FAKE_EDITOR
415           GIT_EDITOR=.git/FAKE_EDITOR
416           export GIT_EDITOR
417           exec git commit -a'\'' &&
418         test ! -f .git/index.lock
419 '
420
421 rm -f .git/MERGE_MSG .git/COMMIT_EDITMSG
422 git reset -q --hard
423
424 test_expect_success 'Hand committing of a redundant merge removes dups' '
425
426         git rev-parse second master >expect &&
427         test_must_fail git merge second master &&
428         git checkout master g &&
429         EDITOR=: git commit -a &&
430         git cat-file commit HEAD | sed -n -e "s/^parent //p" -e "/^$/q" >actual &&
431         test_cmp expect actual
432
433 '
434
435 test_expect_success 'A single-liner subject with a token plus colon is not a footer' '
436
437         git reset --hard &&
438         git commit -s -m "hello: kitty" --allow-empty &&
439         git cat-file commit HEAD | sed -e "1,/^$/d" >actual &&
440         test_line_count = 3 actual
441
442 '
443
444 test_expect_success 'commit -s places sob on third line after two empty lines' '
445         git commit -s --allow-empty --allow-empty-message &&
446         cat <<-EOF >expect &&
447
448
449         Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>
450
451         EOF
452         sed -e "/^#/d" -e "s/^:.*//" .git/COMMIT_EDITMSG >actual &&
453         test_cmp expect actual
454 '
455
456 write_script .git/FAKE_EDITOR <<\EOF
457 mv "$1" "$1.orig"
458 (
459         echo message
460         cat "$1.orig"
461 ) >"$1"
462 EOF
463
464 echo '## Custom template' >template
465
466 try_commit () {
467         git reset --hard &&
468         echo >>negative &&
469         GIT_EDITOR=.git/FAKE_EDITOR git commit -a $* $use_template &&
470         case "$use_template" in
471         '')
472                 test_i18ngrep ! "^## Custom template" .git/COMMIT_EDITMSG ;;
473         *)
474                 test_i18ngrep "^## Custom template" .git/COMMIT_EDITMSG ;;
475         esac
476 }
477
478 try_commit_status_combo () {
479
480         test_expect_success 'commit' '
481                 try_commit "" &&
482                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
483         '
484
485         test_expect_success 'commit' '
486                 try_commit "" &&
487                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
488         '
489
490         test_expect_success 'commit --status' '
491                 try_commit --status &&
492                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
493         '
494
495         test_expect_success 'commit --no-status' '
496                 try_commit --no-status &&
497                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
498         '
499
500         test_expect_success 'commit with commit.status = yes' '
501                 test_config commit.status yes &&
502                 try_commit "" &&
503                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
504         '
505
506         test_expect_success 'commit with commit.status = no' '
507                 test_config commit.status no &&
508                 try_commit "" &&
509                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
510         '
511
512         test_expect_success 'commit --status with commit.status = yes' '
513                 test_config commit.status yes &&
514                 try_commit --status &&
515                 test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
516         '
517
518         test_expect_success 'commit --no-status with commit.status = yes' '
519                 test_config commit.status yes &&
520                 try_commit --no-status &&
521                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
522         '
523
524         test_expect_success 'commit --status with commit.status = no' '
525                 test_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                 test_config commit.status no &&
532                 try_commit --no-status &&
533                 test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
534         '
535
536 }
537
538 try_commit_status_combo
539
540 use_template="-t template"
541
542 try_commit_status_combo
543
544 test_expect_success 'commit --status with custom comment character' '
545         test_config core.commentchar ";" &&
546         try_commit --status &&
547         test_i18ngrep "^; Changes to be committed:" .git/COMMIT_EDITMSG
548 '
549
550 test_done