git/t/t7800-difftool.sh

921 lines
26 KiB
Bash
Raw Normal View History

#!/bin/sh
#
# Copyright (c) 2009, 2010, 2012, 2013 David Aguilar
#
test_description='git-difftool
Testing basic diff tool invocation
'
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
tests: mark tests relying on the current default for `init.defaultBranch` In addition to the manual adjustment to let the `linux-gcc` CI job run the test suite with `master` and then with `main`, this patch makes sure that GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME is set in all test scripts that currently rely on the initial branch name being `master by default. To determine which test scripts to mark up, the first step was to force-set the default branch name to `master` in - all test scripts that contain the keyword `master`, - t4211, which expects `t/t4211/history.export` with a hard-coded ref to initialize the default branch, - t5560 because it sources `t/t556x_common` which uses `master`, - t8002 and t8012 because both source `t/annotate-tests.sh` which also uses `master`) This trick was performed by this command: $ sed -i '/^ *\. \.\/\(test-lib\|lib-\(bash\|cvs\|git-svn\)\|gitweb-lib\)\.sh$/i\ GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=master\ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME\ ' $(git grep -l master t/t[0-9]*.sh) \ t/t4211*.sh t/t5560*.sh t/t8002*.sh t/t8012*.sh After that, careful, manual inspection revealed that some of the test scripts containing the needle `master` do not actually rely on a specific default branch name: either they mention `master` only in a comment, or they initialize that branch specificially, or they do not actually refer to the current default branch. Therefore, the aforementioned modification was undone in those test scripts thusly: $ git checkout HEAD -- \ t/t0027-auto-crlf.sh t/t0060-path-utils.sh \ t/t1011-read-tree-sparse-checkout.sh \ t/t1305-config-include.sh t/t1309-early-config.sh \ t/t1402-check-ref-format.sh t/t1450-fsck.sh \ t/t2024-checkout-dwim.sh \ t/t2106-update-index-assume-unchanged.sh \ t/t3040-subprojects-basic.sh t/t3301-notes.sh \ t/t3308-notes-merge.sh t/t3423-rebase-reword.sh \ t/t3436-rebase-more-options.sh \ t/t4015-diff-whitespace.sh t/t4257-am-interactive.sh \ t/t5323-pack-redundant.sh t/t5401-update-hooks.sh \ t/t5511-refspec.sh t/t5526-fetch-submodules.sh \ t/t5529-push-errors.sh t/t5530-upload-pack-error.sh \ t/t5548-push-porcelain.sh \ t/t5552-skipping-fetch-negotiator.sh \ t/t5572-pull-submodule.sh t/t5608-clone-2gb.sh \ t/t5614-clone-submodules-shallow.sh \ t/t7508-status.sh t/t7606-merge-custom.sh \ t/t9302-fast-import-unpack-limit.sh We excluded one set of test scripts in these commands, though: the range of `git p4` tests. The reason? `git p4` stores the (foreign) remote branch in the branch called `p4/master`, which is obviously not the default branch. Manual analysis revealed that only five of these tests actually require a specific default branch name to pass; They were modified thusly: $ sed -i '/^ *\. \.\/lib-git-p4\.sh$/i\ GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=master\ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME\ ' t/t980[0167]*.sh t/t9811*.sh Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-11-18 23:44:19 +00:00
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
. ./test-lib.sh
difftool_test_setup ()
{
test_config diff.tool test-tool &&
test_config difftool.test-tool.cmd 'cat "$LOCAL"' &&
test_config difftool.bogus-tool.cmd false
}
prompt_given ()
{
prompt="$1"
test "$prompt" = "Launch 'test-tool' [Y/n]? branch"
}
test_expect_success 'basic usage requires no repo' '
test_expect_code 129 git difftool -h >output &&
test_i18ngrep ^usage: output &&
# create a ceiling directory to prevent Git from finding a repo
mkdir -p not/repo &&
test_when_finished rm -r not &&
test_expect_code 129 \
env GIT_CEILING_DIRECTORIES="$(pwd)/not" \
git -C not/repo difftool -h >output &&
test_i18ngrep ^usage: output
'
# Create a file on main and change it on branch
test_expect_success 'setup' '
echo main >file &&
git add file &&
git commit -m "added file" &&
git checkout -b branch main &&
echo branch >file &&
git commit -a -m "branch changed file" &&
git checkout main
'
# Configure a custom difftool.<tool>.cmd and use it
test_expect_success 'custom commands' '
difftool_test_setup &&
test_config difftool.test-tool.cmd "cat \"\$REMOTE\"" &&
echo main >expect &&
git difftool --no-prompt branch >actual &&
test_cmp expect actual &&
test_config difftool.test-tool.cmd "cat \"\$LOCAL\"" &&
echo branch >expect &&
git difftool --no-prompt branch >actual &&
test_cmp expect actual
'
test_expect_success 'custom tool commands override built-ins' '
test_config difftool.vimdiff.cmd "cat \"\$REMOTE\"" &&
echo main >expect &&
git difftool --tool vimdiff --no-prompt branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool ignores bad --tool values' '
: >expect &&
test_must_fail \
git difftool --no-prompt --tool=bad-tool branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool forwards arguments to diff' '
difftool_test_setup &&
>for-diff &&
git add for-diff &&
echo changes>for-diff &&
git add for-diff &&
: >expect &&
git difftool --cached --no-prompt -- for-diff >actual &&
test_cmp expect actual &&
git reset -- for-diff &&
rm for-diff
'
test_expect_success 'difftool ignores exit code' '
test_config difftool.error.cmd false &&
git difftool -y -t error branch
'
test_expect_success 'difftool forwards exit code with --trust-exit-code' '
test_config difftool.error.cmd false &&
test_must_fail git difftool -y --trust-exit-code -t error branch
'
test_expect_success 'difftool forwards exit code with --trust-exit-code for built-ins' '
test_config difftool.vimdiff.path false &&
test_must_fail git difftool -y --trust-exit-code -t vimdiff branch
'
test_expect_success 'difftool honors difftool.trustExitCode = true' '
test_config difftool.error.cmd false &&
test_config difftool.trustExitCode true &&
test_must_fail git difftool -y -t error branch
'
test_expect_success 'difftool honors difftool.trustExitCode = false' '
test_config difftool.error.cmd false &&
test_config difftool.trustExitCode false &&
git difftool -y -t error branch
'
test_expect_success 'difftool ignores exit code with --no-trust-exit-code' '
test_config difftool.error.cmd false &&
test_config difftool.trustExitCode true &&
git difftool -y --no-trust-exit-code -t error branch
'
test_expect_success 'difftool stops on error with --trust-exit-code' '
test_when_finished "rm -f for-diff .git/fail-right-file" &&
test_when_finished "git reset -- for-diff" &&
write_script .git/fail-right-file <<-\EOF &&
t7800: don't rely on reuse_worktree_file() A test in t7800 tries to make sure that when git-difftool runs an external tool that fails, it stops looking at files. Our fake failing tool prints the file name it was asked to diff before exiting non-zero, and then we confirm the output contains only that file. However, this subtly relies on our internal reuse_worktree_file(). Because we're diffing between branches, the command run by difftool might see: - the git-stored filename (e.g., "file"), if we decided that the working tree contents were up-to-date with the object in the index and HEAD, and we could reuse them - a temporary filename (e.g. "/tmp/abc123_file") if we had to dump the contents from the object database If the latter case happens, then the test fails, because it's expecting the string "file". I discovered this when debugging something unrelated with reuse_worktree_file(). I _thought_ it should be able to be triggered by a racy-git situation, but running: ./t7800-difftool.sh --stress --run=2,13 never seems to fail. However, by my reading of reuse_worktree_file(), this would probably always fail under Cygwin, because it sets NO_FAST_WORKING_DIRECTORY. At any rate, since reuse_worktree_file() is meant to be an optimization that may or may not trigger, our test should be robust either way. Instead of checking the filename, let's just make sure we got a single line of output (which would not be true if we continued after the first failure). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-01-16 18:19:40 +00:00
echo failed
exit 1
EOF
>for-diff &&
git add for-diff &&
test_must_fail git difftool -y --trust-exit-code \
--extcmd .git/fail-right-file branch >actual &&
t7800: don't rely on reuse_worktree_file() A test in t7800 tries to make sure that when git-difftool runs an external tool that fails, it stops looking at files. Our fake failing tool prints the file name it was asked to diff before exiting non-zero, and then we confirm the output contains only that file. However, this subtly relies on our internal reuse_worktree_file(). Because we're diffing between branches, the command run by difftool might see: - the git-stored filename (e.g., "file"), if we decided that the working tree contents were up-to-date with the object in the index and HEAD, and we could reuse them - a temporary filename (e.g. "/tmp/abc123_file") if we had to dump the contents from the object database If the latter case happens, then the test fails, because it's expecting the string "file". I discovered this when debugging something unrelated with reuse_worktree_file(). I _thought_ it should be able to be triggered by a racy-git situation, but running: ./t7800-difftool.sh --stress --run=2,13 never seems to fail. However, by my reading of reuse_worktree_file(), this would probably always fail under Cygwin, because it sets NO_FAST_WORKING_DIRECTORY. At any rate, since reuse_worktree_file() is meant to be an optimization that may or may not trigger, our test should be robust either way. Instead of checking the filename, let's just make sure we got a single line of output (which would not be true if we continued after the first failure). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-01-16 18:19:40 +00:00
test_line_count = 1 actual
'
test_expect_success 'difftool honors exit status if command not found' '
test_config difftool.nonexistent.cmd i-dont-exist &&
test_config difftool.trustExitCode false &&
test_must_fail git difftool -y -t nonexistent branch
'
test_expect_success 'difftool honors --gui' '
difftool_test_setup &&
test_config merge.tool bogus-tool &&
test_config diff.tool bogus-tool &&
test_config diff.guitool test-tool &&
echo branch >expect &&
git difftool --no-prompt --gui branch >actual &&
test_cmp expect actual
'
mergetool: new config guiDefault supports auto-toggling gui by DISPLAY When no merge.tool or diff.tool is configured or manually selected, the selection of a default tool is sensitive to the DISPLAY variable; in a GUI session a gui-specific tool will be proposed if found, and otherwise a terminal-based one. This "GUI-optimizing" behavior is important because a GUI can make a huge difference to a user's ability to understand and correctly complete a non-trivial conflicting merge. Some time ago the merge.guitool and diff.guitool config options were introduced to enable users to configure both a GUI tool, and a non-GUI tool (with fallback if no GUI tool configured), in the same environment. Unfortunately, the --gui argument introduced to support the selection of the guitool is still explicit. When using configured tools, there is no equivalent of the no-tool-configured "propose a GUI tool if we are in a GUI environment" behavior. As proposed in <xmqqmtb8jsej.fsf@gitster.g>, introduce new configuration options, difftool.guiDefault and mergetool.guiDefault, supporting a special value "auto" which causes the corresponding tool or guitool to be selected depending on the presence of a non-empty DISPLAY value. Also support "true" to say "default to the guitool (unless --no-gui is passed on the commandline)", and "false" as the previous default behavior when these new configuration options are not specified. Signed-off-by: Tao Klerks <tao@klerks.biz> Acked-by: David Aguilar <davvid@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-03-18 15:27:43 +00:00
test_expect_success 'difftool with guiDefault auto selects gui tool when there is DISPLAY' '
difftool_test_setup &&
test_config merge.tool bogus-tool &&
test_config diff.tool bogus-tool &&
test_config diff.guitool test-tool &&
test_config difftool.guiDefault auto &&
DISPLAY=SOMETHING && export DISPLAY &&
echo branch >expect &&
git difftool --no-prompt branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool with guiDefault auto selects regular tool when no DISPLAY' '
difftool_test_setup &&
test_config diff.guitool bogus-tool &&
test_config diff.tool test-tool &&
test_config difftool.guiDefault Auto &&
DISPLAY= && export DISPLAY &&
echo branch >expect &&
git difftool --no-prompt branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool with guiDefault true selects gui tool' '
difftool_test_setup &&
test_config diff.tool bogus-tool &&
test_config diff.guitool test-tool &&
test_config difftool.guiDefault true &&
DISPLAY= && export DISPLAY &&
echo branch >expect &&
git difftool --no-prompt branch >actual &&
test_cmp expect actual &&
DISPLAY=Something && export DISPLAY &&
echo branch >expect &&
git difftool --no-prompt branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool --no-gui trumps config guiDefault' '
difftool_test_setup &&
test_config diff.guitool bogus-tool &&
test_config diff.tool test-tool &&
test_config difftool.guiDefault true &&
echo branch >expect &&
git difftool --no-prompt --no-gui branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool --gui last setting wins' '
difftool_test_setup &&
: >expect &&
git difftool --no-prompt --gui --no-gui >actual &&
test_cmp expect actual &&
test_config merge.tool bogus-tool &&
test_config diff.tool bogus-tool &&
test_config diff.guitool test-tool &&
echo branch >expect &&
git difftool --no-prompt --no-gui --gui branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool --gui works without configured diff.guitool' '
difftool_test_setup &&
echo branch >expect &&
git difftool --no-prompt --gui branch >actual &&
test_cmp expect actual
'
# Specify the diff tool using $GIT_DIFF_TOOL
test_expect_success 'GIT_DIFF_TOOL variable' '
difftool_test_setup &&
git config --unset diff.tool &&
echo branch >expect &&
GIT_DIFF_TOOL=test-tool git difftool --no-prompt branch >actual &&
test_cmp expect actual
'
# Test the $GIT_*_TOOL variables and ensure
# that $GIT_DIFF_TOOL always wins unless --tool is specified
test_expect_success 'GIT_DIFF_TOOL overrides' '
difftool_test_setup &&
test_config diff.tool bogus-tool &&
test_config merge.tool bogus-tool &&
echo branch >expect &&
GIT_DIFF_TOOL=test-tool git difftool --no-prompt branch >actual &&
test_cmp expect actual &&
test_config diff.tool bogus-tool &&
test_config merge.tool bogus-tool &&
GIT_DIFF_TOOL=bogus-tool \
git difftool --no-prompt --tool=test-tool branch >actual &&
test_cmp expect actual
'
# 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' '
difftool_test_setup &&
echo branch >expect &&
GIT_DIFFTOOL_NO_PROMPT=true git difftool branch >actual &&
test_cmp expect actual
'
# git-difftool supports the difftool.prompt variable.
# Test that GIT_DIFFTOOL_PROMPT can override difftool.prompt = false
test_expect_success 'GIT_DIFFTOOL_PROMPT variable' '
difftool_test_setup &&
test_config difftool.prompt false &&
echo >input &&
GIT_DIFFTOOL_PROMPT=true git difftool branch <input >output &&
prompt=$(tail -1 <output) &&
prompt_given "$prompt"
'
# Test that we don't have to pass --no-prompt when difftool.prompt is false
test_expect_success 'difftool.prompt config variable is false' '
difftool_test_setup &&
test_config difftool.prompt false &&
echo branch >expect &&
git difftool branch >actual &&
test_cmp expect actual
'
# Test that we don't have to pass --no-prompt when mergetool.prompt is false
test_expect_success 'difftool merge.prompt = false' '
difftool_test_setup &&
test_might_fail git config --unset difftool.prompt &&
test_config mergetool.prompt false &&
echo branch >expect &&
git difftool branch >actual &&
test_cmp expect actual
'
# Test that the -y flag can override difftool.prompt = true
test_expect_success 'difftool.prompt can overridden with -y' '
difftool_test_setup &&
test_config difftool.prompt true &&
echo branch >expect &&
git difftool -y branch >actual &&
test_cmp expect actual
'
# Test that the --prompt flag can override difftool.prompt = false
test_expect_success 'difftool.prompt can overridden with --prompt' '
difftool_test_setup &&
test_config difftool.prompt false &&
echo >input &&
git difftool --prompt branch <input >output &&
prompt=$(tail -1 <output) &&
prompt_given "$prompt"
'
# Test that the last flag passed on the command-line wins
test_expect_success 'difftool last flag wins' '
difftool_test_setup &&
echo branch >expect &&
git difftool --prompt --no-prompt branch >actual &&
test_cmp expect actual &&
echo >input &&
git difftool --no-prompt --prompt branch <input >output &&
prompt=$(tail -1 <output) &&
prompt_given "$prompt"
'
# git-difftool falls back to git-mergetool config variables
# so test that behavior here
test_expect_success 'difftool + mergetool config variables' '
test_config merge.tool test-tool &&
test_config mergetool.test-tool.cmd "cat \$LOCAL" &&
echo branch >expect &&
git difftool --no-prompt branch >actual &&
test_cmp expect actual &&
git difftool --gui --no-prompt branch >actual &&
test_cmp expect actual &&
# set merge.tool to something bogus, diff.tool to test-tool
test_config merge.tool bogus-tool &&
test_config diff.tool test-tool &&
git difftool --no-prompt branch >actual &&
test_cmp expect actual &&
git difftool --gui --no-prompt branch >actual &&
test_cmp expect actual &&
# set merge.tool, diff.tool to something bogus, merge.guitool to test-tool
test_config diff.tool bogus-tool &&
test_config merge.guitool test-tool &&
git difftool --gui --no-prompt branch >actual &&
test_cmp expect actual &&
# set merge.tool, diff.tool, merge.guitool to something bogus, diff.guitool to test-tool
test_config merge.guitool bogus-tool &&
test_config diff.guitool test-tool &&
git difftool --gui --no-prompt branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool.<tool>.path' '
test_config difftool.tkdiff.path echo &&
git difftool --tool=tkdiff --no-prompt branch >output &&
grep file output >grep-output &&
test_line_count = 1 grep-output
'
test_expect_success 'difftool --extcmd=cat' '
echo branch >expect &&
echo main >>expect &&
git difftool --no-prompt --extcmd=cat branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool --extcmd cat' '
echo branch >expect &&
echo main >>expect &&
git difftool --no-prompt --extcmd=cat branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool -x cat' '
echo branch >expect &&
echo main >>expect &&
git difftool --no-prompt -x cat branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool --extcmd echo arg1' '
echo file >expect &&
git difftool --no-prompt \
--extcmd sh\ -c\ \"echo\ \$1\" branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool --extcmd cat arg1' '
echo main >expect &&
git difftool --no-prompt \
--extcmd sh\ -c\ \"cat\ \$1\" branch >actual &&
test_cmp expect actual
'
test_expect_success 'difftool --extcmd cat arg2' '
echo branch >expect &&
git difftool --no-prompt \
--extcmd sh\ -c\ \"cat\ \\\"\$2\\\"\" branch >actual &&
test_cmp expect actual
'
# Create a second file on main and a different version on branch
test_expect_success 'setup with 2 files different' '
echo m2 >file2 &&
git add file2 &&
git commit -m "added file2" &&
git checkout branch &&
echo br2 >file2 &&
git add file2 &&
git commit -a -m "branch changed file2" &&
git checkout main
'
test_expect_success 'say no to the first file' '
(echo n && echo) >input &&
git difftool -x cat branch <input >output &&
grep m2 output &&
grep br2 output &&
! grep main output &&
! grep branch output
'
test_expect_success 'say no to the second file' '
(echo && echo n) >input &&
git difftool -x cat branch <input >output &&
grep main output &&
grep branch output &&
! grep m2 output &&
! grep br2 output
'
test_expect_success 'ending prompt input with EOF' '
git difftool -x cat branch </dev/null >output &&
! grep main output &&
! grep branch output &&
! grep m2 output &&
! grep br2 output
'
test_expect_success 'difftool --tool-help' '
git difftool --tool-help >output &&
grep tool output
'
test_expect_success 'setup change in subdirectory' '
git checkout main &&
mkdir sub &&
echo main >sub/sub &&
git add sub/sub &&
git commit -m "added sub/sub" &&
git tag v1 &&
echo test >>file &&
echo test >>sub/sub &&
git add file sub/sub &&
git commit -m "modified both"
'
test_expect_success 'difftool -d with growing paths' '
a=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&
git init growing &&
(
cd growing &&
echo "test -f \"\$2/b\"" | write_script .git/test-for-b.sh &&
one=$(printf 1 | git hash-object -w --stdin) &&
two=$(printf 2 | git hash-object -w --stdin) &&
git update-index --add \
--cacheinfo 100644,$one,$a --cacheinfo 100644,$two,b &&
tree1=$(git write-tree) &&
git update-index --add \
--cacheinfo 100644,$two,$a --cacheinfo 100644,$one,b &&
tree2=$(git write-tree) &&
git checkout -- $a &&
git difftool -d --extcmd .git/test-for-b.sh $tree1 $tree2
)
'
run_dir_diff_test () {
test_expect_success "$1 --no-symlinks" "
symlinks=--no-symlinks &&
$2
"
test_expect_success SYMLINKS "$1 --symlinks" "
symlinks=--symlinks &&
$2
"
}
run_dir_diff_test 'difftool -d' '
git difftool -d $symlinks --extcmd ls branch >output &&
grep "^sub$" output &&
grep "^file$" output
'
run_dir_diff_test 'difftool --dir-diff' '
git difftool --dir-diff $symlinks --extcmd ls branch >output &&
grep "^sub$" output &&
grep "^file$" output
'
run_dir_diff_test 'difftool --dir-diff avoids repeated slashes in TMPDIR' '
TMPDIR="${TMPDIR:-/tmp}////" \
git difftool --dir-diff $symlinks --extcmd echo branch >output &&
grep -v // output >actual &&
test_line_count = 1 actual
'
run_dir_diff_test 'difftool --dir-diff ignores --prompt' '
git difftool --dir-diff $symlinks --prompt --extcmd ls branch >output &&
grep "^sub$" output &&
grep "^file$" output
'
run_dir_diff_test 'difftool --dir-diff branch from subdirectory' '
(
cd sub &&
git difftool --dir-diff $symlinks --extcmd ls branch >output &&
# "sub" must only exist in "right"
# "file" and "file2" must be listed in both "left" and "right"
grep "^sub$" output >sub-output &&
test_line_count = 1 sub-output &&
grep "^file$" output >file-output &&
test_line_count = 2 file-output &&
grep "^file2$" output >file2-output &&
test_line_count = 2 file2-output
)
'
run_dir_diff_test 'difftool --dir-diff v1 from subdirectory' '
(
cd sub &&
git difftool --dir-diff $symlinks --extcmd ls v1 >output &&
# "sub" and "file" exist in both v1 and HEAD.
# "file2" is unchanged.
grep "^sub$" output >sub-output &&
test_line_count = 2 sub-output &&
grep "^file$" output >file-output &&
test_line_count = 2 file-output &&
! grep "^file2$" output
)
'
run_dir_diff_test 'difftool --dir-diff branch from subdirectory w/ pathspec' '
(
cd sub &&
git difftool --dir-diff $symlinks --extcmd ls branch -- .>output &&
# "sub" only exists in "right"
# "file" and "file2" must not be listed
grep "^sub$" output >sub-output &&
test_line_count = 1 sub-output &&
! grep "^file$" output
)
'
run_dir_diff_test 'difftool --dir-diff v1 from subdirectory w/ pathspec' '
(
cd sub &&
git difftool --dir-diff $symlinks --extcmd ls v1 -- .>output &&
# "sub" exists in v1 and HEAD
# "file" is filtered out by the pathspec
grep "^sub$" output >sub-output &&
test_line_count = 2 sub-output &&
! grep "^file$" output
)
'
run_dir_diff_test 'difftool --dir-diff from subdirectory with GIT_DIR set' '
(
GIT_DIR=$(pwd)/.git &&
export GIT_DIR &&
GIT_WORK_TREE=$(pwd) &&
export GIT_WORK_TREE &&
cd sub &&
git difftool --dir-diff $symlinks --extcmd ls \
branch -- sub >output &&
grep "^sub$" output &&
! grep "^file$" output
)
'
run_dir_diff_test 'difftool --dir-diff when worktree file is missing' '
test_when_finished git reset --hard &&
rm file2 &&
git difftool --dir-diff $symlinks --extcmd ls branch main >output &&
grep "^file2$" output
'
run_dir_diff_test 'difftool --dir-diff with unmerged files' '
test_when_finished git reset --hard &&
test_config difftool.echo.cmd "echo ok" &&
git checkout -B conflict-a &&
git checkout -B conflict-b &&
git checkout conflict-a &&
echo a >>file &&
git add file &&
git commit -m conflict-a &&
git checkout conflict-b &&
echo b >>file &&
git add file &&
git commit -m conflict-b &&
git checkout main &&
git merge conflict-a &&
test_must_fail git merge conflict-b &&
cat >expect <<-EOF &&
ok
EOF
git difftool --dir-diff $symlinks -t echo >actual &&
test_cmp expect actual
'
write_script .git/CHECK_SYMLINKS <<\EOF
for f in file file2 sub/sub
do
echo "$f"
ls -ld "$2/$f" | sed -e 's/.* -> //'
done >actual
EOF
test_expect_success SYMLINKS 'difftool --dir-diff --symlinks without unstaged changes' '
cat >expect <<-EOF &&
file
$PWD/file
file2
$PWD/file2
sub/sub
$PWD/sub/sub
EOF
git difftool --dir-diff --symlinks \
--extcmd "./.git/CHECK_SYMLINKS" branch HEAD &&
test_cmp expect actual
'
write_script modify-right-file <<\EOF
echo "new content" >"$2/file"
EOF
run_dir_diff_test 'difftool --dir-diff syncs worktree with unstaged change' '
test_when_finished git reset --hard &&
echo "orig content" >file &&
git difftool -d $symlinks --extcmd "$PWD/modify-right-file" branch &&
echo "new content" >expect &&
test_cmp expect file
'
run_dir_diff_test 'difftool --dir-diff syncs worktree without unstaged change' '
test_when_finished git reset --hard &&
git difftool -d $symlinks --extcmd "$PWD/modify-right-file" branch &&
echo "new content" >expect &&
test_cmp expect file
'
write_script modify-file <<\EOF
echo "new content" >file
EOF
test_expect_success 'difftool --no-symlinks does not overwrite working tree file ' '
echo "orig content" >file &&
git difftool --dir-diff --no-symlinks --extcmd "$PWD/modify-file" branch &&
echo "new content" >expect &&
test_cmp expect file
'
write_script modify-both-files <<\EOF
echo "wt content" >file &&
echo "tmp content" >"$2/file" &&
echo "$2" >tmpdir
EOF
test_expect_success 'difftool --no-symlinks detects conflict ' '
(
TMPDIR=$TRASH_DIRECTORY &&
export TMPDIR &&
echo "orig content" >file &&
test_must_fail git difftool --dir-diff --no-symlinks --extcmd "$PWD/modify-both-files" branch &&
echo "wt content" >expect &&
test_cmp expect file &&
echo "tmp content" >expect &&
test_cmp expect "$(cat tmpdir)/file"
)
'
test_expect_success 'difftool properly honors gitlink and core.worktree' '
test_when_finished rm -rf submod/ule &&
test_config_global protocol.file.allow always &&
git submodule add ./. submod/ule &&
test_config -C submod/ule diff.tool checktrees &&
test_config -C submod/ule difftool.checktrees.cmd '\''
test -d "$LOCAL" && test -d "$REMOTE" && echo good
'\'' &&
(
cd submod/ule &&
echo good >expect &&
git difftool --tool=checktrees --dir-diff HEAD~ >actual &&
test_cmp expect actual &&
rm -f expect actual
)
'
test_expect_success SYMLINKS 'difftool --dir-diff symlinked directories' '
test_when_finished git reset --hard &&
git init dirlinks &&
(
cd dirlinks &&
git config diff.tool checktrees &&
git config difftool.checktrees.cmd "echo good" &&
mkdir foo &&
: >foo/bar &&
git add foo/bar &&
test_commit symlink-one &&
ln -s foo link &&
git add link &&
test_commit symlink-two &&
echo good >expect &&
git difftool --tool=checktrees --dir-diff HEAD~ >actual &&
test_cmp expect actual
)
'
test_expect_success SYMLINKS 'difftool --dir-diff handles modified symlinks' '
test_when_finished git reset --hard &&
touch b &&
ln -s b c &&
git add b c &&
test_tick &&
git commit -m initial &&
touch d &&
rm c &&
ln -s d c &&
cat >expect <<-EOF &&
c
c
EOF
git difftool --symlinks --dir-diff --extcmd ls >output &&
grep -v ^/ output >actual &&
test_cmp expect actual &&
git difftool --no-symlinks --dir-diff --extcmd ls >output &&
grep -v ^/ output >actual &&
test_cmp expect actual &&
# The left side contains symlink "c" that points to "b"
test_config difftool.cat.cmd "cat \$LOCAL/c" &&
printf "%s\n" b >expect &&
git difftool --symlinks --dir-diff --tool cat >actual &&
test_cmp expect actual &&
git difftool --symlinks --no-symlinks --dir-diff --tool cat >actual &&
test_cmp expect actual &&
# The right side contains symlink "c" that points to "d"
test_config difftool.cat.cmd "cat \$REMOTE/c" &&
printf "%s\n" d >expect &&
git difftool --symlinks --dir-diff --tool cat >actual &&
test_cmp expect actual &&
git difftool --no-symlinks --dir-diff --tool cat >actual &&
test_cmp expect actual &&
# Deleted symlinks
rm -f c &&
cat >expect <<-EOF &&
c
EOF
git difftool --symlinks --dir-diff --extcmd ls >output &&
grep -v ^/ output >actual &&
test_cmp expect actual &&
git difftool --no-symlinks --dir-diff --extcmd ls >output &&
grep -v ^/ output >actual &&
test_cmp expect actual
'
difftool: fix symlink-file writing in dir-diff mode The difftool dir-diff mode handles symlinks by replacing them with their readlink(2) values. This allows diff tools to see changes to symlinks as if they were regular text diffs with the old and new path values. This is analogous to what "git diff" displays when symlinks change. The temporary diff directories that are created initially contain symlinks because they get checked-out using a temporary index that retains the original symlinks as checked-in to the repository. A bug was introduced when difftool was rewritten in C that made difftool write the readlink(2) contents into the pointed-to file rather than the symlink itself. The write was going through the symlink and writing to its target rather than writing to the symlink path itself. Replace symlinks with raw text files by unlinking the symlink path before writing the readlink(2) content into them. When 18ec800512 (difftool: handle modified symlinks in dir-diff mode, 2017-03-15) added handling for modified symlinks this bug got recorded in the test suite. The tests included the pointed-to symlink target paths. These paths were being reported because difftool was erroneously writing to them, but they should have never been reported nor written. Correct the modified-symlinks test cases by removing the target files from the expected output. Add a test to ensure that symlinks are written with the readlink(2) values and that the target files contain their original content. Reported-by: Alan Blotz <work@blotz.org> Helped-by: Đoàn Trần Công Danh <congdanhqx@gmail.com> Signed-off-by: David Aguilar <davvid@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-09-23 04:12:50 +00:00
test_expect_success SYMLINKS 'difftool --dir-diff writes symlinks as raw text' '
# Start out on a branch called "branch-init".
git init -b branch-init symlink-files &&
(
cd symlink-files &&
# This test ensures that symlinks are written as raw text.
# The "cat" tools output link and file contents.
git config difftool.cat-left-link.cmd "cat \"\$LOCAL/link\"" &&
git config difftool.cat-left-a.cmd "cat \"\$LOCAL/file-a\"" &&
git config difftool.cat-right-link.cmd "cat \"\$REMOTE/link\"" &&
git config difftool.cat-right-b.cmd "cat \"\$REMOTE/file-b\"" &&
# Record the empty initial state so that we can come back here
# later and not have to consider the any cases where difftool
# will create symlinks back into the worktree.
test_tick &&
git commit --allow-empty -m init &&
# Create a file called "file-a" with a symlink pointing to it.
git switch -c branch-a &&
echo a >file-a &&
ln -s file-a link &&
git add file-a link &&
test_tick &&
git commit -m link-to-file-a &&
# Create a file called "file-b" and point the symlink to it.
git switch -c branch-b &&
echo b >file-b &&
rm link &&
ln -s file-b link &&
git add file-b link &&
git rm file-a &&
test_tick &&
git commit -m link-to-file-b &&
# Checkout the initial branch so that the --symlinks behavior is
# not activated. The two directories should be completely
# independent with no symlinks pointing back here.
git switch branch-init &&
# The left link must be "file-a" and "file-a" must contain "a".
echo file-a >expect &&
git difftool --symlinks --dir-diff --tool cat-left-link \
branch-a branch-b >actual &&
test_cmp expect actual &&
echo a >expect &&
git difftool --symlinks --dir-diff --tool cat-left-a \
branch-a branch-b >actual &&
test_cmp expect actual &&
# The right link must be "file-b" and "file-b" must contain "b".
echo file-b >expect &&
git difftool --symlinks --dir-diff --tool cat-right-link \
branch-a branch-b >actual &&
test_cmp expect actual &&
echo b >expect &&
git difftool --symlinks --dir-diff --tool cat-right-b \
branch-a branch-b >actual &&
test_cmp expect actual
)
'
test_expect_success 'add -N and difftool -d' '
test_when_finished git reset --hard &&
test_write_lines A B C >intent-to-add &&
git add -N intent-to-add &&
git difftool --dir-diff --extcmd ls
'
test_expect_success 'difftool --cached with unmerged files' '
test_when_finished git reset --hard &&
test_commit conflicting &&
test_commit conflict-a conflict.t a &&
git reset --hard conflicting &&
test_commit conflict-b conflict.t b &&
test_must_fail git merge conflict-a &&
git difftool --cached --no-prompt >output &&
test_must_be_empty output
'
test_expect_success 'outside worktree' '
echo 1 >1 &&
echo 2 >2 &&
test_expect_code 1 nongit git \
-c diff.tool=echo -c difftool.echo.cmd="echo \$LOCAL \$REMOTE" \
difftool --no-prompt --no-index ../1 ../2 >actual &&
echo "../1 ../2" >expect &&
test_cmp expect actual
'
test_expect_success 'difftool --gui, --tool and --extcmd are mutually exclusive' '
difftool_test_setup &&
test_must_fail git difftool --gui --tool=test-tool &&
test_must_fail git difftool --gui --extcmd=cat &&
test_must_fail git difftool --tool=test-tool --extcmd=cat &&
test_must_fail git difftool --gui --tool=test-tool --extcmd=cat
'
test_expect_success 'difftool --rotate-to' '
difftool_test_setup &&
test_when_finished git reset --hard &&
echo 1 >1 &&
echo 2 >2 &&
echo 4 >4 &&
git add 1 2 4 &&
git commit -a -m "124" &&
git difftool --no-prompt --extcmd=cat --rotate-to="2" HEAD^ >output &&
cat >expect <<-\EOF &&
2
4
1
EOF
test_cmp output expect
'
test_expect_success 'difftool --skip-to' '
difftool_test_setup &&
test_when_finished git reset --hard &&
git difftool --no-prompt --extcmd=cat --skip-to="2" HEAD^ >output &&
cat >expect <<-\EOF &&
2
4
EOF
test_cmp output expect
'
test_expect_success 'difftool --rotate/skip-to error condition' '
test_must_fail git difftool --no-prompt --extcmd=cat --rotate-to="3" HEAD^ &&
test_must_fail git difftool --no-prompt --extcmd=cat --skip-to="3" HEAD^
'
test_done