convert resources to ResourceGenerator

kubernetes-sigs · Sep 28, 2024 · b9e9e65 · b9e9e65
1 parent 01cce4f
commit b9e9e65
Show file tree

Hide file tree

Showing 30 changed files with 470 additions and 166 deletions.
diff --git a/Makefile-plugins.mk b/Makefile-plugins.mk
@@ -41,6 +41,7 @@ _builtinplugins = \
 	PatchTransformer.go \
 	PrefixTransformer.go \
 	SuffixTransformer.go \
+	ResourceGenerator.go \
 	ReplacementTransformer.go \
 	ReplicaCountTransformer.go \
 	SecretGenerator.go \
@@ -70,6 +71,7 @@ $(pGen)/PatchStrategicMergeTransformer.go: $(pSrc)/patchstrategicmergetransforme
 $(pGen)/PatchTransformer.go: $(pSrc)/patchtransformer/PatchTransformer.go
 $(pGen)/PrefixTransformer.go: $(pSrc)/prefixtransformer/PrefixTransformer.go
 $(pGen)/SuffixTransformer.go: $(pSrc)/suffixtransformer/SuffixTransformer.go
+$(pGen)/ResourceGenerator.go: $(pSrc)/resourcegenerator/ResourceGenerator.go
 $(pGen)/ReplacementTransformer.go: $(pSrc)/replacementtransformer/ReplacementTransformer.go
 $(pGen)/ReplicaCountTransformer.go: $(pSrc)/replicacounttransformer/ReplicaCountTransformer.go
 $(pGen)/SecretGenerator.go: $(pSrc)/secretgenerator/SecretGenerator.go

diff --git a/api/builtins/builtins.go b/api/builtins/builtins.go
@@ -10,6 +10,7 @@ import (
 
 type (
 	AnnotationsTransformerPlugin         = internal.AnnotationsTransformerPlugin
+	ResourceGeneratorPlugin              = internal.ResourceGeneratorPlugin
 	ConfigMapGeneratorPlugin             = internal.ConfigMapGeneratorPlugin
 	HashTransformerPlugin                = internal.HashTransformerPlugin
 	HelmChartInflationGeneratorPlugin    = internal.HelmChartInflationGeneratorPlugin
@@ -28,8 +29,10 @@ type (
 	ValueAddTransformerPlugin            = internal.ValueAddTransformerPlugin
 )
 
+//nolint:gochecknoglobals
 var (
 	NewAnnotationsTransformerPlugin         = internal.NewAnnotationsTransformerPlugin
+	NewResourceGeneratorPlugin              = internal.NewResourceGeneratorPlugin
 	NewConfigMapGeneratorPlugin             = internal.NewConfigMapGeneratorPlugin
 	NewHashTransformerPlugin                = internal.NewHashTransformerPlugin
 	NewHelmChartInflationGeneratorPlugin    = internal.NewHelmChartInflationGeneratorPlugin

diff --git a/api/internal/accumulator/resaccumulator.go b/api/internal/accumulator/resaccumulator.go
@@ -14,9 +14,8 @@ import (
 	"sigs.k8s.io/kustomize/kyaml/resid"
 )
 
-// ResAccumulator accumulates resources and the rules
-// used to customize those resources.  It's a ResMap
-// plus stuff needed to modify the ResMap.
+// ResAccumulator accumulates resources and the rules used to customize those resources.
+// It's a ResMap plus stuff needed to modify the ResMap.
 type ResAccumulator struct {
 	resMap  resmap.ResMap
 	tConfig *builtinconfig.TransformerConfig

diff --git a/api/internal/builtins/ResourceGenerator.go b/api/internal/builtins/ResourceGenerator.go
diff --git a/api/internal/plugins/builtinhelpers/builtinplugintype_string.go b/api/internal/plugins/builtinhelpers/builtinplugintype_string.go
diff --git a/api/internal/plugins/builtinhelpers/builtins.go b/api/internal/plugins/builtinhelpers/builtins.go
@@ -14,6 +14,7 @@ type BuiltinPluginType int
 const (
 	Unknown BuiltinPluginType = iota
 	AnnotationsTransformer
+	ResourceGenerator
 	ConfigMapGenerator
 	IAMPolicyGenerator
 	HashTransformer
@@ -59,6 +60,7 @@ func GetBuiltinPluginType(n string) BuiltinPluginType {
 }
 
 var GeneratorFactories = map[BuiltinPluginType]func() resmap.GeneratorPlugin{
+	ResourceGenerator:           builtins.NewResourceGeneratorPlugin,
 	ConfigMapGenerator:          builtins.NewConfigMapGeneratorPlugin,
 	IAMPolicyGenerator:          builtins.NewIAMPolicyGeneratorPlugin,
 	SecretGenerator:             builtins.NewSecretGeneratorPlugin,

diff --git a/api/internal/plugins/execplugin/execplugin_test.go b/api/internal/plugins/execplugin/execplugin_test.go
@@ -31,8 +31,7 @@ func TestExecPluginConfig(t *testing.T) {
 	err := fSys.WriteFile("sed-input.txt", []byte(`
 s/$FOO/foo/g
 s/$BAR/bar baz/g
- \ \ \ 
-`))
+ \ \ \ `))
 	require.NoError(t, err)
 	ldr, err := fLdr.NewLoader(
 		fLdr.RestrictionRootOnly, filesys.Separator, fSys)
@@ -74,8 +73,7 @@ s/$BAR/bar baz/g
 		t.Fatalf("unexpected err: %v", err)
 	}
 	err = p.Config(
-		resmap.NewPluginHelpers(ldr, pvd.GetFieldValidator(), rf, pc),
-		yaml)
+		resmap.NewPluginHelpers(ldr, pvd.GetFieldValidator(), rf, pc), yaml)
 	require.NoError(t, err)
 
 	expected := "someteam.example.com/v1/sedtransformer/SedTransformer"

diff --git a/api/internal/plugins/loader/loader.go b/api/internal/plugins/loader/loader.go
@@ -57,10 +57,10 @@ func (l *Loader) Config() *types.PluginConfig {
 }
 
 func (l *Loader) LoadGenerators(
-	ldr ifc.Loader, v ifc.Validator, rm resmap.ResMap) (
+	ldr ifc.Loader, v ifc.Validator, rm resmap.ResMap, kt resmap.KustTargetInterface) (
 	result []*resmap.GeneratorWithProperties, err error) {
 	for _, res := range rm.Resources() {
-		g, err := l.LoadGenerator(ldr, v, res)
+		g, err := l.LoadGenerator(ldr, v, res, kt)
 		if err != nil {
 			return nil, fmt.Errorf("failed to load generator: %w", err)
 		}
@@ -74,8 +74,8 @@ func (l *Loader) LoadGenerators(
 }
 
 func (l *Loader) LoadGenerator(
-	ldr ifc.Loader, v ifc.Validator, res *resource.Resource) (resmap.Generator, error) {
-	c, err := l.loadAndConfigurePlugin(ldr, v, res)
+	ldr ifc.Loader, v ifc.Validator, res *resource.Resource, kt resmap.KustTargetInterface) (resmap.Generator, error) {
+	c, err := l.loadAndConfigurePlugin(ldr, v, res, kt)
 	if err != nil {
 		return nil, err
 	}
@@ -87,10 +87,10 @@ func (l *Loader) LoadGenerator(
 }
 
 func (l *Loader) LoadTransformers(
-	ldr ifc.Loader, v ifc.Validator, rm resmap.ResMap) ([]*resmap.TransformerWithProperties, error) {
+	ldr ifc.Loader, v ifc.Validator, rm resmap.ResMap, kt resmap.KustTargetInterface) ([]*resmap.TransformerWithProperties, error) {
 	var result []*resmap.TransformerWithProperties
 	for _, res := range rm.Resources() {
-		t, err := l.LoadTransformer(ldr, v, res)
+		t, err := l.LoadTransformer(ldr, v, res, kt)
 		if err != nil {
 			return nil, err
 		}
@@ -104,8 +104,8 @@ func (l *Loader) LoadTransformers(
 }
 
 func (l *Loader) LoadTransformer(
-	ldr ifc.Loader, v ifc.Validator, res *resource.Resource) (*resmap.TransformerWithProperties, error) {
-	c, err := l.loadAndConfigurePlugin(ldr, v, res)
+	ldr ifc.Loader, v ifc.Validator, res *resource.Resource, kt resmap.KustTargetInterface) (*resmap.TransformerWithProperties, error) {
+	c, err := l.loadAndConfigurePlugin(ldr, v, res, kt)
 	if err != nil {
 		return nil, err
 	}
@@ -179,7 +179,9 @@ func isBuiltinPlugin(res *resource.Resource) bool {
 func (l *Loader) loadAndConfigurePlugin(
 	ldr ifc.Loader,
 	v ifc.Validator,
-	res *resource.Resource) (c resmap.Configurable, err error) {
+	res *resource.Resource,
+	kt resmap.KustTargetInterface,
+) (c resmap.Configurable, err error) {
 	if isBuiltinPlugin(res) {
 		switch l.pc.BpLoadingOptions {
 		case types.BploLoadFromFileSys:
@@ -214,7 +216,7 @@ func (l *Loader) loadAndConfigurePlugin(
 	if err != nil {
 		return nil, errors.WrapPrefixf(err, "marshalling yaml from res %s", res.OrgId())
 	}
-	err = c.Config(resmap.NewPluginHelpers(ldr, v, l.rf, l.pc), yaml)
+	err = c.Config(resmap.NewPluginHelpersWithKt(ldr, v, l.rf, l.pc, kt), yaml)
 	if err != nil {
 		return nil, errors.WrapPrefixf(
 			err, "plugin %s fails configuration", res.OrgId())
@@ -282,4 +284,3 @@ func (l *Loader) loadExecOrGoPlugin(resId resid.ResId) (resmap.Configurable, err
 	}
 	return c, nil
 }
-
diff --git a/api/internal/plugins/loader/loader_test.go b/api/internal/plugins/loader/loader_test.go
@@ -73,7 +73,7 @@ func TestLoader(t *testing.T) {
 			t.Fatal("expect non-nil loader")
 		}
 		_, err = pLdr.LoadGenerators(
-			fLdr, valtest_test.MakeFakeValidator(), generatorConfigs)
+			fLdr, valtest_test.MakeFakeValidator(), generatorConfigs, nil)
 		if err != nil {
 			t.Fatal(err)
 		}