development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-07-17 11:07:55 +00:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity
git/t/t7814-grep-recurse-submodules.sh
Derrick Stolee 9c7d1b057f repository: create read_replace_refs setting 
The 'read_replace_refs' global specifies whether or not we should
respect the references of the form 'refs/replace/<oid>' to replace which
object we look up when asking for '<oid>'. This global has caused issues
when it is not initialized properly, such as in b6551feadf (merge-tree:
load default git config, 2023-05-10).

To make this more robust, move its config-based initialization out of
git_default_config and into prepare_repo_settings(). This provides a
repository-scoped version of the 'read_replace_refs' global.

The global still has its purpose: it is disabled process-wide by the
GIT_NO_REPLACE_OBJECTS environment variable or by a call to
disable_replace_refs() in some specific Git commands.

Since we already encapsulated the use of the constant inside
replace_refs_enabled(), we can perform the initialization inside that
method, if necessary. This solves the problem of forgetting to check the
config, as we will check it before returning this value.

Due to this encapsulation, the global can move to be static within
replace-object.c.

There is an interesting behavior change possible here: we now have a
repository-scoped understanding of this config value. Thus, if there was
a command that recurses into submodules and might follow replace refs,
then it would now respect the core.useReplaceRefs config value in each
repository.

'git grep --recurse-submodules' is such a command that recurses into
submodules in-process. We can demonstrate the granularity of this config
value via a test in t7814.

Signed-off-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-06-12 13:34:55 -07:00

638 lines
18 KiB
Bash
Executable file
Raw Blame History

#!/bin/sh
test_description='Test grep recurse-submodules feature
This test verifies the recurse-submodules feature correctly greps across
submodules.
'
TEST_CREATE_REPO_NO_TEMPLATE=1
. ./test-lib.sh
GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB=1
export GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB
test_expect_success 'setup directory structure and submodule' '
echo "(1|2)d(3|4)" >a &&
mkdir b &&
echo "(3|4)" >b/b &&
git add a b &&
git commit -m "add a and b" &&
test_tick &&
git init submodule &&
echo "(1|2)d(3|4)" >submodule/a &&
git -C submodule add a &&
git -C submodule commit -m "add a" &&
git submodule add ./submodule &&
git commit -m "added submodule" &&
test_tick
'
test_expect_success 'grep correctly finds patterns in a submodule' '
cat >expect <<-\EOF &&
a:(1|2)d(3|4)
b/b:(3|4)
submodule/a:(1|2)d(3|4)
EOF
git grep -e "(3|4)" --recurse-submodules >actual &&
test_cmp expect actual
'
test_expect_success 'grep finds patterns in a submodule via config' '
test_config submodule.recurse true &&
# expect from previous test
git grep -e "(3|4)" >actual &&
test_cmp expect actual
'
test_expect_success 'grep --no-recurse-submodules overrides config' '
test_config submodule.recurse true &&
cat >expect <<-\EOF &&
a:(1|2)d(3|4)
b/b:(3|4)
EOF
git grep -e "(3|4)" --no-recurse-submodules >actual &&
test_cmp expect actual
'
test_expect_success 'grep and basic pathspecs' '
cat >expect <<-\EOF &&
submodule/a:(1|2)d(3|4)
EOF
git grep -e. --recurse-submodules -- submodule >actual &&
test_cmp expect actual
'
test_expect_success 'grep and nested submodules' '
git init submodule/sub &&
echo "(1|2)d(3|4)" >submodule/sub/a &&
git -C submodule/sub add a &&
git -C submodule/sub commit -m "add a" &&
test_tick &&
git -C submodule submodule add ./sub &&
git -C submodule add sub &&
git -C submodule commit -m "added sub" &&
test_tick &&
git add submodule &&
git commit -m "updated submodule" &&
test_tick &&
cat >expect <<-\EOF &&
a:(1|2)d(3|4)
b/b:(3|4)
submodule/a:(1|2)d(3|4)
submodule/sub/a:(1|2)d(3|4)
EOF
git grep -e "(3|4)" --recurse-submodules >actual &&
test_cmp expect actual
'
test_expect_success 'grep and multiple patterns' '
cat >expect <<-\EOF &&
a:(1|2)d(3|4)
submodule/a:(1|2)d(3|4)
submodule/sub/a:(1|2)d(3|4)
EOF
git grep -e "(3|4)" --and -e "(1|2)" --recurse-submodules >actual &&
test_cmp expect actual
'
test_expect_success 'grep and multiple patterns' '
cat >expect <<-\EOF &&
b/b:(3|4)
EOF
git grep -e "(3|4)" --and --not -e "(1|2)" --recurse-submodules >actual &&
test_cmp expect actual
'
test_expect_success 'basic grep tree' '
cat >expect <<-\EOF &&
HEAD:a:(1|2)d(3|4)
HEAD:b/b:(3|4)
HEAD:submodule/a:(1|2)d(3|4)
HEAD:submodule/sub/a:(1|2)d(3|4)
EOF
git grep -e "(3|4)" --recurse-submodules HEAD >actual &&
test_cmp expect actual
'
test_expect_success 'grep tree HEAD^' '
cat >expect <<-\EOF &&
HEAD^:a:(1|2)d(3|4)
HEAD^:b/b:(3|4)
HEAD^:submodule/a:(1|2)d(3|4)
EOF
git grep -e "(3|4)" --recurse-submodules HEAD^ >actual &&
test_cmp expect actual
'
test_expect_success 'grep tree HEAD^^' '
cat >expect <<-\EOF &&
HEAD^^:a:(1|2)d(3|4)
HEAD^^:b/b:(3|4)
EOF
git grep -e "(3|4)" --recurse-submodules HEAD^^ >actual &&
test_cmp expect actual
'
test_expect_success 'grep tree and pathspecs' '
cat >expect <<-\EOF &&
HEAD:submodule/a:(1|2)d(3|4)
HEAD:submodule/sub/a:(1|2)d(3|4)
EOF
git grep -e "(3|4)" --recurse-submodules HEAD -- submodule >actual &&
test_cmp expect actual
'
test_expect_success 'grep tree and pathspecs' '
cat >expect <<-\EOF &&
HEAD:submodule/a:(1|2)d(3|4)
HEAD:submodule/sub/a:(1|2)d(3|4)
EOF
git grep -e "(3|4)" --recurse-submodules HEAD -- "submodule*a" >actual &&
test_cmp expect actual
'
test_expect_success 'grep tree and more pathspecs' '
cat >expect <<-\EOF &&
HEAD:submodule/a:(1|2)d(3|4)
EOF
git grep -e "(3|4)" --recurse-submodules HEAD -- "submodul?/a" >actual &&
test_cmp expect actual
'
test_expect_success 'grep tree and more pathspecs' '
cat >expect <<-\EOF &&
HEAD:submodule/sub/a:(1|2)d(3|4)
EOF
git grep -e "(3|4)" --recurse-submodules HEAD -- "submodul*/sub/a" >actual &&
test_cmp expect actual
'
test_expect_success !MINGW 'grep recurse submodule colon in name' '
git init parent &&
test_when_finished "rm -rf parent" &&
echo "(1|2)d(3|4)" >"parent/fi:le" &&
git -C parent add "fi:le" &&
git -C parent commit -m "add fi:le" &&
test_tick &&
git init "su:b" &&
test_when_finished "rm -rf su:b" &&
echo "(1|2)d(3|4)" >"su:b/fi:le" &&
git -C "su:b" add "fi:le" &&
git -C "su:b" commit -m "add fi:le" &&
test_tick &&
test_config_global protocol.file.allow always &&
git -C parent submodule add "../su:b" "su:b" &&
git -C parent commit -m "add submodule" &&
test_tick &&
cat >expect <<-\EOF &&
fi:le:(1|2)d(3|4)
su:b/fi:le:(1|2)d(3|4)
EOF
git -C parent grep -e "(1|2)d(3|4)" --recurse-submodules >actual &&
test_cmp expect actual &&
cat >expect <<-\EOF &&
HEAD:fi:le:(1|2)d(3|4)
HEAD:su:b/fi:le:(1|2)d(3|4)
EOF
git -C parent grep -e "(1|2)d(3|4)" --recurse-submodules HEAD >actual &&
test_cmp expect actual
'
test_expect_success 'grep history with moved submoules' '
git init parent &&
test_when_finished "rm -rf parent" &&
echo "(1|2)d(3|4)" >parent/file &&
git -C parent add file &&
git -C parent commit -m "add file" &&
test_tick &&
git init sub &&
test_when_finished "rm -rf sub" &&
echo "(1|2)d(3|4)" >sub/file &&
git -C sub add file &&
git -C sub commit -m "add file" &&
test_tick &&
test_config_global protocol.file.allow always &&
git -C parent submodule add ../sub dir/sub &&
git -C parent commit -m "add submodule" &&
test_tick &&
cat >expect <<-\EOF &&
dir/sub/file:(1|2)d(3|4)
file:(1|2)d(3|4)
EOF
git -C parent grep -e "(1|2)d(3|4)" --recurse-submodules >actual &&
test_cmp expect actual &&
git -C parent mv dir/sub sub-moved &&
git -C parent commit -m "moved submodule" &&
test_tick &&
cat >expect <<-\EOF &&
file:(1|2)d(3|4)
sub-moved/file:(1|2)d(3|4)
EOF
git -C parent grep -e "(1|2)d(3|4)" --recurse-submodules >actual &&
test_cmp expect actual &&
cat >expect <<-\EOF &&
HEAD^:dir/sub/file:(1|2)d(3|4)
HEAD^:file:(1|2)d(3|4)
EOF
git -C parent grep -e "(1|2)d(3|4)" --recurse-submodules HEAD^ >actual &&
test_cmp expect actual
'
test_expect_success 'grep using relative path' '
test_when_finished "rm -rf parent sub" &&
git init sub &&
echo "(1|2)d(3|4)" >sub/file &&
git -C sub add file &&
git -C sub commit -m "add file" &&
test_tick &&
git init parent &&
echo "(1|2)d(3|4)" >parent/file &&
git -C parent add file &&
mkdir parent/src &&
echo "(1|2)d(3|4)" >parent/src/file2 &&
git -C parent add src/file2 &&
test_config_global protocol.file.allow always &&
git -C parent submodule add ../sub &&
git -C parent commit -m "add files and submodule" &&
test_tick &&
# From top works
cat >expect <<-\EOF &&
file:(1|2)d(3|4)
src/file2:(1|2)d(3|4)
sub/file:(1|2)d(3|4)
EOF
git -C parent grep --recurse-submodules -e "(1|2)d(3|4)" >actual &&
test_cmp expect actual &&
# Relative path to top
cat >expect <<-\EOF &&
../file:(1|2)d(3|4)
file2:(1|2)d(3|4)
../sub/file:(1|2)d(3|4)
EOF
git -C parent/src grep --recurse-submodules -e "(1|2)d(3|4)" -- .. >actual &&
test_cmp expect actual &&
# Relative path to submodule
cat >expect <<-\EOF &&
../sub/file:(1|2)d(3|4)
EOF
git -C parent/src grep --recurse-submodules -e "(1|2)d(3|4)" -- ../sub >actual &&
test_cmp expect actual
'
test_expect_success 'grep from a subdir' '
test_when_finished "rm -rf parent sub" &&
git init sub &&
echo "(1|2)d(3|4)" >sub/file &&
git -C sub add file &&
git -C sub commit -m "add file" &&
test_tick &&
git init parent &&
mkdir parent/src &&
echo "(1|2)d(3|4)" >parent/src/file &&
git -C parent add src/file &&
test_config_global protocol.file.allow always &&
git -C parent submodule add ../sub src/sub &&
git -C parent submodule add ../sub sub &&
git -C parent commit -m "add files and submodules" &&
test_tick &&
# Verify grep from root works
cat >expect <<-\EOF &&
src/file:(1|2)d(3|4)
src/sub/file:(1|2)d(3|4)
sub/file:(1|2)d(3|4)
EOF
git -C parent grep --recurse-submodules -e "(1|2)d(3|4)" >actual &&
test_cmp expect actual &&
# Verify grep from a subdir works
cat >expect <<-\EOF &&
file:(1|2)d(3|4)
sub/file:(1|2)d(3|4)
EOF
git -C parent/src grep --recurse-submodules -e "(1|2)d(3|4)" >actual &&
test_cmp expect actual
'
test_incompatible_with_recurse_submodules ()
{
test_expect_success "--recurse-submodules and $1 are incompatible" "
test_must_fail git grep -e. --recurse-submodules $1 2>actual &&
test_i18ngrep 'not supported with --recurse-submodules' actual
"
}
test_incompatible_with_recurse_submodules --untracked
test_expect_success 'grep --recurse-submodules --no-index ignores --recurse-submodules' '
git grep --recurse-submodules --no-index -e "^(.|.)[\d]" >actual &&
cat >expect <<-\EOF &&
a:(1|2)d(3|4)
submodule/a:(1|2)d(3|4)
submodule/sub/a:(1|2)d(3|4)
EOF
test_cmp expect actual
'
test_expect_success 'grep --recurse-submodules should pass the pattern type along' '
# Fixed
test_must_fail git grep -F --recurse-submodules -e "(.|.)[\d]" &&
test_must_fail git -c grep.patternType=fixed grep --recurse-submodules -e "(.|.)[\d]" &&
# Basic
git grep -G --recurse-submodules -e "(.|.)[\d]" >actual &&
cat >expect <<-\EOF &&
a:(1|2)d(3|4)
submodule/a:(1|2)d(3|4)
submodule/sub/a:(1|2)d(3|4)
EOF
test_cmp expect actual &&
git -c grep.patternType=basic grep --recurse-submodules -e "(.|.)[\d]" >actual &&
test_cmp expect actual &&
# Extended
git grep -E --recurse-submodules -e "(.|.)[\d]" >actual &&
cat >expect <<-\EOF &&
.gitmodules:[submodule "submodule"]
.gitmodules: path = submodule
.gitmodules: url = ./submodule
a:(1|2)d(3|4)
submodule/.gitmodules:[submodule "sub"]
submodule/a:(1|2)d(3|4)
submodule/sub/a:(1|2)d(3|4)
EOF
test_cmp expect actual &&
git -c grep.patternType=extended grep --recurse-submodules -e "(.|.)[\d]" >actual &&
test_cmp expect actual &&
git -c grep.extendedRegexp=true grep --recurse-submodules -e "(.|.)[\d]" >actual &&
test_cmp expect actual &&
# Perl
if test_have_prereq PCRE
then
git grep -P --recurse-submodules -e "(.|.)[\d]" >actual &&
cat >expect <<-\EOF &&
a:(1|2)d(3|4)
b/b:(3|4)
submodule/a:(1|2)d(3|4)
submodule/sub/a:(1|2)d(3|4)
EOF
test_cmp expect actual &&
git -c grep.patternType=perl grep --recurse-submodules -e "(.|.)[\d]" >actual &&
test_cmp expect actual
fi
'
test_expect_success 'grep --recurse-submodules with submodules without .gitmodules in the working tree' '
test_when_finished "git -C submodule checkout .gitmodules" &&
rm submodule/.gitmodules &&
git grep --recurse-submodules -e "(.|.)[\d]" >actual &&
cat >expect <<-\EOF &&
a:(1|2)d(3|4)
submodule/a:(1|2)d(3|4)
submodule/sub/a:(1|2)d(3|4)
EOF
test_cmp expect actual
'
reset_and_clean () {
git reset --hard &&
git clean -fd &&
git submodule foreach --recursive 'git reset --hard' &&
git submodule foreach --recursive 'git clean -fd'
}
test_expect_success 'grep --recurse-submodules without --cached considers worktree modifications' '
reset_and_clean &&
echo "A modified line in submodule" >>submodule/a &&
echo "submodule/a:A modified line in submodule" >expect &&
git grep --recurse-submodules "A modified line in submodule" >actual &&
test_cmp expect actual
'
test_expect_success 'grep --recurse-submodules with --cached ignores worktree modifications' '
reset_and_clean &&
echo "A modified line in submodule" >>submodule/a &&
test_must_fail git grep --recurse-submodules --cached "A modified line in submodule" >actual 2>&1 &&
test_must_be_empty actual
'
test_expect_failure 'grep --textconv: superproject .gitattributes does not affect submodules' '
reset_and_clean &&
test_config_global diff.d2x.textconv "sed -e \"s/d/x/\"" &&
echo "a diff=d2x" >.gitattributes &&
cat >expect <<-\EOF &&
a:(1|2)x(3|4)
EOF
git grep --textconv --recurse-submodules x >actual &&
test_cmp expect actual
'
test_expect_failure 'grep --textconv: superproject .gitattributes (from index) does not affect submodules' '
reset_and_clean &&
test_config_global diff.d2x.textconv "sed -e \"s/d/x/\"" &&
echo "a diff=d2x" >.gitattributes &&
git add .gitattributes &&
rm .gitattributes &&
cat >expect <<-\EOF &&
a:(1|2)x(3|4)
EOF
git grep --textconv --recurse-submodules x >actual &&
test_cmp expect actual
'
test_expect_failure 'grep --textconv: superproject .git/info/attributes does not affect submodules' '
reset_and_clean &&
test_config_global diff.d2x.textconv "sed -e \"s/d/x/\"" &&
super_info="$(git rev-parse --git-path info)" &&
super_attr="$super_info/attributes" &&
test_when_finished "rm -f \"$super_attr\"" &&
mkdir "$super_info" &&
echo "a diff=d2x" >"$super_attr" &&
cat >expect <<-\EOF &&
a:(1|2)x(3|4)
EOF
git grep --textconv --recurse-submodules x >actual &&
test_cmp expect actual
'
# Note: what currently prevents this test from passing is not that the
# .gitattributes file from "./submodule" is being ignored, but that it is being
# propagated to the nested "./submodule/sub" files.
#
test_expect_failure 'grep --textconv correctly reads submodule .gitattributes' '
reset_and_clean &&
test_config_global diff.d2x.textconv "sed -e \"s/d/x/\"" &&
echo "a diff=d2x" >submodule/.gitattributes &&
cat >expect <<-\EOF &&
submodule/a:(1|2)x(3|4)
EOF
git grep --textconv --recurse-submodules x >actual &&
test_cmp expect actual
'
test_expect_failure 'grep --textconv correctly reads submodule .gitattributes (from index)' '
reset_and_clean &&
test_config_global diff.d2x.textconv "sed -e \"s/d/x/\"" &&
echo "a diff=d2x" >submodule/.gitattributes &&
git -C submodule add .gitattributes &&
rm submodule/.gitattributes &&
cat >expect <<-\EOF &&
submodule/a:(1|2)x(3|4)
EOF
git grep --textconv --recurse-submodules x >actual &&
test_cmp expect actual
'
test_expect_failure 'grep --textconv correctly reads submodule .git/info/attributes' '
reset_and_clean &&
test_config_global diff.d2x.textconv "sed -e \"s/d/x/\"" &&
submodule_info="$(git -C submodule rev-parse --path-format=absolute --git-path info)" &&
submodule_attr="$submodule_info/attributes" &&
test_when_finished "rm -f \"$submodule_attr\"" &&
echo "a diff=d2x" >"$submodule_attr" &&
cat >expect <<-\EOF &&
submodule/a:(1|2)x(3|4)
EOF
git grep --textconv --recurse-submodules x >actual &&
test_cmp expect actual
'
test_expect_failure 'grep saves textconv cache in the appropriate repository' '
reset_and_clean &&
test_config_global diff.d2x_cached.textconv "sed -e \"s/d/x/\"" &&
test_config_global diff.d2x_cached.cachetextconv true &&
echo "a diff=d2x_cached" >submodule/.gitattributes &&
# We only read/write to the textconv cache when grepping from an OID,
# as the working tree file might have modifications.
git grep --textconv --cached --recurse-submodules x &&
super_textconv_cache="$(git rev-parse --git-path refs/notes/textconv/d2x_cached)" &&
sub_textconv_cache="$(git -C submodule rev-parse \
--path-format=absolute --git-path refs/notes/textconv/d2x_cached)" &&
test_path_is_missing "$super_textconv_cache" &&
test_path_is_file "$sub_textconv_cache"
'
test_expect_success 'grep partially-cloned submodule' '
# Set up clean superproject and submodule for partial cloning.
test_config_global protocol.file.allow always &&
git init super &&
git init super/sub &&
(
cd super &&
test_commit --no-tag "Add file in superproject" \
super-file "Some content for super-file" &&
test_commit -C sub --no-tag "Add file in submodule" \
sub-file "Some content for sub-file" &&
git submodule add ./sub &&
git commit -m "Add other as submodule sub" &&
test_tick &&
test_commit -C sub --no-tag --append "Update file in submodule" \
sub-file "Some more content for sub-file" &&
git add sub &&
git commit -m "Update submodule" &&
test_tick &&
git config --local uploadpack.allowfilter 1 &&
git config --local uploadpack.allowanysha1inwant 1 &&
git -C sub config --local uploadpack.allowfilter 1 &&
git -C sub config --local uploadpack.allowanysha1inwant 1
) &&
# Clone the superproject & submodule, then make sure we can lazy-fetch submodule objects.
git clone --filter=blob:none --also-filter-submodules \
--recurse-submodules "file://$(pwd)/super" partial &&
(
cd partial &&
cat >expect <<-\EOF &&
HEAD^:sub/sub-file:Some content for sub-file
HEAD^:super-file:Some content for super-file
EOF
GIT_TRACE2_EVENT="$(pwd)/trace2.log" git grep -e content \
--recurse-submodules HEAD^ >actual &&
test_cmp expect actual &&
# Verify that we actually fetched data from the promisor remote:
grep \"category\":\"promisor\",\"key\":\"fetch_count\",\"value\":\"1\" trace2.log
)
'
test_expect_success 'check scope of core.useReplaceRefs' '
git init base &&
git init base/sub &&
echo A >base/a &&
echo B >base/b &&
echo C >base/sub/c &&
echo D >base/sub/d &&
git -C base/sub add c d &&
git -C base/sub commit -m "Add files" &&
git -C base submodule add ./sub &&
git -C base add a b sub &&
git -C base commit -m "Add files and submodule" &&
A=$(git -C base rev-parse HEAD:a) &&
B=$(git -C base rev-parse HEAD:b) &&
C=$(git -C base/sub rev-parse HEAD:c) &&
D=$(git -C base/sub rev-parse HEAD:d) &&
git -C base replace $A $B &&
git -C base/sub replace $C $D &&
test_must_fail git -C base grep --cached --recurse-submodules A &&
test_must_fail git -C base grep --cached --recurse-submodules C &&
git -C base config core.useReplaceRefs false &&
git -C base grep --recurse-submodules A &&
test_must_fail git -C base grep --cached --recurse-submodules C &&
git -C base/sub config core.useReplaceRefs false &&
git -C base grep --cached --recurse-submodules A &&
git -C base grep --cached --recurse-submodules C &&
git -C base config --unset core.useReplaceRefs &&
test_must_fail git -C base grep --cached --recurse-submodules A &&
git -C base grep --cached --recurse-submodules C
'
test_done
Reference in a new issue View git blame Copy permalink