mirror of
https://github.com/git/git.git
synced 2024-10-30 05:47:53 +01:00
a4bf1e3c2e
Although "git worktree add" learned to run the 'post-checkout' hook inade546be47(worktree: invoke post-checkout hook, 2017-12-07), it neglected to change to the directory of the newly-created worktree before running the hook. Instead, the hook runs within the directory from which the "git worktree add" command itself was invoked, which effectively neuters the hook since it knows nothing about the new worktree directory. Further,ade546be47failed to sanitize the environment before running the hook, which means that user-assigned values of GIT_DIR and GIT_WORK_TREE could mislead the hook about the location of the new worktree. In the case of "git worktree add" being run from a bare repository, the GIT_DIR="." assigned by Git itself leaks into the hook's environment and breaks Git commands; this is so even when the working directory is correctly changed to the new worktree before the hook runs since ".", relative to the new worktree directory, does not point at the bare repository. Fix these problems by (1) changing to the new worktree's directory before running the hook, and (2) sanitizing the environment of GIT_DIR and GIT_WORK_TREE so hooks can't be confused by misleading values. Enhance the t2025 'post-checkout' tests to verify that the hook is indeed run within the correct directory and that Git commands invoked by the hook compute Git-dir and top-level worktree locations correctly. While at it, also add two new tests: (1) verify that the hook is run within the correct directory even when the new worktree is created from a sibling worktree (as opposed to the main worktree); (2) verify that the hook is provided with correct context when the new worktree is created from a bare repository (test provided by Lars Schneider). Implementation Notes: Rather than sanitizing the environment of GIT_DIR and GIT_WORK_TREE, an alternative would be to set them explicitly, as is already done for other Git commands run internally by "git worktree add". This patch opts instead to sanitize the environment in order to clearly document that the worktree is fully functional by the time the hook is run, thus does not require special environmental overrides. The hook is run manually, rather than via run_hook_le(), since it needs to change the working directory to that of the worktree, and run_hook_le() does not provide such functionality. As this is a one-off case, adding 'run_hook' overloads which allow the directory to be set does not seem warranted at this time. Reported-by: Lars Schneider <larsxschneider@gmail.com> Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
382 lines
9.3 KiB
Bash
Executable file
382 lines
9.3 KiB
Bash
Executable file
#!/bin/sh
|
|
|
|
test_description='test git worktree add'
|
|
|
|
. ./test-lib.sh
|
|
|
|
. "$TEST_DIRECTORY"/lib-rebase.sh
|
|
|
|
test_expect_success 'setup' '
|
|
test_commit init
|
|
'
|
|
|
|
test_expect_success '"add" an existing worktree' '
|
|
mkdir -p existing/subtree &&
|
|
test_must_fail git worktree add --detach existing master
|
|
'
|
|
|
|
test_expect_success '"add" an existing empty worktree' '
|
|
mkdir existing_empty &&
|
|
git worktree add --detach existing_empty master
|
|
'
|
|
|
|
test_expect_success '"add" using shorthand - fails when no previous branch' '
|
|
test_must_fail git worktree add existing_short -
|
|
'
|
|
|
|
test_expect_success '"add" using - shorthand' '
|
|
git checkout -b newbranch &&
|
|
echo hello >myworld &&
|
|
git add myworld &&
|
|
git commit -m myworld &&
|
|
git checkout master &&
|
|
git worktree add short-hand - &&
|
|
echo refs/heads/newbranch >expect &&
|
|
git -C short-hand rev-parse --symbolic-full-name HEAD >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success '"add" refuses to checkout locked branch' '
|
|
test_must_fail git worktree add zere master &&
|
|
! test -d zere &&
|
|
! test -d .git/worktrees/zere
|
|
'
|
|
|
|
test_expect_success 'checking out paths not complaining about linked checkouts' '
|
|
(
|
|
cd existing_empty &&
|
|
echo dirty >>init.t &&
|
|
git checkout master -- init.t
|
|
)
|
|
'
|
|
|
|
test_expect_success '"add" worktree' '
|
|
git rev-parse HEAD >expect &&
|
|
git worktree add --detach here master &&
|
|
(
|
|
cd here &&
|
|
test_cmp ../init.t init.t &&
|
|
test_must_fail git symbolic-ref HEAD &&
|
|
git rev-parse HEAD >actual &&
|
|
test_cmp ../expect actual &&
|
|
git fsck
|
|
)
|
|
'
|
|
|
|
test_expect_success '"add" worktree with lock' '
|
|
git rev-parse HEAD >expect &&
|
|
git worktree add --detach --lock here-with-lock master &&
|
|
test -f .git/worktrees/here-with-lock/locked
|
|
'
|
|
|
|
test_expect_success '"add" worktree from a subdir' '
|
|
(
|
|
mkdir sub &&
|
|
cd sub &&
|
|
git worktree add --detach here master &&
|
|
cd here &&
|
|
test_cmp ../../init.t init.t
|
|
)
|
|
'
|
|
|
|
test_expect_success '"add" from a linked checkout' '
|
|
(
|
|
cd here &&
|
|
git worktree add --detach nested-here master &&
|
|
cd nested-here &&
|
|
git fsck
|
|
)
|
|
'
|
|
|
|
test_expect_success '"add" worktree creating new branch' '
|
|
git worktree add -b newmaster there master &&
|
|
(
|
|
cd there &&
|
|
test_cmp ../init.t init.t &&
|
|
git symbolic-ref HEAD >actual &&
|
|
echo refs/heads/newmaster >expect &&
|
|
test_cmp expect actual &&
|
|
git fsck
|
|
)
|
|
'
|
|
|
|
test_expect_success 'die the same branch is already checked out' '
|
|
(
|
|
cd here &&
|
|
test_must_fail git checkout newmaster
|
|
)
|
|
'
|
|
|
|
test_expect_success SYMLINKS 'die the same branch is already checked out (symlink)' '
|
|
head=$(git -C there rev-parse --git-path HEAD) &&
|
|
ref=$(git -C there symbolic-ref HEAD) &&
|
|
rm "$head" &&
|
|
ln -s "$ref" "$head" &&
|
|
test_must_fail git -C here checkout newmaster
|
|
'
|
|
|
|
test_expect_success 'not die the same branch is already checked out' '
|
|
(
|
|
cd here &&
|
|
git worktree add --force anothernewmaster newmaster
|
|
)
|
|
'
|
|
|
|
test_expect_success 'not die on re-checking out current branch' '
|
|
(
|
|
cd there &&
|
|
git checkout newmaster
|
|
)
|
|
'
|
|
|
|
test_expect_success '"add" from a bare repo' '
|
|
(
|
|
git clone --bare . bare &&
|
|
cd bare &&
|
|
git worktree add -b bare-master ../there2 master
|
|
)
|
|
'
|
|
|
|
test_expect_success 'checkout from a bare repo without "add"' '
|
|
(
|
|
cd bare &&
|
|
test_must_fail git checkout master
|
|
)
|
|
'
|
|
|
|
test_expect_success '"add" default branch of a bare repo' '
|
|
(
|
|
git clone --bare . bare2 &&
|
|
cd bare2 &&
|
|
git worktree add ../there3 master
|
|
)
|
|
'
|
|
|
|
test_expect_success 'checkout with grafts' '
|
|
test_when_finished rm .git/info/grafts &&
|
|
test_commit abc &&
|
|
SHA1=$(git rev-parse HEAD) &&
|
|
test_commit def &&
|
|
test_commit xyz &&
|
|
echo "$(git rev-parse HEAD) $SHA1" >.git/info/grafts &&
|
|
cat >expected <<-\EOF &&
|
|
xyz
|
|
abc
|
|
EOF
|
|
git log --format=%s -2 >actual &&
|
|
test_cmp expected actual &&
|
|
git worktree add --detach grafted master &&
|
|
git --git-dir=grafted/.git log --format=%s -2 >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success '"add" from relative HEAD' '
|
|
test_commit a &&
|
|
test_commit b &&
|
|
test_commit c &&
|
|
git rev-parse HEAD~1 >expected &&
|
|
git worktree add relhead HEAD~1 &&
|
|
git -C relhead rev-parse HEAD >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success '"add -b" with <branch> omitted' '
|
|
git worktree add -b burble flornk &&
|
|
test_cmp_rev HEAD burble
|
|
'
|
|
|
|
test_expect_success '"add --detach" with <branch> omitted' '
|
|
git worktree add --detach fishhook &&
|
|
git rev-parse HEAD >expected &&
|
|
git -C fishhook rev-parse HEAD >actual &&
|
|
test_cmp expected actual &&
|
|
test_must_fail git -C fishhook symbolic-ref HEAD
|
|
'
|
|
|
|
test_expect_success '"add" with <branch> omitted' '
|
|
git worktree add wiffle/bat &&
|
|
test_cmp_rev HEAD bat
|
|
'
|
|
|
|
test_expect_success '"add" auto-vivify does not clobber existing branch' '
|
|
test_commit c1 &&
|
|
test_commit c2 &&
|
|
git branch precious HEAD~1 &&
|
|
test_must_fail git worktree add precious &&
|
|
test_cmp_rev HEAD~1 precious &&
|
|
test_path_is_missing precious
|
|
'
|
|
|
|
test_expect_success '"add" no auto-vivify with --detach and <branch> omitted' '
|
|
git worktree add --detach mish/mash &&
|
|
test_must_fail git rev-parse mash -- &&
|
|
test_must_fail git -C mish/mash symbolic-ref HEAD
|
|
'
|
|
|
|
test_expect_success '"add" -b/-B mutually exclusive' '
|
|
test_must_fail git worktree add -b poodle -B poodle bamboo master
|
|
'
|
|
|
|
test_expect_success '"add" -b/--detach mutually exclusive' '
|
|
test_must_fail git worktree add -b poodle --detach bamboo master
|
|
'
|
|
|
|
test_expect_success '"add" -B/--detach mutually exclusive' '
|
|
test_must_fail git worktree add -B poodle --detach bamboo master
|
|
'
|
|
|
|
test_expect_success '"add -B" fails if the branch is checked out' '
|
|
git rev-parse newmaster >before &&
|
|
test_must_fail git worktree add -B newmaster bamboo master &&
|
|
git rev-parse newmaster >after &&
|
|
test_cmp before after
|
|
'
|
|
|
|
test_expect_success 'add -B' '
|
|
git worktree add -B poodle bamboo2 master^ &&
|
|
git -C bamboo2 symbolic-ref HEAD >actual &&
|
|
echo refs/heads/poodle >expected &&
|
|
test_cmp expected actual &&
|
|
test_cmp_rev master^ poodle
|
|
'
|
|
|
|
test_expect_success 'local clone from linked checkout' '
|
|
git clone --local here here-clone &&
|
|
( cd here-clone && git fsck )
|
|
'
|
|
|
|
test_expect_success '"add" worktree with --no-checkout' '
|
|
git worktree add --no-checkout -b swamp swamp &&
|
|
! test -e swamp/init.t &&
|
|
git -C swamp reset --hard &&
|
|
test_cmp init.t swamp/init.t
|
|
'
|
|
|
|
test_expect_success '"add" worktree with --checkout' '
|
|
git worktree add --checkout -b swmap2 swamp2 &&
|
|
test_cmp init.t swamp2/init.t
|
|
'
|
|
|
|
test_expect_success 'put a worktree under rebase' '
|
|
git worktree add under-rebase &&
|
|
(
|
|
cd under-rebase &&
|
|
set_fake_editor &&
|
|
FAKE_LINES="edit 1" git rebase -i HEAD^ &&
|
|
git worktree list | grep "under-rebase.*detached HEAD"
|
|
)
|
|
'
|
|
|
|
test_expect_success 'add a worktree, checking out a rebased branch' '
|
|
test_must_fail git worktree add new-rebase under-rebase &&
|
|
! test -d new-rebase
|
|
'
|
|
|
|
test_expect_success 'checking out a rebased branch from another worktree' '
|
|
git worktree add new-place &&
|
|
test_must_fail git -C new-place checkout under-rebase
|
|
'
|
|
|
|
test_expect_success 'not allow to delete a branch under rebase' '
|
|
(
|
|
cd under-rebase &&
|
|
test_must_fail git branch -D under-rebase
|
|
)
|
|
'
|
|
|
|
test_expect_success 'rename a branch under rebase not allowed' '
|
|
test_must_fail git branch -M under-rebase rebase-with-new-name
|
|
'
|
|
|
|
test_expect_success 'check out from current worktree branch ok' '
|
|
(
|
|
cd under-rebase &&
|
|
git checkout under-rebase &&
|
|
git checkout - &&
|
|
git rebase --abort
|
|
)
|
|
'
|
|
|
|
test_expect_success 'checkout a branch under bisect' '
|
|
git worktree add under-bisect &&
|
|
(
|
|
cd under-bisect &&
|
|
git bisect start &&
|
|
git bisect bad &&
|
|
git bisect good HEAD~2 &&
|
|
git worktree list | grep "under-bisect.*detached HEAD" &&
|
|
test_must_fail git worktree add new-bisect under-bisect &&
|
|
! test -d new-bisect
|
|
)
|
|
'
|
|
|
|
test_expect_success 'rename a branch under bisect not allowed' '
|
|
test_must_fail git branch -M under-bisect bisect-with-new-name
|
|
'
|
|
|
|
post_checkout_hook () {
|
|
gitdir=${1:-.git}
|
|
test_when_finished "rm -f $gitdir/hooks/post-checkout" &&
|
|
mkdir -p $gitdir/hooks &&
|
|
write_script $gitdir/hooks/post-checkout <<-\EOF
|
|
{
|
|
echo $*
|
|
git rev-parse --git-dir --show-toplevel
|
|
} >hook.actual
|
|
EOF
|
|
}
|
|
|
|
test_expect_success '"add" invokes post-checkout hook (branch)' '
|
|
post_checkout_hook &&
|
|
{
|
|
echo $_z40 $(git rev-parse HEAD) 1 &&
|
|
echo $(pwd)/.git/worktrees/gumby &&
|
|
echo $(pwd)/gumby
|
|
} >hook.expect &&
|
|
git worktree add gumby &&
|
|
test_cmp hook.expect gumby/hook.actual
|
|
'
|
|
|
|
test_expect_success '"add" invokes post-checkout hook (detached)' '
|
|
post_checkout_hook &&
|
|
{
|
|
echo $_z40 $(git rev-parse HEAD) 1 &&
|
|
echo $(pwd)/.git/worktrees/grumpy &&
|
|
echo $(pwd)/grumpy
|
|
} >hook.expect &&
|
|
git worktree add --detach grumpy &&
|
|
test_cmp hook.expect grumpy/hook.actual
|
|
'
|
|
|
|
test_expect_success '"add --no-checkout" suppresses post-checkout hook' '
|
|
post_checkout_hook &&
|
|
rm -f hook.actual &&
|
|
git worktree add --no-checkout gloopy &&
|
|
test_path_is_missing gloopy/hook.actual
|
|
'
|
|
|
|
test_expect_success '"add" in other worktree invokes post-checkout hook' '
|
|
post_checkout_hook &&
|
|
{
|
|
echo $_z40 $(git rev-parse HEAD) 1 &&
|
|
echo $(pwd)/.git/worktrees/guppy &&
|
|
echo $(pwd)/guppy
|
|
} >hook.expect &&
|
|
git -C gloopy worktree add --detach ../guppy &&
|
|
test_cmp hook.expect guppy/hook.actual
|
|
'
|
|
|
|
test_expect_success '"add" in bare repo invokes post-checkout hook' '
|
|
rm -rf bare &&
|
|
git clone --bare . bare &&
|
|
{
|
|
echo $_z40 $(git --git-dir=bare rev-parse HEAD) 1 &&
|
|
echo $(pwd)/bare/worktrees/goozy &&
|
|
echo $(pwd)/goozy
|
|
} >hook.expect &&
|
|
post_checkout_hook bare &&
|
|
git -C bare worktree add --detach ../goozy &&
|
|
test_cmp hook.expect goozy/hook.actual
|
|
'
|
|
|
|
test_done
|