test(restarter): Test annotation restarter.stackable.tech/ignore

Author: siegfriedweber

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

@@ -1,12 +1,12 @@
 ---
 apiVersion: kuttl.dev/v1beta1
 kind: TestAssert
-timeout: 30
+timeout: 120
 ---
 apiVersion: apps/v1
 kind: StatefulSet
 metadata:
-  name: sleep
+  name: test
 status:
   readyReplicas: 1
   replicas: 1

tests/templates/kuttl/restarter/10-create-test-resources.yaml

@@ -0,0 +1,93 @@
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: configmap-not-ignored
+data:
+  revision: "1"
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: secret-not-ignored
+stringData:
+  revision: "1"
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: configmap-ignored
+  annotations:
+    restarter.stackable.tech/ignore: "true"
+data:
+  revision: "1"
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: secret-ignored
+  annotations:
+    restarter.stackable.tech/ignore: "true"
+stringData:
+  revision: "1"
+---
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: test
+  labels:
+    restarter.stackable.tech/enabled: "true"
+spec:
+  selector:
+    matchLabels:
+      app: test
+  serviceName: test
+  replicas: 1
+  template:
+    metadata:
+      labels:
+        app: test
+    spec:
+      serviceAccount: integration-tests-sa
+      volumes:
+        - name: configmap-not-ignored
+          configMap:
+            name: configmap-not-ignored
+        - name: secret-not-ignored
+          secret:
+            secretName: secret-not-ignored
+        - name: configmap-ignored
+          configMap:
+            name: configmap-ignored
+        - name: secret-ignored
+          secret:
+            secretName: secret-ignored
+      containers:
+        - name: test
+          image: alpine
+          command:
+            - sleep
+          args:
+            - infinity
+          volumeMounts:
+            - mountPath: /config/configmap-not-ignored-subpath/revision
+              name: configmap-not-ignored
+              # Use a subPath, so that changes are only visible after a restart.
+              subPath: revision
+            - mountPath: /config/secret-not-ignored-subpath/revision
+              name: secret-not-ignored
+              # Use a subPath, so that changes are only visible after a restart.
+              subPath: revision
+            - mountPath: /config/configmap-ignored
+              name: configmap-ignored
+            - mountPath: /config/secret-ignored
+              name: secret-ignored
+            - mountPath: /config/configmap-ignored-subpath/revision
+              name: configmap-ignored
+              # Use a subPath, so that changes are only visible after a restart.
+              subPath: revision
+            - mountPath: /config/secret-ignored-subpath/revision
+              name: secret-ignored
+              # Use a subPath, so that changes are only visible after a restart.
+              subPath: revision
+      terminationGracePeriodSeconds: 5

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

@@ -3,4 +3,16 @@ apiVersion: kuttl.dev/v1beta1
 kind: TestAssert
 timeout: 180
 commands:
-  - script: test "restarted" = $(kubectl exec sleep-0 -c sleep -n $NAMESPACE -- cat /config/property)
+  - script: |
+      . ../../../../templates/kuttl/restarter/test-script.sh
+
+      # Resources mounted via subPath are not hot-reloaded by Kubernetes.
+      # It is expected, that the restart controller ignored the annotated resources and that only
+      # the resources not mounted via subPath were updated.
+
+      assert_revision 1 configmap-not-ignored-subpath
+      assert_revision 1 secret-not-ignored-subpath
+      assert_revision 1 configmap-ignored-subpath
+      assert_revision 1 secret-ignored-subpath
+      assert_revision 2 configmap-ignored
+      assert_revision 2 secret-ignored

tests/templates/kuttl/restarter/20-assert.yaml

@@ -0,0 +1,14 @@
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: configmap-ignored
+data:
+  revision: "2"
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: secret-ignored
+stringData:
+  revision: "2"

tests/templates/kuttl/restarter/20-hot-reload.yaml

@@ -0,0 +1,16 @@
+---
+apiVersion: kuttl.dev/v1beta1
+kind: TestAssert
+timeout: 180
+commands:
+  - script: |
+      . ../../../../templates/kuttl/restarter/test-script.sh
+
+      # After a restart, all resources should have been updated.
+
+      assert_revision 2 configmap-not-ignored-subpath
+      assert_revision 2 secret-not-ignored-subpath
+      assert_revision 2 configmap-ignored-subpath
+      assert_revision 2 secret-ignored-subpath
+      assert_revision 2 configmap-ignored
+      assert_revision 2 secret-ignored

tests/templates/kuttl/restarter/20-update-cm.yaml

@@ -0,0 +1,14 @@
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: configmap-not-ignored
+data:
+  revision: "2"
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: secret-not-ignored
+stringData:
+  revision: "2"

tests/templates/kuttl/restarter/21-assert.yaml

@@ -0,0 +1,25 @@
+#!/usr/bin/env sh
+
+get_revision () {
+    resource="$1"
+
+    kubectl exec test-0 \
+        --namespace "$NAMESPACE" \
+        --container test -- \
+        cat "/config/$resource/revision"
+}
+
+assert_revision () {
+    expected_value="$1"
+    resource="$2"
+
+    actual_value="$(get_revision "$resource")"
+    if test "$expected_value" = "$actual_value"
+    then
+        echo "[PASS] $resource contains expected value"
+    else
+        echo "[FAIL] $resource does not contain expected value: " \
+             "expected: $expected_value != actual: $actual_value"
+        exit 1
+    fi
+}