Localize HelmChartInflationGenerator (kubernetes-sigs#5007)

* Localize HelmChartInflationGenerator * Add explicit inline generators test
KnVerey · Jan 30, 2023 · 361154d · 361154d
1 parent 7db330d
commit 361154d
Show file tree

Hide file tree

Showing 3 changed files with 136 additions and 10 deletions.
diff --git a/api/internal/localizer/builtinplugins.go b/api/internal/localizer/builtinplugins.go
@@ -48,6 +48,10 @@ func (lbp *localizeBuiltinPlugins) Filter(plugins []*yaml.RNode) ([]*yaml.RNode,
 					Gvk:  resid.Gvk{Version: konfig.BuiltinPluginApiVersion, Kind: builtinhelpers.SecretGenerator.String()},
 					Path: "envs",
 				},
+				types.FieldSpec{
+					Gvk:  resid.Gvk{Version: konfig.BuiltinPluginApiVersion, Kind: builtinhelpers.HelmChartInflationGenerator.String()},
+					Path: "valuesFile",
+				},
 				types.FieldSpec{
 					Gvk:  resid.Gvk{Version: konfig.BuiltinPluginApiVersion, Kind: builtinhelpers.PatchTransformer.String()},
 					Path: "path",
@@ -82,6 +86,24 @@ func (lbp *localizeBuiltinPlugins) Filter(plugins []*yaml.RNode) ([]*yaml.RNode,
 					return lbp.localizeAll(node)
 				},
 			},
+			yaml.FilterFunc(func(node *yaml.RNode) (*yaml.RNode, error) {
+				isHelm := node.GetApiVersion() == konfig.BuiltinPluginApiVersion &&
+					node.GetKind() == builtinhelpers.HelmChartInflationGenerator.String()
+				if !isHelm {
+					return node, nil
+				}
+				home, err := node.Pipe(yaml.Lookup("chartHome"))
+				if err != nil {
+					return nil, errors.Wrap(err)
+				}
+				if home == nil {
+					_, err = lbp.lc.copyChartHomeEntry("")
+				} else {
+					lbp.locPathFn = lbp.lc.copyChartHomeEntry
+					err = lbp.localizeScalar(home)
+				}
+				return node, errors.WrapPrefixf(err, "plugin %s", resid.FromRNode(node))
+			}),
 			fieldspec.Filter{
 				FieldSpec: types.FieldSpec{
 					Gvk:  resid.Gvk{Version: konfig.BuiltinPluginApiVersion, Kind: builtinhelpers.PatchStrategicMergeTransformer.String()},
@@ -92,7 +114,6 @@ func (lbp *localizeBuiltinPlugins) Filter(plugins []*yaml.RNode) ([]*yaml.RNode,
 					return lbp.localizeAll(node)
 				},
 			})
-		// TODO(annasong): localize HelmChartInflationGenerator
 		if err != nil {
 			return nil, errors.Wrap(err)
 		}

diff --git a/api/internal/localizer/localizer_test.go b/api/internal/localizer/localizer_test.go
@@ -593,8 +593,36 @@ patches:
 }
 
 func TestLocalizePluginsInlineAndFile(t *testing.T) {
-	kustAndPlugins := map[string]string{
-		"kustomization.yaml": `apiVersion: kustomize.config.k8s.io/v1beta1
+	for _, test := range []struct {
+		name  string
+		files map[string]string
+	}{
+		{
+			name: "generators",
+			files: map[string]string{
+				"kustomization.yaml": `generators:
+- generator.yaml
+- |
+  apiVersion: builtin
+  env: second.properties
+  kind: ConfigMapGenerator
+  metadata:
+    name: inline
+`,
+				"generator.yaml": `apiVersion: builtin
+env: first.properties
+kind: ConfigMapGenerator
+metadata:
+  name: file
+`,
+				"first.properties":  "APPLE=orange",
+				"second.properties": "BANANA=pear",
+			},
+		},
+		{
+			name: "transformers",
+			files: map[string]string{
+				"kustomization.yaml": `apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 transformers:
 - |
@@ -605,16 +633,39 @@ transformers:
   path: patchSM-one.yaml
 - patch.yaml
 `,
-		"patch.yaml": `apiVersion: builtin
+				"patch.yaml": `apiVersion: builtin
 kind: PatchTransformer
 metadata:
   name: file
 path: patchSM-two.yaml
 `,
-		"patchSM-one.yaml": podConfiguration,
-		"patchSM-two.yaml": podConfiguration,
+				"patchSM-one.yaml": podConfiguration,
+				"patchSM-two.yaml": podConfiguration,
+			},
+		},
+		{
+			name: "validators",
+			files: map[string]string{
+				"kustomization.yaml": `validators:
+- |
+  apiVersion: builtin
+  kind: ReplacementTransformer
+  metadata:
+    name: inline
+  replacements:
+  - path: first.yaml
+- second.yaml
+`,
+				"first.yaml":       replacementTransformerWithPath,
+				"second.yaml":      replacementTransformerWithPath,
+				"replacement.yaml": replacements,
+			},
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			checkLocalizeInTargetSuccess(t, test.files)
+		})
 	}
-	checkLocalizeInTargetSuccess(t, kustAndPlugins)
 }
 
 func TestLocalizeMultiplePluginsInEntry(t *testing.T) {
@@ -1461,6 +1512,62 @@ func TestCopyChartHomeError(t *testing.T) {
 	}
 }
 
+func TestLocalizeGeneratorsHelm(t *testing.T) {
+	files := map[string]string{
+		"kustomization.yaml": `generators:
+- default.yaml
+- explicit.yaml
+`,
+		"default.yaml": `apiVersion: builtin
+kind: HelmChartInflationGenerator
+metadata:
+  name: no-explicit-references
+name: minecraft
+releaseName: moria
+repo: https://itzg.github.io/minecraft-server-charts
+version: 3.1.3
+`,
+		"explicit.yaml": `apiVersion: builtin
+chartHome: home
+kind: HelmChartInflationGenerator
+metadata:
+  name: explicit-references
+name: mapleStory
+valuesFile: mapleValues.yaml
+`,
+		"mapleValues.yaml":             valuesFile,
+		"home/mapleStory/values.yaml":  valuesFile,
+		"charts/minecraft/values.yaml": valuesFile,
+	}
+	checkLocalizeInTargetSuccess(t, files)
+}
+
+func TestLocalizeGeneratorsNoHelm(t *testing.T) {
+	files := map[string]string{
+		"kustomization.yaml": `generators:
+- configMap.yaml
+`,
+		"configMap.yaml": `apiVersion: builtin
+kind: ConfigMapGenerator
+literals:
+- APPLE=orange
+metadata:
+  name: not-helm-shouldn't-copy-default-helm-chart-home
+`,
+		"charts/minecraft/values.yaml": valuesFile,
+	}
+	expected, actual := makeFileSystems(t, "/a", files)
+
+	err := Run("/a", "", "/dst", actual)
+	require.NoError(t, err)
+
+	addFiles(t, expected, "/dst", map[string]string{
+		"kustomization.yaml": files["kustomization.yaml"],
+		"configMap.yaml":     files["configMap.yaml"],
+	})
+	checkFSys(t, expected, actual)
+}
+
 func TestLocalizeEmpty(t *testing.T) {
 	for name, kustomization := range map[string]string{
 		"file": `configurations:

diff --git a/api/krusty/localizer/runner_test.go b/api/krusty/localizer/runner_test.go
@@ -452,13 +452,11 @@ func TestResourcesRepoNotFile(t *testing.T) {
 
 	err := localizer.Run(fsActual, testDir.String(), "", testDir.Join("dst"))
 
-	const readmeErr = `mapping values are not allowed in this context`
-	fileErr := fmt.Sprintf(`invalid resource at file "%s": MalformedYAMLError:`, repo)
+	fileErr := fmt.Sprintf(`invalid resource at file "%s": MalformedYAMLError`, repo)
 	rootErr := fmt.Sprintf(`unable to localize root "%s": unable to find one of 'kustomization.yaml', 'kustomization.yml' or 'Kustomization'`, repo)
 	var actualErr PathLocalizeError
 	require.ErrorAs(t, err, &actualErr)
 	require.Equal(t, repo, actualErr.Path)
-	require.ErrorContains(t, actualErr.FileError, readmeErr)
 	require.ErrorContains(t, actualErr.FileError, fileErr)
 	require.ErrorContains(t, actualErr.RootError, rootErr)