feat(cf-common): adding helper to calculate classic mongoUri conn string (#25)

Author: mikhail-klimko

charts/cf-common-test/tests/deployment/classic_conn_uri_test.yaml

@@ -46,3 +46,20 @@ tests:
           content:
             name: RABBIT_URL
             value: "amqp://user:pass@cf-rabbitmq"
+
+  - it: Test External MongoDB connection Uri
+    values:
+      - values.yaml
+    set:
+      global:
+        mongoURI: mongodb+srv://username:[email protected]:27017/?tls=true&tlsInsecure=true
+        pipelineManagerService: pipeline-manager
+      container:
+        env:
+          MONGO_URI: '{{ include (printf "cf-common-%s.classic.calculateMongoUri" (index .Subcharts "cf-common").Chart.Version) (dict "dbName" $.Values.global.pipelineManagerService "mongoURI" $.Values.global.mongoURI) }}'
+    asserts:
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: MONGO_URI
+            value: "mongodb+srv://username:[email protected]:27017/pipeline-manager?tls=true&tlsInsecure=true"

charts/cf-common/Chart.yaml

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

charts/cf-common/README.md

@@ -2,7 +2,7 @@
 
 Codefresh library chart
 
-![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.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.1.1](https://img.shields.io/badge/Version-0.1.1-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.1.0
+  version: 0.1.1
   repository: https://chartmuseum.codefresh.io/cf-common
 ```
 

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

@@ -1,20 +1,20 @@
 {{/*
-Calculate RabbitMQ URI
+Calculate RabbitMQ URI (for On-Prem)
 Usage
-{{ include "cf-common-0.1.0.classic.calculateRabbitMqUri" . }}
+{{ include "cf-common-0.1.1.classic.calculateRabbitMqUri" . }}
 */}}
 
-{{- define "cf-common-0.1.0.classic.calculateRabbitMqUri" }}
+{{- define "cf-common-0.1.1.classic.calculateRabbitMqUri" }}
 
-{{- $rabbitmqProtocol := $.Values.global.rabbitmqProtocol | default "amqp" -}}
+{{- $rabbitmqProtocol := .Values.global.rabbitmqProtocol | default "amqp" -}}
 {{- $rabbitmqUsername := .Values.global.rabbitmqUsername -}}
 {{- $rabbitmqPassword := .Values.global.rabbitmqPassword -}}
 
 {{- /*
 If built-in bitnami/rabbitmq chart enabled get username/password there
 */}}
-{{- if $.Values.rabbitmq }}
-  {{- if $.Values.rabbitmq.enabled }}
+{{- if .Values.rabbitmq }}
+  {{- if .Values.rabbitmq.enabled }}
     {{- $rabbitmqUsername = .Values.rabbitmq.auth.username -}}
     {{- $rabbitmqPassword = .Values.rabbitmq.auth.password -}}
   {{- end }}
@@ -28,3 +28,17 @@ coalesce here for backward compatibility
 {{- printf "%s://%s:%s@%s" $rabbitmqProtocol $rabbitmqUsername $rabbitmqPassword $rabbitmqHostname -}}
 
 {{- end }}
+
+{{/*
+Calculate Mongo Uri (for On-Prem)
+Usage:
+{{ include "cf.common-0.1.1.classic.calculateMongoUri" (dict "dbName" $.Values.global.pipelineManagerService "mongoURI" $.Values.global.mongoURI) }}
+*/}}
+{{- define "cf-common-0.1.1.classic.calculateMongoUri" -}}
+  {{- if contains "?" .mongoURI -}}
+    {{- $mongoURI :=  (splitList "?" .mongoURI) -}}
+    {{- printf "%s%s?%s" (first $mongoURI) .dbName (last $mongoURI) }}
+  {{- else -}}
+    {{- printf "%s/%s" .mongoURI .dbName -}}
+  {{- end -}}
+{{- end -}}

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

@@ -2,17 +2,17 @@
 Render checksum annotation
 Usage:
 */}}
-{{- define "cf-common-0.1.0.annotations.podAnnotations" -}}
+{{- define "cf-common-0.1.1.annotations.podAnnotations" -}}
 
 {{- if .Values.podAnnotations -}}
-  {{- include "cf-common-0.1.0.tplrender" (dict "Values" .Values.podAnnotations "context" $) | nindent 0 }}
+  {{- include "cf-common-0.1.1.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.1.0.tplrender" (dict "Values" $configMapItem.data "context" $) | sha256sum) -}}
+    {{- $_ := set $configMapFound $configMapIndex ( include "cf-common-0.1.1.tplrender" (dict "Values" $configMapItem.data "context" $) | sha256sum) -}}
   {{- end -}}
 
   {{- if $configMapFound -}}
@@ -25,7 +25,7 @@ Usage:
 {{- range $secretIndex, $secretItem := .Values.secrets -}}
 
   {{- if $secretItem.enabled -}}
-    {{- $_ := set $secretFound $secretIndex ( include "cf-common-0.1.0.tplrender" (dict "Values" $secretItem.stringData "context" $) | sha256sum) -}}
+    {{- $_ := set $secretFound $secretIndex ( include "cf-common-0.1.1.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.1.0.labels.standard" -}}
-app.kubernetes.io/name: {{ include "cf-common-0.1.0.names.name" . }}
-helm.sh/chart: {{ include "cf-common-0.1.0.names.chart" . }}
+{{- define "cf-common-0.1.1.labels.standard" -}}
+app.kubernetes.io/name: {{ include "cf-common-0.1.1.names.name" . }}
+helm.sh/chart: {{ include "cf-common-0.1.1.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.1.0.labels.matchLabels" -}}
-app.kubernetes.io/name: {{ include "cf-common-0.1.0.names.name" . }}
+{{- define "cf-common-0.1.1.labels.matchLabels" -}}
+app.kubernetes.io/name: {{ include "cf-common-0.1.1.names.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end -}}
 
 
 {{/*
 Extra labels
 Usage:
-{{ include "cf-common-0.1.0.labels.extraLabels" ( dict "Values" .Values.path.to.the.labels "context" $) }}
+{{ include "cf-common-0.1.1.labels.extraLabels" ( dict "Values" .Values.path.to.the.labels "context" $) }}
 */}}
-{{- define "cf-common-0.1.0.labels.extraLabels" -}}
+{{- define "cf-common-0.1.1.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.1.0.annotations" ( dict "Values" .Values.path.to.the.annotations "context" $) }}
+{{ include "cf-common-0.1.1.annotations" ( dict "Values" .Values.path.to.the.annotations "context" $) }}
 */}}
-{{- define "cf-common-0.1.0.annotations" -}}
+{{- define "cf-common-0.1.1.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.1.0.names.name" -}}
+{{- define "cf-common-0.1.1.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.1.0.names.chart" -}}
+{{- define "cf-common-0.1.1.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.1.0.names.fullname" -}}
+{{- define "cf-common-0.1.1.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.1.0.names.serviceAccountName" -}}
+{{- define "cf-common-0.1.1.names.serviceAccountName" -}}
   {{- if .Values.serviceAccount -}}
     {{- if .Values.serviceAccount.enabled -}}
-      {{- .Values.serviceAccount.nameOverride | default (include "cf-common-0.1.0.names.fullname" .)  -}}
+      {{- .Values.serviceAccount.nameOverride | default (include "cf-common-0.1.1.names.fullname" .)  -}}
     {{- else -}}
       {{- print "default" -}}
     {{- end -}}

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

@@ -1,9 +1,9 @@
 {{/*
 Renders a value that contains template.
 Usage:
-{{ include "cf-common-0.1.0.tplrender" ( dict "Values" .Values.path.to.the.Value "context" $) }}
+{{ include "cf-common-0.1.1.tplrender" ( dict "Values" .Values.path.to.the.Value "context" $) }}
 */}}
-{{- define "cf-common-0.1.0.tplrender" -}}
+{{- define "cf-common-0.1.1.tplrender" -}}
   {{- $tpl := .Values -}}
   {{- if not (typeIs "string" $tpl) -}}
     {{- $tpl = toYaml $tpl -}}

charts/cf-common/templates/container/_container.tpl

@@ -1,22 +1,22 @@
 {{/*
 Renders main container in pod template
 Usage:
-{{ include "cf-common-0.1.0.container" (dict "Values" .Values.container "context" $) }}
+{{ include "cf-common-0.1.1.container" (dict "Values" .Values.container "context" $) }}
 */}}
-{{-  define "cf-common-0.1.0.container" -}}
+{{-  define "cf-common-0.1.1.container" -}}
 
 {{/* Restoring root $ context */}}
 {{- $ := .context -}}
 
-- name: {{ include "cf-common-0.1.0.names.fullname" $ }}
-  image: {{ include "cf-common-0.1.0.image.name" (dict "image" .Values.image "context" $) }}
+- name: {{ include "cf-common-0.1.1.names.fullname" $ }}
+  image: {{ include "cf-common-0.1.1.image.name" (dict "image" .Values.image "context" $) }}
   imagePullPolicy: {{ .Values.image.pullPolicy | default "Always" }}
 
   {{- with .Values.command }}
     {{- if not (kindIs "slice" .) }}
       {{- fail "ERROR: container.command block must be a list!" }}
     {{- end }}
-  command: {{- include "cf-common-0.1.0.tplrender" (dict "Values" . "context" $) | nindent 2 }}
+  command: {{- include "cf-common-0.1.1.tplrender" (dict "Values" . "context" $) | nindent 2 }}
   {{- end }}
 
   {{- with .Values.args }}
@@ -46,11 +46,11 @@ Usage:
       {{- if not (kindIs "slice" .) }}
         {{ fail "ERROR: container.envFrom block must be a list!"}}
       {{- end }}
-      {{- include "cf-common-0.1.0.tplrender" (dict "Values" . "context" $) | trim | nindent 4 }}
+      {{- include "cf-common-0.1.1.tplrender" (dict "Values" . "context" $) | trim | nindent 4 }}
     {{- end }}
     {{- range $secretName, $_ := $.Values.secrets }}
     - secretRef:
-        name: {{ printf "%s-%s" (include "cf-common-0.1.0.names.fullname" $) $secretName }}
+        name: {{ printf "%s-%s" (include "cf-common-0.1.1.names.fullname" $) $secretName }}
     {{- end }}
   {{- end }}
 
@@ -66,18 +66,18 @@ For backward compatibility (.Values.env takes precedence over .Values.container.
   {{- $mergedEnv = merge $mergedEnv $.Values.global.env }}
     {{- end }}
   env:
-  {{- include "cf-common-0.1.0.env-vars" (dict "Values" $mergedEnv "context" $) | trim | nindent 2 }}
+  {{- include "cf-common-0.1.1.env-vars" (dict "Values" $mergedEnv "context" $) | trim | nindent 2 }}
   {{- end }}
 
-  ports: {{- include "cf-common-0.1.0.ports" $ | trim | nindent 2 }}
+  ports: {{- include "cf-common-0.1.1.ports" $ | trim | nindent 2 }}
 
   {{- with .Values.volumeMounts }}
   volumeMounts:
-  {{- include "cf-common-0.1.0.volumeMounts" (dict "Values" . "context" $) | trim | nindent 2 }}
+  {{- include "cf-common-0.1.1.volumeMounts" (dict "Values" . "context" $) | trim | nindent 2 }}
   {{- end }}
 
   {{- with .Values.probes }}
-  {{- include "cf-common-0.1.0.probes" . | trim | nindent 2 }}
+  {{- include "cf-common-0.1.1.probes" . | trim | nindent 2 }}
   {{- end }}
 
   {{- with .Values.resources }}

charts/cf-common/templates/container/_env_vars.tpl

@@ -8,15 +8,15 @@ Create environment variables from the following structure:
        secretKeyRef/configMapKeyRef/fieldRef
 Accepts: env Dict
 */}}
-{{- define "cf-common-0.1.0.env-vars"}}
+{{- define "cf-common-0.1.1.env-vars"}}
 {{- $ := .context }}
   {{- if .Values }}
     {{- if not (kindIs "map" .Values) }}
       {{ fail "ERROR: env block must be a map"}}
     {{- end }}
   {{- end }}
   {{- $env := .Values }}
-  {{- $templatedEnv := include "cf-common-0.1.0.tplrender" (dict "Values" $env "context" $) | fromYaml }}
+  {{- $templatedEnv := include "cf-common-0.1.1.tplrender" (dict "Values" $env "context" $) | fromYaml }}
   {{- range $name, $val := $templatedEnv }}
     {{- if or (kindIs "string" $val) (kindIs "bool" $val) (kindIs "int" $val) (kindIs "float64" $val) }}
 - name: {{ $name }}