feat(helm-namespace): consistent namespace handling for Helm charts and update related tests

Author: Skaronator

api/internal/builtins/HelmChartInflationGenerator.go

@@ -49,4 +49,7 @@ const (
 
 	// Annotation key for marking helm-generated resources to skip namespace transformation
 	HelmGeneratedAnnotation = ConfigAnnoDomain + "/helm-generated"
+
+	// Annotation key for preserving the effective Helm chart namespace during build-time transforms.
+	HelmChartNamespaceAnnotation = ConfigAnnoDomain + "/helm-chart-namespace"
 )

api/internal/builtins/NamespaceTransformer.go

@@ -1179,6 +1179,52 @@ metadata:
 `)
 }
 
+func TestHelmChartDifferentNamespacesMissingResourceNamespace(t *testing.T) {
+	th := kusttest_test.MakeEnhancedHarnessWithTmpRoot(t)
+	defer th.Reset()
+	if err := th.ErrIfNoHelm(); err != nil {
+		t.Skip("skipping: " + err.Error())
+	}
+
+	chartDir := filepath.Join(th.GetRoot(), "charts", "service")
+	require.NoError(t, th.GetFSys().MkdirAll(filepath.Join(chartDir, "templates")))
+	th.WriteF(filepath.Join(chartDir, "Chart.yaml"), `
+apiVersion: v2
+name: service
+type: application
+version: 1.0.0
+`)
+	th.WriteF(filepath.Join(chartDir, "values.yaml"), ``)
+	th.WriteF(filepath.Join(chartDir, "templates", "service.yaml"), `
+apiVersion: v1
+kind: Service
+metadata:
+  name: test-service
+  annotations:
+    release-namespace: {{ .Release.Namespace }}
+`)
+
+	th.WriteK(th.GetRoot(), `
+helmGlobals:
+  chartHome: ./charts
+namespace: transformer-ns
+helmCharts:
+  - name: service
+    releaseName: service
+    namespace: helm-ns
+`)
+
+	m := th.Run(th.GetRoot(), th.MakeOptionsPluginsEnabled())
+	th.AssertActualEqualsExpected(m, `apiVersion: v1
+kind: Service
+metadata:
+  annotations:
+    release-namespace: helm-ns
+  name: test-service
+  namespace: helm-ns
+`)
+}
+
 func TestHelmChartSameNamespace(t *testing.T) {
 	th := kusttest_test.MakeEnhancedHarnessWithTmpRoot(t)
 	defer th.Reset()

api/konfig/general.go

@@ -50,6 +50,7 @@ var BuildAnnotations = []string{
 	kioutil.LegacyIdAnnotation,
 
 	konfig.HelmGeneratedAnnotation,
+	konfig.HelmChartNamespaceAnnotation,
 }
 
 func (r *Resource) ResetRNode(incoming *Resource) {
@@ -160,7 +161,9 @@ func (r *Resource) DeepCopy() *Resource {
 // the resource.
 // TODO: move to RNode, use GetMeta to improve performance.
 // TODO: make a version of mergeStringMaps that is build-annotation aware
-//   to avoid repeatedly setting refby and genargs annotations
+//
+//	to avoid repeatedly setting refby and genargs annotations
+//
 // Must remove the kustomize bit at the end.
 func (r *Resource) CopyMergeMetaDataFieldsFrom(other *Resource) error {
 	if err := r.SetLabels(

api/krusty/helmchartinflationgenerator_test.go

@@ -31,11 +31,13 @@ output=$(kustomize build \
 printf '%s\n' "$output"
 ```
 
+## Helm Chart with Namespace in `helmChart.namespace`
+
 The Service is emitted by the chart without a namespace, so the example namespace should be applied:
 
 <!-- @checkMissingNamespaceFilled @testHelm -->
 ```sh
-printf '%s\n' "$output" | grep -A4 'name: chart-service' | grep 'namespace: top-level-ns'
+printf '%s\n' "$output" | grep -A4 'name: chart-service' | grep 'namespace: chart-ns'
 ```
 
 The ConfigMap is emitted by the chart with an explicit namespace, so that value should be preserved:
@@ -51,3 +53,26 @@ The Secret is emitted by the chart with an release namespace, so that value shou
 ```sh
 printf '%s\n' "$output" | grep -A4 'name: chart-secret' | grep 'namespace: chart-ns'
 ```
+
+## Helm Chart without Namespace in `helmChart.namespace`
+
+The Service is emitted by the chart without a namespace, so the example namespace should be applied:
+
+<!-- @checkMissingNamespaceFilled @testHelm -->
+```sh
+printf '%s\n' "$output" | grep -A4 'name: chart-service' | grep 'namespace: top-level-ns'
+```
+
+The ConfigMap is emitted by the chart with an explicit namespace, so that value should be preserved:
+
+<!-- @checkExistingNamespacePreserved @testHelm -->
+```sh
+printf '%s\n' "$output" | grep -A4 'name: chart-config' | grep 'namespace: chart-owned-ns'
+```
+
+The Secret is emitted by the chart with an release namespace, so that value should be preserved:
+
+<!-- @checkExistingNamespacePreserved @testHelm -->
+```sh
+printf '%s\n' "$output" | grep -A4 'name: chart-secret' | grep 'namespace: top-level-ns'
+```

api/resource/resource.go

@@ -1,7 +1,7 @@
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: chart-config
+  name: {{ .Release.Name }}-config
   namespace: chart-owned-ns
 data:
   owner: helm-chart

examples/helmNamespace/README.md

@@ -1,7 +1,7 @@
 apiVersion: v1
 kind: Secret
 metadata:
-  name: chart-secret
+  name: {{ .Release.Name }}-secret
   namespace: {{ .Release.Namespace }}
 data:
   .secret-file: dmFsdWUtMg0KDQo=

examples/helmNamespace/charts/namespace-fill/templates/configmap.yaml

@@ -1,10 +1,10 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: chart-service
+  name: {{ .Release.Name }}-service
 spec:
   selector:
-    app: chart-service
+    app: app-service
   ports:
   - port: 80
     targetPort: 8080

examples/helmNamespace/charts/namespace-fill/templates/secrets.yaml

@@ -7,5 +7,10 @@ helmGlobals:
   chartHome: charts
 
 helmCharts:
+# test a contains a namespace
 - name: namespace-fill
+  releaseName: test-a
   namespace: chart-ns
+# test b inherits the namespace from top level
+- name: namespace-fill
+  releaseName: test-b