[thirdparty/git.git] / t / t7500-commit.sh

#!/bin/sh
#
# Copyright (c) 2007 Steven Grimm
#

test_description='git commit

Tests for selected commit options.'

. ./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)" >$expect &&
	printf "%s" "$1" >$actual &&
	test_i18ncmp $expect $actual
}

# A sanity check to see if commit is working at all.
test_expect_success 'a basic commit in an empty tree should succeed' '
	echo content > foo &&
	git add foo &&
	git commit -m "initial commit"
'

test_expect_success 'nonexistent template file should return error' '
	echo changes >> foo &&
	git add foo &&
	(
		GIT_EDITOR="echo hello >\"\$1\"" &&
		export GIT_EDITOR &&
		test_must_fail git commit --template "$PWD"/notexist
	)
'

test_expect_success 'nonexistent template file in config should return error' '
	test_config commit.template "$PWD"/notexist &&
	(
		GIT_EDITOR="echo hello >\"\$1\"" &&
		export GIT_EDITOR &&
		test_must_fail git commit
	)
'

# From now on we'll use a template file that exists.
TEMPLATE="$PWD"/template

test_expect_success 'unedited template should not commit' '
	echo "template line" > "$TEMPLATE" &&
	test_must_fail git commit --template "$TEMPLATE"
'

test_expect_success 'unedited template with comments should not commit' '
	echo "# comment in template" >> "$TEMPLATE" &&
	test_must_fail git commit --template "$TEMPLATE"
'

test_expect_success 'a Signed-off-by line by itself should not commit' '
	(
		test_set_editor "$TEST_DIRECTORY"/t7500/add-signed-off &&
		test_must_fail git commit --template "$TEMPLATE"
	)
'

test_expect_success 'adding comments to a template should not commit' '
	(
		test_set_editor "$TEST_DIRECTORY"/t7500/add-comments &&
		test_must_fail git commit --template "$TEMPLATE"
	)
'

test_expect_success 'adding real content to a template should commit' '
	(
		test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
		git commit --template "$TEMPLATE"
	) &&
	commit_msg_is "template linecommit message"
'

test_expect_success '-t option should be short for --template' '
	echo "short template" > "$TEMPLATE" &&
	echo "new content" >> foo &&
	git add foo &&
	(
		test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
		git commit -t "$TEMPLATE"
	) &&
	commit_msg_is "short templatecommit message"
'

test_expect_success 'config-specified template should commit' '
	echo "new template" > "$TEMPLATE" &&
	test_config commit.template "$TEMPLATE" &&
	echo "more content" >> foo &&
	git add foo &&
	(
		test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
		git commit
	) &&
	commit_msg_is "new templatecommit message"
'

test_expect_success 'explicit commit message should override template' '
	echo "still more content" >> foo &&
	git add foo &&
	GIT_EDITOR="$TEST_DIRECTORY"/t7500/add-content git commit --template "$TEMPLATE" \
		-m "command line msg" &&
	commit_msg_is "command line msg"
'

test_expect_success 'commit message from file should override template' '
	echo "content galore" >> foo &&
	git add foo &&
	echo "standard input msg" |
	(
		test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
		git commit --template "$TEMPLATE" --file -
	) &&
	commit_msg_is "standard input msg"
'

cat >"$TEMPLATE" <<\EOF


### template

EOF
test_expect_success 'commit message from template with whitespace issue' '
	echo "content galore" >>foo &&
	git add foo &&
	GIT_EDITOR="$TEST_DIRECTORY"/t7500/add-whitespaced-content git commit \
		--template "$TEMPLATE" &&
	commit_msg_is "commit message"
'

test_expect_success 'using alternate GIT_INDEX_FILE (1)' '

	cp .git/index saved-index &&
	(
		echo some new content >file &&
	        GIT_INDEX_FILE=.git/another_index &&
		export GIT_INDEX_FILE &&
		git add file &&
		git commit -m "commit using another index" &&
		git diff-index --exit-code HEAD &&
		git diff-files --exit-code
	) &&
	cmp .git/index saved-index >/dev/null

'

test_expect_success 'using alternate GIT_INDEX_FILE (2)' '

	cp .git/index saved-index &&
	(
		rm -f .git/no-such-index &&
		GIT_INDEX_FILE=.git/no-such-index &&
		export GIT_INDEX_FILE &&
		git commit -m "commit using nonexistent index" &&
		test -z "$(git ls-files)" &&
		test -z "$(git ls-tree HEAD)"

	) &&
	cmp .git/index saved-index >/dev/null
'

cat > expect << EOF
zort

Signed-off-by: C O Mitter <committer@example.com>
EOF

test_expect_success '--signoff' '
	echo "yet another content *narf*" >> foo &&
	echo "zort" | git commit -s -F - foo &&
	git cat-file commit HEAD | sed "1,/^\$/d" > output &&
	test_cmp expect output
'

test_expect_success 'commit message from file (1)' '
	mkdir subdir &&
	echo "Log in top directory" >log &&
	echo "Log in sub directory" >subdir/log &&
	(
		cd subdir &&
		git commit --allow-empty -F log
	) &&
	commit_msg_is "Log in sub directory"
'

test_expect_success 'commit message from file (2)' '
	rm -f log &&
	echo "Log in sub directory" >subdir/log &&
	(
		cd subdir &&
		git commit --allow-empty -F log
	) &&
	commit_msg_is "Log in sub directory"
'

test_expect_success 'commit message from stdin' '
	(
		cd subdir &&
		echo "Log with foo word" | git commit --allow-empty -F -
	) &&
	commit_msg_is "Log with foo word"
'

test_expect_success 'commit -F overrides -t' '
	(
		cd subdir &&
		echo "-F log" > f.log &&
		echo "-t template" > t.template &&
		git commit --allow-empty -F f.log -t t.template
	) &&
	commit_msg_is "-F log"
'

test_expect_success 'Commit without message is allowed with --allow-empty-message' '
	echo "more content" >>foo &&
	git add foo &&
	>empty &&
	git commit --allow-empty-message <empty &&
	commit_msg_is ""
'

test_expect_success 'Commit without message is no-no without --allow-empty-message' '
	echo "more content" >>foo &&
	git add foo &&
	>empty &&
	test_must_fail git commit <empty
'

test_expect_success 'Commit a message with --allow-empty-message' '
	echo "even more content" >>foo &&
	git add foo &&
	git commit --allow-empty-message -m"hello there" &&
	commit_msg_is "hello there"
'

commit_for_rebase_autosquash_setup () {
	echo "first content line" >>foo &&
	git add foo &&
	cat >log <<EOF &&
target message subject line

target message body line 1
target message body line 2
EOF
	git commit -F log &&
	echo "second content line" >>foo &&
	git add foo &&
	git commit -m "intermediate commit" &&
	echo "third content line" >>foo &&
	git add foo
}

test_expect_success 'commit --fixup provides correct one-line commit message' '
	commit_for_rebase_autosquash_setup &&
	git commit --fixup HEAD~1 &&
	commit_msg_is "fixup! target message subject line"
'

test_expect_success 'commit --squash works with -F' '
	commit_for_rebase_autosquash_setup &&
	echo "log message from file" >msgfile &&
	git commit --squash HEAD~1 -F msgfile  &&
	commit_msg_is "squash! target message subject linelog message from file"
'

test_expect_success 'commit --squash works with -m' '
	commit_for_rebase_autosquash_setup &&
	git commit --squash HEAD~1 -m "foo bar\nbaz" &&
	commit_msg_is "squash! target message subject linefoo bar\nbaz"
'

test_expect_success 'commit --squash works with -C' '
	commit_for_rebase_autosquash_setup &&
	git commit --squash HEAD~1 -C HEAD &&
	commit_msg_is "squash! target message subject lineintermediate commit"
'

test_expect_success 'commit --squash works with -c' '
	commit_for_rebase_autosquash_setup &&
	test_set_editor "$TEST_DIRECTORY"/t7500/edit-content &&
	git commit --squash HEAD~1 -c HEAD &&
	commit_msg_is "squash! target message subject lineedited commit"
'

test_expect_success 'commit --squash works with -C for same commit' '
	commit_for_rebase_autosquash_setup &&
	git commit --squash HEAD -C HEAD &&
	commit_msg_is "squash! intermediate commit"
'

test_expect_success 'commit --squash works with -c for same commit' '
	commit_for_rebase_autosquash_setup &&
	test_set_editor "$TEST_DIRECTORY"/t7500/edit-content &&
	git commit --squash HEAD -c HEAD &&
	commit_msg_is "squash! edited commit"
'

test_expect_success 'commit --squash works with editor' '
	commit_for_rebase_autosquash_setup &&
	test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
	git commit --squash HEAD~1 &&
	commit_msg_is "squash! target message subject linecommit message"
'

test_expect_success 'invalid message options when using --fixup' '
	echo changes >>foo &&
	echo "message" >log &&
	git add foo &&
	test_must_fail git commit --fixup HEAD~1 --squash HEAD~2 &&
	test_must_fail git commit --fixup HEAD~1 -C HEAD~2 &&
	test_must_fail git commit --fixup HEAD~1 -c HEAD~2 &&
	test_must_fail git commit --fixup HEAD~1 -m "cmdline message" &&
	test_must_fail git commit --fixup HEAD~1 -F log
'

test_done
Commit	Line	Data
d1cc130a SG	1	#!/bin/sh
	2	#
	3	# Copyright (c) 2007 Steven Grimm
	4	#
	5
47a528ad	6	test_description='git commit
d1cc130a SG	7
	8	Tests for selected commit options.'
	9
	10	. ./test-lib.sh
	11
	12	commit_msg_is () {
d5a719e4 ÆAB	13	expect=commit_msg_is.expect
	14	actual=commit_msg_is.actual
	15
	16	printf "%s" "$(git log --pretty=format:%s%b -1)" >$expect &&
	17	printf "%s" "$1" >$actual &&
29853c82	18	test_i18ncmp $expect $actual
d1cc130a SG	19	}
	20
	21	# A sanity check to see if commit is working at all.
	22	test_expect_success 'a basic commit in an empty tree should succeed' '
	23	echo content > foo &&
	24	git add foo &&
	25	git commit -m "initial commit"
	26	'
	27
	28	test_expect_success 'nonexistent template file should return error' '
	29	echo changes >> foo &&
	30	git add foo &&
2140b140 JN	31	(
	32	GIT_EDITOR="echo hello >\"\$1\"" &&
	33	export GIT_EDITOR &&
	34	test_must_fail git commit --template "$PWD"/notexist
	35	)
d1cc130a SG	36	'
	37
	38	test_expect_success 'nonexistent template file in config should return error' '
22179b30	39	test_config commit.template "$PWD"/notexist &&
2140b140 JN	40	(
	41	GIT_EDITOR="echo hello >\"\$1\"" &&
	42	export GIT_EDITOR &&
	43	test_must_fail git commit
	44	)
d1cc130a SG	45	'
	46
	47	# From now on we'll use a template file that exists.
	48	TEMPLATE="$PWD"/template
	49
	50	test_expect_success 'unedited template should not commit' '
	51	echo "template line" > "$TEMPLATE" &&
d492b31c	52	test_must_fail git commit --template "$TEMPLATE"
d1cc130a SG	53	'
	54
	55	test_expect_success 'unedited template with comments should not commit' '
	56	echo "# comment in template" >> "$TEMPLATE" &&
d492b31c	57	test_must_fail git commit --template "$TEMPLATE"
d1cc130a SG	58	'
	59
	60	test_expect_success 'a Signed-off-by line by itself should not commit' '
bfdbee98 JH	61	(
	62	test_set_editor "$TEST_DIRECTORY"/t7500/add-signed-off &&
	63	test_must_fail git commit --template "$TEMPLATE"
	64	)
d1cc130a SG	65	'
	66
	67	test_expect_success 'adding comments to a template should not commit' '
bfdbee98 JH	68	(
	69	test_set_editor "$TEST_DIRECTORY"/t7500/add-comments &&
	70	test_must_fail git commit --template "$TEMPLATE"
	71	)
d1cc130a SG	72	'
d1cc130a SG	73
29853c82	74	test_expect_success 'adding real content to a template should commit' '
bfdbee98 JH	75	(
	76	test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
	77	git commit --template "$TEMPLATE"
	78	) &&
d1cc130a SG	79	commit_msg_is "template linecommit message"
	80	'
	81
29853c82	82	test_expect_success '-t option should be short for --template' '
d1cc130a SG	83	echo "short template" > "$TEMPLATE" &&
	84	echo "new content" >> foo &&
	85	git add foo &&
bfdbee98 JH	86	(
	87	test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
	88	git commit -t "$TEMPLATE"
	89	) &&
d1cc130a SG	90	commit_msg_is "short templatecommit message"
	91	'
	92
29853c82	93	test_expect_success 'config-specified template should commit' '
d1cc130a	94	echo "new template" > "$TEMPLATE" &&
22179b30	95	test_config commit.template "$TEMPLATE" &&
d1cc130a SG	96	echo "more content" >> foo &&
d1cc130a SG	97	git add foo &&
bfdbee98 JH	98	(
	99	test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
	100	git commit
	101	) &&
d1cc130a SG	102	commit_msg_is "new templatecommit message"
	103	'
	104
	105	test_expect_success 'explicit commit message should override template' '
	106	echo "still more content" >> foo &&
	107	git add foo &&
bfdbee98	108	GIT_EDITOR="$TEST_DIRECTORY"/t7500/add-content git commit --template "$TEMPLATE" \
d1cc130a	109	-m "command line msg" &&
55246aac	110	commit_msg_is "command line msg"
d1cc130a SG	111	'
	112
	113	test_expect_success 'commit message from file should override template' '
	114	echo "content galore" >> foo &&
	115	git add foo &&
	116	echo "standard input msg" \|
bfdbee98 JH	117	(
	118	test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
	119	git commit --template "$TEMPLATE" --file -
	120	) &&
55246aac	121	commit_msg_is "standard input msg"
d1cc130a SG	122	'
d1cc130a SG	123
8b1ae678 BF	124	cat >"$TEMPLATE" <<\EOF
	125
	126
	127	### template
	128
	129	EOF
	130	test_expect_success 'commit message from template with whitespace issue' '
	131	echo "content galore" >>foo &&
	132	git add foo &&
	133	GIT_EDITOR="$TEST_DIRECTORY"/t7500/add-whitespaced-content git commit \
	134	--template "$TEMPLATE" &&
	135	commit_msg_is "commit message"
	136	'
	137
859a4dbc RV	138	test_expect_success 'using alternate GIT_INDEX_FILE (1)' '
	139
	140	cp .git/index saved-index &&
	141	(
	142	echo some new content >file &&
	143	GIT_INDEX_FILE=.git/another_index &&
	144	export GIT_INDEX_FILE &&
	145	git add file &&
	146	git commit -m "commit using another index" &&
	147	git diff-index --exit-code HEAD &&
	148	git diff-files --exit-code
	149	) &&
	150	cmp .git/index saved-index >/dev/null
	151
	152	'
	153
	154	test_expect_success 'using alternate GIT_INDEX_FILE (2)' '
	155
	156	cp .git/index saved-index &&
	157	(
	158	rm -f .git/no-such-index &&
	159	GIT_INDEX_FILE=.git/no-such-index &&
	160	export GIT_INDEX_FILE &&
	161	git commit -m "commit using nonexistent index" &&
	162	test -z "$(git ls-files)" &&
	163	test -z "$(git ls-tree HEAD)"
	164
	165	) &&
	166	cmp .git/index saved-index >/dev/null
13208572	167	'
859a4dbc	168
13208572 JS	169	cat > expect << EOF
13208572 JS	170	zort
2150554b	171
13208572 JS	172	Signed-off-by: C O Mitter <committer@example.com>
	173	EOF
	174
	175	test_expect_success '--signoff' '
	176	echo "yet another content narf" >> foo &&
7eb5bbdb	177	echo "zort" \| git commit -s -F - foo &&
9524cf29	178	git cat-file commit HEAD \| sed "1,/^\$/d" > output &&
bfdbee98	179	test_cmp expect output
859a4dbc RV	180	'
859a4dbc RV	181
dbd0f5c7 JH	182	test_expect_success 'commit message from file (1)' '
	183	mkdir subdir &&
	184	echo "Log in top directory" >log &&
	185	echo "Log in sub directory" >subdir/log &&
	186	(
	187	cd subdir &&
	188	git commit --allow-empty -F log
	189	) &&
	190	commit_msg_is "Log in sub directory"
	191	'
	192
	193	test_expect_success 'commit message from file (2)' '
	194	rm -f log &&
	195	echo "Log in sub directory" >subdir/log &&
	196	(
	197	cd subdir &&
	198	git commit --allow-empty -F log
	199	) &&
	200	commit_msg_is "Log in sub directory"
	201	'
	202
	203	test_expect_success 'commit message from stdin' '
	204	(
	205	cd subdir &&
	206	echo "Log with foo word" \| git commit --allow-empty -F -
	207	) &&
	208	commit_msg_is "Log with foo word"
	209	'
	210
aae94ffb SB	211	test_expect_success 'commit -F overrides -t' '
	212	(
	213	cd subdir &&
	214	echo "-F log" > f.log &&
	215	echo "-t template" > t.template &&
	216	git commit --allow-empty -F f.log -t t.template
	217	) &&
	218	commit_msg_is "-F log"
	219	'
	220
c9b5fde7 ÆAB	221	test_expect_success 'Commit without message is allowed with --allow-empty-message' '
	222	echo "more content" >>foo &&
	223	git add foo &&
	224	>empty &&
	225	git commit --allow-empty-message <empty &&
	226	commit_msg_is ""
	227	'
	228
	229	test_expect_success 'Commit without message is no-no without --allow-empty-message' '
	230	echo "more content" >>foo &&
	231	git add foo &&
	232	>empty &&
	233	test_must_fail git commit <empty
	234	'
	235
	236	test_expect_success 'Commit a message with --allow-empty-message' '
	237	echo "even more content" >>foo &&
	238	git add foo &&
	239	git commit --allow-empty-message -m"hello there" &&
	240	commit_msg_is "hello there"
	241	'
	242
b1a6c0a9 PN	243	commit_for_rebase_autosquash_setup () {
	244	echo "first content line" >>foo &&
	245	git add foo &&
	246	cat >log <<EOF &&
	247	target message subject line
	248
	249	target message body line 1
	250	target message body line 2
	251	EOF
	252	git commit -F log &&
	253	echo "second content line" >>foo &&
	254	git add foo &&
	255	git commit -m "intermediate commit" &&
	256	echo "third content line" >>foo &&
	257	git add foo
	258	}
	259
	260	test_expect_success 'commit --fixup provides correct one-line commit message' '
	261	commit_for_rebase_autosquash_setup &&
	262	git commit --fixup HEAD~1 &&
	263	commit_msg_is "fixup! target message subject line"
	264	'
	265
7951bd30 PN	266	test_expect_success 'commit --squash works with -F' '
	267	commit_for_rebase_autosquash_setup &&
	268	echo "log message from file" >msgfile &&
	269	git commit --squash HEAD~1 -F msgfile &&
	270	commit_msg_is "squash! target message subject linelog message from file"
	271	'
	272
	273	test_expect_success 'commit --squash works with -m' '
	274	commit_for_rebase_autosquash_setup &&
	275	git commit --squash HEAD~1 -m "foo bar\nbaz" &&
	276	commit_msg_is "squash! target message subject linefoo bar\nbaz"
	277	'
	278
	279	test_expect_success 'commit --squash works with -C' '
	280	commit_for_rebase_autosquash_setup &&
	281	git commit --squash HEAD~1 -C HEAD &&
	282	commit_msg_is "squash! target message subject lineintermediate commit"
	283	'
	284
	285	test_expect_success 'commit --squash works with -c' '
	286	commit_for_rebase_autosquash_setup &&
	287	test_set_editor "$TEST_DIRECTORY"/t7500/edit-content &&
	288	git commit --squash HEAD~1 -c HEAD &&
	289	commit_msg_is "squash! target message subject lineedited commit"
	290	'
	291
	292	test_expect_success 'commit --squash works with -C for same commit' '
	293	commit_for_rebase_autosquash_setup &&
	294	git commit --squash HEAD -C HEAD &&
	295	commit_msg_is "squash! intermediate commit"
	296	'
	297
	298	test_expect_success 'commit --squash works with -c for same commit' '
	299	commit_for_rebase_autosquash_setup &&
	300	test_set_editor "$TEST_DIRECTORY"/t7500/edit-content &&
	301	git commit --squash HEAD -c HEAD &&
	302	commit_msg_is "squash! edited commit"
	303	'
	304
29853c82	305	test_expect_success 'commit --squash works with editor' '
7951bd30 PN	306	commit_for_rebase_autosquash_setup &&
	307	test_set_editor "$TEST_DIRECTORY"/t7500/add-content &&
	308	git commit --squash HEAD~1 &&
	309	commit_msg_is "squash! target message subject linecommit message"
	310	'
	311
b1a6c0a9 PN	312	test_expect_success 'invalid message options when using --fixup' '
	313	echo changes >>foo &&
	314	echo "message" >log &&
	315	git add foo &&
7951bd30	316	test_must_fail git commit --fixup HEAD~1 --squash HEAD~2 &&
b1a6c0a9 PN	317	test_must_fail git commit --fixup HEAD~1 -C HEAD~2 &&
	318	test_must_fail git commit --fixup HEAD~1 -c HEAD~2 &&
	319	test_must_fail git commit --fixup HEAD~1 -m "cmdline message" &&
	320	test_must_fail git commit --fixup HEAD~1 -F log
	321	'
	322
d1cc130a	323	test_done