refactoring

Author: cbarbian-sap

pkg/manifests/helm.go

@@ -146,14 +146,14 @@ func NewHelmGenerator(name string, fsys fs.FS, chartPath string, client client.C
 		// because the 'Template' builtin needs that to work properly
 		if t == nil {
 			t = template.New(manifest)
+			t.Option("missingkey=zero").
+				Funcs(sprig.TxtFuncMap()).
+				Funcs(templatex.FuncMap()).
+				Funcs(templatex.FuncMapForTemplate(t)).
+				Funcs(templatex.FuncMapForClient(client))
 		} else {
 			t = t.New(manifest)
 		}
-		t.Option("missingkey=zero").
-			Funcs(sprig.TxtFuncMap()).
-			Funcs(templatex.FuncMap()).
-			Funcs(templatex.FuncMapForTemplate(t)).
-			Funcs(templatex.FuncMapForClient(client))
 		if _, err := t.Parse(string(raw)); err != nil {
 			return nil, err
 		}
@@ -167,11 +167,6 @@ func NewHelmGenerator(name string, fsys fs.FS, chartPath string, client client.C
 		// Note: we use absolute paths (instead of relative ones) as template names
 		// because the 'Template' builtin needs that to work properly
 		t = t.New(include)
-		t.Option("missingkey=zero").
-			Funcs(sprig.TxtFuncMap()).
-			Funcs(templatex.FuncMap()).
-			Funcs(templatex.FuncMapForTemplate(t)).
-			Funcs(templatex.FuncMapForClient(client))
 		if _, err := t.Parse(string(raw)); err != nil {
 			return nil, err
 		}
@@ -180,7 +175,7 @@ func NewHelmGenerator(name string, fsys fs.FS, chartPath string, client client.C
 	return &g, nil
 }
 
-// Create a new HelmGenerator as TransformableGenerator
+// Create a new HelmGenerator as TransformableGenerator.
 func NewTransformableHelmGenerator(name string, fsys fs.FS, chartPath string, client client.Client, discoveryClient discovery.DiscoveryInterface) (TransformableGenerator, error) {
 	g, err := NewHelmGenerator(name, fsys, chartPath, client, discoveryClient)
 	if err != nil {
@@ -257,6 +252,14 @@ func (g *HelmGenerator) Generate(namespace string, name string, parameters types
 		}
 	}
 
+	var t0 *template.Template
+	if len(g.templates) > 0 {
+		t0, err = g.templates[0].Clone()
+		if err != nil {
+			return nil, err
+		}
+		t0.Option("missingkey=zero")
+	}
 	for _, t := range g.templates {
 		data["Template"] = &helm.TemplateData{
 			Name: t.Name(),
@@ -272,7 +275,7 @@ func (g *HelmGenerator) Generate(namespace string, name string, parameters types
 			}(t.Name()),
 		}
 		var buf bytes.Buffer
-		if err := t.Execute(&buf, data); err != nil {
+		if err := t0.ExecuteTemplate(&buf, t.Name(), data); err != nil {
 			return nil, err
 		}
 		decoder := utilyaml.NewYAMLToJSONDecoder(&buf)

pkg/manifests/kustomize.go

@@ -72,14 +72,15 @@ func NewKustomizeGenerator(fsys fs.FS, kustomizationPath string, templateSuffix
 		}
 		if t == nil {
 			t = template.New(name)
+			t.Option("missingkey=zero").
+				Funcs(sprig.TxtFuncMap()).
+				Funcs(templatex.FuncMap()).
+				Funcs(templatex.FuncMapForTemplate(t)).
+				Funcs(templatex.FuncMapForClient(client)).
+				Funcs(funcMapForGenerateContext("", ""))
 		} else {
 			t = t.New(name)
 		}
-		t.Option("missingkey=zero").
-			Funcs(sprig.TxtFuncMap()).
-			Funcs(templatex.FuncMap()).
-			Funcs(templatex.FuncMapForTemplate(t)).
-			Funcs(templatex.FuncMapForClient(client))
 		if _, err := t.Parse(string(raw)); err != nil {
 			return nil, err
 		}
@@ -89,7 +90,7 @@ func NewKustomizeGenerator(fsys fs.FS, kustomizationPath string, templateSuffix
 	return &g, nil
 }
 
-// Create a new KustomizeGenerator as TransformableGenerator
+// Create a new KustomizeGenerator as TransformableGenerator.
 func NewTransformableKustomizeGenerator(fsys fs.FS, kustomizationPath string, templateSuffix string, client client.Client) (TransformableGenerator, error) {
 	g, err := NewKustomizeGenerator(fsys, kustomizationPath, templateSuffix, client)
 	if err != nil {
@@ -123,9 +124,19 @@ func (g *KustomizeGenerator) Generate(namespace string, name string, parameters
 	data := parameters.ToUnstructured()
 	fsys := kustfsys.MakeFsInMemory()
 
+	var t0 *template.Template
+	var err error
+	if len(g.templates) > 0 {
+		t0, err = g.templates[0].Clone()
+		if err != nil {
+			return nil, err
+		}
+		t0.Option("missingkey=zero").
+			Funcs(funcMapForGenerateContext(namespace, name))
+	}
 	for _, t := range g.templates {
 		var buf bytes.Buffer
-		if err := t.Execute(&buf, data); err != nil {
+		if err := t0.ExecuteTemplate(&buf, t.Name(), data); err != nil {
 			return nil, err
 		}
 		if err := fsys.WriteFile(t.Name(), buf.Bytes()); err != nil {
@@ -160,3 +171,10 @@ func (g *KustomizeGenerator) Generate(namespace string, name string, parameters
 
 	return objects, nil
 }
+
+func funcMapForGenerateContext(namespace string, name string) template.FuncMap {
+	return template.FuncMap{
+		"namespace": func() string { return namespace },
+		"name":      func() string { return name },
+	}
+}

pkg/manifests/types.go

@@ -12,10 +12,8 @@ import (
 )
 
 // Resource generator interface.
-// When called from the reconciler, namespace and name will match the respective values in the
-// reconciled Component's spec, and parameters will be a pointer to the whole Component spec.
-// Therefore, implementations which are directly called from the reconciler,
-// can safely cast parameters back to their concrete spec struct.
+// When called from the reconciler, the arguments namespace, name and parameters will match the return values
+// of the component's GetDeploymentNamespace(), GetDeploymentName() and GetSpec() methods, respectively.
 type Generator interface {
 	Generate(namespace string, name string, parameters types.Unstructurable) ([]client.Object, error)
 }

pkg/manifests/util.go

@@ -10,6 +10,7 @@ import (
 	"fmt"
 	"io/fs"
 	"path"
+	"path/filepath"
 	"strings"
 
 	"k8s.io/apimachinery/pkg/runtime"
@@ -84,6 +85,9 @@ func fileTypeFromMode(mode fs.FileMode) uint {
 }
 
 func find(fsys fs.FS, dir string, namePattern string, fileType uint, maxDepth uint) ([]string, error) {
+	if dir == "" {
+		dir = "."
+	}
 	if strings.Contains(namePattern, "/") {
 		return nil, fmt.Errorf("invalid name pattern; must not contain slashes")
 	}
@@ -113,15 +117,16 @@ func find(fsys fs.FS, dir string, namePattern string, fileType uint, maxDepth ui
 	for _, entry := range entries {
 		entryName := entry.Name()
 		entryType := entry.Type()
+		entryPath := filepath.Clean(dir + "/" + entryName)
 		match, err := path.Match(namePattern, entryName)
 		if err != nil {
 			return nil, err
 		}
 		if match && (fileTypeFromMode(entryType)&fileType != 0) {
-			result = append(result, dir+"/"+entryName)
+			result = append(result, entryPath)
 		}
 		if entry.IsDir() && maxDepth > 1 {
-			entryResult, err := find(fsys, dir+"/"+entryName, namePattern, fileType, maxDepth-1)
+			entryResult, err := find(fsys, entryPath, namePattern, fileType, maxDepth-1)
 			if err != nil {
 				return nil, err
 			}