Add Job, CronJob (#12)

* added Job * added CronJob
rantanevich · Mar 22, 2023 · 2f5d92d · 2f5d92d
1 parent e448b7d
commit 2f5d92d
Show file tree

Hide file tree

Showing 11 changed files with 212 additions and 1 deletion.
diff --git a/charts/universal/Chart.yaml b/charts/universal/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: universal
-version: 0.5.0
+version: 0.6.0
 description: A universal Helm chart for deploying services to Kubernetes
 maintainers:
 - name: rantanevich

diff --git a/charts/universal/ci/cronjob-values.yaml b/charts/universal/ci/cronjob-values.yaml
@@ -0,0 +1,14 @@
+image:
+  repository: busybox
+  tag: 1.35.0
+
+cronJobs:
+  cleaner:
+    schedule: 10 * * * *
+    backoffLimit: 1
+    restartPolicy: Never
+    containers:
+      cleaner:
+        command: ["echo", "bundle", "exec", "rails", "runner", "'InboxItems::Cleaner.call'"]
+        env:
+          LOGGING_LEVEL_ROOT: debug
diff --git a/charts/universal/ci/job-values.yaml b/charts/universal/ci/job-values.yaml
@@ -0,0 +1,11 @@
+image:
+  repository: busybox
+  tag: 1.35.0
+
+jobs:
+  migration:
+    backoffLimit: 1
+    restartPolicy: Never
+    containers:
+      migration:
+        command: ["echo", "bundle", "exec", "rake", "db:migrate"]
diff --git a/charts/universal/templates/cronjob.yaml b/charts/universal/templates/cronjob.yaml
@@ -0,0 +1,24 @@
+{{- range $name, $_ := $.Values.cronJobs }}
+---
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: {{ include "helpers.app.name" $ }}-{{ $name }}
+  namespace: {{ $.Release.Namespace }}
+  labels:
+    {{- include "helpers.app.labels" $ | nindent 4 }}
+  {{- with .annotations }}
+  annotations:
+    {{- include "helpers.render" (dict "value" . "context" $) | nindent 4 }}
+  {{- end }}
+spec:
+  {{- range $fname, $fvalue := . }}
+  {{- if has $fname (list "concurrencyPolicy" "failedJobsHistoryLimit" "startingDeadlineSeconds" "successfulJobsHistoryLimit" "timeZone") }}
+  {{ $fname }}: {{ $fvalue }}
+  {{- end }}
+  {{- end }}
+  schedule: {{ .schedule }}
+  jobTemplate:
+    spec:
+      {{- include "helpers.job" (dict "component" $name "value" . "context" $) | nindent 6 }}
+{{- end }}
diff --git a/charts/universal/templates/helpers/_job.tpl b/charts/universal/templates/helpers/_job.tpl
@@ -0,0 +1,13 @@
+{{- define "helpers.job" }}
+{{- $ := .context }}
+{{- $val := .value }}
+{{- $component := .component }}
+{{- range $fname, $fvalue := $val }}
+{{- if has $fname (list "activeDeadlineSeconds" "backoffLimit" "completionMode" "completions" "parallelism" "ttlSecondsAfterFinished") }}
+{{ $fname }}: {{ $fvalue }}
+{{- end }}
+{{- end }}
+template:
+  spec:
+    {{- include "helpers.pod" (dict "component" $component "value" $val "context" $) | nindent 4 }}
+{{- end }}
diff --git a/charts/universal/templates/job.yaml b/charts/universal/templates/job.yaml
@@ -0,0 +1,16 @@
+{{- range $name, $_ := $.Values.jobs }}
+---
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: {{ include "helpers.app.name" $ }}-{{ $name }}
+  namespace: {{ $.Release.Namespace }}
+  labels:
+    {{- include "helpers.app.labels" $ | nindent 4 }}
+  {{- with .annotations }}
+  annotations:
+    {{- include "helpers.render" (dict "value" . "context" $) | nindent 4 }}
+  {{- end }}
+spec:
+  {{- include "helpers.job" (dict "component" $name "value" . "context" $) | nindent 2 }}
+{{- end }}
diff --git a/charts/universal/tests/cronjob_test.yaml b/charts/universal/tests/cronjob_test.yaml
@@ -0,0 +1,56 @@
+suite: test cronjob
+templates:
+- cronjob.yaml
+release:
+  name: example
+  namespace: &namespace sandbox
+tests:
+- it: common
+  values: &values
+  - values/cronjob.yaml
+  asserts:
+  - hasDocuments:
+      count: 1
+- it: cleaner
+  values: *values
+  asserts:
+  - containsDocument:
+      apiVersion: batch/v1
+      kind: CronJob
+      name: example-cleaner
+      namespace: *namespace
+  - equal:
+      path: spec.schedule
+      value: 10 * * * *
+  - equal:
+      path: spec.jobTemplate.spec.backoffLimit
+      value: 3
+  - equal:
+      path: spec.jobTemplate.spec.template.spec.restartPolicy
+      value: Never
+  - equal:
+      path: spec.jobTemplate.spec.template.spec.containers[0].name
+      value: cleaner
+  - equal:
+      path: spec.jobTemplate.spec.template.spec.containers[0].command
+      value: ["bundle", "exec", "rails", "runner", "InboxItemsCleaner.perform"]
+  - equal:
+      path: spec.jobTemplate.spec.template.spec.containers[0].env
+      value:
+      - name: LOGGING_LEVEL_ROOT
+        value: debug
+      - name: DB_NAME
+        valueFrom:
+          secretKeyRef:
+            name: example-mysql
+            key: database
+      - name: DB_PASSWORD
+        valueFrom:
+          secretKeyRef:
+            name: example-mysql
+            key: password
+      - name: DB_USERNAME
+        valueFrom:
+          secretKeyRef:
+            name: example-mysql
+            key: username
diff --git a/charts/universal/tests/job_test.yaml b/charts/universal/tests/job_test.yaml
@@ -0,0 +1,41 @@
+suite: test job
+templates:
+- job.yaml
+release:
+  name: example
+  namespace: &namespace sandbox
+tests:
+- it: common
+  values: &values
+  - values/job.yaml
+  asserts:
+  - hasDocuments:
+      count: 1
+- it: migration
+  values: *values
+  asserts:
+  - containsDocument:
+      apiVersion: batch/v1
+      kind: Job
+      name: example-migration
+      namespace: *namespace
+  - equal:
+      path: metadata.annotations
+      value:
+        helm.sh/hook: pre-install,pre-upgrade
+        helm.sh/hook-delete-policy: before-hook-creation,hook-succeeded
+  - equal:
+      path: spec.backoffLimit
+      value: 1
+  - equal:
+      path: spec.template.spec.restartPolicy
+      value: Never
+  - equal:
+      path: spec.template.spec.containers[0].name
+      value: migration
+  - equal:
+      path: spec.template.spec.containers[0].image
+      value: busybox:1.35.0
+  - equal:
+      path: spec.template.spec.containers[0].command
+      value: ["bundle", "exec", "rake", "db:migrate"]
diff --git a/charts/universal/tests/values/cronjob.yaml b/charts/universal/tests/values/cronjob.yaml
@@ -0,0 +1,19 @@
+image:
+  repository: busybox
+  tag: 1.35.0
+
+cronJobs:
+  cleaner:
+    schedule: "10 * * * *"
+    backoffLimit: 3
+    restartPolicy: Never
+    containers:
+      cleaner:
+        command: ["bundle", "exec", "rails", "runner", "InboxItemsCleaner.perform"]
+        env:
+          LOGGING_LEVEL_ROOT: debug
+        envFromSecret:
+          example-mysql:
+            DB_NAME: database
+            DB_USERNAME: username
+            DB_PASSWORD: password
diff --git a/charts/universal/tests/values/job.yaml b/charts/universal/tests/values/job.yaml
@@ -0,0 +1,14 @@
+image:
+  repository: busybox
+  tag: 1.35.0
+
+jobs:
+  migration:
+    annotations:
+      helm.sh/hook: pre-install,pre-upgrade
+      helm.sh/hook-delete-policy: before-hook-creation,hook-succeeded
+    backoffLimit: 1
+    restartPolicy: Never
+    containers:
+      migration:
+        command: ["bundle", "exec", "rake", "db:migrate"]
diff --git a/charts/universal/values.yaml b/charts/universal/values.yaml
@@ -18,6 +18,9 @@ ingresses: {}
 
 pdbs: {}
 
+jobs: {}
+cronJobs: {}
+
 rbac:
   serviceAccounts: {}
   roles: {}