Add kuttl test

Author: sbernauer

tests/templates/kuttl/restarter-no-unneeded-restart/00-patch-ns.yaml.j2

@@ -0,0 +1,9 @@
+{% if test_scenario['values']['openshift'] == 'true' %}
+# see https://github.com/stackabletech/issues/issues/566
+---
+apiVersion: kuttl.dev/v1beta1
+kind: TestStep
+commands:
+  - script: kubectl patch namespace $NAMESPACE -p '{"metadata":{"labels":{"pod-security.kubernetes.io/enforce":"privileged"}}}'
+    timeout: 120
+{% endif %}

tests/templates/kuttl/restarter-no-unneeded-restart/01-assert.yaml

@@ -0,0 +1,22 @@
+---
+apiVersion: kuttl.dev/v1beta1
+kind: TestAssert
+timeout: 180
+commands:
+  - script: |
+      kubectl -n $NAMESPACE rollout status sts/early --timeout=5m
+
+      read n1 t1 n2 t2 n3 t3 < <(
+        kubectl -n $NAMESPACE get pod early-{1,2,0} \
+          -o jsonpath='{range .items[*]}{.metadata.name}{" "}{.metadata.creationTimestamp}{" "}{end}'
+      )
+
+      if [[ "$t1" > "$t2" || "$t2" > "$t3" ]]; then
+        echo "ERROR: Pod creation order invalid:"
+        printf "  %s: %s\n  %s: %s\n  %s: %s\n" "$n1" "$t1" "$n2" "$t2" "$n3" "$t3"
+        exit 1
+      fi
+
+      echo "OK: Pod creation order verified:"
+      printf "  %s (%s)\n  %s (%s)\n  %s (%s)\n" "$n1" "$t1" "$n2" "$t2" "$n3" "$t3"
+      echo "  Asserted: $n1 <= $n2 <= $n3"

_TEST.yaml …eded-restart/01-early-before-config.yaml_TEST.yaml renamed to tests/templates/kuttl/restarter-no-unneeded-restart/01-early-before-config.yaml _TEST.yaml renamed to tests/templates/kuttl/restarter-no-unneeded-restart/01-early-before-config.yaml

@@ -1,63 +1,59 @@
----
-apiVersion: v1
-kind: Service
-metadata:
-  name: nginx
-  labels:
-    app: nginx
-spec:
-  ports:
-  - port: 80
-    name: web
-  clusterIP: None
-  selector:
-    app: nginx
----
-apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: web-config
-data:
-  foo: bar
----
-apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: web-config-2
-data:
-  foo: bar
----
+# As the STS is created *before* the ConfigMap, even the mutating webhook can not prevent the first
+# Pod from being restarted.
+
 apiVersion: apps/v1
 kind: StatefulSet
 metadata:
-  name: web
+  name: early
   labels:
     restarter.stackable.tech/enabled: "true"
 spec:
   selector:
     matchLabels:
-      app: nginx
-  serviceName: nginx
+      app: early
+  serviceName: early
   replicas: 3
   template:
     metadata:
       labels:
-        app: nginx
+        app: early
     spec:
       terminationGracePeriodSeconds: 10
       containers:
         - name: nginx
           image: registry.k8s.io/nginx-slim:0.24
-          ports:
-            - containerPort: 80
-              name: web
           volumeMounts:
             - name: config
               mountPath: "/config"
           envFrom:
             - configMapRef:
-                name: web-config-2
+                name: early-config-2
       volumes:
         - name: config
           configMap:
-            name: web-config
+            name: early-config
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: early
+  labels:
+    app: early
+spec:
+  clusterIP: None
+  selector:
+    app: early
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: early-config
+data:
+  foo: bar
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: early-config-2
+data:
+  foo: bar

tests/templates/kuttl/restarter-no-unneeded-restart/02-assert.yaml

@@ -0,0 +1,22 @@
+---
+apiVersion: kuttl.dev/v1beta1
+kind: TestAssert
+timeout: 180
+commands:
+  - script: |
+      kubectl -n $NAMESPACE rollout status sts/late --timeout=5m
+
+      read n0 t0 n1 t1 n2 t2 < <(
+        kubectl -n $NAMESPACE get pod late-{0,1,2} \
+          -o jsonpath='{range .items[*]}{.metadata.name}{" "}{.metadata.creationTimestamp}{" "}{end}'
+      )
+
+      if [[ "$t0" > "$t1" || "$t1" > "$t2" ]]; then
+        echo "ERROR: Pod creation order invalid:"
+        printf "  %s: %s\n  %s: %s\n  %s: %s\n" "$n0" "$t0" "$n1" "$t1" "$n2" "$t2"
+        exit 1
+      fi
+
+      echo "OK: Pod creation order verified:"
+      printf "  %s (%s)\n  %s (%s)\n  %s (%s)\n" "$n0" "$t0" "$n1" "$t1" "$n2" "$t2"
+      echo "  Asserted: $n0 <= $n1 <= $n2"

tests/templates/kuttl/restarter-no-unneeded-restart/02-late-after-config.yaml

@@ -0,0 +1,59 @@
+# Same situation as in 01-late-before-config.yaml, but this time the STS is created *after* the
+# mounted ConfigMaps, so no unneeded Pod restarts occur.
+
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: late-config
+data:
+  foo: bar
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: late-config-2
+data:
+  foo: bar
+---
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: late
+  labels:
+    restarter.stackable.tech/enabled: "true"
+spec:
+  selector:
+    matchLabels:
+      app: late
+  serviceName: late
+  replicas: 3
+  template:
+    metadata:
+      labels:
+        app: late
+    spec:
+      terminationGracePeriodSeconds: 10
+      containers:
+        - name: nginx
+          image: registry.k8s.io/nginx-slim:0.24
+          volumeMounts:
+            - name: config
+              mountPath: "/config"
+          envFrom:
+            - configMapRef:
+                name: late-config-2
+      volumes:
+        - name: config
+          configMap:
+            name: late-config
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: late
+  labels:
+    app: late
+spec:
+  clusterIP: None
+  selector:
+    app: late

tests/templates/kuttl/restarter/10-sleep.yaml

@@ -41,3 +41,4 @@ spec:
           volumeMounts:
             - name: config
               mountPath: /config
+      terminationGracePeriodSeconds: 5

tests/test-definition.yaml

@@ -7,6 +7,9 @@ tests:
   - name: restarter
     dimensions:
       - openshift
+  - name: restarter-no-unneeded-restart
+    dimensions:
+      - openshift
 suites:
   - name: nightly
   - name: openshift