Templating scope for generated results

This adds the generated data to a .element scope in the templates to
make it easier to add additional data without overwriting the changes.

Author: bigkevmcd

controllers/gitopsset_controller_test.go

@@ -105,13 +105,13 @@ func TestReconciliation(t *testing.T) {
 				{
 					Content: runtime.RawExtension{
 						Raw: mustMarshalJSON(t, makeTestKustomization(nsn("unused", "unused"), func(ks *kustomizev1.Kustomization) {
-							ks.Name = "{{.cluster}}-demo"
+							ks.Name = "{{ .element.cluster }}-demo"
 							ks.Annotations = map[string]string{
-								"testing.cluster": "{{.cluster}}",
+								"testing.cluster": "{{ .element.cluster }}",
 								"testing":         "newVersion",
 							}
-							ks.Spec.Path = "./templated/clusters/{{ .cluster }}/"
-							ks.Spec.KubeConfig = &meta.KubeConfigReference{SecretRef: meta.SecretKeyReference{Name: "{{ .cluster }}"}}
+							ks.Spec.Path = "./templated/clusters/{{ .element.cluster }}/"
+							ks.Spec.KubeConfig = &meta.KubeConfigReference{SecretRef: meta.SecretKeyReference{Name: "{{ .element.cluster }}"}}
 							ks.Spec.Force = true
 						})),
 					},
@@ -195,13 +195,13 @@ func TestReconciliation(t *testing.T) {
 				{
 					Content: runtime.RawExtension{
 						Raw: mustMarshalJSON(t, makeTestKustomization(nsn("unused", "unused"), func(ks *kustomizev1.Kustomization) {
-							ks.Name = "{{.cluster}}-demo"
+							ks.Name = "{{ .element.cluster }}-demo"
 							ks.Annotations = map[string]string{
-								"testing.cluster": "{{.cluster}}",
+								"testing.cluster": "{{ .element.cluster }}",
 								"testing":         "newVersion",
 							}
-							ks.Spec.Path = "./templated/clusters/{{ .cluster }}/"
-							ks.Spec.KubeConfig = &meta.KubeConfigReference{SecretRef: meta.SecretKeyReference{Name: "{{ .cluster }}"}}
+							ks.Spec.Path = "./templated/clusters/{{ .element.cluster }}/"
+							ks.Spec.KubeConfig = &meta.KubeConfigReference{SecretRef: meta.SecretKeyReference{Name: "{{ .element.cluster }}"}}
 							ks.Spec.Force = true
 						})),
 					},
@@ -367,18 +367,18 @@ func makeTestGitOpsSet(t *testing.T, opts ...func(*templatesv1.GitOpsSet)) *temp
 			Templates: []templatesv1.GitOpsSetTemplate{
 				{
 					Content: runtime.RawExtension{
-						Raw: mustMarshalJSON(t, makeTestKustomization(nsn("default", "{{.cluster}}-demo"), func(k *kustomizev1.Kustomization) {
+						Raw: mustMarshalJSON(t, makeTestKustomization(nsn("default", "{{ .element.cluster }}-demo"), func(k *kustomizev1.Kustomization) {
 							k.Spec = kustomizev1.KustomizationSpec{
 								Interval: metav1.Duration{Duration: 5 * time.Minute},
-								Path:     "./clusters/{{.cluster}}/",
+								Path:     "./clusters/{{ .element.cluster }}/",
 								Prune:    true,
 								SourceRef: kustomizev1.CrossNamespaceSourceReference{
 									Kind: "GitRepository",
 									Name: "demo-repo",
 								},
 								KubeConfig: &meta.KubeConfigReference{
 									SecretRef: meta.SecretKeyReference{
-										Name: "{{.cluster}}",
+										Name: "{{ .element.cluster }}",
 									},
 								},
 							}

controllers/templates/renderer.go

@@ -94,8 +94,12 @@ func render(b []byte, params map[string]any) ([]byte, error) {
 		return nil, fmt.Errorf("failed to parse template: %w", err)
 	}
 
+	data := map[string]any{
+		"element": params,
+	}
+
 	var out bytes.Buffer
-	if err := t.Execute(&out, params); err != nil {
+	if err := t.Execute(&out, data); err != nil {
 		return nil, fmt.Errorf("failed to render template: %w", err)
 	}
 

controllers/templates/renderer_test.go

@@ -63,7 +63,7 @@ func TestRender(t *testing.T) {
 					s.Spec.Templates = []templatesv1.GitOpsSetTemplate{
 						{
 							Content: runtime.RawExtension{
-								Raw: mustMarshalJSON(t, makeTestService(types.NamespacedName{Name: "{{sanitize .env}}-demo"})),
+								Raw: mustMarshalJSON(t, makeTestService(types.NamespacedName{Name: "{{ sanitize .element.env }}-demo"})),
 							},
 						},
 					}
@@ -86,12 +86,12 @@ func TestRender(t *testing.T) {
 					s.Spec.Templates = []templatesv1.GitOpsSetTemplate{
 						{
 							Content: runtime.RawExtension{
-								Raw: mustMarshalJSON(t, makeTestService(types.NamespacedName{Name: "{{ .env}}-demo1"})),
+								Raw: mustMarshalJSON(t, makeTestService(types.NamespacedName{Name: "{{ .element.env }}-demo1"})),
 							},
 						},
 						{
 							Content: runtime.RawExtension{
-								Raw: mustMarshalJSON(t, makeTestService(types.NamespacedName{Name: "{{ .env}}-demo2"})),
+								Raw: mustMarshalJSON(t, makeTestService(types.NamespacedName{Name: "{{ .element.env }}-demo2"})),
 							},
 						},
 					}
@@ -185,7 +185,7 @@ func makeTestGitOpsSet(t *testing.T, opts ...func(*templatesv1.GitOpsSet)) *temp
 			Templates: []templatesv1.GitOpsSetTemplate{
 				{
 					Content: runtime.RawExtension{
-						Raw: mustMarshalJSON(t, makeTestService(types.NamespacedName{Name: "{{.env}}-demo"})),
+						Raw: mustMarshalJSON(t, makeTestService(types.NamespacedName{Name: "{{ .element.env }}-demo"})),
 					},
 				},
 			},
@@ -208,11 +208,11 @@ func makeTestService(name types.NamespacedName, opts ...func(*corev1.Service)) *
 			Name:      name.Name,
 			Namespace: name.Namespace,
 			Annotations: map[string]string{
-				"app.kubernetes.io/instance": "{{ .env }}",
+				"app.kubernetes.io/instance": "{{ .element.env }}",
 			},
 		},
 		Spec: corev1.ServiceSpec{
-			ClusterIP: "{{ .externalIP }}",
+			ClusterIP: "{{ .element.externalIP }}",
 			Ports: []corev1.ServicePort{
 				{
 					Name:       "http",

examples/list-generator/list-generator.yaml

@@ -23,14 +23,14 @@ spec:
         kind: Kustomization
         apiVersion: kustomize.toolkit.fluxcd.io/v1beta2
         metadata:
-          name: "{{ .env }}-demo"
+          name: "{{ .element.env }}-demo"
           labels:
             app.kubernetes.io/name: go-demo
-            app.kubernetes.io/instance: "{{ .env }}"
+            app.kubernetes.io/instance: "{{ .element.env }}"
             com.example/team: "{{ .team }}"
         spec:
           interval: 5m
-          path: "./examples/kustomize/environments/{{ .env }}"
+          path: "./examples/kustomize/environments/{{ .element.env }}"
           prune: true
           sourceRef:
             kind: GitRepository