tests: test/deployer golden files are more end-to-end (#13037)

Signed-off-by: David L. Chandler <[email protected]>
Signed-off-by: John Howard <[email protected]>

Author: chandler-solo

test/deployer/deployer_helm.go

@@ -126,11 +126,13 @@ func (dt DeployerTester) RunHelmChartTest(
 	ctx := t.Context()
 	fakeClient.RunAndWait(ctx.Done())
 
-	vals, err := gwParams.GetValues(ctx, gtw)
-	assert.NoError(t, err, "error getting values for GwParams")
+	// Get objects (what actually gets deployed), which in the future is likely
+	// to differ from helm's rendered output
+	deployObjs, err := deployer.GetObjsToDeploy(ctx, gtw)
+	assert.NoError(t, err, "error getting objects to deploy")
 
-	got, err := deployer.RenderManifest(gtw.Namespace, gtw.Name, vals)
-	assert.NoError(t, err, "error rendering helm manifest")
+	got, err := objectsToYAML(deployObjs)
+	assert.NoError(t, err, "error converting objects to YAML")
 
 	if envutils.IsEnvTruthy("REFRESH_GOLDEN") {
 		t.Log("REFRESH_GOLDEN is set, writing output file", outputFile)
@@ -252,3 +254,19 @@ func validateYAML(t *testing.T, filename string, data []byte) {
 		}
 	}
 }
+
+// objectsToYAML converts a slice of client.Object to YAML bytes, separated by "---"
+func objectsToYAML(objs []client.Object) ([]byte, error) {
+	var result []byte
+	for i, obj := range objs {
+		objYAML, err := yaml.Marshal(obj)
+		if err != nil {
+			return nil, err
+		}
+		if i > 0 {
+			result = append(result, []byte("---\n")...)
+		}
+		result = append(result, objYAML...)
+	}
+	return result, nil
+}

test/deployer/testdata/agentgateway-controller-but-custom-gatewayclass-out.yaml

@@ -1,11 +1,7 @@
----
-# Source: agentgateway/templates/serviceaccount.yaml
 apiVersion: v1
+automountServiceAccountToken: false
 kind: ServiceAccount
 metadata:
-  name: gw
-  annotations:
-    {}
   labels:
     app.kubernetes.io/instance: gw
     app.kubernetes.io/managed-by: kgateway
@@ -14,15 +10,14 @@ metadata:
     gateway.networking.k8s.io/gateway-class-name: a-lot-like-agentgateway-but-not-named-agentgateway
     gateway.networking.k8s.io/gateway-name: gw
     kgateway: kube-gateway
-automountServiceAccountToken: false
+  name: gw
 ---
-# Source: agentgateway/templates/configmap.yaml
 apiVersion: v1
+data:
+  config.yaml: |
+    config: {}
 kind: ConfigMap
 metadata:
-  name: gw
-  annotations:
-    {}
   labels:
     app.kubernetes.io/instance: gw
     app.kubernetes.io/managed-by: kgateway
@@ -31,17 +26,11 @@ metadata:
     gateway.networking.k8s.io/gateway-class-name: a-lot-like-agentgateway-but-not-named-agentgateway
     gateway.networking.k8s.io/gateway-name: gw
     kgateway: kube-gateway
-data:
-  config.yaml: |
-    config: {}
+  name: gw
 ---
-# Source: agentgateway/templates/service.yaml
 apiVersion: v1
 kind: Service
 metadata:
-  name: gw
-  annotations:
-    {}
   labels:
     app.kubernetes.io/instance: gw
     app.kubernetes.io/managed-by: kgateway
@@ -50,23 +39,24 @@ metadata:
     gateway.networking.k8s.io/gateway-class-name: a-lot-like-agentgateway-but-not-named-agentgateway
     gateway.networking.k8s.io/gateway-name: gw
     kgateway: kube-gateway
+  name: gw
 spec:
-  type: LoadBalancer
   ports:
-    - name: listener-8080
-      protocol: TCP
-      targetPort: 8080
-      port: 8080
+  - name: listener-8080
+    port: 8080
+    protocol: TCP
+    targetPort: 8080
   selector:
-    app.kubernetes.io/name: gw
     app.kubernetes.io/instance: gw
+    app.kubernetes.io/name: gw
     gateway.networking.k8s.io/gateway-name: gw
+  type: LoadBalancer
+status:
+  loadBalancer: {}
 ---
-# Source: agentgateway/templates/deployment.yaml
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: gw
   labels:
     app.kubernetes.io/instance: gw
     app.kubernetes.io/managed-by: kgateway
@@ -75,12 +65,14 @@ metadata:
     gateway.networking.k8s.io/gateway-class-name: a-lot-like-agentgateway-but-not-named-agentgateway
     gateway.networking.k8s.io/gateway-name: gw
     kgateway: kube-gateway
+  name: gw
 spec:
   selector:
     matchLabels:
-      app.kubernetes.io/name: gw
       app.kubernetes.io/instance: gw
+      app.kubernetes.io/name: gw
       gateway.networking.k8s.io/gateway-name: gw
+  strategy: {}
   template:
     metadata:
       annotations:
@@ -93,93 +85,94 @@ spec:
         gateway.networking.k8s.io/gateway-class-name: a-lot-like-agentgateway-but-not-named-agentgateway
         gateway.networking.k8s.io/gateway-name: gw
     spec:
-      serviceAccountName: gw
+      containers:
+      - args:
+        - -f
+        - /config/config.yaml
+        env:
+        - name: TERMINATION_GRACE_PERIOD_SECONDS
+          value: "60"
+        - name: CONNECTION_MIN_TERMINATION_DEADLINE
+          value: 10s
+        - name: NODE_NAME
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.name
+        - name: POD_NAMESPACE
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.namespace
+        - name: POD_NAME
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.name
+        - name: GW_NAME
+          value: gw
+        - name: RUST_BACKTRACE
+          value: "1"
+        - name: RUST_LOG
+          value: info
+        - name: XDS_ADDRESS
+          value: http://xds.cluster.local:9978
+        - name: NAMESPACE
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.namespace
+        - name: GATEWAY
+          value: gw
+        image: ghcr.io/agentgateway/agentgateway:0.11.0-alpha.f45f1a94cdfa53d96e14301d59ac62200214cb9c
+        name: agent-gateway
+        ports:
+        - containerPort: 15020
+          name: metrics
+          protocol: TCP
+        readinessProbe:
+          httpGet:
+            path: /healthz/ready
+            port: 15021
+          periodSeconds: 10
+        resources: {}
+        securityContext:
+          allowPrivilegeEscalation: false
+          capabilities:
+            drop:
+            - ALL
+          readOnlyRootFilesystem: true
+          runAsNonRoot: true
+          runAsUser: 10101
+        startupProbe:
+          failureThreshold: 60
+          httpGet:
+            path: /healthz/ready
+            port: 15021
+          periodSeconds: 1
+          successThreshold: 1
+          timeoutSeconds: 2
+        volumeMounts:
+        - mountPath: /config
+          name: config-volume
+        - mountPath: /tmp
+          name: tmp
+        - mountPath: /var/run/secrets/xds-tokens
+          name: xds-token
+          readOnly: true
       securityContext:
         sysctls:
         - name: net.ipv4.ip_unprivileged_port_start
           value: "0"
-      containers:
-        - name: agent-gateway
-          image: "ghcr.io/agentgateway/agentgateway:0.11.0-alpha.f45f1a94cdfa53d96e14301d59ac62200214cb9c"
-          securityContext:
-            allowPrivilegeEscalation: false
-            capabilities:
-              drop:
-              - ALL
-            readOnlyRootFilesystem: true
-            runAsNonRoot: true
-            runAsUser: 10101
-          startupProbe:
-            failureThreshold: 60
-            httpGet:
-              path: /healthz/ready
-              port: 15021
-            periodSeconds: 1
-            successThreshold: 1
-            timeoutSeconds: 2
-          readinessProbe:
-            httpGet:
-              path: /healthz/ready
-              port: 15021
-            periodSeconds: 10
-          ports:
-          - containerPort: 15020
-            name: metrics
-            protocol: TCP
-          args:
-            - -f
-            - /config/config.yaml
-          env:
-            - name: TERMINATION_GRACE_PERIOD_SECONDS
-              value: "60"
-            - name: CONNECTION_MIN_TERMINATION_DEADLINE
-              value: "10s"
-            - name: NODE_NAME
-              valueFrom:
-                fieldRef:
-                  fieldPath: metadata.name
-            - name: POD_NAMESPACE
-              valueFrom:
-                fieldRef:
-                  fieldPath: metadata.namespace
-            - name: POD_NAME
-              valueFrom:
-                fieldRef:
-                  fieldPath: metadata.name
-            - name: GW_NAME
-              value: gw
-            - name: RUST_BACKTRACE
-              value: "1"
-            - name: RUST_LOG
-              value: info
-            - name: XDS_ADDRESS
-              value: "http://xds.cluster.local:9978"
-            - name: NAMESPACE
-              valueFrom:
-                fieldRef:
-                  fieldPath: metadata.namespace
-            - name: GATEWAY
-              value: gw
-          volumeMounts:
-            - name: config-volume
-              mountPath: /config
-            # Make /tmp writeable, needed for pprof
-            - name: tmp
-              mountPath: /tmp
-            - name: xds-token
-              mountPath: /var/run/secrets/xds-tokens
-              readOnly: true
-      volumes:
-        - name: config-volume
-          configMap:
-            name: gw
-        - name: xds-token
-          projected:
-            sources:
-            - serviceAccountToken:
-                audience: kgateway
-                expirationSeconds: 43200
-                path: xds-token
-        - name: tmp
-          emptyDir: {}
+      serviceAccountName: gw
       terminationGracePeriodSeconds: 60
+      volumes:
+      - configMap:
+          name: gw
+        name: config-volume
+      - name: xds-token
+        projected:
+          sources:
+          - serviceAccountToken:
+              audience: kgateway
+              expirationSeconds: 43200
+              path: xds-token
+      - emptyDir: {}
+        name: tmp
+status: {}