@sap/cds-dk 4.9.6 → 6.0.2

package/lib/k8s/resources/helm/chart/templates/_deployment_helpers.tpl

@@ -0,0 +1,221 @@
+{{/*
+Generate VCAP_APPLICATION
+*/}}
+{{- define "cap.vcapApplication" -}}
+    {{- $deploymentHost := include "cap.deploymentHost" . -}}
+    {{- $VCAP_APPLICATION := dict "application_uris" (list (print $deploymentHost "." .Values.global.domain)) }}
+    {{- $VCAP_APPLICATION | toJson }}
+{{- end -}}
+
+{{/*
+Add custom env variables
+*/}}
+{{- define "cap.env" -}}
+    {{- if . -}}
+        {{- range $name, $value := . }}
+- name: {{ $name | quote }}
+  value: {{ $value | quote }}
+        {{- end -}}
+    {{- end -}}
+{{- end -}}
+
+{{- define "cap.bindingsVolumes" -}}
+{{- if $.Values.newBindings -}}
+{{- include "cap.newBindingsVolumes" $ }}
+{{- else -}}
+{{- include "cap.oldBindingsVolumes" $ }}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Old Service Bindings: volumes
+*/}}
+{{- define "cap.oldBindingsVolumes" -}}
+    {{- $ := . -}}
+    {{ range $bindingName, $binding := .deployment.bindings -}}
+        {{- $secret := include "cap.bindingSecretName" (dict "Release" $.Release "name" $.name "bindingName" $bindingName "binding" $binding) }}
+- name: {{ $bindingName }}-secret
+  secret:
+    secretName: {{ $secret | quote }}
+        {{- if and (eq $bindingName "db") $.deployment.multitenancy }}
+    # the "plan" property must not be in the secret for the service manager
+    # it would be used as plan for HANA
+    items:
+    - key: clientid
+      path: clientid
+    - key: clientsecret
+      path: clientsecret
+    - key: sm_url
+      path: sm_url
+    - key: url
+      path: url
+    - key: xsappname
+      path: xsappname
+          {{- end -}}
+          {{- if eq $.deployment.language "Node" }}
+- name: {{ $bindingName }}-metadata
+  secret:
+    secretName: {{ $secret | quote }}
+    optional: true
+    items:
+    - key: label
+      path: label
+    - key: plan
+      path: plan
+    - key: tags
+      path: tags
+        {{- end -}}
+    {{- end -}}
+{{- end -}}
+
+{{/*
+New Service Bindings: volumes
+*/}}
+{{- define "cap.newBindingsVolumes" -}}
+    {{- $ := . -}}
+    {{ range $bindingName, $binding := .deployment.bindings -}}
+        {{- $secret := include "cap.bindingSecretName" (dict "Release" $.Release "name" $.name "bindingName" $bindingName "binding" $binding) }}
+- name: {{ $bindingName }}-secret
+  secret:
+    secretName: {{ $secret | quote }}
+    {{- end -}}
+{{- end -}}
+
+
+{{- define "cap.bindingsEnv" -}}
+{{- if $.Values.newBindings -}}
+{{- include "cap.newBindingsEnv" $ }}
+{{- else -}}
+{{- include "cap.oldBindingsEnv" $ }}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Old Service Bindings: env vars
+*/}}
+{{- define "cap.oldBindingsEnv" }}
+    {{- $ := . }}
+    {{- if eq .deployment.language "Java" }}
+        {{- range $key, $binding := .deployment.bindings }}
+            {{- $cleanKey := $key | upper | replace "-" "" | replace "_" "" | replace "." "" }}
+            {{- $prefix := print "CDS_ENVIRONMENT_K8S_SERVICEBINDINGS_" $cleanKey }}
+            {{- $secret := default (print $.Release.Name "-" $.name "-" $key) $binding.secret }}
+- name: {{ $prefix }}_SERVICE
+  valueFrom:
+    secretKeyRef:
+      name: {{ $secret | quote }}
+      key: label
+- name: {{ $prefix }}_PLAN
+  valueFrom:
+    secretKeyRef:
+      name: {{ $secret | quote }}
+      key: plan
+      optional: true
+- name: {{ $prefix }}_SECRETSPATH
+  value: /etc/secrets/cds/requires/{{ $key }}/credentials
+        {{- end }}
+    {{- else }}
+  {{- /* Read credentials from file system */ -}}
+- name: CDS_CONFIG
+  value: /etc/secrets/cds
+    {{ end }}
+{{- end }}
+
+{{/*
+New Service Bindings: env vars
+*/}}
+{{- define "cap.newBindingsEnv" }}
+- name: SERVICE_BINDING_ROOT
+  value: /bindings
+{{- end }}
+
+
+{{- define "cap.bindingsVolumeMounts" -}}
+{{- if $.Values.newBindings -}}
+{{- include "cap.newBindingsVolumeMounts" $ }}
+{{- else -}}
+{{- include "cap.oldBindingsVolumeMounts" $ }}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Old Service Bindings: volume mounts
+*/}}
+{{- define "cap.oldBindingsVolumeMounts" }}
+    {{- $ := . -}}
+    {{- range $key, $binding := .deployment.bindings }}
+- name: {{ $key }}-secret
+  mountPath: /etc/secrets/cds/requires/{{ $key }}/credentials
+  readOnly: true
+        {{- if eq $.deployment.language "Node" }}
+- name: {{ $key }}-metadata
+  mountPath: /etc/secrets/cds/requires/{{ $key }}/vcap
+  readOnly: true
+        {{- end }}
+    {{- end }}
+{{- end }}
+
+{{/*
+New Service Bindings: volume mounts
+*/}}
+{{- define "cap.newBindingsVolumeMounts" }}
+    {{- $ := . -}}
+    {{- range $key, $binding := .deployment.bindings }}
+- name: {{ $key }}-secret
+  mountPath: /bindings/{{ $key }}
+  readOnly: true
+    {{- end }}
+{{- end }}
+
+
+{{/*
+Get list of deployment names
+*/}}
+{{- define "cap.deploymentNames" -}}
+{{- $defaultDeployments := (list "srv") -}}
+  {{- if .mtx -}}
+{{-   $_ := (append $defaultDeployments "mtx") -}}
+  {{- end -}}
+{{ .deploymentNames | default $defaultDeployments | join ";" }}
+{{- end -}}
+
+{{/*
+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.
+
+copied from web-application: web-application.fullname
+
+*/}}
+{{- define "cap.deploymentHost" -}}
+{{- if .deployment.expose.host }}
+{{- .deployment.expose.host }}
+{{- else }}
+{{- $name := (include "cap.web-application.fullname" .) }}
+{{- if hasPrefix $name .Release.Namespace }}
+{{- .Release.Namespace }}
+{{- else }}
+{{- printf "%s-%s" $name .Release.Namespace | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{- define "cap.web-application.fullname" -}}
+{{- if .deployment.fullnameOverride }}
+{{- .deployment.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .name .deployment.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Get FQDN of a deployment
+*/}}
+{{- define "cap.deploymentHostFull" -}}
+{{ include "cap.deploymentHost" $ }}.{{ $.Values.global.domain }}
+{{- end -}}

package/lib/k8s/resources/helm/chart/templates/_helpers.tpl

@@ -0,0 +1,167 @@
+{{/*
+Check for mandatory configuration options
+*/}}
+{{- define "cap.expect" -}}
+{{-   $root := first . -}}
+{{-   $vars := rest . -}}
+{{-   range $path := $vars -}}
+{{-     $var := $root.Values -}}
+{{-     $segments := regexSplit "\\." $path -1 -}}
+{{-     $context := (dict "var" $var) -}}
+{{-     range $segment := $segments -}}
+{{-       $var := (get $context "var") -}}
+{{-       $var := get $var $segment -}}
+{{-       if empty $var -}}
+{{-         fail (join "" (list "Expect .Values." $path)) -}}
+{{-       end -}}
+{{-       $context := set $context "var" $var -}}
+{{-     end -}}
+{{-   end -}}
+{{- end -}}
+
+{{/*
+Labels for a component
+*/}}
+{{- define "cap.labels" -}}
+helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}
+app.kubernetes.io/name: {{ .name }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+app.kubernetes.io/version: {{ .Chart.AppVersion }}
+{{- end -}}
+{{- define "cap.labelsWithRevision" -}}
+{{- include "cap.labels" . }}
+revision: "{{ .Release.Revision }}"
+{{- end -}}
+
+{{/*
+Labels to select a component
+*/}}
+{{- define "cap.selectorLabels" -}}
+app.kubernetes.io/name: {{ .name }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end -}}
+
+{{/*
+Image
+*/}}
+{{- define "cap.image.srv" -}}
+    {{- if .Values.srv.image.tag -}}
+{{ .Values.srv.image.repository }}:{{ .Values.srv.image.tag }}
+    {{- else -}}
+{{ .Values.srv.image.repository }}
+    {{- end -}}
+{{- end -}}
+
+{{- define "cap.image" -}}
+    {{- if .image.tag -}}
+{{ .image.repository }}:{{ .image.tag }}
+    {{- else -}}
+{{ .image.repository }}
+    {{- end -}}
+{{- end -}}
+
+{{/*
+Image Pull Policy
+*/}}
+{{- define "cap.imagePullPolicy.srv" -}}
+    {{- if and (.Values.srv.image.tag) (ne .Values.srv.image.tag "latest") -}}
+IfNotPresent
+   {{- else -}}
+Always
+    {{- end -}}
+{{- end -}}
+
+{{- define "cap.imagePullPolicy" -}}
+    {{- if and (.image.tag) (ne .image.tag "latest") -}}
+IfNotPresent
+    {{- else -}}
+Always
+    {{- end -}}
+{{- end -}}
+
+{{/*
+Image Pull Secrets
+*/}}
+{{- define "cap.imagePullSecrets" -}}
+    {{- if (and .Values.global.imagePullSecret .Values.global.imagePullSecret.name) }}
+imagePullSecrets:
+- name: {{ .Values.global.imagePullSecret.name | quote }}
+    {{- end -}}
+{{- end -}}
+
+
+{{/*
+Binding
+*/}}
+{{- define "cap.binding" -}}
+apiVersion: services.cloud.sap.com/v1alpha1
+kind: ServiceBinding
+metadata:
+  name: {{ include "cap.bindingSecretName" $ | quote }}
+  namespace: {{ $.Release.Namespace }}
+  labels: {{- include "cap.labels" $ | nindent 4 }}
+spec:
+  serviceInstanceName: {{ $.Release.Name }}-{{ $.binding.service }}
+  externalName: {{ include "cap.bindingSecretName" $ | quote }}
+  secretName: {{ include "cap.bindingSecretName" $ | quote }}
+{{- end -}}
+
+{{/*
+Service Instance NEW
+ternary dict ($.Files.Get $.service.config | fromJson)
+*/}}
+{{- define "cap.service-instance" -}}
+{{- $key := .Template.Name | lower | regexFind "[a-zA-Z0-9_-]+.yaml" | replace ".yaml" "" | replace "-" "_" }}
+{{- $service := get .Values $key }}
+{{- if $service }}
+{{- if or (not (hasKey $service "enabled")) $service.enabled }}
+{{- $name := $key | replace "_" "-" }}
+{{- $serviceParameters := $service.parameters | default (dict) }}
+{{- $configParameters := (dict) }}
+{{- if $service.config }}
+    {{- $configString := $.Files.Get $service.config }}
+    {{- if not $configString }}
+        {{- fail (print "Config file " $service.config " not found") }}
+    {{- end }}
+    {{- $_ := merge $configParameters (fromJson $configString) }}
+{{- end }}
+{{- $defaultParameters := $.defaultParameters | default dict }}
+{{ $parameters := merge $serviceParameters $configParameters $defaultParameters }}
+apiVersion: services.cloud.sap.com/v1alpha1
+kind: ServiceInstance
+metadata:
+  name: {{ include "cap.service-instance.serviceInstanceName" (dict "root" . "name" $name "service" $service) }}
+  namespace: {{ .Release.Namespace }}
+  labels: {{- include "cap.labels" (merge (dict "name" $name) .) | nindent 4 }}
+spec:
+  serviceOfferingName: {{ $service.serviceOfferingName }}
+  servicePlanName: {{ $service.servicePlanName }}
+  externalName: {{ .Release.Namespace }}-{{ include "cap.service-instance.serviceInstanceName" (dict "root" . "name" $name "service" $service) }}
+  parameters:
+{{ toYaml $parameters | indent 4 }}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+    Service Instance
+    from web-application helm chart
+*/}}
+{{- define "cap.service-instance.serviceInstanceName" -}}
+  {{- if .service.fullnameOverride }}
+    {{- if gt (len .service.fullnameOverride) 63 }}
+      {{- fail (printf "name exceeds 63 characters: '%s'" .service.fullnameOverride) }}
+    {{- end }}
+    {{- .service.fullnameOverride }}
+  {{- else }}
+    {{- $name := .name }}
+    {{- 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 }}
+{{- end }}

package/lib/k8s/resources/helm/chart/templates/_sapcp_helpers.tpl

@@ -0,0 +1,103 @@
+
+{{/*
+SAPCP Service Bindings: volume mounts
+*/}}
+{{- define "cap.sapcp.bindingsVolumeMounts" }}
+    {{- $ := . -}}
+    {{- range $key, $binding := .bindings }}
+- name: {{ $key | replace "_" "-" }}-secret
+  mountPath: /etc/secrets/sapcp/{{ $key | replace "_" "-" }}/{{ $key }}
+  readOnly: true
+    {{- end }}
+{{- end }}
+
+{{/*
+SAPCP Service Bindings: volumes
+*/}}
+{{- define "cap.sapcp.bindingsVolumes" -}}
+    {{- $ := . -}}
+    {{ range $bindingName, $binding := .bindings -}}
+        {{- $secret := include "cap.sapcp.bindingSecretName" (dict "root" $.root "name" $.name "bindingName" $bindingName "binding" $binding) }}
+- name: {{ $bindingName | replace "_" "-" }}-secret
+  secret:
+    secretName: {{ $secret | quote }}
+    {{- end -}}
+{{- end -}}
+
+
+{{/*
+Binding Secret Name
+*/}}
+{{- define "cap.sapcp.bindingName" -}}
+{{ print $.root.Release.Name "-" $.name "-" $.bindingName | replace "_" "-" }}
+{{- end -}}
+
+{{/*
+SAPCP Service Bindings: bindings
+*/}}
+{{- define "cap.sapcp.bindings" -}}
+{{- $ := . -}}
+{{- range $name, $params := .bindings }}
+{{- if not $params.fromSecret }}
+---
+apiVersion: services.cloud.sap.com/v1
+kind: ServiceBinding
+metadata:
+  namespace: {{ $.Release.Namespace }}
+  name: {{ include "cap.sapcp.bindingName" (dict "root" $.root "name" $.name "bindingName" $name) }}
+  labels: {{- include "cap.labels" $ | nindent 4 }}
+spec:
+  serviceInstanceName: {{include "cap.sapcp.serviceInstanceName" (dict "binding" $params "release" $.Release.Name) }}
+  {{- if $params.externalName }}
+  externalName: {{ $params.externalName }}
+  {{- end }}
+  {{- if $params.secretName }}
+  secretName: {{ $params.secretName }}
+  {{- end }}
+  {{- if $params.parameters }}
+  parameters: {{ $params.parameters | toYaml | nindent 4 }}
+  {{- end }}
+  {{- if $params.parametersFrom }}
+  parametersFrom: {{ $params.parametersFrom | toYaml | nindent 4 }}
+  {{- end }}
+  {{- if $params.credentialsRotationPolicy }}
+  credentialsRotationPolicy: {{ $params.credentialsRotationPolicy | toYaml | nindent 4 }}
+  {{- end }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Binding Secret Name
+*/}}
+{{- define "cap.sapcp.bindingSecretName" -}}
+{{- $secretName := include "cap.sapcp.bindingName" . }}
+{{- if .binding.fromSecret }}
+{{- $secretName = .binding.fromSecret}}
+{{- else if .binding.secretName }}
+{{- $secretName = .binding.secretName }}
+{{- end }}
+{{- $secretName }}
+{{- end }}
+
+{{/*
+    Service Instance
+    from web-application helm chart
+*/}}
+{{- define "cap.sapcp.serviceInstanceName" -}}
+  {{- if .binding.serviceInstanceFullname }}
+    {{- if gt (len .binding.serviceInstanceFullname) 63 }}
+      {{- fail (printf "name exceeds 63 characters: '%s'" .binding.serviceInstanceFullname) }}
+    {{- end }}
+    {{- .binding.serviceInstanceFullname }}
+  {{- else }}
+    {{- $name := .binding.serviceInstanceName }}
+    {{- if not (hasPrefix .release $name)}}
+      {{- $name = printf "%s-%s" .release $name }}
+    {{- end }}
+    {{- if gt (len $name) 63 }}
+      {{- fail (printf "name exceeds 63 characters: '%s'" $name) }}
+    {{- end }}
+    {{- $name }}
+  {{- end }}
+{{- end }}

package/lib/k8s/util.js

@@ -0,0 +1,186 @@
+
+const { glob } = require('./modules');
+const Path = require('path');
+const fs = require('fs');
+const { $, exec, execSync } = require('../util/exec');
+const os = require('os');
+/**
+ *
+ * @param {string} msg
+ * @returns {never}
+ */
+function throwError(msg = 'Internal Error', ...args) {
+    if (Array.isArray(msg)) {
+        msg = format(msg, ...args);
+    }
+
+    throw new Error(msg);
+}
+
+function resource(path, plugin) {
+    return plugin == undefined ? Path.join(__dirname, 'resources', path)
+                                : Path.join(__dirname, plugin, path)
+}
+
+function cp(from, to) {
+    const content = fs.readFileSync(from);
+    fs.writeFileSync(to, content);
+}
+
+function format(text, ...args) {
+    if (Array.isArray(text)) {
+        text = text.slice(0,-1).map( (str, index) => `${str}$${index}` ).concat(text.slice(-1)).join('');
+    }
+
+    const forTTY = process.stdout.isTTY;
+    if (forTTY) {
+        text = text
+            .replace(/\n# ([^\n]*)\n/g, `\n\x1b[1m$1\x1b[0m\n`)
+            .replace(/ \*([^*]+)\*/g,   ` \x1b[1m$1\x1b[0m`)
+            .replace(/ _([^_]+)_/g,     ` \x1b[4m$1\x1b[0m`);
+    } else {
+        text = text
+            .replace(/\n# ([^\n]*)\n/g, `\n$\n`)
+            .replace(/ \*([^*]+)\*/g,   `$1`)
+            .replace(/ _([^_]+)_/g,     `$1`);
+    }
+
+    return text.replace(/\$(\d+)/, (match, value) => args[value]);
+}
+
+function help(text) {
+    console.log(format(text))
+}
+
+function checkDebug(category) {
+    const debug = (process.env.DEBUG || '').split(/\W+/);
+    return debug.indexOf(category)>=0;
+}
+
+function dirExists(path) {
+    try {
+        const stat = fs.statSync(path);
+        return stat.isDirectory();
+    } catch (error) {
+        if (error.code === 'ENOENT' || error.code === 'ENOTDIR')
+            return false;
+        else
+            throw error;
+    }
+}
+
+function globSingleFile(pattern) {
+    const result = glob.sync(pattern);
+    if (result.length !== 1) throwError `Expect 1 file matching the pattern *${ pattern }*. Found ${ result.length }.`;
+    return result[0];
+}
+
+function getProperty(obj, name, handleUndefined) {
+    const path = name.split('.');
+    for (const field of path) {
+        if (typeof obj !== 'object') throwError `Invalid property *${name}*.`;
+        obj = obj[field];
+        if (typeof obj === 'undefined') return handleUndefined(name);
+    }
+
+    return obj;
+}
+
+function checkProperties(properties, obj, onError = name => throwError `Expect property *${name}*`, path = '') {
+    for (const name of Object.keys(properties)) {
+        const property = properties[name];
+        if (typeof property === 'object') {
+            checkProperties(property, obj[name] || {}, onError, path = `${path}${name}.`);
+        } else if (property) {
+            if (!obj[name]) onError(`${path}${name}`);
+        }
+    }
+}
+
+function mergeDeep(...objs) {
+    const target = {...objs[0]};
+    const obj = objs[1];
+    for (const name of Object.keys(obj)) {
+        if (name === '__proto__') continue;
+        const property = obj[name];
+        if (typeof property === 'object') {
+            if (target[name]) {
+                target[name] = mergeDeep(target[name], property);
+            } else {
+                delete property.__proto__;
+                target[name] = {...property};
+            }
+        } else {
+            target[name] = property;
+        }
+    }
+
+    if (objs.length > 2) {
+        return mergeDeep(target, objs.slice(2));
+    } else {
+        return target;
+    }
+}
+
+async function readFileIfExists(path, encoding) {
+    try {
+        return await fs.promises.readFile(path, encoding);
+    } catch(error) {
+        if (error.code === 'ENOENT' || error.code === 'EISDIR') return undefined;
+        else throw error;
+    }
+}
+
+/**
+ * Takes path of md5 file as an argument and returns a JSON object containing hashes of files stored in MD5 file.
+ * @param {String} path 
+ * @returns {JSON}
+ */
+async function parseMd5File(path) {
+    let md5Hashes = {};
+    const md5FileContent = await readFileIfExists(path);
+    if(md5FileContent == undefined) return md5Hashes;
+    let md5Checksums = md5FileContent.toString().split(os.EOL)
+    md5Checksums.forEach((checksum) => {
+        checksum = checksum.split(" ")
+        md5Hashes[checksum[1]] = checksum[0];
+    })
+    return md5Hashes;
+}
+
+/**
+ * Takes json object containing key as filename and value as MD5 hash and generates a md5sum format file.
+ * @param {String} path 
+ * @param {JSON} data 
+ */
+async function writeMd5File(path, data) {
+    let md5_output;
+    Object.keys(data).forEach(key => {
+        var currMd5 = `${data[key]} ${key}`;
+        if(md5_output == undefined)
+            md5_output = currMd5;
+        else
+            md5_output += os.EOL + currMd5;
+    })
+    await fs.promises.writeFile(path, md5_output);
+}
+
+module.exports = {
+    throwError,
+    resource,
+    cp,
+    format,
+    help,
+    checkDebug,
+    dirExists,
+    readFileIfExists,
+    globSingleFile,
+    getProperty,
+    checkProperties,
+    mergeDeep,
+    $,
+    exec,
+    execSync,
+    parseMd5File,
+    writeMd5File
+}