feat(cf-common): improve ingress tpl (#33)

Author: mikhail-klimko

charts/cf-common-test/tests/ingress/error_test.yaml

@@ -3,36 +3,6 @@ suite: ingress error handler
 templates:
   - templates/ingress.yaml
 tests:
-  - it: Test no service name specified
-    set:
-      ingress:
-        main:
-          enabled: true
-          hosts:
-            - host: host.domain.local
-              paths:
-                - path: /path
-                  service:
-                    port: 80
-    asserts:
-      - failedTemplate:
-          errorMessage: "service.name is required for ingress main!"
-
-  - it: Test no service port specified
-    set:
-      ingress:
-        main:
-          enabled: true
-          hosts:
-            - host: host.domain.local
-              paths:
-                - path: /path
-                  service:
-                    name: svc-test
-    asserts:
-      - failedTemplate:
-          errorMessage: "service.port is required for ingress main!"
-
   - it: Test tls as invalid type
     values:
       - values.yaml

charts/cf-common-test/tests/ingress/metadata_test.yaml

@@ -22,7 +22,7 @@ tests:
             helm.sh/chart: cf-common-test-0.0.0
       - equal:
           path: metadata.name
-          value: RELEASE-NAME-cf-common-test-main
+          value: RELEASE-NAME-cf-common-test
 
   - it: Test Ingress custom metadata
     values:

charts/cf-common-test/tests/ingress/spec_test.yaml

@@ -14,13 +14,35 @@ tests:
           path: spec.rules[0].http.paths[0].path
           value: /path
 
-  - it: Test service and port
+  - it: Test default (from service) service and port
     values:
       - values.yaml
     asserts:
       - equal:
           path: spec.rules[0].http.paths[0].backend.service.name
-          value: svc-test
+          value: RELEASE-NAME-cf-common-test
+      - equal:
+          path: spec.rules[0].http.paths[0].backend.service.port.number
+          value: 80
+
+  - it: Test override service and port
+    values:
+      - values.yaml
+    set:
+      ingress:
+        main:
+          hosts:
+            - host: host.domain.local
+              paths:
+                - path: /path
+                  pathType: ImplementationSpecific
+                  service:
+                    name: some-other-svc
+                    port: 8080
+    asserts:
+      - equal:
+          path: spec.rules[0].http.paths[0].backend.service.name
+          value: some-other-svc
       - equal:
           path: spec.rules[0].http.paths[0].backend.service.port.number
           value: 8080

charts/cf-common-test/tests/ingress/values.yaml

@@ -11,6 +11,15 @@ ingress:
           - path: /path
             pathType: ImplementationSpecific
             service:
-              name: svc-test
-              port: 8080
+              port: 80
     tls: []
+
+service:
+  main:
+    enabled: false
+    type: ClusterIP
+    ports:
+      http:
+        port: 80
+        protocol: HTTP
+        targetPort: 8080

charts/cf-common/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: v0.0.0
 description: Codefresh library chart
 name: cf-common
-version: 0.4.0
+version: 0.5.0
 type: library
 keywords:
   - codefresh

charts/cf-common/README.md

@@ -2,7 +2,7 @@
 
 Codefresh library chart
 
-![Version: 0.4.0](https://img.shields.io/badge/Version-0.4.0-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.5.0](https://img.shields.io/badge/Version-0.5.0-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.4.0
+  version: 0.5.0
   repository: https://chartmuseum.codefresh.io/cf-common
 ```
 
@@ -117,8 +117,8 @@ dependencies:
 | ingress.main.hosts[0].host | string | `"domain.example.com"` | Host address. Helm template can be passed. |
 | ingress.main.hosts[0].paths[0].path | string | `"/"` | Path. Helm template can be passed. |
 | ingress.main.hosts[0].paths[0].pathType | string | `nil` | Path Type (`Prefix`/`ImplementationSpecific`(default)/`Exact`) |
-| ingress.main.hosts[0].paths[0].service.name | string | `nil` | Set the service name reference for this path. Helm template can be passed. |
-| ingress.main.hosts[0].paths[0].service.port | string | `nil` | Set the service port reference for this path. Helm template can be passed. |
+| ingress.main.hosts[0].paths[0].service.name | string | `nil` | Overrides the service name reference for this path. Helm template can be passed. |
+| ingress.main.hosts[0].paths[0].service.port | string | `nil` | Overrides the service port reference for this path. Helm template can be passed. |
 | ingress.main.ingressClassName | string | `nil` | Set the ingressClass that is used for the ingress. |
 | ingress.main.labels | object | `{}` | Add additional labels for ingress. |
 | ingress.main.tls | list | `[]` | Configure TLS for the ingress. Both secretName and hosts can process a Helm template. |

charts/cf-common/templates/classic/_helpers.tpl

@@ -2,10 +2,10 @@
 Calculate RabbitMQ URI (for On-Prem)
 Must me called from chart root context.
 Usage:
-{{ include "cf-common-0.4.0.classic.calculateRabbitMqUri" . }}
+{{ include "cf-common-0.5.0.classic.calculateRabbitMqUri" . }}
 */}}
 
-{{- define "cf-common-0.4.0.classic.calculateRabbitMqUri" }}
+{{- define "cf-common-0.5.0.classic.calculateRabbitMqUri" }}
 
 {{- $rabbitmqProtocol := .Values.global.rabbitmqProtocol | default "amqp" -}}
 {{- $rabbitmqUsername := .Values.global.rabbitmqUsername -}}
@@ -23,9 +23,9 @@ coalesce here for backward compatibility
 {{/*
 Calculate Mongo Uri (for On-Prem)
 Usage:
-{{ include "cf.common-0.4.0.classic.calculateMongoUri" (dict "dbName" $.Values.global.pipelineManagerService "mongoURI" $.Values.global.mongoURI) }}
+{{ include "cf.common-0.5.0.classic.calculateMongoUri" (dict "dbName" $.Values.global.pipelineManagerService "mongoURI" $.Values.global.mongoURI) }}
 */}}
-{{- define "cf-common-0.4.0.classic.calculateMongoUri" -}}
+{{- define "cf-common-0.5.0.classic.calculateMongoUri" -}}
   {{- if contains "?" .mongoURI -}}
     {{- $mongoURI :=  (splitList "?" .mongoURI) -}}
     {{- printf "%s%s?%s" (first $mongoURI) .dbName (last $mongoURI) }}

charts/cf-common/templates/common/_annotations.tpl

@@ -2,19 +2,19 @@
 Render checksum annotation
 Must be called from chart root context.
 Usage:
-annotations: {{ include "cf-common-0.4.0.annotations.podAnnotations" . | nindent }}
+annotations: {{ include "cf-common-0.5.0.annotations.podAnnotations" . | nindent }}
 */}}
-{{- define "cf-common-0.4.0.annotations.podAnnotations" -}}
+{{- define "cf-common-0.5.0.annotations.podAnnotations" -}}
 
 {{- if .Values.podAnnotations -}}
-  {{- include "cf-common-0.4.0.tplrender" (dict "Values" .Values.podAnnotations "context" $) | nindent 0 }}
+  {{- include "cf-common-0.5.0.tplrender" (dict "Values" .Values.podAnnotations "context" $) | nindent 0 }}
 {{- end -}}
 
 {{- $configMapFound := dict -}}
 {{- range $configMapIndex, $configMapItem := .Values.configMaps -}}
 
   {{- if $configMapItem.enabled -}}
-    {{- $_ := set $configMapFound $configMapIndex ( include "cf-common-0.4.0.tplrender" (dict "Values" $configMapItem.data "context" $) | sha256sum) -}}
+    {{- $_ := set $configMapFound $configMapIndex ( include "cf-common-0.5.0.tplrender" (dict "Values" $configMapItem.data "context" $) | sha256sum) -}}
   {{- end -}}
 
   {{- if $configMapFound -}}
@@ -27,7 +27,7 @@ annotations: {{ include "cf-common-0.4.0.annotations.podAnnotations" . | nindent
 {{- range $secretIndex, $secretItem := .Values.secrets -}}
 
   {{- if $secretItem.enabled -}}
-    {{- $_ := set $secretFound $secretIndex ( include "cf-common-0.4.0.tplrender" (dict "Values" $secretItem.stringData "context" $) | sha256sum) -}}
+    {{- $_ := set $secretFound $secretIndex ( include "cf-common-0.5.0.tplrender" (dict "Values" $secretItem.stringData "context" $) | sha256sum) -}}
   {{- end -}}
 
   {{- if $secretFound -}}

charts/cf-common/templates/common/_labels.tpl

@@ -1,28 +1,28 @@
 {{/*
 Kubernetes standard labels
 */}}
-{{- define "cf-common-0.4.0.labels.standard" -}}
-app.kubernetes.io/name: {{ include "cf-common-0.4.0.names.name" . }}
-helm.sh/chart: {{ include "cf-common-0.4.0.names.chart" . }}
+{{- define "cf-common-0.5.0.labels.standard" -}}
+app.kubernetes.io/name: {{ include "cf-common-0.5.0.names.name" . }}
+helm.sh/chart: {{ include "cf-common-0.5.0.names.chart" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end -}}
 
 {{/*
 Labels to use on deploy.spec.selector.matchLabels and svc.spec.selector
 */}}
-{{- define "cf-common-0.4.0.labels.matchLabels" -}}
-app.kubernetes.io/name: {{ include "cf-common-0.4.0.names.name" . }}
+{{- define "cf-common-0.5.0.labels.matchLabels" -}}
+app.kubernetes.io/name: {{ include "cf-common-0.5.0.names.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end -}}
 
 
 {{/*
 Extra labels
 Usage:
-{{ include "cf-common-0.4.0.labels.extraLabels" ( dict "Values" .Values.path.to.the.labels "context" $) }}
+{{ include "cf-common-0.5.0.labels.extraLabels" ( dict "Values" .Values.path.to.the.labels "context" $) }}
 */}}
-{{- define "cf-common-0.4.0.labels.extraLabels" -}}
+{{- define "cf-common-0.5.0.labels.extraLabels" -}}
   {{- if not (kindIs "map" .Values) -}}
   {{- fail "ERROR: labels block must be a map" -}}
   {{- end -}}
@@ -34,9 +34,9 @@ Usage:
 {{/*
 Annotations
 Usage:
-{{ include "cf-common-0.4.0.annotations" ( dict "Values" .Values.path.to.the.annotations "context" $) }}
+{{ include "cf-common-0.5.0.annotations" ( dict "Values" .Values.path.to.the.annotations "context" $) }}
 */}}
-{{- define "cf-common-0.4.0.annotations" -}}
+{{- define "cf-common-0.5.0.annotations" -}}
   {{- if not (kindIs "map" .Values) -}}
   {{- fail "ERROR: annotations block must be a map" -}}
   {{- end -}}

charts/cf-common/templates/common/_names.tpl

@@ -1,14 +1,14 @@
 {{/*
 Expand the name of the chart.
 */}}
-{{- define "cf-common-0.4.0.names.name" -}}
+{{- define "cf-common-0.5.0.names.name" -}}
 {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
 {{/*
 Create chart name and version as used by the chart label.
 */}}
-{{- define "cf-common-0.4.0.names.chart" -}}
+{{- define "cf-common-0.5.0.names.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
@@ -17,7 +17,7 @@ Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
 If release name contains chart name it will be used as a full name.
 */}}
-{{- define "cf-common-0.4.0.names.fullname" -}}
+{{- define "cf-common-0.5.0.names.fullname" -}}
 {{- if .Values.fullnameOverride -}}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
 {{- else -}}
@@ -33,10 +33,10 @@ If release name contains chart name it will be used as a full name.
 {{/*
 ServiceAccount Name
 */}}
-{{- define "cf-common-0.4.0.names.serviceAccountName" -}}
+{{- define "cf-common-0.5.0.names.serviceAccountName" -}}
   {{- if .Values.serviceAccount -}}
     {{- if .Values.serviceAccount.enabled -}}
-      {{- .Values.serviceAccount.nameOverride | default (include "cf-common-0.4.0.names.fullname" .)  -}}
+      {{- .Values.serviceAccount.nameOverride | default (include "cf-common-0.5.0.names.fullname" .)  -}}
     {{- else -}}
       {{- print "default" -}}
     {{- end -}}