[thirdparty/git.git] / t / t7800-difftool.sh

#!/bin/sh
#
# Copyright (c) 2009, 2010 David Aguilar
#

test_description='git-difftool

Testing basic diff tool invocation
'

. ./test-lib.sh

if ! test_have_prereq PERL; then
	skip_all='skipping difftool tests, perl not available'
	test_done
fi

LF='
'

remove_config_vars()
{
	# Unset all config variables used by git-difftool
	git config --unset diff.tool
	git config --unset diff.guitool
	git config --unset difftool.test-tool.cmd
	git config --unset difftool.prompt
	git config --unset merge.tool
	git config --unset mergetool.test-tool.cmd
	git config --unset mergetool.prompt
	return 0
}

restore_test_defaults()
{
	# Restores the test defaults used by several tests
	remove_config_vars
	unset GIT_DIFF_TOOL
	unset GIT_DIFFTOOL_PROMPT
	unset GIT_DIFFTOOL_NO_PROMPT
	git config diff.tool test-tool &&
	git config difftool.test-tool.cmd 'cat $LOCAL'
	git config difftool.bogus-tool.cmd false
}

prompt_given()
{
	prompt="$1"
	test "$prompt" = "Hit return to launch 'test-tool': branch"
}

# Create a file on master and change it on branch
test_expect_success 'setup' '
	echo master >file &&
	git add file &&
	git commit -m "added file" &&

	git checkout -b branch master &&
	echo branch >file &&
	git commit -a -m "branch changed file" &&
	git checkout master
'

# Configure a custom difftool.<tool>.cmd and use it
test_expect_success 'custom commands' '
	restore_test_defaults &&
	git config difftool.test-tool.cmd "cat \$REMOTE" &&

	diff=$(git difftool --no-prompt branch) &&
	test "$diff" = "master" &&

	restore_test_defaults &&
	diff=$(git difftool --no-prompt branch) &&
	test "$diff" = "branch"
'

# Ensures that git-difftool ignores bogus --tool values
test_expect_success 'difftool ignores bad --tool values' '
	diff=$(git difftool --no-prompt --tool=bad-tool branch)
	test "$?" = 1 &&
	test "$diff" = ""
'

test_expect_success 'difftool honors --gui' '
	git config merge.tool bogus-tool &&
	git config diff.tool bogus-tool &&
	git config diff.guitool test-tool &&

	diff=$(git difftool --no-prompt --gui branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults
'

test_expect_success 'difftool --gui works without configured diff.guitool' '
	git config diff.tool test-tool &&

	diff=$(git difftool --no-prompt --gui branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults
'

# Specify the diff tool using $GIT_DIFF_TOOL
test_expect_success 'GIT_DIFF_TOOL variable' '
	git config --unset diff.tool
	GIT_DIFF_TOOL=test-tool &&
	export GIT_DIFF_TOOL &&

	diff=$(git difftool --no-prompt branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults
'

# Test the $GIT_*_TOOL variables and ensure
# that $GIT_DIFF_TOOL always wins unless --tool is specified
test_expect_success 'GIT_DIFF_TOOL overrides' '
	git config diff.tool bogus-tool &&
	git config merge.tool bogus-tool &&

	GIT_DIFF_TOOL=test-tool &&
	export GIT_DIFF_TOOL &&

	diff=$(git difftool --no-prompt branch) &&
	test "$diff" = "branch" &&

	GIT_DIFF_TOOL=bogus-tool &&
	export GIT_DIFF_TOOL &&

	diff=$(git difftool --no-prompt --tool=test-tool branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults
'

# Test that we don't have to pass --no-prompt to difftool
# when $GIT_DIFFTOOL_NO_PROMPT is true
test_expect_success 'GIT_DIFFTOOL_NO_PROMPT variable' '
	GIT_DIFFTOOL_NO_PROMPT=true &&
	export GIT_DIFFTOOL_NO_PROMPT &&

	diff=$(git difftool branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults
'

# git-difftool supports the difftool.prompt variable.
# Test that GIT_DIFFTOOL_PROMPT can override difftool.prompt = false
test_expect_success 'GIT_DIFFTOOL_PROMPT variable' '
	git config difftool.prompt false &&
	GIT_DIFFTOOL_PROMPT=true &&
	export GIT_DIFFTOOL_PROMPT &&

	prompt=$(echo | git difftool branch | tail -1) &&
	prompt_given "$prompt" &&

	restore_test_defaults
'

# Test that we don't have to pass --no-prompt when difftool.prompt is false
test_expect_success 'difftool.prompt config variable is false' '
	git config difftool.prompt false &&

	diff=$(git difftool branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults
'

# Test that we don't have to pass --no-prompt when mergetool.prompt is false
test_expect_success 'difftool merge.prompt = false' '
	git config --unset difftool.prompt
	git config mergetool.prompt false &&

	diff=$(git difftool branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults
'

# Test that the -y flag can override difftool.prompt = true
test_expect_success 'difftool.prompt can overridden with -y' '
	git config difftool.prompt true &&

	diff=$(git difftool -y branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults
'

# Test that the --prompt flag can override difftool.prompt = false
test_expect_success 'difftool.prompt can overridden with --prompt' '
	git config difftool.prompt false &&

	prompt=$(echo | git difftool --prompt branch | tail -1) &&
	prompt_given "$prompt" &&

	restore_test_defaults
'

# Test that the last flag passed on the command-line wins
test_expect_success 'difftool last flag wins' '
	diff=$(git difftool --prompt --no-prompt branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults &&

	prompt=$(echo | git difftool --no-prompt --prompt branch | tail -1) &&
	prompt_given "$prompt" &&

	restore_test_defaults
'

# git-difftool falls back to git-mergetool config variables
# so test that behavior here
test_expect_success 'difftool + mergetool config variables' '
	remove_config_vars
	git config merge.tool test-tool &&
	git config mergetool.test-tool.cmd "cat \$LOCAL" &&

	diff=$(git difftool --no-prompt branch) &&
	test "$diff" = "branch" &&

	# set merge.tool to something bogus, diff.tool to test-tool
	git config merge.tool bogus-tool &&
	git config diff.tool test-tool &&

	diff=$(git difftool --no-prompt branch) &&
	test "$diff" = "branch" &&

	restore_test_defaults
'

test_expect_success 'difftool.<tool>.path' '
	git config difftool.tkdiff.path echo &&
	diff=$(git difftool --tool=tkdiff --no-prompt branch) &&
	git config --unset difftool.tkdiff.path &&
	lines=$(echo "$diff" | grep file | wc -l) &&
	test "$lines" -eq 1 &&

	restore_test_defaults
'

test_expect_success 'difftool --extcmd=cat' '
	diff=$(git difftool --no-prompt --extcmd=cat branch) &&
	test "$diff" = branch"$LF"master
'

test_expect_success 'difftool --extcmd cat' '
	diff=$(git difftool --no-prompt --extcmd cat branch) &&
	test "$diff" = branch"$LF"master
'

test_expect_success 'difftool -x cat' '
	diff=$(git difftool --no-prompt -x cat branch) &&
	test "$diff" = branch"$LF"master
'

test_expect_success 'difftool --extcmd echo arg1' '
	diff=$(git difftool --no-prompt --extcmd sh\ -c\ \"echo\ \$1\" branch)
	test "$diff" = file
'

test_expect_success 'difftool --extcmd cat arg1' '
	diff=$(git difftool --no-prompt --extcmd sh\ -c\ \"cat\ \$1\" branch)
	test "$diff" = master
'

test_expect_success 'difftool --extcmd cat arg2' '
	diff=$(git difftool --no-prompt --extcmd sh\ -c\ \"cat\ \$2\" branch)
	test "$diff" = branch
'

test_done
Commit	Line	Data
f92f2038 DA	1	#!/bin/sh
f92f2038 DA	2	#
c8a5672e	3	# Copyright (c) 2009, 2010 David Aguilar
f92f2038 DA	4	#
	5
	6	test_description='git-difftool
	7
	8	Testing basic diff tool invocation
	9	'
	10
	11	. ./test-lib.sh
	12
a7668294	13	if ! test_have_prereq PERL; then
fadb5156	14	skip_all='skipping difftool tests, perl not available'
a7668294 JK	15	test_done
	16	fi
	17
a9e11220 DA	18	LF='
	19	'
	20
f92f2038 DA	21	remove_config_vars()
	22	{
	23	# Unset all config variables used by git-difftool
	24	git config --unset diff.tool
4cefa495	25	git config --unset diff.guitool
f92f2038	26	git config --unset difftool.test-tool.cmd
a904392e	27	git config --unset difftool.prompt
f92f2038 DA	28	git config --unset merge.tool
f92f2038 DA	29	git config --unset mergetool.test-tool.cmd
a88183f1	30	git config --unset mergetool.prompt
f92f2038 DA	31	return 0
	32	}
	33
	34	restore_test_defaults()
	35	{
	36	# Restores the test defaults used by several tests
	37	remove_config_vars
	38	unset GIT_DIFF_TOOL
a904392e	39	unset GIT_DIFFTOOL_PROMPT
f92f2038 DA	40	unset GIT_DIFFTOOL_NO_PROMPT
	41	git config diff.tool test-tool &&
	42	git config difftool.test-tool.cmd 'cat $LOCAL'
23218bbd	43	git config difftool.bogus-tool.cmd false
f92f2038 DA	44	}
f92f2038 DA	45
a904392e DA	46	prompt_given()
	47	{
	48	prompt="$1"
	49	test "$prompt" = "Hit return to launch 'test-tool': branch"
	50	}
	51
f92f2038 DA	52	# Create a file on master and change it on branch
	53	test_expect_success 'setup' '
	54	echo master >file &&
	55	git add file &&
	56	git commit -m "added file" &&
	57
	58	git checkout -b branch master &&
	59	echo branch >file &&
	60	git commit -a -m "branch changed file" &&
	61	git checkout master
	62	'
	63
	64	# Configure a custom difftool.<tool>.cmd and use it
	65	test_expect_success 'custom commands' '
	66	restore_test_defaults &&
	67	git config difftool.test-tool.cmd "cat \$REMOTE" &&
	68
	69	diff=$(git difftool --no-prompt branch) &&
	70	test "$diff" = "master" &&
	71
	72	restore_test_defaults &&
	73	diff=$(git difftool --no-prompt branch) &&
	74	test "$diff" = "branch"
	75	'
	76
	77	# Ensures that git-difftool ignores bogus --tool values
	78	test_expect_success 'difftool ignores bad --tool values' '
23218bbd	79	diff=$(git difftool --no-prompt --tool=bad-tool branch)
f92f2038 DA	80	test "$?" = 1 &&
	81	test "$diff" = ""
	82	'
	83
4cefa495 DA	84	test_expect_success 'difftool honors --gui' '
	85	git config merge.tool bogus-tool &&
	86	git config diff.tool bogus-tool &&
	87	git config diff.guitool test-tool &&
	88
	89	diff=$(git difftool --no-prompt --gui branch) &&
	90	test "$diff" = "branch" &&
	91
	92	restore_test_defaults
	93	'
	94
42accaec DA	95	test_expect_success 'difftool --gui works without configured diff.guitool' '
	96	git config diff.tool test-tool &&
	97
	98	diff=$(git difftool --no-prompt --gui branch) &&
	99	test "$diff" = "branch" &&
	100
	101	restore_test_defaults
	102	'
	103
f92f2038 DA	104	# Specify the diff tool using $GIT_DIFF_TOOL
	105	test_expect_success 'GIT_DIFF_TOOL variable' '
	106	git config --unset diff.tool
	107	GIT_DIFF_TOOL=test-tool &&
	108	export GIT_DIFF_TOOL &&
	109
	110	diff=$(git difftool --no-prompt branch) &&
	111	test "$diff" = "branch" &&
	112
	113	restore_test_defaults
	114	'
	115
	116	# Test the $GIT_*_TOOL variables and ensure
	117	# that $GIT_DIFF_TOOL always wins unless --tool is specified
	118	test_expect_success 'GIT_DIFF_TOOL overrides' '
	119	git config diff.tool bogus-tool &&
	120	git config merge.tool bogus-tool &&
	121
f92f2038	122	GIT_DIFF_TOOL=test-tool &&
f92f2038 DA	123	export GIT_DIFF_TOOL &&
	124
	125	diff=$(git difftool --no-prompt branch) &&
	126	test "$diff" = "branch" &&
	127
	128	GIT_DIFF_TOOL=bogus-tool &&
	129	export GIT_DIFF_TOOL &&
	130
	131	diff=$(git difftool --no-prompt --tool=test-tool branch) &&
	132	test "$diff" = "branch" &&
	133
	134	restore_test_defaults
	135	'
	136
	137	# Test that we don't have to pass --no-prompt to difftool
	138	# when $GIT_DIFFTOOL_NO_PROMPT is true
	139	test_expect_success 'GIT_DIFFTOOL_NO_PROMPT variable' '
	140	GIT_DIFFTOOL_NO_PROMPT=true &&
	141	export GIT_DIFFTOOL_NO_PROMPT &&
	142
	143	diff=$(git difftool branch) &&
	144	test "$diff" = "branch" &&
	145
	146	restore_test_defaults
	147	'
	148
a904392e DA	149	# git-difftool supports the difftool.prompt variable.
	150	# Test that GIT_DIFFTOOL_PROMPT can override difftool.prompt = false
	151	test_expect_success 'GIT_DIFFTOOL_PROMPT variable' '
	152	git config difftool.prompt false &&
	153	GIT_DIFFTOOL_PROMPT=true &&
	154	export GIT_DIFFTOOL_PROMPT &&
	155
3319df6f	156	prompt=$(echo \| git difftool branch \| tail -1) &&
a904392e DA	157	prompt_given "$prompt" &&
	158
	159	restore_test_defaults
	160	'
	161
	162	# Test that we don't have to pass --no-prompt when difftool.prompt is false
	163	test_expect_success 'difftool.prompt config variable is false' '
	164	git config difftool.prompt false &&
	165
	166	diff=$(git difftool branch) &&
	167	test "$diff" = "branch" &&
	168
	169	restore_test_defaults
	170	'
	171
a88183f1 DA	172	# Test that we don't have to pass --no-prompt when mergetool.prompt is false
	173	test_expect_success 'difftool merge.prompt = false' '
	174	git config --unset difftool.prompt
	175	git config mergetool.prompt false &&
	176
	177	diff=$(git difftool branch) &&
	178	test "$diff" = "branch" &&
	179
	180	restore_test_defaults
	181	'
	182
a904392e DA	183	# Test that the -y flag can override difftool.prompt = true
	184	test_expect_success 'difftool.prompt can overridden with -y' '
	185	git config difftool.prompt true &&
	186
	187	diff=$(git difftool -y branch) &&
	188	test "$diff" = "branch" &&
	189
	190	restore_test_defaults
	191	'
	192
	193	# Test that the --prompt flag can override difftool.prompt = false
	194	test_expect_success 'difftool.prompt can overridden with --prompt' '
	195	git config difftool.prompt false &&
	196
	197	prompt=$(echo \| git difftool --prompt branch \| tail -1) &&
	198	prompt_given "$prompt" &&
	199
	200	restore_test_defaults
	201	'
	202
	203	# Test that the last flag passed on the command-line wins
	204	test_expect_success 'difftool last flag wins' '
	205	diff=$(git difftool --prompt --no-prompt branch) &&
	206	test "$diff" = "branch" &&
	207
	208	restore_test_defaults &&
	209
	210	prompt=$(echo \| git difftool --no-prompt --prompt branch \| tail -1) &&
	211	prompt_given "$prompt" &&
	212
	213	restore_test_defaults
	214	'
	215
f92f2038 DA	216	# git-difftool falls back to git-mergetool config variables
	217	# so test that behavior here
	218	test_expect_success 'difftool + mergetool config variables' '
	219	remove_config_vars
	220	git config merge.tool test-tool &&
	221	git config mergetool.test-tool.cmd "cat \$LOCAL" &&
	222
	223	diff=$(git difftool --no-prompt branch) &&
	224	test "$diff" = "branch" &&
	225
	226	# set merge.tool to something bogus, diff.tool to test-tool
	227	git config merge.tool bogus-tool &&
	228	git config diff.tool test-tool &&
	229
	230	diff=$(git difftool --no-prompt branch) &&
	231	test "$diff" = "branch" &&
	232
	233	restore_test_defaults
	234	'
	235
	236	test_expect_success 'difftool.<tool>.path' '
	237	git config difftool.tkdiff.path echo &&
	238	diff=$(git difftool --tool=tkdiff --no-prompt branch) &&
	239	git config --unset difftool.tkdiff.path &&
	240	lines=$(echo "$diff" \| grep file \| wc -l) &&
1c6f5b52 DA	241	test "$lines" -eq 1 &&
	242
	243	restore_test_defaults
	244	'
	245
a9e11220	246	test_expect_success 'difftool --extcmd=cat' '
1c6f5b52	247	diff=$(git difftool --no-prompt --extcmd=cat branch) &&
a9e11220	248	test "$diff" = branch"$LF"master
f47f1e2c	249	'
1c6f5b52	250
f47f1e2c DA	251	test_expect_success 'difftool --extcmd cat' '
	252	diff=$(git difftool --no-prompt --extcmd cat branch) &&
	253	test "$diff" = branch"$LF"master
	254	'
1c6f5b52	255
f47f1e2c DA	256	test_expect_success 'difftool -x cat' '
	257	diff=$(git difftool --no-prompt -x cat branch) &&
	258	test "$diff" = branch"$LF"master
9f3d54d1 DA	259	'
	260
	261	test_expect_success 'difftool --extcmd echo arg1' '
	262	diff=$(git difftool --no-prompt --extcmd sh\ -c\ \"echo\ \$1\" branch)
	263	test "$diff" = file
	264	'
1c6f5b52	265
9f3d54d1 DA	266	test_expect_success 'difftool --extcmd cat arg1' '
	267	diff=$(git difftool --no-prompt --extcmd sh\ -c\ \"cat\ \$1\" branch)
	268	test "$diff" = master
	269	'
1c6f5b52	270
9f3d54d1 DA	271	test_expect_success 'difftool --extcmd cat arg2' '
	272	diff=$(git difftool --no-prompt --extcmd sh\ -c\ \"cat\ \$2\" branch)
	273	test "$diff" = branch
f92f2038 DA	274	'
	275
	276	test_done