fix(helm): ensure coder can be deployed in a non-default namespace (coder#16579)

Added namespace to all resources in the helm chart and added tests to ensure that coder can be deployed in non-default namespaces, as specified via the namespace flag in the helm command.

Ways to verify this:

- current state: 
  ```bash
  $ helm template my-coder coder -n coder --version 2.19.0 --repo https://helm.coder.com/v2 | yq '.metadata.namespace'
  null
  ---
  null
  ---
  null
  ---
  null
  ---
  null
  ```

- fixed state when checking out this PR: 
  ```bash
  $ helm template my-coder ./helm/coder -n coder --set coder.image.tag=latest | yq '.metadata.namespace'
  coder
  ---
  coder
  ---
  coder
  ---
  coder
  ---
  coder
  ```

Change-Id: Ib66d4be9bcc4984dfe15709362e1fe0dcd3e847f
Signed-off-by: Thomas Kosiewski <[email protected]>

Author: ThomasK33

helm/coder/templates/ingress.yaml

@@ -1,10 +1,10 @@
-
 {{- if .Values.coder.ingress.enable }}
 ---
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
   name: coder
+  namespace: {{ .Release.Namespace }}
   labels:
     {{- include "coder.labels" . | nindent 4 }}
   annotations:

helm/coder/templates/service.yaml

@@ -4,6 +4,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: coder
+  namespace: {{ .Release.Namespace }}
   labels:
     {{- include "coder.labels" . | nindent 4 }}
   annotations:

helm/coder/tests/chart_test.go

@@ -23,6 +23,11 @@ import (
 // updateGoldenFiles is a flag that can be set to update golden files.
 var updateGoldenFiles = flag.Bool("update", false, "Update golden files")
 
+var namespaces = []string{
+	"default",
+	"coder",
+}
+
 var testCases = []testCase{
 	{
 		name:          "default_values",
@@ -116,6 +121,7 @@ var testCases = []testCase{
 
 type testCase struct {
 	name          string // Name of the test case. This is used to control which values and golden file are used.
+	namespace     string // Namespace is the name of the namespace the resources should be generated within
 	expectedError string // Expected error from running `helm template`.
 }
 
@@ -124,7 +130,11 @@ func (tc testCase) valuesFilePath() string {
 }
 
 func (tc testCase) goldenFilePath() string {
-	return filepath.Join("./testdata", tc.name+".golden")
+	if tc.namespace == "default" {
+		return filepath.Join("./testdata", tc.name+".golden")
+	}
+
+	return filepath.Join("./testdata", tc.name+"_"+tc.namespace+".golden")
 }
 
 func TestRenderChart(t *testing.T) {
@@ -146,35 +156,41 @@ func TestRenderChart(t *testing.T) {
 
 	for _, tc := range testCases {
 		tc := tc
-		t.Run(tc.name, func(t *testing.T) {
-			t.Parallel()
 
-			// Ensure that the values file exists.
-			valuesFilePath := tc.valuesFilePath()
-			if _, err := os.Stat(valuesFilePath); os.IsNotExist(err) {
-				t.Fatalf("values file %q does not exist", valuesFilePath)
-			}
+		for _, ns := range namespaces {
+			tc := tc
+			tc.namespace = ns
 
-			// Run helm template with the values file.
-			templateOutput, err := runHelmTemplate(t, helmPath, "..", valuesFilePath)
-			if tc.expectedError != "" {
-				require.Error(t, err, "helm template should have failed")
-				require.Contains(t, templateOutput, tc.expectedError, "helm template output should contain expected error")
-			} else {
-				require.NoError(t, err, "helm template should not have failed")
-				require.NotEmpty(t, templateOutput, "helm template output should not be empty")
-				goldenFilePath := tc.goldenFilePath()
-				goldenBytes, err := os.ReadFile(goldenFilePath)
-				require.NoError(t, err, "failed to read golden file %q", goldenFilePath)
-
-				// Remove carriage returns to make tests pass on Windows.
-				goldenBytes = bytes.Replace(goldenBytes, []byte("\r"), []byte(""), -1)
-				expected := string(goldenBytes)
-
-				require.NoError(t, err, "failed to load golden file %q")
-				require.Equal(t, expected, templateOutput)
-			}
-		})
+			t.Run(tc.namespace+"/"+tc.name, func(t *testing.T) {
+				t.Parallel()
+
+				// Ensure that the values file exists.
+				valuesFilePath := tc.valuesFilePath()
+				if _, err := os.Stat(valuesFilePath); os.IsNotExist(err) {
+					t.Fatalf("values file %q does not exist", valuesFilePath)
+				}
+
+				// Run helm template with the values file.
+				templateOutput, err := runHelmTemplate(t, helmPath, "..", valuesFilePath, tc.namespace)
+				if tc.expectedError != "" {
+					require.Error(t, err, "helm template should have failed")
+					require.Contains(t, templateOutput, tc.expectedError, "helm template output should contain expected error")
+				} else {
+					require.NoError(t, err, "helm template should not have failed")
+					require.NotEmpty(t, templateOutput, "helm template output should not be empty")
+					goldenFilePath := tc.goldenFilePath()
+					goldenBytes, err := os.ReadFile(goldenFilePath)
+					require.NoError(t, err, "failed to read golden file %q", goldenFilePath)
+
+					// Remove carriage returns to make tests pass on Windows.
+					goldenBytes = bytes.ReplaceAll(goldenBytes, []byte("\r"), []byte(""))
+					expected := string(goldenBytes)
+
+					require.NoError(t, err, "failed to load golden file %q")
+					require.Equal(t, expected, templateOutput)
+				}
+			})
+		}
 	}
 }
 
@@ -189,22 +205,28 @@ func TestUpdateGoldenFiles(t *testing.T) {
 	require.NoError(t, err, "failed to build Helm dependencies")
 
 	for _, tc := range testCases {
+		tc := tc
 		if tc.expectedError != "" {
 			t.Logf("skipping test case %q with render error", tc.name)
 			continue
 		}
 
-		valuesPath := tc.valuesFilePath()
-		templateOutput, err := runHelmTemplate(t, helmPath, "..", valuesPath)
-		if err != nil {
-			t.Logf("error running `helm template -f %q`: %v", valuesPath, err)
-			t.Logf("output: %s", templateOutput)
-		}
-		require.NoError(t, err, "failed to run `helm template -f %q`", valuesPath)
+		for _, ns := range namespaces {
+			tc := tc
+			tc.namespace = ns
+
+			valuesPath := tc.valuesFilePath()
+			templateOutput, err := runHelmTemplate(t, helmPath, "..", valuesPath, tc.namespace)
+			if err != nil {
+				t.Logf("error running `helm template -f %q`: %v", valuesPath, err)
+				t.Logf("output: %s", templateOutput)
+			}
+			require.NoError(t, err, "failed to run `helm template -f %q`", valuesPath)
 
-		goldenFilePath := tc.goldenFilePath()
-		err = os.WriteFile(goldenFilePath, []byte(templateOutput), 0o644) // nolint:gosec
-		require.NoError(t, err, "failed to write golden file %q", goldenFilePath)
+			goldenFilePath := tc.goldenFilePath()
+			err = os.WriteFile(goldenFilePath, []byte(templateOutput), 0o644) // nolint:gosec
+			require.NoError(t, err, "failed to write golden file %q", goldenFilePath)
+		}
 	}
 	t.Log("Golden files updated. Please review the changes and commit them.")
 }
@@ -231,13 +253,13 @@ func updateHelmDependencies(t testing.TB, helmPath, chartDir string) error {
 
 // runHelmTemplate runs helm template on the given chart with the given values and
 // returns the raw output.
-func runHelmTemplate(t testing.TB, helmPath, chartDir, valuesFilePath string) (string, error) {
+func runHelmTemplate(t testing.TB, helmPath, chartDir, valuesFilePath, namespace string) (string, error) {
 	// Ensure that valuesFilePath exists
 	if _, err := os.Stat(valuesFilePath); err != nil {
 		return "", xerrors.Errorf("values file %q does not exist: %w", valuesFilePath, err)
 	}
 
-	cmd := exec.Command(helmPath, "template", chartDir, "-f", valuesFilePath, "--namespace", "default")
+	cmd := exec.Command(helmPath, "template", chartDir, "-f", valuesFilePath, "--namespace", namespace)
 	t.Logf("exec command: %v", cmd.Args)
 	out, err := cmd.CombinedOutput()
 	return string(out), err

helm/coder/tests/testdata/auto_access_url_1.golden

@@ -12,12 +12,14 @@ metadata:
     app.kubernetes.io/version: 0.1.0
     helm.sh/chart: coder-0.1.0
   name: coder
+  namespace: default
 ---
 # Source: coder/templates/rbac.yaml
 apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
 metadata:
   name: coder-workspace-perms
+  namespace: default
 rules:
   - apiGroups: [""]
     resources: ["pods"]
@@ -60,6 +62,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: RoleBinding
 metadata:
   name: "coder"
+  namespace: default
 subjects:
   - kind: ServiceAccount
     name: "coder"
@@ -73,6 +76,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: coder
+  namespace: default
   labels:
     helm.sh/chart: coder-0.1.0
     app.kubernetes.io/name: coder
@@ -109,6 +113,7 @@ metadata:
     app.kubernetes.io/version: 0.1.0
     helm.sh/chart: coder-0.1.0
   name: coder
+  namespace: default
 spec:
   replicas: 1
   selector: