mirror of
https://github.com/git/git
synced 2024-09-12 21:04:12 +00:00
c033a2f62d
When running 'git submodule foreach --recursive' from a subdirectory of
your repository, nested submodules get a bogus value for $path:
For a submodule 'sub' that contains a nested submodule 'nested',
running 'git -C dir submodule foreach echo $path' from the root of the
superproject would report path='../nested' for the nested submodule.
The first part '../' is derived from the logic computing the relative
path from $pwd to the root of the superproject. The second part is the
submodule path inside the submodule. This value is of little use and is
hard to document.
Also, in git-submodule.txt, $path is documented to be the "name of the
submodule directory relative to the superproject", but "the
superproject" is ambiguous.
To resolve both these issues, we could:
(a) Change "the superproject" to "its immediate superproject", so
$path would be "nested" instead of "../nested".
(b) Change "the superproject" to "the superproject the original
command was run from", so $path would be "sub/nested" instead of
"../nested".
(c) Change "the superproject" to "the directory the original command
was run from", so $path would be "../sub/nested" instead of
"../nested".
The behavior for (c) was attempted to be introduced in 091a6eb0fe
(submodule: drop the top-level requirement, 2013-06-16) with the intent
for $path to be relative from $pwd to the submodule worktree, but that
did not work for nested submodules, as the intermittent submodules
were not included in the path.
If we were to fix the meaning of the $path using (a), we would break
any existing submodule user that runs foreach from non-root of the
superproject as the non-nested submodule '../sub' would change its
path to 'sub'.
If we were to fix the meaning of $path using (b), then we would break
any user that uses nested submodules (even from the root directory)
as the 'nested' would become 'sub/nested'.
If we were to fix the meaning of $path using (c), then we would break
the same users as in (b) as 'nested' would become 'sub/nested' from
the root directory of the superproject.
All groups can be found in the wild. The author has no data if one group
outweighs the other by large margin, and offending each one seems equally
bad at first. However in the authors imagination it is better to go with
(a) as running from a sub directory sounds like it is carried out by a
human rather than by some automation task. With a human on the keyboard
the feedback loop is short and the changed behavior can be adapted to
quickly unlike some automation that can break silently.
Discussed-with: Ramsay Jones <ramsay@ramsayjones.plus.com>
Signed-off-by: Prathamesh Chavan <pc44800@gmail.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
415 lines
12 KiB
Bash
Executable file
415 lines
12 KiB
Bash
Executable file
#!/bin/sh
|
|
#
|
|
# Copyright (c) 2009 Johan Herland
|
|
#
|
|
|
|
test_description='Test "git submodule foreach"
|
|
|
|
This test verifies that "git submodule foreach" correctly visits all submodules
|
|
that are currently checked out.
|
|
'
|
|
|
|
. ./test-lib.sh
|
|
|
|
|
|
test_expect_success 'setup a submodule tree' '
|
|
echo file > file &&
|
|
git add file &&
|
|
test_tick &&
|
|
git commit -m upstream &&
|
|
git clone . super &&
|
|
git clone super submodule &&
|
|
(
|
|
cd super &&
|
|
git submodule add ../submodule sub1 &&
|
|
git submodule add ../submodule sub2 &&
|
|
git submodule add ../submodule sub3 &&
|
|
git config -f .gitmodules --rename-section \
|
|
submodule.sub1 submodule.foo1 &&
|
|
git config -f .gitmodules --rename-section \
|
|
submodule.sub2 submodule.foo2 &&
|
|
git config -f .gitmodules --rename-section \
|
|
submodule.sub3 submodule.foo3 &&
|
|
git add .gitmodules &&
|
|
test_tick &&
|
|
git commit -m "submodules" &&
|
|
git submodule init sub1 &&
|
|
git submodule init sub2 &&
|
|
git submodule init sub3
|
|
) &&
|
|
(
|
|
cd submodule &&
|
|
echo different > file &&
|
|
git add file &&
|
|
test_tick &&
|
|
git commit -m "different"
|
|
) &&
|
|
(
|
|
cd super &&
|
|
(
|
|
cd sub3 &&
|
|
git pull
|
|
) &&
|
|
git add sub3 &&
|
|
test_tick &&
|
|
git commit -m "update sub3"
|
|
)
|
|
'
|
|
|
|
sub1sha1=$(cd super/sub1 && git rev-parse HEAD)
|
|
sub3sha1=$(cd super/sub3 && git rev-parse HEAD)
|
|
|
|
pwd=$(pwd)
|
|
|
|
cat > expect <<EOF
|
|
Entering 'sub1'
|
|
$pwd/clone-foo1-sub1-$sub1sha1
|
|
Entering 'sub3'
|
|
$pwd/clone-foo3-sub3-$sub3sha1
|
|
EOF
|
|
|
|
test_expect_success 'test basic "submodule foreach" usage' '
|
|
git clone super clone &&
|
|
(
|
|
cd clone &&
|
|
git submodule update --init -- sub1 sub3 &&
|
|
git submodule foreach "echo \$toplevel-\$name-\$path-\$sha1" > ../actual &&
|
|
git config foo.bar zar &&
|
|
git submodule foreach "git config --file \"\$toplevel/.git/config\" foo.bar"
|
|
) &&
|
|
test_i18ncmp expect actual
|
|
'
|
|
|
|
cat >expect <<EOF
|
|
Entering '../sub1'
|
|
$pwd/clone-foo1-sub1-$sub1sha1
|
|
Entering '../sub3'
|
|
$pwd/clone-foo3-sub3-$sub3sha1
|
|
EOF
|
|
|
|
test_expect_success 'test "submodule foreach" from subdirectory' '
|
|
mkdir clone/sub &&
|
|
(
|
|
cd clone/sub &&
|
|
git submodule foreach "echo \$toplevel-\$name-\$sm_path-\$sha1" >../../actual
|
|
) &&
|
|
test_i18ncmp expect actual
|
|
'
|
|
|
|
test_expect_success 'setup nested submodules' '
|
|
git clone submodule nested1 &&
|
|
git clone submodule nested2 &&
|
|
git clone submodule nested3 &&
|
|
(
|
|
cd nested3 &&
|
|
git submodule add ../submodule submodule &&
|
|
test_tick &&
|
|
git commit -m "submodule" &&
|
|
git submodule init submodule
|
|
) &&
|
|
(
|
|
cd nested2 &&
|
|
git submodule add ../nested3 nested3 &&
|
|
test_tick &&
|
|
git commit -m "nested3" &&
|
|
git submodule init nested3
|
|
) &&
|
|
(
|
|
cd nested1 &&
|
|
git submodule add ../nested2 nested2 &&
|
|
test_tick &&
|
|
git commit -m "nested2" &&
|
|
git submodule init nested2
|
|
) &&
|
|
(
|
|
cd super &&
|
|
git submodule add ../nested1 nested1 &&
|
|
test_tick &&
|
|
git commit -m "nested1" &&
|
|
git submodule init nested1
|
|
)
|
|
'
|
|
|
|
test_expect_success 'use "submodule foreach" to checkout 2nd level submodule' '
|
|
git clone super clone2 &&
|
|
(
|
|
cd clone2 &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub1/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub2/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub3/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir nested1/.git &&
|
|
git submodule update --init &&
|
|
git rev-parse --resolve-git-dir sub1/.git &&
|
|
git rev-parse --resolve-git-dir sub2/.git &&
|
|
git rev-parse --resolve-git-dir sub3/.git &&
|
|
git rev-parse --resolve-git-dir nested1/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir nested1/nested2/.git &&
|
|
git submodule foreach "git submodule update --init" &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir nested1/nested2/nested3/.git
|
|
)
|
|
'
|
|
|
|
test_expect_success 'use "foreach --recursive" to checkout all submodules' '
|
|
(
|
|
cd clone2 &&
|
|
git submodule foreach --recursive "git submodule update --init" &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/nested3/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/nested3/submodule/.git
|
|
)
|
|
'
|
|
|
|
cat > expect <<EOF
|
|
Entering 'nested1'
|
|
Entering 'nested1/nested2'
|
|
Entering 'nested1/nested2/nested3'
|
|
Entering 'nested1/nested2/nested3/submodule'
|
|
Entering 'sub1'
|
|
Entering 'sub2'
|
|
Entering 'sub3'
|
|
EOF
|
|
|
|
test_expect_success 'test messages from "foreach --recursive"' '
|
|
(
|
|
cd clone2 &&
|
|
git submodule foreach --recursive "true" > ../actual
|
|
) &&
|
|
test_i18ncmp expect actual
|
|
'
|
|
|
|
cat > expect <<EOF
|
|
Entering '../nested1'
|
|
Entering '../nested1/nested2'
|
|
Entering '../nested1/nested2/nested3'
|
|
Entering '../nested1/nested2/nested3/submodule'
|
|
Entering '../sub1'
|
|
Entering '../sub2'
|
|
Entering '../sub3'
|
|
EOF
|
|
|
|
test_expect_success 'test messages from "foreach --recursive" from subdirectory' '
|
|
(
|
|
cd clone2 &&
|
|
mkdir untracked &&
|
|
cd untracked &&
|
|
git submodule foreach --recursive >../../actual
|
|
) &&
|
|
test_i18ncmp expect actual
|
|
'
|
|
sub1sha1=$(cd clone2/sub1 && git rev-parse HEAD)
|
|
sub2sha1=$(cd clone2/sub2 && git rev-parse HEAD)
|
|
sub3sha1=$(cd clone2/sub3 && git rev-parse HEAD)
|
|
nested1sha1=$(cd clone2/nested1 && git rev-parse HEAD)
|
|
nested2sha1=$(cd clone2/nested1/nested2 && git rev-parse HEAD)
|
|
nested3sha1=$(cd clone2/nested1/nested2/nested3 && git rev-parse HEAD)
|
|
submodulesha1=$(cd clone2/nested1/nested2/nested3/submodule && git rev-parse HEAD)
|
|
|
|
cat >expect <<EOF
|
|
Entering '../nested1'
|
|
toplevel: $pwd/clone2 name: nested1 path: nested1 hash: $nested1sha1
|
|
Entering '../nested1/nested2'
|
|
toplevel: $pwd/clone2/nested1 name: nested2 path: nested2 hash: $nested2sha1
|
|
Entering '../nested1/nested2/nested3'
|
|
toplevel: $pwd/clone2/nested1/nested2 name: nested3 path: nested3 hash: $nested3sha1
|
|
Entering '../nested1/nested2/nested3/submodule'
|
|
toplevel: $pwd/clone2/nested1/nested2/nested3 name: submodule path: submodule hash: $submodulesha1
|
|
Entering '../sub1'
|
|
toplevel: $pwd/clone2 name: foo1 path: sub1 hash: $sub1sha1
|
|
Entering '../sub2'
|
|
toplevel: $pwd/clone2 name: foo2 path: sub2 hash: $sub2sha1
|
|
Entering '../sub3'
|
|
toplevel: $pwd/clone2 name: foo3 path: sub3 hash: $sub3sha1
|
|
EOF
|
|
|
|
test_expect_success 'test "submodule foreach --recursive" from subdirectory' '
|
|
(
|
|
cd clone2/untracked &&
|
|
git submodule foreach --recursive "echo toplevel: \$toplevel name: \$name path: \$sm_path hash: \$sha1" >../../actual
|
|
) &&
|
|
test_i18ncmp expect actual
|
|
'
|
|
|
|
cat > expect <<EOF
|
|
nested1-nested1
|
|
nested2-nested2
|
|
nested3-nested3
|
|
submodule-submodule
|
|
foo1-sub1
|
|
foo2-sub2
|
|
foo3-sub3
|
|
EOF
|
|
|
|
test_expect_success 'test "foreach --quiet --recursive"' '
|
|
(
|
|
cd clone2 &&
|
|
git submodule foreach -q --recursive "echo \$name-\$path" > ../actual
|
|
) &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'use "update --recursive" to checkout all submodules' '
|
|
git clone super clone3 &&
|
|
(
|
|
cd clone3 &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub1/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub2/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub3/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir nested1/.git &&
|
|
git submodule update --init --recursive &&
|
|
git rev-parse --resolve-git-dir sub1/.git &&
|
|
git rev-parse --resolve-git-dir sub2/.git &&
|
|
git rev-parse --resolve-git-dir sub3/.git &&
|
|
git rev-parse --resolve-git-dir nested1/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/nested3/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/nested3/submodule/.git
|
|
)
|
|
'
|
|
|
|
nested1sha1=$(cd clone3/nested1 && git rev-parse HEAD)
|
|
nested2sha1=$(cd clone3/nested1/nested2 && git rev-parse HEAD)
|
|
nested3sha1=$(cd clone3/nested1/nested2/nested3 && git rev-parse HEAD)
|
|
submodulesha1=$(cd clone3/nested1/nested2/nested3/submodule && git rev-parse HEAD)
|
|
sub1sha1=$(cd clone3/sub1 && git rev-parse HEAD)
|
|
sub2sha1=$(cd clone3/sub2 && git rev-parse HEAD)
|
|
sub3sha1=$(cd clone3/sub3 && git rev-parse HEAD)
|
|
sub1sha1_short=$(cd clone3/sub1 && git rev-parse --short HEAD)
|
|
sub2sha1_short=$(cd clone3/sub2 && git rev-parse --short HEAD)
|
|
|
|
cat > expect <<EOF
|
|
$nested1sha1 nested1 (heads/master)
|
|
$nested2sha1 nested1/nested2 (heads/master)
|
|
$nested3sha1 nested1/nested2/nested3 (heads/master)
|
|
$submodulesha1 nested1/nested2/nested3/submodule (heads/master)
|
|
$sub1sha1 sub1 ($sub1sha1_short)
|
|
$sub2sha1 sub2 ($sub2sha1_short)
|
|
$sub3sha1 sub3 (heads/master)
|
|
EOF
|
|
|
|
test_expect_success 'test "status --recursive"' '
|
|
(
|
|
cd clone3 &&
|
|
git submodule status --recursive > ../actual
|
|
) &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
cat > expect <<EOF
|
|
$nested1sha1 nested1 (heads/master)
|
|
+$nested2sha1 nested1/nested2 (file2~1)
|
|
$nested3sha1 nested1/nested2/nested3 (heads/master)
|
|
$submodulesha1 nested1/nested2/nested3/submodule (heads/master)
|
|
EOF
|
|
|
|
test_expect_success 'ensure "status --cached --recursive" preserves the --cached flag' '
|
|
(
|
|
cd clone3 &&
|
|
(
|
|
cd nested1/nested2 &&
|
|
test_commit file2
|
|
) &&
|
|
git submodule status --cached --recursive -- nested1 > ../actual
|
|
) &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
nested2sha1=$(git -C clone3/nested1/nested2 rev-parse HEAD)
|
|
|
|
cat > expect <<EOF
|
|
$nested1sha1 ../nested1 (heads/master)
|
|
+$nested2sha1 ../nested1/nested2 (file2)
|
|
$nested3sha1 ../nested1/nested2/nested3 (heads/master)
|
|
$submodulesha1 ../nested1/nested2/nested3/submodule (heads/master)
|
|
$sub1sha1 ../sub1 ($sub1sha1_short)
|
|
$sub2sha1 ../sub2 ($sub2sha1_short)
|
|
$sub3sha1 ../sub3 (heads/master)
|
|
EOF
|
|
|
|
test_expect_success 'test "status --recursive" from sub directory' '
|
|
(
|
|
cd clone3 &&
|
|
mkdir tmp && cd tmp &&
|
|
git submodule status --recursive > ../../actual
|
|
) &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'use "git clone --recursive" to checkout all submodules' '
|
|
git clone --recursive super clone4 &&
|
|
(
|
|
cd clone4 &&
|
|
git rev-parse --resolve-git-dir .git &&
|
|
git rev-parse --resolve-git-dir sub1/.git &&
|
|
git rev-parse --resolve-git-dir sub2/.git &&
|
|
git rev-parse --resolve-git-dir sub3/.git &&
|
|
git rev-parse --resolve-git-dir nested1/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/nested3/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/nested3/submodule/.git
|
|
)
|
|
'
|
|
|
|
test_expect_success 'test "update --recursive" with a flag with spaces' '
|
|
git clone super "common objects" &&
|
|
git clone super clone5 &&
|
|
(
|
|
cd clone5 &&
|
|
test_must_fail git rev-parse --resolve-git-dir d nested1/.git &&
|
|
git submodule update --init --recursive --reference="$(dirname "$PWD")/common objects" &&
|
|
git rev-parse --resolve-git-dir nested1/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/nested3/.git &&
|
|
test -f .git/modules/nested1/objects/info/alternates &&
|
|
test -f .git/modules/nested1/modules/nested2/objects/info/alternates &&
|
|
test -f .git/modules/nested1/modules/nested2/modules/nested3/objects/info/alternates
|
|
)
|
|
'
|
|
|
|
test_expect_success 'use "update --recursive nested1" to checkout all submodules rooted in nested1' '
|
|
git clone super clone6 &&
|
|
(
|
|
cd clone6 &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub1/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub2/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub3/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir nested1/.git &&
|
|
git submodule update --init --recursive -- nested1 &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub1/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub2/.git &&
|
|
test_must_fail git rev-parse --resolve-git-dir sub3/.git &&
|
|
git rev-parse --resolve-git-dir nested1/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/nested3/.git &&
|
|
git rev-parse --resolve-git-dir nested1/nested2/nested3/submodule/.git
|
|
)
|
|
'
|
|
|
|
test_expect_success 'command passed to foreach retains notion of stdin' '
|
|
(
|
|
cd super &&
|
|
git submodule foreach echo success >../expected &&
|
|
yes | git submodule foreach "read y && test \"x\$y\" = xy && echo success" >../actual
|
|
) &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'command passed to foreach --recursive retains notion of stdin' '
|
|
(
|
|
cd clone2 &&
|
|
git submodule foreach --recursive echo success >../expected &&
|
|
yes | git submodule foreach --recursive "read y && test \"x\$y\" = xy && echo success" >../actual
|
|
) &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'multi-argument command passed to foreach is not shell-evaluated twice' '
|
|
(
|
|
cd super &&
|
|
git submodule foreach "echo \\\"quoted\\\"" > ../expected &&
|
|
git submodule foreach echo \"quoted\" > ../actual
|
|
) &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_done
|