feat(cf-common): add job template (#15)

mikhail-klimko · web-flow · commit 23c0a88f3122 · 2023-03-02T18:18:38.000+03:00
diff --git a/charts/cf-common-test/templates/controller.yaml b/charts/cf-common-test/templates/controller.yaml
@@ -0,0 +1 @@
+{{- include "cf-common.controller" . -}}
diff --git a/charts/cf-common-test/templates/deployment.yaml b/charts/cf-common-test/templates/deployment.yaml
diff --git a/charts/cf-common-test/tests/deployment/classic_conn_uri_test.yaml b/charts/cf-common-test/tests/deployment/classic_conn_uri_test.yaml
@@ -1,7 +1,7 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/quintush/helm-unittest/master/schema/helm-testsuite.json
 suite: classic connection Uri
 templates:
-  - templates/deployment.yaml
+  - templates/controller.yaml
 tests:
   - it: Test External RabbitMQ connection Uri
     values:
@@ -45,4 +45,4 @@ tests:
           path: spec.template.spec.containers[0].env
           content:
             name: RABBIT_URL
-            value: "amqp://user:pass@cf-rabbitmq"
+            value: "amqp://user:pass@cf-rabbitmq"
diff --git a/charts/cf-common-test/tests/deployment/container_test.yaml b/charts/cf-common-test/tests/deployment/container_test.yaml
@@ -1,7 +1,7 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/quintush/helm-unittest/master/schema/helm-testsuite.json
 suite: deployment container spec
 templates:
-  - templates/deployment.yaml
+  - templates/controller.yaml
 values:
   - values.yaml
 tests:
diff --git a/charts/cf-common-test/tests/deployment/error_test.yaml b/charts/cf-common-test/tests/deployment/error_test.yaml
@@ -1,7 +1,7 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/quintush/helm-unittest/master/schema/helm-testsuite.json
 suite: deployment error handlers
 templates:
-  - templates/deployment.yaml
+  - templates/controller.yaml
 tests:
   - it: Test invalid controller type
     values:
diff --git a/charts/cf-common-test/tests/deployment/metadata_test.yaml b/charts/cf-common-test/tests/deployment/metadata_test.yaml
@@ -1,7 +1,7 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/quintush/helm-unittest/master/schema/helm-testsuite.json
 suite: deployment metadata
 templates:
-  - templates/deployment.yaml
+  - templates/controller.yaml
 tests:
   - it: Test deployment default metadata
     values:
diff --git a/charts/cf-common-test/tests/deployment/spec_test.yaml b/charts/cf-common-test/tests/deployment/spec_test.yaml
@@ -1,7 +1,7 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/quintush/helm-unittest/master/schema/helm-testsuite.json
 suite: deployment spec
 templates:
-  - templates/deployment.yaml
+  - templates/controller.yaml
 values:
   - values.yaml
 tests:
diff --git a/charts/cf-common-test/tests/deployment/volumes_test.yaml b/charts/cf-common-test/tests/deployment/volumes_test.yaml
@@ -1,7 +1,7 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/quintush/helm-unittest/master/schema/helm-testsuite.json
 suite: depoyment volumes test
 templates:
-  - templates/deployment.yaml
+  - templates/controller.yaml
 values:
   - values.yaml
 tests:
diff --git a/charts/cf-common-test/tests/job/error_test.yaml b/charts/cf-common-test/tests/job/error_test.yaml
@@ -0,0 +1,22 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/quintush/helm-unittest/master/schema/helm-testsuite.json
+suite: job error handlers
+templates:
+  - templates/controller.yaml
+tests:
+  - it: Test no .spec.selector
+    values:
+      - values.yaml
+    asserts:
+      - isNull:
+          path: spec.selector
+
+  - it: Test no selector specified when manualSelector set to true
+    set:
+      controller:
+        job:
+          manualSelector: true
+    values:
+      - values.yaml
+    asserts:
+      - failedTemplate:
+          errorMessage: "manualSelector is enabled! Specify `.job.selector` labels!"
diff --git a/charts/cf-common-test/tests/job/metadata_test.yaml b/charts/cf-common-test/tests/job/metadata_test.yaml
@@ -0,0 +1,68 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/quintush/helm-unittest/master/schema/helm-testsuite.json
+suite: job metadata
+templates:
+  - templates/controller.yaml
+tests:
+  - it: Test job default metadata
+    values:
+      - values.yaml
+    asserts:
+      - hasDocuments:
+          count: 1
+      - isKind:
+          of: Job
+      - isNull:
+          path: metadata.annotations
+      - equal:
+          path: metadata.labels
+          value:
+            app.kubernetes.io/instance: RELEASE-NAME
+            app.kubernetes.io/managed-by: Helm
+            app.kubernetes.io/name: cf-common-test
+            helm.sh/chart: cf-common-test-0.0.0
+      - equal:
+          path: metadata.name
+          value: RELEASE-NAME-cf-common-test
+
+  - it: Test deployment custom metadata
+    values:
+      - values.yaml
+    set:
+      controller:
+        labels:
+          alice: bob
+        annotations:
+          foo: bar
+    asserts:
+      - hasDocuments:
+          count: 1
+      - isKind:
+          of: Job
+      - equal:
+          path: metadata.annotations
+          value:
+            foo: bar
+      - equal:
+          path: metadata.labels
+          value:
+            app.kubernetes.io/instance: RELEASE-NAME
+            app.kubernetes.io/managed-by: Helm
+            app.kubernetes.io/name: cf-common-test
+            helm.sh/chart: cf-common-test-0.0.0
+            alice: bob
+
+  - it: Test pod labels and annotations
+    values:
+      - values.yaml
+    set:
+      podLabels:
+        alice: bob
+      podAnnotations:
+        foo: bar
+    asserts:
+      - equal:
+          path: spec.template.metadata.labels.alice
+          value: bob
+      - equal:
+          path: spec.template.metadata.annotations.foo
+          value: bar
diff --git a/charts/cf-common-test/tests/job/spec_test.yaml b/charts/cf-common-test/tests/job/spec_test.yaml
@@ -0,0 +1,69 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/quintush/helm-unittest/master/schema/helm-testsuite.json
+suite: job spec
+templates:
+  - templates/controller.yaml
+values:
+  - values.yaml
+tests:
+  - it: Test job activeDeadlineSeconds
+    asserts:
+      - equal:
+          path: spec.activeDeadlineSeconds
+          value: 100
+
+  - it: Test job backoffLimit
+    asserts:
+      - equal:
+          path: spec.backoffLimit
+          value: 5
+
+  - it: Test job ttlSecondsAfterFinished
+    asserts:
+      - equal:
+          path: spec.ttlSecondsAfterFinished
+          value: 300
+
+  - it: Test job pod restartPolicy
+    asserts:
+      - equal:
+          path: spec.template.spec.restartPolicy
+          value: OnFailure
+
+  - it: Test job parallelism
+    asserts:
+      - equal:
+          path: spec.parallelism
+          value: 3
+
+  - it: Test job completions
+    asserts:
+      - equal:
+          path: spec.completions
+          value: 12
+
+  - it: Test job suspend
+    set:
+      controller:
+        job:
+          suspend: true
+    asserts:
+      - equal:
+          path: spec.suspend
+          value: true
+
+  - it: Test job with manual selector
+    set:
+      controller:
+        job:
+          manualSelector: true
+          selector:
+            controller-uid: a8f3d00d-c6d2-11e5-9f87-42010af00002
+    asserts:
+      - equal:
+          path: spec.manualSelector
+          value: true
+      - equal:
+          path: spec.selector
+          value:
+            matchLabels:
+              controller-uid: a8f3d00d-c6d2-11e5-9f87-42010af00002
diff --git a/charts/cf-common-test/tests/job/values.yaml b/charts/cf-common-test/tests/job/values.yaml
@@ -0,0 +1,34 @@
+# mock values for tests
+controller:
+  enabled: true
+  type: job
+  labels: {}
+  annotations: {}
+  job:
+    activeDeadlineSeconds: 100
+    backoffLimit: 5
+    completions: 12
+    parallelism: 3
+    ttlSecondsAfterFinished: 300
+  restartPolicy: OnFailure
+
+container:
+  image:
+    registry: docker.io
+    repository: bitnami/kubectl
+    tag: latest
+    pullPolicy: Always
+
+  command:
+    - "/bin/sh"
+  args:
+    - "-c"
+    - "sleep 10"
+
+  resources:
+    limits:
+      cpu: 100m
+      memory: 128Mi
+    requests:
+      cpu: 100m
+      memory: 128Mi
diff --git a/charts/cf-common-test/tests/rbac/metadata_test.yaml b/charts/cf-common-test/tests/rbac/metadata_test.yaml
@@ -2,7 +2,7 @@
 suite: rbac metadata
 templates:
   - templates/rbac.yaml
-  - templates/deployment.yaml
+  - templates/controller.yaml
 tests:
   - it: Test SA default metadata
     template: rbac.yaml
diff --git a/charts/cf-common-test/tests/rbac/spec_test.yaml b/charts/cf-common-test/tests/rbac/spec_test.yaml
@@ -2,7 +2,7 @@
 suite: rbac spec
 templates:
   - templates/rbac.yaml
-  - templates/deployment.yaml
+  - templates/controller.yaml
 tests:
   - it: Test SA name in deployment
     template: templates/rbac.yaml
@@ -15,7 +15,7 @@ tests:
       - equal:
           path: spec.template.spec.serviceAccountName
           value: RELEASE-NAME-cf-common-test
-        template: templates/deployment.yaml
+        template: templates/controller.yaml
 
   - it: Test SA secret
     template: templates/rbac.yaml
@@ -112,7 +112,7 @@ tests:
       - equal:
           path: spec.template.spec.serviceAccountName
           value: alice
-        template: templates/deployment.yaml
+        template: templates/controller.yaml
 
   - it: Test Deployment should use a default SA if rbac is disabled
     template: templates/rbac.yaml
@@ -125,4 +125,4 @@ tests:
       - equal:
           path: spec.template.spec.serviceAccountName
           value: default
-        template: templates/deployment.yaml
+        template: templates/controller.yaml
diff --git a/charts/cf-common-test/tests/service/spec_test.yaml b/charts/cf-common-test/tests/service/spec_test.yaml
@@ -2,7 +2,7 @@
 suite: service metadata
 templates:
   - templates/service.yaml
-  - templates/deployment.yaml
+  - templates/controller.yaml
 values:
   - values.yaml
 tests:
@@ -129,7 +129,7 @@ tests:
           value: ClusterIP
 
   - it: Test ports list in deployment
-    template: templates/deployment.yaml
+    template: templates/controller.yaml
     values:
       - values.yaml
     set:
diff --git a/charts/cf-common/Chart.yaml b/charts/cf-common/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: v0.0.0
 description: Codefresh library chart
 name: cf-common
-version: 0.0.14
+version: 0.0.15
 type: library
 keywords:
   - codefresh
diff --git a/charts/cf-common/README.md b/charts/cf-common/README.md
@@ -2,7 +2,7 @@
 
 Codefresh library chart
 
-![Version: 0.0.14](https://img.shields.io/badge/Version-0.0.14-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
+![Version: 0.0.15](https://img.shields.io/badge/Version-0.0.15-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
 
 ## Installing the Chart
 
@@ -18,7 +18,7 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
 # Chart.yaml
 dependencies:
 - name: cf-common
-  version: 0.0.14
+  version: 0.0.15
   repository: https://chartmuseum.codefresh.io/cf-common
 ```
 
@@ -66,10 +66,27 @@ dependencies:
 | controller.deployment.rollingUpdate.maxSurge | string | `nil` | Set RollingUpdate max surge (absolute number or percentage) |
 | controller.deployment.rollingUpdate.maxUnavailable | string | `nil` | Set RollingUpdate max unavailable (absolute number or percentage) |
 | controller.deployment.strategy | string | `nil` | Set deployment upgrade strategy (`RollingUpdate`/`Recreate`) |
+| controller.job.activeDeadlineSeconds | string | `nil` | Set the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. (int) |
+| controller.job.backoffLimit | string | `nil` | Set the number of retries before marking this job failed. Defaults to 6. (int) |
+| controller.job.completions | string | `nil` | Set the desired number of successfully finished pods the job should be run with. (int) |
+| controller.job.manualSelector | string | `nil` | Controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. (boolean) Ref: https://kubernetes.io/docs/concepts/workloads/controllers/job/#specifying-your-own-pod-selector |
+| controller.job.parallelism | string | `nil` | Set the maximum desired number of pods the job should run at any given time. (int) |
+| controller.job.selector | string | `nil` | A label query over pods that should match the pod count. Normally, the system sets this field for you. Ref: https://kubernetes.io/docs/concepts/workloads/controllers/job/#specifying-your-own-pod-selector |
+| controller.job.suspend | string | `nil` | Suspend specifies whether the Job controller should create Pods or not. (boolean) |
+| controller.job.ttlSecondsAfterFinished | string | `nil` | Set the limit on the lifetime of a Job that has finished execution (either Complete or Failed). (int) |
 | controller.labels | object | `{}` | Set labels on controller |
 | controller.replicas | string | `nil` | Set number of pods |
 | controller.revisionHistoryLimit | string | `nil` | Set ReplicaSet revision history limit |
-| controller.type | string | `""` | Define the controller type (`deployment` \ `rollout`) |
+| controller.rollout.analysis.successfulRunHistoryLimit | string | `nil` | Limits the number of successful analysis runs and experiments to be stored in a history |
+| controller.rollout.analysis.unsuccessfulRunHistoryLimit | string | `nil` | Limits the number of unsuccessful analysis runs and experiments to be stored in a history. ( Stages for unsuccessful: "Error", "Failed", "Inconclusive" ) |
+| controller.rollout.canary | object | `{"maxSurge":null,"maxUnavailable":null,"steps":[{"setWeight":null},{"pause":{"duration":null}},{"setWeight":null},{"pause":{"duration":null}}]}` | Canary update strategy parameters |
+| controller.rollout.canary.maxSurge | string | `nil` | The maximum number of pods that can be scheduled above the original number of pods. Value can be an absolute number / percentage |
+| controller.rollout.canary.maxUnavailable | string | `nil` | The maximum number of pods that can be unavailable during the update. Value can be an absolute number / percentage |
+| controller.rollout.canary.steps | list | `[{"setWeight":null},{"pause":{"duration":null}},{"setWeight":null},{"pause":{"duration":null}}]` | Steps define sequence of steps to take during an update of the canary. |
+| controller.rollout.canary.steps[0] | object | `{"setWeight":null}` | Sets the ratio of canary ReplicaSet in percentage. |
+| controller.rollout.canary.steps[1] | object | `{"pause":{"duration":null}}` | Pauses the rollout for configured duration of time. Supported units: s, m, h. when setting `duration: {}` it will pauses indefinitely until manually resumed |
+| controller.rollout.strategy | string | `nil` | Rollout update strategy - can be Canary or BlueGreen. |
+| controller.type | string | `""` | Define the controller type (`deployment`/`rollout`/`job`) |
 | extraResources | list | `[]` | Array of extra objects to deploy with the release |
 | global | object | `{"controller":{"deployment":{"rollingUpdate":{"maxSurge":null,"maxUnavailable":null},"strategy":null},"rollout":{"analysis":{"successfulRunHistoryLimit":null,"unsuccessfulRunHistoryLimit":null},"canary":{"maxSurge":null,"maxUnavailable":null,"steps":[{"setWeight":null},{"pause":{"duration":null}},{"setWeight":null},{"pause":{"duration":null}}]},"strategy":null},"type":""},"env":{},"imagePullSecrets":[],"imageRegistry":""}` | Global parameters |
 | global.controller.deployment.rollingUpdate.maxSurge | string | `nil` | Set RollingUpdate max surge (absolute number or percentage) |
diff --git a/charts/cf-common/templates/common/_names.tpl b/charts/cf-common/templates/common/_names.tpl
@@ -34,8 +34,12 @@ If release name contains chart name it will be used as a full name.
 ServiceAccount Name
 */}}
 {{- define "cf-common.names.serviceAccountName" -}}
-  {{- if .Values.serviceAccount.enabled -}}
-    {{- .Values.serviceAccount.nameOverride | default (include "cf-common.names.fullname" .)  -}}
+  {{- if .Values.serviceAccount -}}
+    {{- if .Values.serviceAccount.enabled -}}
+      {{- .Values.serviceAccount.nameOverride | default (include "cf-common.names.fullname" .)  -}}
+    {{- else -}}
+      {{- print "default" -}}
+    {{- end -}}
   {{- else -}}
     {{- print "default" -}}
   {{- end -}}
diff --git a/charts/cf-common/templates/container/_container.tpl b/charts/cf-common/templates/container/_container.tpl
diff --git a/charts/cf-common/templates/controller/_controller.tpl b/charts/cf-common/templates/controller/_controller.tpl
diff --git a/charts/cf-common/templates/controller/_job.tpl b/charts/cf-common/templates/controller/_job.tpl
diff --git a/charts/cf-common/values.yaml b/charts/cf-common/values.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{{- include "cf-common.controller" . -}}`