Add test for issue kubernetes-sigs#5131

api/krusty/remoteloader_test.go

@@ -38,7 +38,7 @@ func TestRemoteLoad_LocalProtocol(t *testing.T) {
 	//   nosuffix/				- same as simple.git/ without the .git suffix
 	//   multibase.git/			- base with a dev overlay
 	//   with-submodule.git/	- includes `simple` as a submodule
-	//     submodule/			- the submodule referencing `simple
+	//     submodule/			- the submodule referencing `simple`
 	createGitRepos := func(t *testing.T) testRepos {
 		t.Helper()
 
@@ -85,12 +85,20 @@ cp -r testdata/remoteload/multibase $ROOT/multibase.git
 	git add .
 	git commit -m "import"
 )
+cp -r testdata/remoteload/with-submodule $ROOT/with-submodule.git # see README
+export HASH_DIR=unique-$RANDOM
+cp -r $ROOT/simple.git $ROOT/$HASH_DIR
 (
-	mkdir $ROOT/with-submodule.git
 	cd $ROOT/with-submodule.git
 	git init --initial-branch=main
-	git submodule add $ROOT/simple.git submodule
+	git add .
 	git commit -m "import"
+	git checkout -b relative-submodule
+	git submodule add ../$HASH_DIR submodule
+	git commit -m "relative submodule"
+	git checkout main
+	git submodule add $ROOT/simple.git submodule
+	git commit -m "submodule"	
 )
 `, root))
 		return testRepos{
@@ -183,6 +191,15 @@ resources:
 `,
 			expected: simpleBuild,
 		},
+		{
+			name: "has relative submodule",
+			kustomization: `
+resources:
+- file://$ROOT/with-submodule.git/submodule?ref=relative-submodule
+`,
+			// TODO(annasong): Replace with simpleBuild once #5131 is fixed.
+			err: `failed to run '\S+/git submodule update --init --recursive': warning: could not look up configuration 'remote.origin.url'. Assuming this repository is its own authoritative upstream`,
+		},
 		{
 			name: "has timeout",
 			kustomization: `
@@ -273,7 +290,7 @@ resources:
 
 			if test.err != "" {
 				require.Error(t, err)
-				require.Contains(t, err.Error(), test.err)
+				require.Regexp(t, test.err, err.Error())
 			} else {
 				require.NoError(t, err)
 				checkYaml(t, m, strings.ReplaceAll(test.expected, "$ROOT", repos.root))
@@ -430,6 +447,10 @@ func createKustDir(t *testing.T, content string) (filesys.FileSystem, filesys.Co
 	fSys := filesys.MakeFsOnDisk()
 	tmpDir, err := filesys.NewTmpConfirmedDir()
 	require.NoError(t, err)
+	t.Cleanup(func() {
+		require.NoError(t, fSys.RemoveAll(tmpDir.String()))
+	})
+
 	require.NoError(t, fSys.WriteFile(filepath.Join(tmpDir.String(), "kustomization.yaml"), []byte(content)))
 	return fSys, tmpDir
 }

api/krusty/testdata/remoteload/with-submodule/README.md

@@ -0,0 +1,10 @@
+# submodule
+
+This repo demonstrates kustomize's ability to download git repos 
+with submodules. The following branches contain
+* main: submodule via absolute path
+* relative-submodule: submodule via relative path
+
+For the submodule accessed via a relative path, we include a random hash in the
+submodule name to avoid accessing an unintended directory in the case kustomize
+contains loader bugs (issue #5131).