feat: enable https and http liveliness and readyness probes (#15)

* feat: enable https and http liveliness and readyness probes Signed-off-by: Gergely Brautigam <[email protected]> * adding some helm tests and snapshost Signed-off-by: Gergely Brautigam <[email protected]> --------- Signed-off-by: Gergely Brautigam <[email protected]>
external-secrets · Aug 13, 2024 · 3a0f180 · 3a0f180
1 parent 704e397
commit 3a0f180
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 17 deletions.
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -34,7 +34,15 @@ jobs:
             ${{ runner.os }}-go-
       - name: Install musl tools
         run: sudo apt install unzip musl-tools -y
+      - name: Install Helm
+        uses: azure/setup-helm@v4
+      - name: Install chart unittest
+        run: |
+          helm env
+          helm plugin install https://github.com/helm-unittest/helm-unittest
       - name: Run lint
         run: make lint
       - name: Run tests
         run: make test-ci
+      - name: Run helm test
+        run: make helm-test
diff --git a/Makefile b/Makefile
@@ -68,6 +68,12 @@ test-ci: ## Test the project
 prime-test-cluster: mkcert
 	./hack/prime_test_cluster.sh
 
+helm-test:
+	@helm unittest --file tests/*.yaml --file 'tests/**/*.yaml' deploy/charts/bitwarden-sdk-server/
+
+helm-test-update:
+	@helm unittest -u --file tests/*.yaml --file 'tests/**/*.yaml' deploy/charts/bitwarden-sdk-server/
+
 ##@ Docker
 
 IMG ?= ghcr.io/external-secrets/bitwarden-sdk-server

diff --git a/deploy/charts/bitwarden-sdk-server/templates/deployment.yaml b/deploy/charts/bitwarden-sdk-server/templates/deployment.yaml
@@ -43,18 +43,20 @@ spec:
             - name: http
               containerPort: {{ .Values.service.port }}
               protocol: TCP
-          {{- if not .Values.image.tls.enabled }}
           livenessProbe:
             httpGet:
               path: /live
               port: http
+              {{- if .Values.image.tls.enabled }}
               scheme: HTTPS
+              {{- end }}
           readinessProbe:
             httpGet:
               path: /ready
               port: http
+              {{- if .Values.image.tls.enabled }}
               scheme: HTTPS
-          {{- end }}
+              {{- end }}
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
       {{- with .Values.nodeSelector }}

diff --git a/deploy/charts/bitwarden-sdk-server/templates/tests/test-connection.yaml b/deploy/charts/bitwarden-sdk-server/templates/tests/test-connection.yaml
diff --git a/deploy/charts/bitwarden-sdk-server/tests/__snapshot__/deployment_test.yaml.snap b/deploy/charts/bitwarden-sdk-server/tests/__snapshot__/deployment_test.yaml.snap
@@ -0,0 +1,60 @@
+deployment should match snapshot:
+  1: |
+    apiVersion: apps/v1
+    kind: Deployment
+    metadata:
+      labels:
+        app.kubernetes.io/instance: RELEASE-NAME
+        app.kubernetes.io/managed-by: Helm
+        app.kubernetes.io/name: bitwarden-sdk-server
+        app.kubernetes.io/version: 1.16.0
+        helm.sh/chart: bitwarden-sdk-server-0.1.0
+      name: bitwarden-sdk-server
+    spec:
+      replicas: 1
+      selector:
+        matchLabels:
+          app.kubernetes.io/instance: RELEASE-NAME
+          app.kubernetes.io/name: bitwarden-sdk-server
+      template:
+        metadata:
+          labels:
+            app.kubernetes.io/instance: RELEASE-NAME
+            app.kubernetes.io/name: bitwarden-sdk-server
+        spec:
+          containers:
+            - image: ghcr.io/external-secrets/bitwarden-sdk-server:v0.8.0
+              imagePullPolicy: IfNotPresent
+              livenessProbe:
+                httpGet:
+                  path: /live
+                  port: http
+                  scheme: HTTPS
+              name: bitwarden-sdk-server
+              ports:
+                - containerPort: 9998
+                  name: http
+                  protocol: TCP
+              readinessProbe:
+                httpGet:
+                  path: /ready
+                  port: http
+                  scheme: HTTPS
+              resources: {}
+              securityContext: {}
+              volumeMounts:
+                - mountPath: /certs
+                  name: bitwarden-tls-certs
+          securityContext: {}
+          serviceAccountName: bitwarden-sdk-server
+          volumes:
+            - name: bitwarden-tls-certs
+              secret:
+                items:
+                  - key: tls.crt
+                    path: cert.pem
+                  - key: tls.key
+                    path: key.pem
+                  - key: ca.crt
+                    path: ca.pem
+                secretName: bitwarden-tls-certs
diff --git a/deploy/charts/bitwarden-sdk-server/tests/deployment_test.yaml b/deploy/charts/bitwarden-sdk-server/tests/deployment_test.yaml
@@ -0,0 +1,9 @@
+suite: test deployment
+templates:
+  - deployment.yaml
+tests:
+  - it: deployment should match snapshot
+    set:
+      image.tag: v0.8.0
+    asserts:
+      - matchSnapshot: {}