git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[RFC PATCH 2/2] submodule: add test mode for checking absence of "superProjectGitDir"

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Nov 17, 2021, 11:43 UTC
Message-ID
<RFC-patch-2.2-b49d4c8db7d-20211117T113134Z-avarab@gmail.com>
In-Reply-To
<RFC-cover-0.2-00000000000-20211117T113134Z-avarab@gmail.com>

Add a GIT_TEST_SUBMODULE_CACHE_SUPERPROJECT_DIR=false test mode to assert what happens if "submodule.superProjectGitDir" is absent or missing, this checks if the "fallback" codepath in get_superproject_working_tree() is equivalent to the config lookup.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 ci/run-build-and-tests.sh          |  1 +
 git-submodule.sh                   |  2 +-
 submodule.c                        |  7 +++++++
 t/lib-submodule-superproject.sh    | 24 ++++++++++++++++++++++++
 t/t7406-submodule-update.sh        |  9 ++++-----
 t/t7412-submodule-absorbgitdirs.sh | 19 ++++++-------------
 6 files changed, 43 insertions(+), 19 deletions(-)
 create mode 100644 t/lib-submodule-superproject.sh
diff --git a/ci/run-build-and-tests.sh b/ci/run-build-and-tests.sh
index cc62616d806..5132a210057 100755
--- a/ci/run-build-and-tests.sh
+++ b/ci/run-build-and-tests.sh
@@ -33,6 +33,7 @@ linux-gcc)
 	export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=master
 	export GIT_TEST_WRITE_REV_INDEX=1
 	export GIT_TEST_CHECKOUT_WORKERS=2
+	export GIT_TEST_SUBMODULE_CACHE_SUPERPROJECT_DIR=false
 	make test
 	;;
 linux-clang)
diff --git a/git-submodule.sh b/git-submodule.sh
index 7c247bee7f6..2b423ee05bc 100755
--- a/git-submodule.sh
+++ b/git-submodule.sh
@@ -453,7 +453,7 @@ cmd_update()
 		# changed, unless it's a fresh clone. Write to worktree if
 		# applicable, and point to superproject's worktree gitdir if
 		# applicable.
-		if test -z "$just_cloned"
+		if test -z "$just_cloned" && test "$GIT_TEST_SUBMODULE_CACHE_SUPERPROJECT_DIR" != "false"
 		then
 			sm_gitdir="$(git -C "$sm_path" rev-parse --absolute-git-dir)"
 			relative_gitdir="$(git rev-parse --path-format=relative \
diff --git a/submodule.c b/submodule.c
index ad95cdda07d..f0411a320a8 100644
--- a/submodule.c
+++ b/submodule.c
@@ -2143,6 +2143,9 @@ static void relocate_single_git_dir_into_superproject(const char *path)
 	if (!git_configset_get_bool(&sub_cs, "extensions.worktreeConfig", &tmp))
 		strbuf_addstr(&config_path, ".worktree");
 
+	if (!git_env_bool("GIT_TEST_SUBMODULE_CACHE_SUPERPROJECT_DIR", 1))
+		goto fallback;
+
 	git_config_set_in_file(config_path.buf, "submodule.superprojectGitdir",
 			       relative_path(absolute_path(get_git_dir()),
 					     real_new_git_dir, &sb));
@@ -2150,6 +2153,8 @@ static void relocate_single_git_dir_into_superproject(const char *path)
 	git_configset_clear(&sub_cs);
 	strbuf_release(&config_path);
 	strbuf_release(&sb);
+
+fallback:
 	free(old_git_dir);
 	free(real_old_git_dir);
 	free(real_new_git_dir);
@@ -2332,6 +2337,8 @@ int get_superproject_working_tree(struct strbuf *buf)
 	const char *wt_prefix = "worktree ";
 	int rc = 0;
 
+	if (!git_env_bool("GIT_TEST_SUBMODULE_CACHE_SUPERPROJECT_DIR", 1))
+		goto fallback;
 
 	/* Do we know we have a superproject? */
 	if (git_config_get_string("submodule.superprojectgitdir", &super_gitdir))
diff --git a/t/lib-submodule-superproject.sh b/t/lib-submodule-superproject.sh
new file mode 100644
index 00000000000..4d49dd3782e
--- /dev/null
+++ b/t/lib-submodule-superproject.sh
@@ -0,0 +1,24 @@
+#!/bin/sh
+
+test_lazy_prereq SUBMODULE_CACHE_SUPERPROJECT_DIR '
+	test_bool_env GIT_TEST_SUBMODULE_CACHE_SUPERPROJECT_DIR true
+'
+
+test_cmp_submodule_superprojectgitdir () {
+	if ! test_have_prereq SUBMODULE_CACHE_SUPERPROJECT_DIR
+	then
+		return 0
+	fi
+
+	git -C "$1" config submodule.superprojectGitDir >actual &&
+	test_cmp expect actual
+}
+
+test_file_not_empty_superprojectgitdir () {
+	if ! test_have_prereq SUBMODULE_CACHE_SUPERPROJECT_DIR
+	then
+		return 0
+	fi
+
+	test_file_not_empty "$(git -C $1 rev-parse --absolute-git-dir)/$2"
+}
diff --git a/t/t7406-submodule-update.sh b/t/t7406-submodule-update.sh
index 01e1acaf300..f362f8d0ef0 100755
--- a/t/t7406-submodule-update.sh
+++ b/t/t7406-submodule-update.sh
@@ -13,6 +13,7 @@ GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
 
 . ./test-lib.sh
+. "$TEST_DIRECTORY"/lib-submodule-superproject.sh
 
 
 compare_head()
@@ -1068,8 +1069,7 @@ test_expect_success 'submodule update adds superproject gitdir to older repos' '
 	 test-tool path-utils relative_path \
 		"$(git rev-parse --absolute-git-dir)" \
 		"$(git -C submodule rev-parse --absolute-git-dir)" >expect &&
-	 git -C submodule config submodule.superprojectGitdir >actual &&
-	 test_cmp expect actual
+	 test_cmp_submodule_superprojectgitdir submodule
 	)
 '
 
@@ -1081,10 +1081,9 @@ test_expect_success 'submodule update uses config.worktree if applicable' '
 	 test-tool path-utils relative_path \
 		"$(git rev-parse --absolute-git-dir)" \
 		"$(git -C submodule rev-parse --absolute-git-dir)" >expect &&
-	 git -C submodule config submodule.superprojectGitdir >actual &&
-	 test_cmp expect actual &&
+	 test_cmp_submodule_superprojectgitdir submodule &&
 
-	 test_file_not_empty "$(git -C submodule rev-parse --absolute-git-dir)/config.worktree"
+	 test_file_not_empty_superprojectgitdir submodule config.worktree
 	)
 '
 
diff --git a/t/t7412-submodule-absorbgitdirs.sh b/t/t7412-submodule-absorbgitdirs.sh
index 5753f902687..6faab7e56e9 100755
--- a/t/t7412-submodule-absorbgitdirs.sh
+++ b/t/t7412-submodule-absorbgitdirs.sh
@@ -7,6 +7,7 @@ directory into the superproject.
 '
 
 . ./test-lib.sh
+. "$TEST_DIRECTORY"/lib-submodule-superproject.sh
 
 test_expect_success 'setup a real submodule' '
 	git init sub1 &&
@@ -38,9 +39,7 @@ test_expect_success 'absorb the git dir' '
 
 	test-tool path-utils relative_path "$superproject_gitdir" \
 		"$submodule_gitdir" >expect &&
-	git -C sub1 config submodule.superprojectGitDir >actual &&
-
-	test_cmp expect actual
+	test_cmp_submodule_superprojectgitdir sub1
 '
 
 test_expect_success 'absorbing does not fail for deinitialized submodules' '
@@ -78,9 +77,7 @@ test_expect_success 'absorb the git dir in a nested submodule' '
 
 	test-tool path-utils relative_path "$sub1_gitdir" "$sub1_nested_gitdir" \
 		>expect &&
-	git -C sub1/nested config submodule.superprojectGitDir >actual &&
-
-	test_cmp expect actual
+	test_cmp_submodule_superprojectgitdir sub1
 '
 
 test_expect_success 're-setup nested submodule' '
@@ -170,9 +167,7 @@ test_expect_success 'absorbgitdirs works when called from a superproject worktre
 
 	test-tool path-utils relative_path "$superproject_gitdir" \
 		"$submodule_gitdir" >expect &&
-	git -C sub4 config submodule.superprojectGitDir >actual &&
-
-	test_cmp expect actual
+	test_cmp_submodule_superprojectgitdir sub4
 	)
 '
 
@@ -199,12 +194,10 @@ test_expect_success 'absorbgitdirs works with a submodule with worktree config'
 
 	test-tool path-utils relative_path "$superproject_gitdir" \
 		"$submodule_gitdir" >expect &&
-	git -C sub5 config submodule.superprojectGitDir >actual &&
-
-	test_cmp expect actual &&
+	test_cmp_submodule_superprojectgitdir sub5 &&
 
 	# make sure the config went into the submodule config.worktree
-	test_file_not_empty "$submodule_gitdir/config.worktree"
+	test_file_not_empty_superprojectgitdir sub5 config.worktree
 	)
 '
 
-- 
2.34.0.796.g2c87ed6146a
Previous: Ævar Arnfjörð BjarmasonNext: Emily Shaffer
Message 10 of 64 in “teach submodules to know they're submodules”
  1. 0/5 teach submodules to know they're submodulesEmily Shaffer, Nov 17, 2021
  2. 1/5 t7400-submodule-basic: modernize inspect() helperEmily Shaffer, Nov 17, 2021
  3. 2/5 introduce submodule.superprojectGitDir recordEmily Shaffer, Nov 17, 2021
  4. Jonathan TanNov 17, 2021
  5. 3/5 submodule: record superproject gitdir during absorbgitdirsEmily Shaffer, Nov 17, 2021
  6. 4/5 submodule: record superproject gitdir during 'update'Emily Shaffer, Nov 17, 2021
  7. 5/5 submodule: use config to find superproject worktreeEmily Shaffer, Nov 17, 2021
  8. 0/2 submodule: test what happens if submodule.superprojectGitDir isn't aroundÆvar Arnfjörð Bjarmason, Nov 17, 2021
  9. 1/2 submodule tests: fix potentially broken "config .. --unset"Ævar Arnfjörð Bjarmason, Nov 17, 2021
  10. 2/2 submodule: add test mode for checking absence of "superProjectGitDir"Ævar Arnfjörð Bjarmason, Nov 17, 2021
  11. Emily ShafferNov 23, 2021
  12. Ævar Arnfjörð BjarmasonNov 24, 2021
  13. Jonathan TanNov 17, 2021
  14. Emily ShafferNov 23, 2021
  15. 0/5 teach submodules to know they're submodulesEmily Shaffer, Feb 3, 2022
  16. 1/4 t7400-submodule-basic: modernize inspect() helperEmily Shaffer, Feb 3, 2022
  17. 2/4 introduce submodule.superprojectGitDir recordEmily Shaffer, Feb 3, 2022
  18. 3/4 submodule: record superproject gitdir during absorbgitdirsEmily Shaffer, Feb 3, 2022
  19. 4/4 submodule: record superproject gitdir during 'update'Emily Shaffer, Feb 3, 2022
  20. Junio C HamanoFeb 3, 2022
  21. Ævar Arnfjörð BjarmasonFeb 4, 2022
  22. Junio C HamanoFeb 4, 2022
  23. Jonathan NiederFeb 7, 2022
  24. Junio C HamanoFeb 7, 2022
  25. Jonathan NiederFeb 8, 2022
  26. Junio C HamanoFeb 8, 2022
  27. Emily ShafferFeb 10, 2022
  28. Jonathan NiederFeb 10, 2022
  29. Ævar Arnfjörð BjarmasonFeb 12, 2022
  30. Junio C HamanoFeb 13, 2022
  31. 0/3 teach submodules to know they're submodulesEmily Shaffer, Mar 1, 2022
  32. 1/3 t7400-submodule-basic: modernize inspect() helperEmily Shaffer, Mar 1, 2022
  33. 2/3 introduce submodule.hasSuperproject recordEmily Shaffer, Mar 1, 2022
  34. Junio C HamanoMar 1, 2022
  35. Emily ShafferMar 8, 2022
  36. Glen ChooMar 8, 2022
  37. Glen ChooMar 8, 2022
  38. 3/3 rev-parse: short-circuit superproject worktree when config unsetEmily Shaffer, Mar 1, 2022
  39. Junio C HamanoMar 1, 2022
  40. Emily ShafferMar 9, 2022
  41. Junio C HamanoMar 1, 2022
  42. Emily ShafferMar 8, 2022
  43. 0/3 teach submodules to know they're submodulesEmily Shaffer, Mar 10, 2022
  44. 1/3 t7400-submodule-basic: modernize inspect() helperEmily Shaffer, Mar 10, 2022
  45. 2/3 introduce submodule.hasSuperproject recordEmily Shaffer, Mar 10, 2022
  46. Junio C HamanoMar 10, 2022
  47. Glen ChooMar 10, 2022
  48. Glen ChooMar 10, 2022
  49. Junio C HamanoMar 10, 2022
  50. Glen ChooMar 10, 2022
  51. Glen ChooMar 10, 2022
  52. Emily ShafferMar 15, 2022
  53. Emily ShafferMar 15, 2022
  54. Glen ChooMar 15, 2022
  55. Emily ShafferMar 15, 2022
  56. Junio C HamanoMar 15, 2022
  57. Junio C HamanoMar 10, 2022
  58. Glen ChooMar 10, 2022
  59. Emily ShafferMar 15, 2022
  60. 3/3 rev-parse: short-circuit superproject worktree when config unsetEmily Shaffer, Mar 10, 2022
  61. Junio C HamanoMar 10, 2022
  62. Eric SunshineMar 10, 2022
  63. Ævar Arnfjörð BjarmasonMar 11, 2022
  64. Junio C HamanoMar 13, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.