git/t/t7502-commit.sh

617 lines
15 KiB
Bash
Raw Normal View History

#!/bin/sh
test_description='git commit porcelain-ish'
. ./test-lib.sh
commit_msg_is () {
expect=commit_msg_is.expect
actual=commit_msg_is.actual
printf "%s" "$(git log --pretty=format:%s%b -1)" >$actual &&
printf "%s" "$1" >$expect &&
test_i18ncmp $expect $actual
}
# Arguments: [<prefix] [<commit message>] [<commit options>]
check_summary_oneline() {
test_tick &&
git commit ${3+"$3"} -m "$2" | head -1 > act &&
# branch name
SUMMARY_PREFIX="$(git name-rev --name-only HEAD)" &&
# append the "special" prefix, like "root-commit", "detached HEAD"
if test -n "$1"
then
SUMMARY_PREFIX="$SUMMARY_PREFIX ($1)"
fi
# abbrev SHA-1
SUMMARY_POSTFIX="$(git log -1 --pretty='format:%h')"
echo "[$SUMMARY_PREFIX $SUMMARY_POSTFIX] $2" >exp &&
test_i18ncmp exp act
}
test_expect_success 'output summary format' '
echo new >file1 &&
git add file1 &&
check_summary_oneline "root-commit" "initial" &&
echo change >>file1 &&
git add file1
'
test_expect_success 'output summary format: root-commit' '
check_summary_oneline "" "a change"
'
test_expect_success 'output summary format for commit with an empty diff' '
check_summary_oneline "" "empty" "--allow-empty"
'
test_expect_success 'output summary format for merges' '
git checkout -b recursive-base &&
test_commit base file1 &&
git checkout -b recursive-a recursive-base &&
test_commit commit-a file1 &&
git checkout -b recursive-b recursive-base &&
test_commit commit-b file1 &&
# conflict
git checkout recursive-a &&
test_must_fail git merge recursive-b &&
# resolve the conflict
echo commit-a > file1 &&
git add file1 &&
check_summary_oneline "" "Merge"
'
output_tests_cleanup() {
# this is needed for "do not fire editor in the presence of conflicts"
git checkout master &&
# this is needed for the "partial removal" test to pass
git rm file1 &&
git commit -m "cleanup"
}
test_expect_success 'the basics' '
output_tests_cleanup &&
echo doing partial >"commit is" &&
mkdir not &&
echo very much encouraged but we should >not/forbid &&
git add "commit is" not &&
echo update added "commit is" file >"commit is" &&
echo also update another >not/forbid &&
test_tick &&
git commit -a -m "initial with -a" &&
git cat-file blob HEAD:"commit is" >current.1 &&
git cat-file blob HEAD:not/forbid >current.2 &&
cmp current.1 "commit is" &&
cmp current.2 not/forbid
'
test_expect_success 'partial' '
echo another >"commit is" &&
echo another >not/forbid &&
test_tick &&
git commit -m "partial commit to handle a file" "commit is" &&
changed=$(git diff-tree --name-only HEAD^ HEAD) &&
test "$changed" = "commit is"
'
test_expect_success 'partial modification in a subdirectory' '
test_tick &&
git commit -m "partial commit to subdirectory" not &&
changed=$(git diff-tree -r --name-only HEAD^ HEAD) &&
test "$changed" = "not/forbid"
'
test_expect_success 'partial removal' '
git rm not/forbid &&
git commit -m "partial commit to remove not/forbid" not &&
changed=$(git diff-tree -r --name-only HEAD^ HEAD) &&
test "$changed" = "not/forbid" &&
remain=$(git ls-tree -r --name-only HEAD) &&
test "$remain" = "commit is"
'
test_expect_success 'sign off' '
>positive &&
git add positive &&
git commit -s -m "thank you" &&
actual=$(git cat-file commit HEAD | sed -ne "s/Signed-off-by: //p") &&
expected=$(git var GIT_COMMITTER_IDENT | sed -e "s/>.*/>/") &&
test "z$actual" = "z$expected"
'
test_expect_success 'multiple -m' '
>negative &&
git add negative &&
git commit -m "one" -m "two" -m "three" &&
actual=$(git cat-file commit HEAD | sed -e "1,/^\$/d") &&
expected=$(echo one; echo; echo two; echo; echo three) &&
test "z$actual" = "z$expected"
'
test_expect_success 'verbose' '
echo minus >negative &&
git add negative &&
git status -v | sed -ne "/^diff --git /p" >actual &&
echo "diff --git a/negative b/negative" >expect &&
test_cmp expect actual
'
test_expect_success 'verbose respects diff config' '
test_config color.diff always &&
git status -v >actual &&
grep "\[1mdiff --git" actual
'
t7502: demonstrate breakage with a commit message with trailing newlines This test attempts to verify that a commit message supplied to 'git commit' via the -m switch was used in full as the commit message for a commit when --cleanup=verbatim was used. But, this test has been broken since it was introduced. Since the commit message containing trailing newlines was supplied to 'git commit' using a command substitution, the trailing newlines were removed by the shell. This means that a string without any trailing newlines was actually supplied to 'git commit'. The test was able to complete successfully since internally, git appends two newlines to each string supplied via the -m switch. So, the two newlines removed by the shell were then re-added by git, and the resulting commit matched what was expected. So, let's move the initial creation of the commit message string out from within a previous test so that it stands alone. Assign the desired commit message to a variable using literal newlines. Then populate the expect file from the contents of the commit message variable. This way the shell variable becomes the authoritative source of the commit message and can be supplied via the -m switch with the trailing newlines intact. Mark this test as failing, since it is not handled correctly by git. As described above, git appends two extra newlines to every string supplied via -m, even to the ones that already end with a newline. Signed-off-by: Brandon Casey <drafnel@gmail.com> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-19 12:17:05 +08:00
mesg_with_comment_and_newlines='
# text
'
test_expect_success 'prepare file with comment line and trailing newlines' '
printf "%s" "$mesg_with_comment_and_newlines" >expect
'
test_expect_success 'cleanup commit messages (verbatim option,-t)' '
echo >>negative &&
git commit --cleanup=verbatim --no-status -t expect -a &&
git cat-file -p HEAD |sed -e "1,/^\$/d" >actual &&
test_cmp expect actual
'
test_expect_success 'cleanup commit messages (verbatim option,-F)' '
echo >>negative &&
git commit --cleanup=verbatim -F expect -a &&
git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
test_cmp expect actual
'
test_expect_success 'cleanup commit messages (verbatim option,-m)' '
echo >>negative &&
t7502: demonstrate breakage with a commit message with trailing newlines This test attempts to verify that a commit message supplied to 'git commit' via the -m switch was used in full as the commit message for a commit when --cleanup=verbatim was used. But, this test has been broken since it was introduced. Since the commit message containing trailing newlines was supplied to 'git commit' using a command substitution, the trailing newlines were removed by the shell. This means that a string without any trailing newlines was actually supplied to 'git commit'. The test was able to complete successfully since internally, git appends two newlines to each string supplied via the -m switch. So, the two newlines removed by the shell were then re-added by git, and the resulting commit matched what was expected. So, let's move the initial creation of the commit message string out from within a previous test so that it stands alone. Assign the desired commit message to a variable using literal newlines. Then populate the expect file from the contents of the commit message variable. This way the shell variable becomes the authoritative source of the commit message and can be supplied via the -m switch with the trailing newlines intact. Mark this test as failing, since it is not handled correctly by git. As described above, git appends two extra newlines to every string supplied via -m, even to the ones that already end with a newline. Signed-off-by: Brandon Casey <drafnel@gmail.com> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-19 12:17:05 +08:00
git commit --cleanup=verbatim -m "$mesg_with_comment_and_newlines" -a &&
git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
test_cmp expect actual
'
test_expect_success 'cleanup commit messages (whitespace option,-F)' '
echo >>negative &&
{ echo;echo "# text";echo; } >text &&
echo "# text" >expect &&
git commit --cleanup=whitespace -F text -a &&
git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
test_cmp expect actual
'
test_expect_success 'cleanup commit messages (scissors option,-F,-e)' '
echo >>negative &&
cat >text <<EOF &&
# to be kept
# ------------------------ >8 ------------------------
# to be kept, too
# ------------------------ >8 ------------------------
to be removed
# ------------------------ >8 ------------------------
to be removed, too
EOF
cat >expect <<EOF &&
# to be kept
# ------------------------ >8 ------------------------
# to be kept, too
EOF
git commit --cleanup=scissors -e -F text -a &&
git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
test_cmp expect actual
'
test_expect_success 'cleanup commit messages (scissors option,-F,-e, scissors on first line)' '
echo >>negative &&
cat >text <<EOF &&
# ------------------------ >8 ------------------------
to be removed
EOF
git commit --cleanup=scissors -e -F text -a --allow-empty-message &&
git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
test_must_be_empty actual
'
test_expect_success 'cleanup commit messages (strip option,-F)' '
echo >>negative &&
{ echo;echo "# text";echo sample;echo; } >text &&
echo sample >expect &&
git commit --cleanup=strip -F text -a &&
git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
test_cmp expect actual
'
test_expect_success 'cleanup commit messages (strip option,-F,-e)' '
echo >>negative &&
{ echo;echo sample;echo; } >text &&
git commit -e -F text -a &&
head -n 4 .git/COMMIT_EDITMSG >actual
'
echo "sample
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit." >expect
test_expect_success 'cleanup commit messages (strip option,-F,-e): output' '
test_i18ncmp expect actual
'
test_expect_success 'cleanup commit message (fail on invalid cleanup mode option)' '
test_must_fail git commit --cleanup=non-existent
'
test_expect_success 'cleanup commit message (fail on invalid cleanup mode configuration)' '
test_must_fail git -c commit.cleanup=non-existent commit
'
test_expect_success 'cleanup commit message (no config and no option uses default)' '
echo content >>file &&
git add file &&
(
test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
git commit --no-status
) &&
commit_msg_is "commit message"
'
test_expect_success 'cleanup commit message (option overrides default)' '
echo content >>file &&
git add file &&
(
test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
git commit --cleanup=whitespace --no-status
) &&
commit_msg_is "commit message # comment"
'
test_expect_success 'cleanup commit message (config overrides default)' '
echo content >>file &&
git add file &&
(
test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
git -c commit.cleanup=whitespace commit --no-status
) &&
commit_msg_is "commit message # comment"
'
test_expect_success 'cleanup commit message (option overrides config)' '
echo content >>file &&
git add file &&
(
test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
git -c commit.cleanup=whitespace commit --cleanup=default
) &&
commit_msg_is "commit message"
'
test_expect_success 'cleanup commit message (default, -m)' '
echo content >>file &&
git add file &&
git commit -m "message #comment " &&
commit_msg_is "message #comment"
'
test_expect_success 'cleanup commit message (whitespace option, -m)' '
echo content >>file &&
git add file &&
git commit --cleanup=whitespace --no-status -m "message #comment " &&
commit_msg_is "message #comment"
'
test_expect_success 'cleanup commit message (whitespace config, -m)' '
echo content >>file &&
git add file &&
git -c commit.cleanup=whitespace commit --no-status -m "message #comment " &&
commit_msg_is "message #comment"
'
test_expect_success 'message shows author when it is not equal to committer' '
echo >>negative &&
t7502: drop confusing test_might_fail call In t7502.20, we run "git commit" and check that it warns us that the author and committer identity are not the same (this is always the case in the test environment, since we set up the idents differently). Instead of actually making a commit, we have a clean index, so the "git commit" we run will fail. This is marked as might_fail, which is not really correct; it will always fail since there is nothing to commit. However, the only reason not to do a complete commit would be to see the intermediate state of the COMMIT_EDITMSG file when the commit is not completed. We don't need to care about this, though; even a complete commit will leave COMMIT_EDITMSG for us to view. By doing a real commit and dropping the might_fail, we are more robust against other unforeseen failures of "git commit" that might influence our test result. It might seem less robust to depend on the fact that "git commit" leaves COMMIT_EDITMSG in place after a successful commit. However, that brings this test in line with others parts of the script, which make the same assumption. Furthermore, if that ever does change, the right solution is not to prevent commit from completing, but to set EDITOR to a script that will record the contents we see. After all, the point of these tests is to check what the user sees in their EDITOR, so that would be the most direct test. For now, though, we can continue to use the "shortcut" that COMMIT_EDITMSG is left intact. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-07-27 04:31:15 +08:00
git commit -e -m "sample" -a &&
test_i18ngrep \
"^# Author: *A U Thor <author@example.com>\$" \
.git/COMMIT_EDITMSG
'
test_expect_success 'message shows date when it is explicitly set' '
git commit --allow-empty -e -m foo --date="2010-01-02T03:04:05" &&
test_i18ngrep \
"^# Date: *Sat Jan 2 03:04:05 2010 +0000" \
.git/COMMIT_EDITMSG
'
test_expect_success AUTOIDENT 'message shows committer when it is automatic' '
echo >>negative &&
(
sane_unset GIT_COMMITTER_EMAIL &&
sane_unset GIT_COMMITTER_NAME &&
git commit -e -m "sample" -a
) &&
# the ident is calculated from the system, so we cannot
# check the actual value, only that it is there
test_i18ngrep "^# Committer: " .git/COMMIT_EDITMSG
'
write_script .git/FAKE_EDITOR <<EOF
echo editor started > "$(pwd)/.git/result"
exit 0
EOF
test_expect_success !AUTOIDENT 'do not fire editor when committer is bogus' '
>.git/result &&
>expect &&
echo >>negative &&
(
sane_unset GIT_COMMITTER_EMAIL &&
sane_unset GIT_COMMITTER_NAME &&
GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
export GIT_EDITOR &&
test_must_fail git commit -e -m sample -a
) &&
test_cmp expect .git/result
'
test_expect_success 'do not fire editor if -m <msg> was given' '
echo tick >file &&
git add file &&
echo "editor not started" >.git/result &&
(GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" git commit -m tick) &&
test "$(cat .git/result)" = "editor not started"
'
test_expect_success 'do not fire editor if -m "" was given' '
echo tock >file &&
git add file &&
echo "editor not started" >.git/result &&
(GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" \
git commit -m "" --allow-empty-message) &&
test "$(cat .git/result)" = "editor not started"
'
test_expect_success 'do not fire editor in the presence of conflicts' '
git clean -f &&
echo f >g &&
git add g &&
git commit -m "add g" &&
git branch second &&
echo master >g &&
echo g >h &&
git add g h &&
git commit -m "modify g and add h" &&
git checkout second &&
echo second >g &&
git add g &&
git commit -m second &&
# Must fail due to conflict
test_must_fail git cherry-pick -n master &&
echo "editor not started" >.git/result &&
(
GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
export GIT_EDITOR &&
test_must_fail git commit
) &&
test "$(cat .git/result)" = "editor not started"
'
write_script .git/FAKE_EDITOR <<EOF
# kill -TERM command added below.
EOF
test_expect_success EXECKEEPSPID 'a SIGTERM should break locks' '
echo >>negative &&
! "$SHELL_PATH" -c '\''
echo kill -TERM $$ >> .git/FAKE_EDITOR
GIT_EDITOR=.git/FAKE_EDITOR
export GIT_EDITOR
exec git commit -a'\'' &&
test ! -f .git/index.lock
'
rm -f .git/MERGE_MSG .git/COMMIT_EDITMSG
git reset -q --hard
test_expect_success 'Hand committing of a redundant merge removes dups' '
git rev-parse second master >expect &&
test_must_fail git merge second master &&
git checkout master g &&
EDITOR=: git commit -a &&
git cat-file commit HEAD | sed -n -e "s/^parent //p" -e "/^$/q" >actual &&
test_cmp expect actual
'
test_expect_success 'A single-liner subject with a token plus colon is not a footer' '
git reset --hard &&
git commit -s -m "hello: kitty" --allow-empty &&
git cat-file commit HEAD | sed -e "1,/^$/d" >actual &&
test_line_count = 3 actual
'
test_expect_success 'commit -s places sob on third line after two empty lines' '
git commit -s --allow-empty --allow-empty-message &&
cat <<-EOF >expect &&
Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>
EOF
sed -e "/^#/d" -e "s/^:.*//" .git/COMMIT_EDITMSG >actual &&
test_cmp expect actual
'
write_script .git/FAKE_EDITOR <<\EOF
mv "$1" "$1.orig"
(
echo message
cat "$1.orig"
) >"$1"
EOF
echo '## Custom template' >template
try_commit () {
git reset --hard &&
echo >>negative &&
GIT_EDITOR=.git/FAKE_EDITOR git commit -a $* $use_template &&
case "$use_template" in
'')
test_i18ngrep ! "^## Custom template" .git/COMMIT_EDITMSG ;;
*)
test_i18ngrep "^## Custom template" .git/COMMIT_EDITMSG ;;
esac
}
try_commit_status_combo () {
test_expect_success 'commit' '
try_commit "" &&
test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'commit --status' '
try_commit --status &&
test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'commit --no-status' '
try_commit --no-status &&
test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'commit with commit.status = yes' '
test_config commit.status yes &&
try_commit "" &&
test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'commit with commit.status = no' '
test_config commit.status no &&
try_commit "" &&
test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'commit --status with commit.status = yes' '
test_config commit.status yes &&
try_commit --status &&
test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'commit --no-status with commit.status = yes' '
test_config commit.status yes &&
try_commit --no-status &&
test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'commit --status with commit.status = no' '
test_config commit.status no &&
try_commit --status &&
test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'commit --no-status with commit.status = no' '
test_config commit.status no &&
try_commit --no-status &&
test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
'
}
try_commit_status_combo
use_template="-t template"
try_commit_status_combo
test_expect_success 'commit --status with custom comment character' '
test_config core.commentchar ";" &&
try_commit --status &&
test_i18ngrep "^; Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'switch core.commentchar' '
test_commit "#foo" foo &&
GIT_EDITOR=.git/FAKE_EDITOR git -c core.commentChar=auto commit --amend &&
test_i18ngrep "^; Changes to be committed:" .git/COMMIT_EDITMSG
'
test_expect_success 'switch core.commentchar but out of options' '
cat >text <<\EOF &&
# 1
; 2
@ 3
! 4
$ 5
% 6
^ 7
& 8
| 9
: 10
EOF
git commit --amend -F text &&
(
test_set_editor .git/FAKE_EDITOR &&
test_must_fail git -c core.commentChar=auto commit --amend
)
'
test_done