git/t/t2403-worktree-move.sh
Eric Sunshine 810382ed37 worktree: make "move" refuse to move atop missing registered worktree
"git worktree add" takes special care to avoid creating a new worktree
at a location already registered to an existing worktree even if that
worktree is missing (which can happen, for instance, if the worktree
resides on removable media). "git worktree move", however, is not so
careful when validating the destination location and will happily move
the source worktree atop the location of a missing worktree. This leads
to the anomalous situation of multiple worktrees being associated with
the same path, which is expressly forbidden by design. For example:

    $ git clone foo.git
    $ cd foo
    $ git worktree add ../bar
    $ git worktree add ../baz
    $ rm -rf ../bar
    $ git worktree move ../baz ../bar
    $ git worktree list
    .../foo beefd00f [master]
    .../bar beefd00f [bar]
    .../bar beefd00f [baz]
    $ git worktree remove ../bar
    fatal: validation failed, cannot remove working tree:
        '.../bar' does not point back to '.git/worktrees/bar'

Fix this shortcoming by enhancing "git worktree move" to perform the
same additional validation of the destination directory as done by "git
worktree add".

While at it, add a test to verify that "git worktree move" won't move a
worktree atop an existing (non-worktree) path -- a restriction which has
always been in place but was never tested.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-06-10 10:54:49 -07:00

247 lines
6.6 KiB
Bash
Executable File

#!/bin/sh
test_description='test git worktree move, remove, lock and unlock'
. ./test-lib.sh
test_expect_success 'setup' '
test_commit init &&
git worktree add source &&
git worktree list --porcelain >out &&
grep "^worktree" out >actual &&
cat <<-EOF >expected &&
worktree $(pwd)
worktree $(pwd)/source
EOF
test_cmp expected actual
'
test_expect_success 'lock main worktree' '
test_must_fail git worktree lock .
'
test_expect_success 'lock linked worktree' '
git worktree lock --reason hahaha source &&
echo hahaha >expected &&
test_cmp expected .git/worktrees/source/locked
'
test_expect_success 'lock linked worktree from another worktree' '
rm .git/worktrees/source/locked &&
git worktree add elsewhere &&
git -C elsewhere worktree lock --reason hahaha ../source &&
echo hahaha >expected &&
test_cmp expected .git/worktrees/source/locked
'
test_expect_success 'lock worktree twice' '
test_must_fail git worktree lock source &&
echo hahaha >expected &&
test_cmp expected .git/worktrees/source/locked
'
test_expect_success 'lock worktree twice (from the locked worktree)' '
test_must_fail git -C source worktree lock . &&
echo hahaha >expected &&
test_cmp expected .git/worktrees/source/locked
'
test_expect_success 'unlock main worktree' '
test_must_fail git worktree unlock .
'
test_expect_success 'unlock linked worktree' '
git worktree unlock source &&
test_path_is_missing .git/worktrees/source/locked
'
test_expect_success 'unlock worktree twice' '
test_must_fail git worktree unlock source &&
test_path_is_missing .git/worktrees/source/locked
'
test_expect_success 'move non-worktree' '
mkdir abc &&
test_must_fail git worktree move abc def
'
test_expect_success 'move locked worktree' '
git worktree lock source &&
test_when_finished "git worktree unlock source" &&
test_must_fail git worktree move source destination
'
test_expect_success 'move worktree' '
git worktree move source destination &&
test_path_is_missing source &&
git worktree list --porcelain >out &&
grep "^worktree.*/destination$" out &&
! grep "^worktree.*/source$" out &&
git -C destination log --format=%s >actual2 &&
echo init >expected2 &&
test_cmp expected2 actual2
'
test_expect_success 'move main worktree' '
test_must_fail git worktree move . def
'
test_expect_success 'move worktree to another dir' '
mkdir some-dir &&
git worktree move destination some-dir &&
test_when_finished "git worktree move some-dir/destination destination" &&
test_path_is_missing destination &&
git worktree list --porcelain >out &&
grep "^worktree.*/some-dir/destination$" out &&
git -C some-dir/destination log --format=%s >actual2 &&
echo init >expected2 &&
test_cmp expected2 actual2
'
test_expect_success 'move locked worktree (force)' '
test_when_finished "
git worktree unlock flump || :
git worktree remove flump || :
git worktree unlock ploof || :
git worktree remove ploof || :
" &&
git worktree add --detach flump &&
git worktree lock flump &&
test_must_fail git worktree move flump ploof" &&
test_must_fail git worktree move --force flump ploof" &&
git worktree move --force --force flump ploof
'
test_expect_success 'refuse to move worktree atop existing path' '
>bobble &&
git worktree add --detach beeble &&
test_must_fail git worktree move beeble bobble
'
test_expect_success 'move atop existing but missing worktree' '
git worktree add --detach gnoo &&
git worktree add --detach pneu &&
rm -fr pneu &&
test_must_fail git worktree move gnoo pneu &&
git worktree move --force gnoo pneu &&
git worktree add --detach nu &&
git worktree lock nu &&
rm -fr nu &&
test_must_fail git worktree move pneu nu &&
test_must_fail git worktree --force move pneu nu &&
git worktree move --force --force pneu nu
'
test_expect_success 'move a repo with uninitialized submodule' '
git init withsub &&
(
cd withsub &&
test_commit initial &&
git submodule add "$PWD"/.git sub &&
git commit -m withsub &&
git worktree add second HEAD &&
git worktree move second third
)
'
test_expect_success 'not move a repo with initialized submodule' '
(
cd withsub &&
git -C third submodule update &&
test_must_fail git worktree move third forth
)
'
test_expect_success 'remove main worktree' '
test_must_fail git worktree remove .
'
test_expect_success 'remove locked worktree' '
git worktree lock destination &&
test_when_finished "git worktree unlock destination" &&
test_must_fail git worktree remove destination
'
test_expect_success 'remove worktree with dirty tracked file' '
echo dirty >>destination/init.t &&
test_when_finished "git -C destination checkout init.t" &&
test_must_fail git worktree remove destination
'
test_expect_success 'remove worktree with untracked file' '
: >destination/untracked &&
test_must_fail git worktree remove destination
'
test_expect_success 'force remove worktree with untracked file' '
git worktree remove --force destination &&
test_path_is_missing destination
'
test_expect_success 'remove missing worktree' '
git worktree add to-be-gone &&
test -d .git/worktrees/to-be-gone &&
mv to-be-gone gone &&
git worktree remove to-be-gone &&
test_path_is_missing .git/worktrees/to-be-gone
'
test_expect_success 'NOT remove missing-but-locked worktree' '
git worktree add gone-but-locked &&
git worktree lock gone-but-locked &&
test -d .git/worktrees/gone-but-locked &&
mv gone-but-locked really-gone-now &&
test_must_fail git worktree remove gone-but-locked &&
test_path_is_dir .git/worktrees/gone-but-locked
'
test_expect_success 'proper error when worktree not found' '
for i in noodle noodle/bork
do
test_must_fail git worktree lock $i 2>err &&
test_i18ngrep "not a working tree" err || return 1
done
'
test_expect_success 'remove locked worktree (force)' '
git worktree add --detach gumby &&
test_when_finished "git worktree remove gumby || :" &&
git worktree lock gumby &&
test_when_finished "git worktree unlock gumby || :" &&
test_must_fail git worktree remove gumby &&
test_must_fail git worktree remove --force gumby &&
git worktree remove --force --force gumby
'
test_expect_success 'remove cleans up .git/worktrees when empty' '
git init moog &&
(
cd moog &&
test_commit bim &&
git worktree add --detach goom &&
test_path_exists .git/worktrees &&
git worktree remove goom &&
test_path_is_missing .git/worktrees
)
'
test_expect_success 'remove a repo with uninitialized submodule' '
(
cd withsub &&
git worktree add to-remove HEAD &&
git worktree remove to-remove
)
'
test_expect_success 'not remove a repo with initialized submodule' '
(
cd withsub &&
git worktree add to-remove HEAD &&
git -C to-remove submodule update &&
test_must_fail git worktree remove to-remove
)
'
test_done