t/t3507-cherry-pick-conflict.sh - git - Git at Google

 #!/bin/sh

 test_description='test cherry-pick and revert with conflicts

   -
   + picked: rewrites foo to c
   + base: rewrites foo to b
   + initial: writes foo as a, unrelated as unrelated

 '

 GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME

 TEST_CREATE_REPO_NO_TEMPLATE=1
 . ./test-lib.sh

 pristine_detach () {
 	git checkout -f "$1^0" &&
 	git read-tree -u --reset HEAD &&
 	git clean -d -f -f -q -x
 }

 test_expect_success setup '

 	echo unrelated >unrelated &&
 	git add unrelated &&
 	test_commit initial foo a &&
 	test_commit base foo b &&
 	test_commit picked foo c &&
 	test_commit --signoff picked-signed foo d &&
 	git checkout -b topic initial &&
 	test_commit redundant-pick foo c redundant &&
 	git commit --allow-empty --allow-empty-message &&
 	git tag empty &&
 	git checkout main &&
 	git config advice.detachedhead false

 '

 test_expect_success 'failed cherry-pick does not advance HEAD' '
 	pristine_detach initial &&

 	head=$(git rev-parse HEAD) &&
 	test_must_fail git cherry-pick picked &&
 	newhead=$(git rev-parse HEAD) &&

 	test "$head" = "$newhead"
 '

 test_expect_success 'advice from failed cherry-pick' '
 	pristine_detach initial &&

 	picked=$(git rev-parse --short picked) &&
 	cat <<-EOF >expected &&
 	error: could not apply $picked... picked
 	hint: After resolving the conflicts, mark them with
 	hint: "git add/rm <pathspec>", then run
 	hint: "git cherry-pick --continue".
 	hint: You can instead skip this commit with "git cherry-pick --skip".
 	hint: To abort and get back to the state before "git cherry-pick",
 	hint: run "git cherry-pick --abort".
 	EOF
 	test_must_fail git cherry-pick picked 2>actual &&

 	test_cmp expected actual
 '

 test_expect_success 'advice from failed cherry-pick --no-commit' "
 	pristine_detach initial &&

 	picked=\$(git rev-parse --short picked) &&
 	cat <<-EOF >expected &&
 	error: could not apply \$picked... picked
 	hint: after resolving the conflicts, mark the corrected paths
 	hint: with 'git add <paths>' or 'git rm <paths>'
 	EOF
 	test_must_fail git cherry-pick --no-commit picked 2>actual &&

 	test_cmp expected actual
 "

 test_expect_success 'failed cherry-pick sets CHERRY_PICK_HEAD' '
 	pristine_detach initial &&
 	test_must_fail git cherry-pick picked &&
 	test_cmp_rev picked CHERRY_PICK_HEAD
 '

 test_expect_success 'successful cherry-pick does not set CHERRY_PICK_HEAD' '
 	pristine_detach initial &&
 	git cherry-pick base &&
 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
 '

 test_expect_success 'cherry-pick --no-commit does not set CHERRY_PICK_HEAD' '
 	pristine_detach initial &&
 	git cherry-pick --no-commit base &&
 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
 '

 test_expect_success 'cherry-pick w/dirty tree does not set CHERRY_PICK_HEAD' '
 	pristine_detach initial &&
 	echo foo >foo &&
 	test_must_fail git cherry-pick base &&
 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
 '

 test_expect_success \
 	'cherry-pick --strategy=resolve w/dirty tree does not set CHERRY_PICK_HEAD' '
 	pristine_detach initial &&
 	echo foo >foo &&
 	test_must_fail git cherry-pick --strategy=resolve base &&
 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
 '

 test_expect_success 'GIT_CHERRY_PICK_HELP suppresses CHERRY_PICK_HEAD' '
 	pristine_detach initial &&
 	(
 		GIT_CHERRY_PICK_HELP="and then do something else" &&
 		export GIT_CHERRY_PICK_HELP &&
 		test_must_fail git cherry-pick picked
 	) &&
 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
 '

 test_expect_success 'git reset clears CHERRY_PICK_HEAD' '
 	pristine_detach initial &&

 	test_must_fail git cherry-pick picked &&
 	git reset &&

 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
 '

 test_expect_success 'failed commit does not clear CHERRY_PICK_HEAD' '
 	pristine_detach initial &&

 	test_must_fail git cherry-pick picked &&
 	test_must_fail git commit &&

 	test_cmp_rev picked CHERRY_PICK_HEAD
 '

 test_expect_success 'cancelled commit does not clear CHERRY_PICK_HEAD' '
 	pristine_detach initial &&

 	test_must_fail git cherry-pick picked &&
 	echo resolved >foo &&
 	git add foo &&
 	git update-index --refresh -q &&
 	test_must_fail git diff-index --exit-code HEAD &&
 	(
 		GIT_EDITOR=false &&
 		export GIT_EDITOR &&
 		test_must_fail git commit
 	) &&

 	test_cmp_rev picked CHERRY_PICK_HEAD
 '

 test_expect_success 'successful commit clears CHERRY_PICK_HEAD' '
 	pristine_detach initial &&

 	test_must_fail git cherry-pick picked &&
 	echo resolved >foo &&
 	git add foo &&
 	git commit &&

 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
 '

 test_expect_success 'partial commit of cherry-pick fails' '
 	pristine_detach initial &&

 	test_must_fail git cherry-pick picked &&
 	echo resolved >foo &&
 	git add foo &&
 	test_must_fail git commit foo 2>err &&

 	test_i18ngrep "cannot do a partial commit during a cherry-pick." err
 '

 test_expect_success 'commit --amend of cherry-pick fails' '
 	pristine_detach initial &&

 	test_must_fail git cherry-pick picked &&
 	echo resolved >foo &&
 	git add foo &&
 	test_must_fail git commit --amend 2>err &&

 	test_i18ngrep "in the middle of a cherry-pick -- cannot amend." err
 '

 test_expect_success 'successful final commit clears cherry-pick state' '
 	pristine_detach initial &&

 	test_must_fail git cherry-pick base picked-signed &&
 	echo resolved >foo &&
 	test_path_is_file .git/sequencer/todo &&
 	git commit -a &&
 	test_path_is_missing .git/sequencer
 '

 test_expect_success 'reset after final pick clears cherry-pick state' '
 	pristine_detach initial &&

 	test_must_fail git cherry-pick base picked-signed &&
 	echo resolved >foo &&
 	test_path_is_file .git/sequencer/todo &&
 	git reset &&
 	test_path_is_missing .git/sequencer
 '

 test_expect_success 'failed cherry-pick produces dirty index' '
 	pristine_detach initial &&

 	test_must_fail git cherry-pick picked &&

 	test_must_fail git update-index --refresh -q &&
 	test_must_fail git diff-index --exit-code HEAD
 '

 test_expect_success 'failed cherry-pick registers participants in index' '
 	pristine_detach initial &&
 	{
 		git checkout base -- foo &&
 		git ls-files --stage foo &&
 		git checkout initial -- foo &&
 		git ls-files --stage foo &&
 		git checkout picked -- foo &&
 		git ls-files --stage foo
 	} >stages &&
 	sed "
 		1 s/ 0	/ 1	/
 		2 s/ 0	/ 2	/
 		3 s/ 0	/ 3	/
 	" stages >expected &&
 	git read-tree -u --reset HEAD &&

 	test_must_fail git cherry-pick picked &&
 	git ls-files --stage --unmerged >actual &&

 	test_cmp expected actual
 '

 test_expect_success \
 	'cherry-pick conflict, ensure commit.cleanup = scissors places scissors line properly' '
 	pristine_detach initial &&
 	git config commit.cleanup scissors &&
 	cat <<-EOF >expected &&
 		picked

 		# ------------------------ >8 ------------------------
 		# Do not modify or remove the line above.
 		# Everything below it will be ignored.
 		#
 		# Conflicts:
 		#	foo
 		EOF

 	test_must_fail git cherry-pick picked &&

 	test_cmp expected .git/MERGE_MSG
 '

 test_expect_success \
 	'cherry-pick conflict, ensure cleanup=scissors places scissors line properly' '
 	pristine_detach initial &&
 	git config --unset commit.cleanup &&
 	cat <<-EOF >expected &&
 		picked

 		# ------------------------ >8 ------------------------
 		# Do not modify or remove the line above.
 		# Everything below it will be ignored.
 		#
 		# Conflicts:
 		#	foo
 		EOF

 	test_must_fail git cherry-pick --cleanup=scissors picked &&

 	test_cmp expected .git/MERGE_MSG
 '

 test_expect_success 'failed cherry-pick describes conflict in work tree' '
 	pristine_detach initial &&
 	cat <<-EOF >expected &&
 	<<<<<<< HEAD
 	a
 	=======
 	c
 	>>>>>>> objid (picked)
 	EOF

 	test_must_fail git cherry-pick picked &&

 	sed "s/[a-f0-9]* (/objid (/" foo >actual &&
 	test_cmp expected actual
 '

 test_expect_success 'diff3 -m style' '
 	pristine_detach initial &&
 	git config merge.conflictstyle diff3 &&
 	cat <<-EOF >expected &&
 	<<<<<<< HEAD
 	a
 	||||||| parent of objid (picked)
 	b
 	=======
 	c
 	>>>>>>> objid (picked)
 	EOF

 	test_must_fail git cherry-pick picked &&

 	sed "s/[a-f0-9]* (/objid (/" foo >actual &&
 	test_cmp expected actual
 '

 test_expect_success 'revert also handles conflicts sanely' '
 	git config --unset merge.conflictstyle &&
 	pristine_detach initial &&
 	cat <<-EOF >expected &&
 	<<<<<<< HEAD
 	a
 	=======
 	b
 	>>>>>>> parent of objid (picked)
 	EOF
 	{
 		git checkout picked -- foo &&
 		git ls-files --stage foo &&
 		git checkout initial -- foo &&
 		git ls-files --stage foo &&
 		git checkout base -- foo &&
 		git ls-files --stage foo
 	} >stages &&
 	sed "
 		1 s/ 0	/ 1	/
 		2 s/ 0	/ 2	/
 		3 s/ 0	/ 3	/
 	" stages >expected-stages &&
 	git read-tree -u --reset HEAD &&

 	head=$(git rev-parse HEAD) &&
 	test_must_fail git revert picked &&
 	newhead=$(git rev-parse HEAD) &&
 	git ls-files --stage --unmerged >actual-stages &&

 	test "$head" = "$newhead" &&
 	test_must_fail git update-index --refresh -q &&
 	test_must_fail git diff-index --exit-code HEAD &&
 	test_cmp expected-stages actual-stages &&
 	sed "s/[a-f0-9]* (/objid (/" foo >actual &&
 	test_cmp expected actual
 '

 test_expect_success 'failed revert sets REVERT_HEAD' '
 	pristine_detach initial &&
 	test_must_fail git revert picked &&
 	test_cmp_rev picked REVERT_HEAD
 '

 test_expect_success 'successful revert does not set REVERT_HEAD' '
 	pristine_detach base &&
 	git revert base &&
 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD &&
 	test_must_fail git rev-parse --verify REVERT_HEAD
 '

 test_expect_success 'revert --no-commit sets REVERT_HEAD' '
 	pristine_detach base &&
 	git revert --no-commit base &&
 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD &&
 	test_cmp_rev base REVERT_HEAD
 '

 test_expect_success 'revert w/dirty tree does not set REVERT_HEAD' '
 	pristine_detach base &&
 	echo foo >foo &&
 	test_must_fail git revert base &&
 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD &&
 	test_must_fail git rev-parse --verify REVERT_HEAD
 '

 test_expect_success 'GIT_CHERRY_PICK_HELP does not suppress REVERT_HEAD' '
 	pristine_detach initial &&
 	(
 		GIT_CHERRY_PICK_HELP="and then do something else" &&
 		GIT_REVERT_HELP="and then do something else, again" &&
 		export GIT_CHERRY_PICK_HELP GIT_REVERT_HELP &&
 		test_must_fail git revert picked
 	) &&
 	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD &&
 	test_cmp_rev picked REVERT_HEAD
 '

 test_expect_success 'git reset clears REVERT_HEAD' '
 	pristine_detach initial &&
 	test_must_fail git revert picked &&
 	git reset &&
 	test_must_fail git rev-parse --verify REVERT_HEAD
 '

 test_expect_success 'failed commit does not clear REVERT_HEAD' '
 	pristine_detach initial &&
 	test_must_fail git revert picked &&
 	test_must_fail git commit &&
 	test_cmp_rev picked REVERT_HEAD
 '

 test_expect_success 'successful final commit clears revert state' '
 	pristine_detach picked-signed &&

 	test_must_fail git revert picked-signed base &&
 	echo resolved >foo &&
 	test_path_is_file .git/sequencer/todo &&
 	git commit -a &&
 	test_path_is_missing .git/sequencer
 '

 test_expect_success 'reset after final pick clears revert state' '
 	pristine_detach picked-signed &&

 	test_must_fail git revert picked-signed base &&
 	echo resolved >foo &&
 	test_path_is_file .git/sequencer/todo &&
 	git reset &&
 	test_path_is_missing .git/sequencer
 '

 test_expect_success 'revert conflict, diff3 -m style' '
 	pristine_detach initial &&
 	git config merge.conflictstyle diff3 &&
 	cat <<-EOF >expected &&
 	<<<<<<< HEAD
 	a
 	||||||| objid (picked)
 	c
 	=======
 	b
 	>>>>>>> parent of objid (picked)
 	EOF

 	test_must_fail git revert picked &&

 	sed "s/[a-f0-9]* (/objid (/" foo >actual &&
 	test_cmp expected actual
 '

 test_expect_success \
 	'revert conflict, ensure commit.cleanup = scissors places scissors line properly' '
 	pristine_detach initial &&
 	git config commit.cleanup scissors &&
 	cat >expected <<-EOF &&
 		Revert "picked"

 		This reverts commit OBJID.

 		# ------------------------ >8 ------------------------
 		# Do not modify or remove the line above.
 		# Everything below it will be ignored.
 		#
 		# Conflicts:
 		#	foo
 		EOF

 	test_must_fail git revert picked &&

 	sed "s/$OID_REGEX/OBJID/" .git/MERGE_MSG >actual &&
 	test_cmp expected actual
 '

 test_expect_success \
 	'revert conflict, ensure cleanup=scissors places scissors line properly' '
 	pristine_detach initial &&
 	git config --unset commit.cleanup &&
 	cat >expected <<-EOF &&
 		Revert "picked"

 		This reverts commit OBJID.

 		# ------------------------ >8 ------------------------
 		# Do not modify or remove the line above.
 		# Everything below it will be ignored.
 		#
 		# Conflicts:
 		#	foo
 		EOF

 	test_must_fail git revert --cleanup=scissors picked &&

 	sed "s/$OID_REGEX/OBJID/" .git/MERGE_MSG >actual &&
 	test_cmp expected actual
 '

 test_expect_success 'failed cherry-pick does not forget -s' '
 	pristine_detach initial &&
 	test_must_fail git cherry-pick -s picked &&
 	test_i18ngrep -e "Signed-off-by" .git/MERGE_MSG
 '

 test_expect_success 'commit after failed cherry-pick does not add duplicated -s' '
 	pristine_detach initial &&
 	test_must_fail git cherry-pick -s picked-signed &&
 	git commit -a -s &&
 	test $(git show -s >tmp && grep -c "Signed-off-by" tmp && rm tmp) = 1
 '

 test_expect_success 'commit after failed cherry-pick adds -s at the right place' '
 	pristine_detach initial &&
 	test_must_fail git cherry-pick picked &&

 	git commit -a -s &&

 	# Do S-o-b and Conflicts appear in the right order?
 	cat <<-\EOF >expect &&
 	Signed-off-by: C O Mitter <committer@example.com>
 	# Conflicts:
 	EOF
 	grep -e "^# Conflicts:" -e "^Signed-off-by" .git/COMMIT_EDITMSG >actual &&
 	test_cmp expect actual &&

 	cat <<-\EOF >expected &&
 	picked

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

 	git show -s --pretty=format:%B >actual &&
 	test_cmp expected actual
 '

 test_expect_success 'commit --amend -s places the sign-off at the right place' '
 	pristine_detach initial &&
 	test_must_fail git cherry-pick picked &&

 	# emulate old-style conflicts block
 	mv .git/MERGE_MSG .git/MERGE_MSG+ &&
 	sed -e "/^# Conflicts:/,\$s/^# *//" .git/MERGE_MSG+ >.git/MERGE_MSG &&

 	git commit -a &&
 	git commit --amend -s &&

 	# Do S-o-b and Conflicts appear in the right order?
 	cat <<-\EOF >expect &&
 	Signed-off-by: C O Mitter <committer@example.com>
 	Conflicts:
 	EOF
 	grep -e "^Conflicts:" -e "^Signed-off-by" .git/COMMIT_EDITMSG >actual &&
 	test_cmp expect actual
 '

 test_expect_success 'cherry-pick preserves sparse-checkout' '
 	pristine_detach initial &&
 	test_config core.sparseCheckout true &&
 	test_when_finished "
 		echo \"/*\" >.git/info/sparse-checkout
 		git read-tree --reset -u HEAD
 		rm .git/info/sparse-checkout" &&
 	mkdir .git/info &&
 	echo /unrelated >.git/info/sparse-checkout &&
 	git read-tree --reset -u HEAD &&
 	test_must_fail git cherry-pick -Xours picked>actual &&
 	test_i18ngrep ! "Changes not staged for commit:" actual
 '

 test_expect_success 'cherry-pick --continue remembers --keep-redundant-commits' '
 	test_when_finished "git cherry-pick --abort || :" &&
 	pristine_detach initial &&
 	test_must_fail git cherry-pick --keep-redundant-commits picked redundant &&
 	echo c >foo &&
 	git add foo &&
 	git cherry-pick --continue
 '

 test_expect_success 'cherry-pick --continue remembers --allow-empty and --allow-empty-message' '
 	test_when_finished "git cherry-pick --abort || :" &&
 	pristine_detach initial &&
 	test_must_fail git cherry-pick --allow-empty --allow-empty-message \
 				       picked empty &&
 	echo c >foo &&
 	git add foo &&
 	git cherry-pick --continue
 '

 test_done
	#!/bin/sh

	test_description='test cherry-pick and revert with conflicts

	-
	+ picked: rewrites foo to c
	+ base: rewrites foo to b
	+ initial: writes foo as a, unrelated as unrelated

	'

	GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
	export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME

	TEST_CREATE_REPO_NO_TEMPLATE=1
	. ./test-lib.sh

	pristine_detach () {
	git checkout -f "$1^0" &&
	git read-tree -u --reset HEAD &&
	git clean -d -f -f -q -x
	}

	test_expect_success setup '

	echo unrelated >unrelated &&
	git add unrelated &&
	test_commit initial foo a &&
	test_commit base foo b &&
	test_commit picked foo c &&
	test_commit --signoff picked-signed foo d &&
	git checkout -b topic initial &&
	test_commit redundant-pick foo c redundant &&
	git commit --allow-empty --allow-empty-message &&
	git tag empty &&
	git checkout main &&
	git config advice.detachedhead false

	'

	test_expect_success 'failed cherry-pick does not advance HEAD' '
	pristine_detach initial &&

	head=$(git rev-parse HEAD) &&
	test_must_fail git cherry-pick picked &&
	newhead=$(git rev-parse HEAD) &&

	test "$head" = "$newhead"
	'

	test_expect_success 'advice from failed cherry-pick' '
	pristine_detach initial &&

	picked=$(git rev-parse --short picked) &&
	cat <<-EOF >expected &&
	error: could not apply $picked... picked
	hint: After resolving the conflicts, mark them with
	hint: "git add/rm <pathspec>", then run
	hint: "git cherry-pick --continue".
	hint: You can instead skip this commit with "git cherry-pick --skip".
	hint: To abort and get back to the state before "git cherry-pick",
	hint: run "git cherry-pick --abort".
	EOF
	test_must_fail git cherry-pick picked 2>actual &&

	test_cmp expected actual
	'

	test_expect_success 'advice from failed cherry-pick --no-commit' "
	pristine_detach initial &&

	picked=\$(git rev-parse --short picked) &&
	cat <<-EOF >expected &&
	error: could not apply \$picked... picked
	hint: after resolving the conflicts, mark the corrected paths
	hint: with 'git add <paths>' or 'git rm <paths>'
	EOF
	test_must_fail git cherry-pick --no-commit picked 2>actual &&

	test_cmp expected actual
	"

	test_expect_success 'failed cherry-pick sets CHERRY_PICK_HEAD' '
	pristine_detach initial &&
	test_must_fail git cherry-pick picked &&
	test_cmp_rev picked CHERRY_PICK_HEAD
	'

	test_expect_success 'successful cherry-pick does not set CHERRY_PICK_HEAD' '
	pristine_detach initial &&
	git cherry-pick base &&
	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
	'

	test_expect_success 'cherry-pick --no-commit does not set CHERRY_PICK_HEAD' '
	pristine_detach initial &&
	git cherry-pick --no-commit base &&
	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
	'

	test_expect_success 'cherry-pick w/dirty tree does not set CHERRY_PICK_HEAD' '
	pristine_detach initial &&
	echo foo >foo &&
	test_must_fail git cherry-pick base &&
	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
	'

	test_expect_success \
	'cherry-pick --strategy=resolve w/dirty tree does not set CHERRY_PICK_HEAD' '
	pristine_detach initial &&
	echo foo >foo &&
	test_must_fail git cherry-pick --strategy=resolve base &&
	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
	'

	test_expect_success 'GIT_CHERRY_PICK_HELP suppresses CHERRY_PICK_HEAD' '
	pristine_detach initial &&
	(
	GIT_CHERRY_PICK_HELP="and then do something else" &&
	export GIT_CHERRY_PICK_HELP &&
	test_must_fail git cherry-pick picked
	) &&
	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
	'

	test_expect_success 'git reset clears CHERRY_PICK_HEAD' '
	pristine_detach initial &&

	test_must_fail git cherry-pick picked &&
	git reset &&

	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
	'

	test_expect_success 'failed commit does not clear CHERRY_PICK_HEAD' '
	pristine_detach initial &&

	test_must_fail git cherry-pick picked &&
	test_must_fail git commit &&

	test_cmp_rev picked CHERRY_PICK_HEAD
	'

	test_expect_success 'cancelled commit does not clear CHERRY_PICK_HEAD' '
	pristine_detach initial &&

	test_must_fail git cherry-pick picked &&
	echo resolved >foo &&
	git add foo &&
	git update-index --refresh -q &&
	test_must_fail git diff-index --exit-code HEAD &&
	(
	GIT_EDITOR=false &&
	export GIT_EDITOR &&
	test_must_fail git commit
	) &&

	test_cmp_rev picked CHERRY_PICK_HEAD
	'

	test_expect_success 'successful commit clears CHERRY_PICK_HEAD' '
	pristine_detach initial &&

	test_must_fail git cherry-pick picked &&
	echo resolved >foo &&
	git add foo &&
	git commit &&

	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD
	'

	test_expect_success 'partial commit of cherry-pick fails' '
	pristine_detach initial &&

	test_must_fail git cherry-pick picked &&
	echo resolved >foo &&
	git add foo &&
	test_must_fail git commit foo 2>err &&

	test_i18ngrep "cannot do a partial commit during a cherry-pick." err
	'

	test_expect_success 'commit --amend of cherry-pick fails' '
	pristine_detach initial &&

	test_must_fail git cherry-pick picked &&
	echo resolved >foo &&
	git add foo &&
	test_must_fail git commit --amend 2>err &&

	test_i18ngrep "in the middle of a cherry-pick -- cannot amend." err
	'

	test_expect_success 'successful final commit clears cherry-pick state' '
	pristine_detach initial &&

	test_must_fail git cherry-pick base picked-signed &&
	echo resolved >foo &&
	test_path_is_file .git/sequencer/todo &&
	git commit -a &&
	test_path_is_missing .git/sequencer
	'

	test_expect_success 'reset after final pick clears cherry-pick state' '
	pristine_detach initial &&

	test_must_fail git cherry-pick base picked-signed &&
	echo resolved >foo &&
	test_path_is_file .git/sequencer/todo &&
	git reset &&
	test_path_is_missing .git/sequencer
	'

	test_expect_success 'failed cherry-pick produces dirty index' '
	pristine_detach initial &&

	test_must_fail git cherry-pick picked &&

	test_must_fail git update-index --refresh -q &&
	test_must_fail git diff-index --exit-code HEAD
	'

	test_expect_success 'failed cherry-pick registers participants in index' '
	pristine_detach initial &&
	{
	git checkout base -- foo &&
	git ls-files --stage foo &&
	git checkout initial -- foo &&
	git ls-files --stage foo &&
	git checkout picked -- foo &&
	git ls-files --stage foo
	} >stages &&
	sed "
	1 s/ 0 / 1 /
	2 s/ 0 / 2 /
	3 s/ 0 / 3 /
	" stages >expected &&
	git read-tree -u --reset HEAD &&

	test_must_fail git cherry-pick picked &&
	git ls-files --stage --unmerged >actual &&

	test_cmp expected actual
	'

	test_expect_success \
	'cherry-pick conflict, ensure commit.cleanup = scissors places scissors line properly' '
	pristine_detach initial &&
	git config commit.cleanup scissors &&
	cat <<-EOF >expected &&
	picked

	# ------------------------ >8 ------------------------
	# Do not modify or remove the line above.
	# Everything below it will be ignored.
	#
	# Conflicts:
	# foo
	EOF

	test_must_fail git cherry-pick picked &&

	test_cmp expected .git/MERGE_MSG
	'

	test_expect_success \
	'cherry-pick conflict, ensure cleanup=scissors places scissors line properly' '
	pristine_detach initial &&
	git config --unset commit.cleanup &&
	cat <<-EOF >expected &&
	picked

	# ------------------------ >8 ------------------------
	# Do not modify or remove the line above.
	# Everything below it will be ignored.
	#
	# Conflicts:
	# foo
	EOF

	test_must_fail git cherry-pick --cleanup=scissors picked &&

	test_cmp expected .git/MERGE_MSG
	'

	test_expect_success 'failed cherry-pick describes conflict in work tree' '
	pristine_detach initial &&
	cat <<-EOF >expected &&
	<<<<<<< HEAD
	a
	=======
	c
	>>>>>>> objid (picked)
	EOF

	test_must_fail git cherry-pick picked &&

	sed "s/[a-f0-9]* (/objid (/" foo >actual &&
	test_cmp expected actual
	'

	test_expect_success 'diff3 -m style' '
	pristine_detach initial &&
	git config merge.conflictstyle diff3 &&
	cat <<-EOF >expected &&
	<<<<<<< HEAD
	a
	\|\|\|\|\|\|\| parent of objid (picked)
	b
	=======
	c
	>>>>>>> objid (picked)
	EOF

	test_must_fail git cherry-pick picked &&

	sed "s/[a-f0-9]* (/objid (/" foo >actual &&
	test_cmp expected actual
	'

	test_expect_success 'revert also handles conflicts sanely' '
	git config --unset merge.conflictstyle &&
	pristine_detach initial &&
	cat <<-EOF >expected &&
	<<<<<<< HEAD
	a
	=======
	b
	>>>>>>> parent of objid (picked)
	EOF
	{
	git checkout picked -- foo &&
	git ls-files --stage foo &&
	git checkout initial -- foo &&
	git ls-files --stage foo &&
	git checkout base -- foo &&
	git ls-files --stage foo
	} >stages &&
	sed "
	1 s/ 0 / 1 /
	2 s/ 0 / 2 /
	3 s/ 0 / 3 /
	" stages >expected-stages &&
	git read-tree -u --reset HEAD &&

	head=$(git rev-parse HEAD) &&
	test_must_fail git revert picked &&
	newhead=$(git rev-parse HEAD) &&
	git ls-files --stage --unmerged >actual-stages &&

	test "$head" = "$newhead" &&
	test_must_fail git update-index --refresh -q &&
	test_must_fail git diff-index --exit-code HEAD &&
	test_cmp expected-stages actual-stages &&
	sed "s/[a-f0-9]* (/objid (/" foo >actual &&
	test_cmp expected actual
	'

	test_expect_success 'failed revert sets REVERT_HEAD' '
	pristine_detach initial &&
	test_must_fail git revert picked &&
	test_cmp_rev picked REVERT_HEAD
	'

	test_expect_success 'successful revert does not set REVERT_HEAD' '
	pristine_detach base &&
	git revert base &&
	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD &&
	test_must_fail git rev-parse --verify REVERT_HEAD
	'

	test_expect_success 'revert --no-commit sets REVERT_HEAD' '
	pristine_detach base &&
	git revert --no-commit base &&
	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD &&
	test_cmp_rev base REVERT_HEAD
	'

	test_expect_success 'revert w/dirty tree does not set REVERT_HEAD' '
	pristine_detach base &&
	echo foo >foo &&
	test_must_fail git revert base &&
	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD &&
	test_must_fail git rev-parse --verify REVERT_HEAD
	'

	test_expect_success 'GIT_CHERRY_PICK_HELP does not suppress REVERT_HEAD' '
	pristine_detach initial &&
	(
	GIT_CHERRY_PICK_HELP="and then do something else" &&
	GIT_REVERT_HELP="and then do something else, again" &&
	export GIT_CHERRY_PICK_HELP GIT_REVERT_HELP &&
	test_must_fail git revert picked
	) &&
	test_must_fail git rev-parse --verify CHERRY_PICK_HEAD &&
	test_cmp_rev picked REVERT_HEAD
	'

	test_expect_success 'git reset clears REVERT_HEAD' '
	pristine_detach initial &&
	test_must_fail git revert picked &&
	git reset &&
	test_must_fail git rev-parse --verify REVERT_HEAD
	'

	test_expect_success 'failed commit does not clear REVERT_HEAD' '
	pristine_detach initial &&
	test_must_fail git revert picked &&
	test_must_fail git commit &&
	test_cmp_rev picked REVERT_HEAD
	'

	test_expect_success 'successful final commit clears revert state' '
	pristine_detach picked-signed &&

	test_must_fail git revert picked-signed base &&
	echo resolved >foo &&
	test_path_is_file .git/sequencer/todo &&
	git commit -a &&
	test_path_is_missing .git/sequencer
	'

	test_expect_success 'reset after final pick clears revert state' '
	pristine_detach picked-signed &&

	test_must_fail git revert picked-signed base &&
	echo resolved >foo &&
	test_path_is_file .git/sequencer/todo &&
	git reset &&
	test_path_is_missing .git/sequencer
	'

	test_expect_success 'revert conflict, diff3 -m style' '
	pristine_detach initial &&
	git config merge.conflictstyle diff3 &&
	cat <<-EOF >expected &&
	<<<<<<< HEAD
	a
	\|\|\|\|\|\|\| objid (picked)
	c
	=======
	b
	>>>>>>> parent of objid (picked)
	EOF

	test_must_fail git revert picked &&

	sed "s/[a-f0-9]* (/objid (/" foo >actual &&
	test_cmp expected actual
	'

	test_expect_success \
	'revert conflict, ensure commit.cleanup = scissors places scissors line properly' '
	pristine_detach initial &&
	git config commit.cleanup scissors &&
	cat >expected <<-EOF &&
	Revert "picked"

	This reverts commit OBJID.

	# ------------------------ >8 ------------------------
	# Do not modify or remove the line above.
	# Everything below it will be ignored.
	#
	# Conflicts:
	# foo
	EOF

	test_must_fail git revert picked &&

	sed "s/$OID_REGEX/OBJID/" .git/MERGE_MSG >actual &&
	test_cmp expected actual
	'

	test_expect_success \
	'revert conflict, ensure cleanup=scissors places scissors line properly' '
	pristine_detach initial &&
	git config --unset commit.cleanup &&
	cat >expected <<-EOF &&
	Revert "picked"

	This reverts commit OBJID.

	# ------------------------ >8 ------------------------
	# Do not modify or remove the line above.
	# Everything below it will be ignored.
	#
	# Conflicts:
	# foo
	EOF

	test_must_fail git revert --cleanup=scissors picked &&

	sed "s/$OID_REGEX/OBJID/" .git/MERGE_MSG >actual &&
	test_cmp expected actual
	'

	test_expect_success 'failed cherry-pick does not forget -s' '
	pristine_detach initial &&
	test_must_fail git cherry-pick -s picked &&
	test_i18ngrep -e "Signed-off-by" .git/MERGE_MSG
	'

	test_expect_success 'commit after failed cherry-pick does not add duplicated -s' '
	pristine_detach initial &&
	test_must_fail git cherry-pick -s picked-signed &&
	git commit -a -s &&
	test $(git show -s >tmp && grep -c "Signed-off-by" tmp && rm tmp) = 1
	'

	test_expect_success 'commit after failed cherry-pick adds -s at the right place' '
	pristine_detach initial &&
	test_must_fail git cherry-pick picked &&

	git commit -a -s &&

	# Do S-o-b and Conflicts appear in the right order?
	cat <<-\EOF >expect &&
	Signed-off-by: C O Mitter <committer@example.com>
	# Conflicts:
	EOF
	grep -e "^# Conflicts:" -e "^Signed-off-by" .git/COMMIT_EDITMSG >actual &&
	test_cmp expect actual &&

	cat <<-\EOF >expected &&
	picked

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

	git show -s --pretty=format:%B >actual &&
	test_cmp expected actual
	'

	test_expect_success 'commit --amend -s places the sign-off at the right place' '
	pristine_detach initial &&
	test_must_fail git cherry-pick picked &&

	# emulate old-style conflicts block
	mv .git/MERGE_MSG .git/MERGE_MSG+ &&
	sed -e "/^# Conflicts:/,\$s/^# *//" .git/MERGE_MSG+ >.git/MERGE_MSG &&

	git commit -a &&
	git commit --amend -s &&

	# Do S-o-b and Conflicts appear in the right order?
	cat <<-\EOF >expect &&
	Signed-off-by: C O Mitter <committer@example.com>
	Conflicts:
	EOF
	grep -e "^Conflicts:" -e "^Signed-off-by" .git/COMMIT_EDITMSG >actual &&
	test_cmp expect actual
	'

	test_expect_success 'cherry-pick preserves sparse-checkout' '
	pristine_detach initial &&
	test_config core.sparseCheckout true &&
	test_when_finished "
	echo \"/*\" >.git/info/sparse-checkout
	git read-tree --reset -u HEAD
	rm .git/info/sparse-checkout" &&
	mkdir .git/info &&
	echo /unrelated >.git/info/sparse-checkout &&
	git read-tree --reset -u HEAD &&
	test_must_fail git cherry-pick -Xours picked>actual &&
	test_i18ngrep ! "Changes not staged for commit:" actual
	'

	test_expect_success 'cherry-pick --continue remembers --keep-redundant-commits' '
	test_when_finished "git cherry-pick --abort \|\| :" &&
	pristine_detach initial &&
	test_must_fail git cherry-pick --keep-redundant-commits picked redundant &&
	echo c >foo &&
	git add foo &&
	git cherry-pick --continue
	'

	test_expect_success 'cherry-pick --continue remembers --allow-empty and --allow-empty-message' '
	test_when_finished "git cherry-pick --abort \|\| :" &&
	pristine_detach initial &&
	test_must_fail git cherry-pick --allow-empty --allow-empty-message \
	picked empty &&
	echo c >foo &&
	git add foo &&
	git cherry-pick --continue
	'

	test_done