git/t/t7425-submodule-gitdir-path-extension.sh
Adrian Ratiu e897c9b7f3 submodule: detect conflicts with existing gitdir configs
Credit goes to Emily and Josh for testing and noticing a corner-case
which caused conflicts with existing gitdir configs to silently pass
validation, then fail later in add_submodule() with a cryptic error:

fatal: A git directory for 'nested%2fsub' is found locally with remote(s):
  origin	/.../trash directory.t7425-submodule-gitdir-path-extension/sub

This change ensures the validation step checks existing gitdirs for
conflicts. We only have to do this for submodules having gitdirs,
because those without submodule.%s.gitdir need to be migrated and
will throw an error earlier in the submodule codepath.

Quoting Josh:
 My testing setup has been as follows:
 * Using our locally-built Git with our downstream patch of [1] included:
   * create a repo "sub"
   * create a repo "super"
   * In "super":
     * mkdir nested
     * git submodule add ../sub nested/sub
     * Verify that the submodule's gitdir is .git/modules/nested%2fsub
 * Using a build of git from upstream `next` plus this series:
   * git config set --global extensions.submodulepathconfig true
   * git clone --recurse-submodules super super2
   * create a repo "nested%2fsub"
   * In "super2":
     * git submodule add ../nested%2fsub

At this point I'd expect the collision detection / encoding to take
effect, but instead I get the error listed above.
End quote

Suggested-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Adrian Ratiu <adrian.ratiu@collabora.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2026-01-12 11:56:57 -08:00

529 lines
18 KiB
Bash
Executable File

#!/bin/sh
test_description='submodulePathConfig extension works as expected'
. ./test-lib.sh
. "$TEST_DIRECTORY"/lib-verify-submodule-gitdir-path.sh
test_expect_success 'setup: allow file protocol' '
git config --global protocol.file.allow always
'
test_expect_success 'create repo with mixed extension submodules' '
git init -b main legacy-sub &&
test_commit -C legacy-sub legacy-initial &&
legacy_rev=$(git -C legacy-sub rev-parse HEAD) &&
git init -b main new-sub &&
test_commit -C new-sub new-initial &&
new_rev=$(git -C new-sub rev-parse HEAD) &&
git init -b main main &&
(
cd main &&
git submodule add ../legacy-sub legacy &&
test_commit legacy-sub &&
# trigger the "die_path_inside_submodule" check
test_must_fail git submodule add ../new-sub "legacy/nested" &&
git config core.repositoryformatversion 1 &&
git config extensions.submodulePathConfig true &&
git submodule add ../new-sub "New Sub" &&
test_commit new &&
# retrigger the "die_path_inside_submodule" check with encoding
test_must_fail git submodule add ../new-sub "New Sub/nested2"
)
'
test_expect_success 'verify new submodule gitdir config' '
git -C main config submodule."New Sub".gitdir >actual &&
echo ".git/modules/New Sub" >expect &&
test_cmp expect actual &&
verify_submodule_gitdir_path main "New Sub" "modules/New Sub"
'
test_expect_success 'manual add and verify legacy submodule gitdir config' '
# the legacy module should not contain a gitdir config, because it
# was added before the extension was enabled. Add and test it.
test_must_fail git -C main config submodule.legacy.gitdir &&
git -C main config submodule.legacy.gitdir .git/modules/legacy &&
git -C main config submodule.legacy.gitdir >actual &&
echo ".git/modules/legacy" >expect &&
test_cmp expect actual &&
verify_submodule_gitdir_path main "legacy" "modules/legacy"
'
test_expect_success 'gitdir config path is relative for both absolute and relative urls' '
test_when_finished "rm -rf relative-cfg-path-test" &&
git init -b main relative-cfg-path-test &&
(
cd relative-cfg-path-test &&
git config core.repositoryformatversion 1 &&
git config extensions.submodulePathConfig true &&
# Test with absolute URL
git submodule add "$TRASH_DIRECTORY/new-sub" sub-abs &&
git config submodule.sub-abs.gitdir >actual &&
echo ".git/modules/sub-abs" >expect &&
test_cmp expect actual &&
# Test with relative URL
git submodule add ../new-sub sub-rel &&
git config submodule.sub-rel.gitdir >actual &&
echo ".git/modules/sub-rel" >expect &&
test_cmp expect actual
)
'
test_expect_success 'clone from repo with both legacy and new-style submodules' '
git clone --recurse-submodules main cloned-non-extension &&
(
cd cloned-non-extension &&
test_path_is_dir .git/modules/legacy &&
test_path_is_dir .git/modules/"New Sub" &&
test_must_fail git config submodule.legacy.gitdir &&
test_must_fail git config submodule."New Sub".gitdir &&
git submodule status >list &&
test_grep "$legacy_rev legacy" list &&
test_grep "$new_rev New Sub" list
) &&
git clone -c extensions.submodulePathConfig=true --recurse-submodules main cloned-extension &&
(
cd cloned-extension &&
test_path_is_dir .git/modules/legacy &&
test_path_is_dir ".git/modules/New Sub" &&
git config submodule.legacy.gitdir &&
git config submodule."New Sub".gitdir &&
git submodule status >list &&
test_grep "$legacy_rev legacy" list &&
test_grep "$new_rev New Sub" list
)
'
test_expect_success 'commit and push changes to encoded submodules' '
git -C legacy-sub config receive.denyCurrentBranch updateInstead &&
git -C new-sub config receive.denyCurrentBranch updateInstead &&
git -C main config receive.denyCurrentBranch updateInstead &&
(
cd cloned-extension &&
git -C legacy switch --track -C main origin/main &&
test_commit -C legacy second-commit &&
git -C legacy push &&
git -C "New Sub" switch --track -C main origin/main &&
test_commit -C "New Sub" second-commit &&
git -C "New Sub" push &&
# Stage and commit submodule changes in superproject
git switch --track -C main origin/main &&
git add legacy "New Sub" &&
git commit -m "update submodules" &&
# push superproject commit to main repo
git push
) &&
# update expected legacy & new submodule checksums
legacy_rev=$(git -C legacy-sub rev-parse HEAD) &&
new_rev=$(git -C new-sub rev-parse HEAD)
'
test_expect_success 'fetch mixed submodule changes and verify updates' '
(
cd main &&
# only update submodules because superproject was
# pushed into at the end of last test
git submodule update --init --recursive &&
test_path_is_dir .git/modules/legacy &&
test_path_is_dir ".git/modules/New Sub" &&
# Verify both submodules are at the expected commits
git submodule status >list &&
test_grep "$legacy_rev legacy" list &&
test_grep "$new_rev New Sub" list
)
'
test_expect_success '`git init` respects init.defaultSubmodulePathConfig' '
test_config_global init.defaultSubmodulePathConfig true &&
git init repo-init &&
git -C repo-init config extensions.submodulePathConfig >actual &&
echo true >expect &&
test_cmp expect actual &&
# create a submodule and check gitdir
(
cd repo-init &&
git init -b main sub &&
test_commit -C sub sub-initial &&
git submodule add ./sub sub &&
git config submodule.sub.gitdir >actual &&
echo ".git/modules/sub" >expect &&
test_cmp expect actual
)
'
test_expect_success '`git init` does not set extension by default' '
git init upstream &&
test_commit -C upstream initial &&
test_must_fail git -C upstream config extensions.submodulePathConfig &&
# create a pair of submodules and check gitdir is not created
git init -b main sub &&
test_commit -C sub sub-initial &&
(
cd upstream &&
git submodule add ../sub sub1 &&
test_path_is_dir .git/modules/sub1 &&
test_must_fail git config submodule.sub1.gitdir &&
git submodule add ../sub sub2 &&
test_path_is_dir .git/modules/sub2 &&
test_must_fail git config submodule.sub2.gitdir &&
git commit -m "Add submodules"
)
'
test_expect_success '`git clone` does not set extension by default' '
test_when_finished "rm -rf repo-clone-no-ext" &&
git clone upstream repo-clone-no-ext &&
(
cd repo-clone-no-ext &&
test_must_fail git config extensions.submodulePathConfig &&
test_path_is_missing .git/modules/sub1 &&
test_path_is_missing .git/modules/sub2 &&
# create a submodule and check gitdir is not created
git submodule add ../sub sub3 &&
test_must_fail git config submodule.sub3.gitdir
)
'
test_expect_success '`git clone --recurse-submodules` does not set extension by default' '
test_when_finished "rm -rf repo-clone-no-ext" &&
git clone --recurse-submodules upstream repo-clone-no-ext &&
(
cd repo-clone-no-ext &&
# verify that that submodules do not have gitdir set
test_must_fail git config extensions.submodulePathConfig &&
test_path_is_dir .git/modules/sub1 &&
test_must_fail git config submodule.sub1.gitdir &&
test_path_is_dir .git/modules/sub2 &&
test_must_fail git config submodule.sub2.gitdir &&
# create another submodule and check that gitdir is not created
git submodule add ../sub sub3 &&
test_path_is_dir .git/modules/sub3 &&
test_must_fail git config submodule.sub3.gitdir
)
'
test_expect_success '`git clone` respects init.defaultSubmodulePathConfig' '
test_when_finished "rm -rf repo-clone" &&
test_config_global init.defaultSubmodulePathConfig true &&
git clone upstream repo-clone &&
(
cd repo-clone &&
# verify new repo extension is inherited from global config
git config extensions.submodulePathConfig >actual &&
echo true >expect &&
test_cmp expect actual &&
# new submodule has a gitdir config
git submodule add ../sub sub &&
test_path_is_dir .git/modules/sub &&
git config submodule.sub.gitdir >actual &&
echo ".git/modules/sub" >expect &&
test_cmp expect actual
)
'
test_expect_success '`git clone --recurse-submodules` respects init.defaultSubmodulePathConfig' '
test_when_finished "rm -rf repo-clone-recursive" &&
test_config_global init.defaultSubmodulePathConfig true &&
git clone --recurse-submodules upstream repo-clone-recursive &&
(
cd repo-clone-recursive &&
# verify new repo extension is inherited from global config
git config extensions.submodulePathConfig >actual &&
echo true >expect &&
test_cmp expect actual &&
# previous submodules should exist
git config submodule.sub1.gitdir &&
git config submodule.sub2.gitdir &&
test_path_is_dir .git/modules/sub1 &&
test_path_is_dir .git/modules/sub2 &&
# create another submodule and check that gitdir is created
git submodule add ../sub new-sub &&
test_path_is_dir .git/modules/new-sub &&
git config submodule.new-sub.gitdir >actual &&
echo ".git/modules/new-sub" >expect &&
test_cmp expect actual
)
'
test_expect_success 'submodule--helper migrates legacy modules' '
(
cd upstream &&
# previous submodules exist and were not migrated yet
test_must_fail git config submodule.sub1.gitdir &&
test_must_fail git config submodule.sub2.gitdir &&
test_path_is_dir .git/modules/sub1 &&
test_path_is_dir .git/modules/sub2 &&
# run migration
git submodule--helper migrate-gitdir-configs &&
# test that migration worked
git config submodule.sub1.gitdir >actual &&
echo ".git/modules/sub1" >expect &&
test_cmp expect actual &&
git config submodule.sub2.gitdir >actual &&
echo ".git/modules/sub2" >expect &&
test_cmp expect actual &&
# repository extension is enabled after migration
git config extensions.submodulePathConfig >actual &&
echo "true" >expect &&
test_cmp expect actual
)
'
test_expect_success '`git clone --recurse-submodules` works after migration' '
test_when_finished "rm -rf repo-clone-recursive" &&
# test with extension disabled after the upstream repo was migrated
git clone --recurse-submodules upstream repo-clone-recursive &&
(
cd repo-clone-recursive &&
# init.defaultSubmodulePathConfig was disabled before clone, so
# the repo extension config should also be off, the migration ignored
test_must_fail git config extensions.submodulePathConfig &&
# modules should look like there was no migration done
test_must_fail git config submodule.sub1.gitdir &&
test_must_fail git config submodule.sub2.gitdir &&
test_path_is_dir .git/modules/sub1 &&
test_path_is_dir .git/modules/sub2
) &&
rm -rf repo-clone-recursive &&
# enable the extension, then retry the clone
test_config_global init.defaultSubmodulePathConfig true &&
git clone --recurse-submodules upstream repo-clone-recursive &&
(
cd repo-clone-recursive &&
# repository extension is enabled
git config extensions.submodulePathConfig >actual &&
echo "true" >expect &&
test_cmp expect actual &&
# gitdir configs exist for submodules
git config submodule.sub1.gitdir &&
git config submodule.sub2.gitdir &&
test_path_is_dir .git/modules/sub1 &&
test_path_is_dir .git/modules/sub2
)
'
test_expect_success 'setup submodules with nested git dirs' '
git init nested &&
test_commit -C nested nested &&
(
cd nested &&
cat >.gitmodules <<-EOF &&
[submodule "hippo"]
url = .
path = thing1
[submodule "hippo/hooks"]
url = .
path = thing2
EOF
git clone . thing1 &&
git clone . thing2 &&
git add .gitmodules thing1 thing2 &&
test_tick &&
git commit -m nested
)
'
test_expect_success 'git dirs of encoded sibling submodules must not be nested' '
git clone -c extensions.submodulePathConfig=true --recurse-submodules nested clone_nested &&
verify_submodule_gitdir_path clone_nested hippo modules/hippo &&
git -C clone_nested config submodule.hippo.gitdir >actual &&
test_grep "\.git/modules/hippo$" actual &&
verify_submodule_gitdir_path clone_nested hippo/hooks modules/hippo%2fhooks &&
git -C clone_nested config submodule.hippo/hooks.gitdir >actual &&
test_grep "\.git/modules/hippo%2fhooks$" actual
'
test_expect_success 'submodule git dir nesting detection must work with parallel cloning' '
git clone -c extensions.submodulePathConfig=true --recurse-submodules --jobs=2 nested clone_parallel &&
verify_submodule_gitdir_path clone_parallel hippo modules/hippo &&
git -C clone_nested config submodule.hippo.gitdir >actual &&
test_grep "\.git/modules/hippo$" actual &&
verify_submodule_gitdir_path clone_parallel hippo/hooks modules/hippo%2fhooks &&
git -C clone_nested config submodule.hippo/hooks.gitdir >actual &&
test_grep "\.git/modules/hippo%2fhooks$" actual
'
test_expect_success 'disabling extensions.submodulePathConfig prevents nested submodules' '
(
cd clone_nested &&
# disable extension and verify failure
git config --replace-all extensions.submodulePathConfig false &&
test_must_fail git submodule add ./thing2 hippo/foobar &&
# re-enable extension and verify it works
git config --replace-all extensions.submodulePathConfig true &&
git submodule add ./thing2 hippo/foobar
)
'
test_expect_success CASE_INSENSITIVE_FS 'verify case-folding conflicts are correctly encoded' '
git clone -c extensions.submodulePathConfig=true main cloned-folding &&
(
cd cloned-folding &&
# conflict: the "folding" gitdir will already be taken
git submodule add ../new-sub "folding" &&
test_commit lowercase &&
git submodule add ../new-sub "FoldinG" &&
test_commit uppercase &&
# conflict: the "foo" gitdir will already be taken
git submodule add ../new-sub "FOO" &&
test_commit uppercase-foo &&
git submodule add ../new-sub "foo" &&
test_commit lowercase-foo &&
# create a multi conflict between foobar, fooBar and foo%42ar
# the "foo" gitdir will already be taken
git submodule add ../new-sub "foobar" &&
test_commit lowercase-foobar &&
git submodule add ../new-sub "foo%42ar" &&
test_commit encoded-foo%42ar &&
git submodule add ../new-sub "fooBar" &&
test_commit mixed-fooBar
) &&
verify_submodule_gitdir_path cloned-folding "folding" "modules/folding" &&
verify_submodule_gitdir_path cloned-folding "FoldinG" "modules/%46oldin%47" &&
verify_submodule_gitdir_path cloned-folding "FOO" "modules/FOO" &&
verify_submodule_gitdir_path cloned-folding "foo" "modules/foo0" &&
verify_submodule_gitdir_path cloned-folding "foobar" "modules/foobar" &&
verify_submodule_gitdir_path cloned-folding "foo%42ar" "modules/foo%42ar" &&
verify_submodule_gitdir_path cloned-folding "fooBar" "modules/fooBar0"
'
test_expect_success CASE_INSENSITIVE_FS 'verify hashing conflict resolution as a last resort' '
git clone -c extensions.submodulePathConfig=true main cloned-hash &&
(
cd cloned-hash &&
# conflict: add all submodule conflicting variants until we reach the
# final hashing conflict resolution for submodule "foo"
git submodule add ../new-sub "foo" &&
git submodule add ../new-sub "foo0" &&
git submodule add ../new-sub "foo1" &&
git submodule add ../new-sub "foo2" &&
git submodule add ../new-sub "foo3" &&
git submodule add ../new-sub "foo4" &&
git submodule add ../new-sub "foo5" &&
git submodule add ../new-sub "foo6" &&
git submodule add ../new-sub "foo7" &&
git submodule add ../new-sub "foo8" &&
git submodule add ../new-sub "foo9" &&
git submodule add ../new-sub "%46oo" &&
git submodule add ../new-sub "%46oo0" &&
git submodule add ../new-sub "%46oo1" &&
git submodule add ../new-sub "%46oo2" &&
git submodule add ../new-sub "%46oo3" &&
git submodule add ../new-sub "%46oo4" &&
git submodule add ../new-sub "%46oo5" &&
git submodule add ../new-sub "%46oo6" &&
git submodule add ../new-sub "%46oo7" &&
git submodule add ../new-sub "%46oo8" &&
git submodule add ../new-sub "%46oo9" &&
test_commit add-foo-variants &&
git submodule add ../new-sub "Foo" &&
test_commit add-uppercase-foo
) &&
verify_submodule_gitdir_path cloned-hash "foo" "modules/foo" &&
verify_submodule_gitdir_path cloned-hash "foo0" "modules/foo0" &&
verify_submodule_gitdir_path cloned-hash "foo1" "modules/foo1" &&
verify_submodule_gitdir_path cloned-hash "foo2" "modules/foo2" &&
verify_submodule_gitdir_path cloned-hash "foo3" "modules/foo3" &&
verify_submodule_gitdir_path cloned-hash "foo4" "modules/foo4" &&
verify_submodule_gitdir_path cloned-hash "foo5" "modules/foo5" &&
verify_submodule_gitdir_path cloned-hash "foo6" "modules/foo6" &&
verify_submodule_gitdir_path cloned-hash "foo7" "modules/foo7" &&
verify_submodule_gitdir_path cloned-hash "foo8" "modules/foo8" &&
verify_submodule_gitdir_path cloned-hash "foo9" "modules/foo9" &&
verify_submodule_gitdir_path cloned-hash "%46oo" "modules/%46oo" &&
verify_submodule_gitdir_path cloned-hash "%46oo0" "modules/%46oo0" &&
verify_submodule_gitdir_path cloned-hash "%46oo1" "modules/%46oo1" &&
verify_submodule_gitdir_path cloned-hash "%46oo2" "modules/%46oo2" &&
verify_submodule_gitdir_path cloned-hash "%46oo3" "modules/%46oo3" &&
verify_submodule_gitdir_path cloned-hash "%46oo4" "modules/%46oo4" &&
verify_submodule_gitdir_path cloned-hash "%46oo5" "modules/%46oo5" &&
verify_submodule_gitdir_path cloned-hash "%46oo6" "modules/%46oo6" &&
verify_submodule_gitdir_path cloned-hash "%46oo7" "modules/%46oo7" &&
verify_submodule_gitdir_path cloned-hash "%46oo8" "modules/%46oo8" &&
verify_submodule_gitdir_path cloned-hash "%46oo9" "modules/%46oo9" &&
hash=$(printf "Foo" | git hash-object --stdin) &&
verify_submodule_gitdir_path cloned-hash "Foo" "modules/${hash}"
'
test_expect_success 'submodule gitdir conflicts with previously encoded name (local config)' '
git init -b main super_with_encoded &&
(
cd super_with_encoded &&
git config core.repositoryformatversion 1 &&
git config extensions.submodulePathConfig true &&
# Add a submodule with a nested path
git submodule add --name "nested/sub" ../sub nested/sub &&
test_commit add-encoded-gitdir &&
verify_submodule_gitdir_path . "nested/sub" "modules/nested%2fsub" &&
test_path_is_dir ".git/modules/nested%2fsub"
) &&
# create a submodule that will conflict with the encoded gitdir name:
# the existing gitdir is ".git/modules/nested%2fsub", which is used
# by "nested/sub", so the new submod will get another (non-conflicting)
# name: "nested%252fsub".
(
cd super_with_encoded &&
git submodule add ../sub "nested%2fsub" &&
verify_submodule_gitdir_path . "nested%2fsub" "modules/nested%252fsub" &&
test_path_is_dir ".git/modules/nested%252fsub"
)
'
test_done