@sap/cds-dk 6.5.2 → 6.6.1

package/lib/init/template/helm/index.js

@@ -1,22 +1,21 @@
 const { join } = require('path');
 const { exists, rimraf } = require('../../../cds').utils;
-const ProjectReader = require('../../util/projectReader');
+const { readProject } = require('../../util/projectReader');
 const { mergeYAML } = require('../../util/merge')
 const { parseMd5File, writeMd5File, copyAndTrack } = require('../../util/md5Tracking')
 //const { yaml } = require('@sap/cds-foss')
 
 module.exports = class HelmTemplate extends require('../templateBase') {
-    constructor(projectPath, generator) {
-        super(projectPath, generator, __dirname);
-        this.projectReader = new ProjectReader(projectPath);
-        this.oldTrackingData = undefined;
-        this.newTrackingData = {};
+    constructor(generator, oldTrackingData = undefined, newTrackingData = {}) {
+        super(generator)
+        this.oldTrackingData = oldTrackingData;
+        this.newTrackingData = newTrackingData;
     }
 
-    static hasFacet(_, projectPath, options) {
+    static hasFacet(_, options) {
         // REVISIT: this works, but could be semantically nicer with a 'shouldRunDependentMerging' or the like
         if (options?.add.has('mta') && !options?.add.has('helm')) return false
-        return exists(join(projectPath, 'chart', 'values.yaml'))
+        return exists(join('chart', 'values.yaml'))
     }
 
     async canRun() {
@@ -27,15 +26,26 @@ module.exports = class HelmTemplate extends require('../templateBase') {
         return true;
     }
 
+    async addSubChart(subchart) {
+        const subchartPath = join(this.projectPath, 'chart', 'charts', subchart);
+        if(!exists(subchartPath)) {
+            await copyAndTrack(
+                join(__dirname, 'subcharts', subchart),
+                subchartPath,
+                this
+            )
+
+            return true;
+        }
+        
+        return false;
+    }
+
     async run() {
-        const projectDescriptor = await this.projectReader.read(this.options)
+        const projectDescriptor = await readProject(this.options)
         this.oldTrackingData = await parseMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'));
 
-        await copyAndTrack(
-            join(__dirname, 'subcharts', 'web-application'),
-            join(this.projectPath, 'chart', 'charts', 'web-application'),
-            this
-        )
+        await this.addSubChart('web-application');
         await copyAndTrack(
             join(__dirname, 'chart'),
             join(this.projectPath, 'chart'),
@@ -62,8 +72,8 @@ module.exports = class HelmTemplate extends require('../templateBase') {
         const dependentFacets = ['hana', 'xsuaa', 'auditlog', 'enterprise-messaging', 'destinations' , 'multitenancy', 'extensibility', 'approuter']
         for (const facet of dependentFacets) {
             const Template = require('../'+facet)
-            const template = new Template(this.projectPath, this.generator)
-            if (Template.hasFacet(await this.getEnv(), this.projectPath, this.options)) await template.runDependentMerging(this)
+            const template = new Template(this.generator)
+            if (Template.hasFacet(await this.getEnv(), this.options)) await template.runDependentMerging(this)
         }
     }
 };

package/lib/init/template/helm/subcharts/content-deployment/templates/_helpers.tpl

@@ -97,7 +97,7 @@ Service Binding secret volumes
 {{- end }}
 - name: {{ $name }}-binding
   secret:
-    secretName: {{ $secretName }}
+    secretName: {{ tpl $secretName $ }}
 {{- end }}
 {{- end }}
 
@@ -131,30 +131,31 @@ Calculate the final image name
 {{/*
 Create the name of a service instance.
 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 service insatnce name.
+If release name contains chart name it will be used as service instance name.
 */}}
 {{- define "content-deployment.serviceInstanceName" -}}
- {{- if .binding.serviceInstanceFullname }}
+  {{- $name := "" }}
+  {{- if .binding.serviceInstanceFullname }}
     {{- if gt (len .binding.serviceInstanceFullname) 63 }}
       {{- fail (printf "name exceeds 63 characters: '%s'" .binding.serviceInstanceFullname) }}
     {{- end }}
-    {{- .binding.serviceInstanceFullname }}
+    {{- $name = .binding.serviceInstanceFullname }}
   {{- else }}
-    {{- $name := .binding.serviceInstanceName }}
-    {{- if not (hasPrefix .release $name)}}
-      {{- $name = printf "%s-%s" .release $name }}
+    {{- $name = .binding.serviceInstanceName }}
+    {{- if not (hasPrefix .root.Release.Name $name)}}
+      {{- $name = printf "%s-%s" .root.Release.Name $name }}
     {{- end }}
     {{- if gt (len $name) 63 }}
       {{- fail (printf "name exceeds 63 characters: '%s'" $name) }}
     {{- end }}
-    {{- $name }}
   {{- end }}
+  {{- tpl $name .root }}
 {{- end }}
 
 {{- define "content-deployment.processEnv" -}}
 {{- $result := dict }}
 {{- $variables := list }}
-{{- range $k, $v := . }}
+{{- range $k, $v := .Values.env }}
   {{- $variable := dict }}
   {{- if (kindIs "string" $k) }}
     {{- $_ := set $variable "name" $k -}}
@@ -174,11 +175,10 @@ If release name contains chart name it will be used as service insatnce name.
   {{- $variables = append $variables $variable}}
 {{- end }}
 {{- $_ := set $result "vars" $variables }}
-{{- $result | mustToJson }}
+{{- (fromYaml (tpl (toYaml $result) $)) | mustToJson }}
 {{- end }}
 
-{{- define "web-application.processEnvFrom" -}}
-{{- $ := . -}}
+{{- define "content-deployment.processEnvFrom" -}}
 {{- $result := dict }}
 {{- $variables := list }}
 {{- range $secretName := .Values.envSecretNames }}
@@ -187,21 +187,8 @@ If release name contains chart name it will be used as service insatnce name.
   {{- $variables = append $variables (dict "secretRef" $variable)}}
 {{- end }}
 {{- range $envFrom := .Values.envFrom }}
-  {{- if hasKey $envFrom "configMapRef" }}
-    {{- if and (hasKey $envFrom.configMapRef "tpl") ($envFrom.configMapRef.tpl) }}
-    {{- $name := (tpl $envFrom.configMapRef.name $) }}
-    {{- $_ := set $envFrom.configMapRef "name" $name }}
-    {{- end }}
-    {{- $_ := unset $envFrom.configMapRef "tpl" }}
-  {{- else }}
-    {{- if and (hasKey $envFrom.secretRef "tpl") ($envFrom.secretRef.tpl) }}
-    {{- $name := (tpl $envFrom.secretRef.name $) }}
-    {{- $_ := set $envFrom.secretRef "name" $name }}
-    {{- end }}
-    {{- $_ := unset $envFrom.secretRef "tpl" }}
-  {{- end }}
   {{- $variables = append $variables $envFrom }}
 {{- end }}
 {{- $_ := set $result "vars" $variables }}
-{{- $result | mustToJson }}
+{{- (fromYaml (tpl (toYaml $result) $)) | mustToJson }}
 {{- end }}

package/lib/init/template/helm/subcharts/content-deployment/templates/job.yaml

@@ -21,7 +21,7 @@ spec:
         - name: {{ include "content-deployment.imagePullSecretName" . }}
       {{- end }}
       automountServiceAccountToken: false
-      serviceAccountName: {{ include "content-deployment.fullname" . }}
+      serviceAccountName: {{ tpl (.Values.serviceAccountName | default (include "content-deployment.fullname" .)) $ }}
       containers:
       - image: {{ include "content-deployment.imageName" . }}
         name: {{ include "content-deployment.name" . }}
@@ -34,12 +34,12 @@ spec:
           value: /tmp
         - name: SERVICE_BINDING_ROOT
           value: /bindings
-        {{- $envVars := (include "content-deployment.processEnv" .Values.env | fromJson) }}
+        {{- $envVars := (include "content-deployment.processEnv" $ | fromJson) }}
         {{- if not (eq (len $envVars.vars) 0) }}
         {{- $envVars.vars | toYaml | nindent 8}}
         {{- end }}
         envFrom:
-        {{- $envFromVars := (include "web-application.processEnvFrom" . | fromJson) }}
+        {{- $envFromVars := (include "content-deployment.processEnvFrom" . | fromJson) }}
         {{- if not (eq (len $envFromVars.vars) 0) }}
         {{- $envFromVars.vars | toYaml | nindent 8}}
         {{- end }}

package/lib/init/template/helm/subcharts/content-deployment/templates/service-account.yaml

@@ -1,4 +1,6 @@
+{{if not .Values.serviceAccountName}}
 apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: {{ include "content-deployment.fullname" . }}
+{{end}}

package/lib/init/template/helm/subcharts/content-deployment/templates/service-binding.yaml

@@ -7,19 +7,19 @@ metadata:
   name: {{ include "content-deployment.bindingName" (dict "root" $ "name" $name) }}
   labels: {{- include "content-deployment.labels" $ | nindent 4 }}
 spec:
-  serviceInstanceName: {{include "content-deployment.serviceInstanceName" (dict "binding" $params "release" $.Release.Name) }}
+  serviceInstanceName: {{include "content-deployment.serviceInstanceName" (dict "binding" $params "root" $) }}
   secretKey: credentials
   {{- if $params.externalName }}
   externalName: {{ $params.externalName }}
   {{- end }}
   {{- if $params.secretName }}
-  secretName: {{ $params.secretName }}
+  secretName: {{ tpl $params.secretName $ }}
   {{- end }}
   {{- if $params.parameters }}
   parameters: {{ $params.parameters | toYaml | nindent 4 }}
   {{- end }}
   {{- if $params.parametersFrom }}
-  parametersFrom: {{ $params.parametersFrom | toYaml | nindent 4 }}
+  parametersFrom: {{ tpl ($params.parametersFrom | toYaml) $ | nindent 4 }}
   {{- end }}
   {{- if $params.credentialsRotationPolicy }}
   credentialsRotationPolicy: {{ $params.credentialsRotationPolicy | toYaml | nindent 4 }}

package/lib/init/template/helm/subcharts/content-deployment/templating.md

@@ -0,0 +1,37 @@
+# Templating Values
+
+This functionality is enabled only for some of the templates provided by this helm chart. The feature itself comes with some performance costs that you should keep in mind. More details on this feature can be found in the official [documentation](https://helm.sh/docs/howto/charts_tips_and_tricks/#using-the-tpl-function).
+
+The following values can be used in the template:
+
+1. [Global values](https://helm.sh/docs/chart_template_guide/subcharts_and_globals/)
+2. Values passed to the chart directly
+3. [Built-in objects](https://helm.sh/docs/chart_template_guide/builtin_objects/)
+
+Here's a full list of values with examples, where you can use templates:
+
+```yaml
+serviceAccountName: my-service-account-{{ .Release.Name }}
+env:
+  - name: key1
+    value: value1-{{ .Release.Name }}
+  - name: key2
+    configMapKeyRef:
+      name: my-configmap-{{ .Release.Name }}
+      key: my-key
+envFrom:
+- configMapRef:
+    name: my-configmap1-{{ .Release.Name }}
+- secretRef:
+    name: my-secret-ref1-{{ .Release.Name }}
+bindings:
+  hana:
+    serviceInstanceName: hana-{{ .Release.Name }}
+    secretName: hana-secret-{{ .Release.Name }}
+    parametersFrom:
+      - secretKeyRef:
+          key: my-key
+          name: test-RELEASE-NAME
+  serviceManager:
+    fromSecret: manual-secret-{{ .Release.Name }}
+```