@sap/cds-dk 6.3.1 → 6.4.0

package/lib/init/template/helm/subchart/values.schema.json

@@ -310,6 +310,7 @@
         "health_check": {
             "$id": "#/properties/health_check",
             "title": "Health-check configuration",
+            "description": "[Deprecated] Use health instead",
             "type": "object",
             "additionalProperties": false,
             "properties": {
@@ -321,8 +322,7 @@
                     "properties": {
                         "path": {
                             "description": "HTTP path used by Kubernetes, to perform health-check calls.",
-                            "type": "string",
-                            "default": "/healthz"
+                            "type": "string"
                         }
                     }
                 },
@@ -334,6 +334,39 @@
                     "properties": {
                         "path": {
                             "description": "HTTP path used by Kubernetes, to perform health-check calls.",
+                            "type": "string"
+                        }
+                    }
+                }
+            }
+        },
+        "health": {
+            "$id": "#/properties/health",
+            "title": "Health-check configuration",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "liveness": {
+                    "$id": "#/properties/health/properties/liveness",
+                    "description": "Liveness-probe configuration.",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "path": {
+                            "description": "HTTP path used by Kubernetes, to perform liveness-probe calls.",
+                            "type": "string",
+                            "default": "/healthz"
+                        }
+                    }
+                },
+                "readiness": {
+                    "$id": "#/properties/health/properties/readiness",
+                    "description": "Readiness-probe configuration.",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "path": {
+                            "description": "HTTP path used by Kubernetes, to perform readiness-probe calls.",
                             "type": "string",
                             "default": "/healthz"
                         }
@@ -360,10 +393,7 @@
                             "anyOf": [
                                 {
                                     "description": "Plain value of an environment variable.",
-                                    "type": [
-                                        "integer",
-                                        "string"
-                                    ]
+                                    "type": ["integer", "string"]
                                 },
                                 {
                                     "description": "`valueFrom` configuration for the environment variable https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/",
@@ -451,10 +481,7 @@
                                 "pattern": "^[-._a-zA-Z][-._a-zA-Z0-9]*$"
                             },
                             "value": {
-                                "type": [
-                                    "string",
-                                    "integer"
-                                ]
+                                "type": ["string", "integer"]
                             },
                             "configMapKeyRef": {
                                 "description": "Selects a key of a ConfigMap.",
@@ -520,13 +547,69 @@
         },
         "envSecretNames": {
             "$id": "#/properties/envSecretNames",
-            "description": "List of Kubernetes Secret names, used as sources for the Pod's environment variables.",
+            "description": "[Deprecated] Use `envFrom` instead",
             "type": "array",
             "uniqueItems": true,
             "items": {
                 "$ref": "#/definitions/KubernetesName"
-            },
-            "default": []
+            }
+        },
+        "envFrom": {
+            "$id": "#/properties/envFrom",
+            "description": "List of sources to populate environment variables in the pod.",
+            "type": "array",
+            "default": [],
+            "items": {
+                "type": "object",
+                "oneOf": [
+                    {
+                        "additionalProperties": false,
+                        "properties": {
+                            "configMapRef": {
+                                "description": "The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
+                                "properties": {
+                                    "name": {
+                                        "description": "Name of a ConfigMap.",
+                                        "type": "string"
+                                    },
+                                    "tpl": {
+                                        "description": "Flag which tells whether the name is a template string or not.",
+                                        "type": "boolean",
+                                        "default": false
+                                    }
+                                },
+                                "required": [ "name" ],
+                                "additionalProperties": false,
+                                "type": "object"
+                            }
+                        },
+                        "required": [ "configMapRef" ]
+                    },
+                    {
+                        "additionalProperties": false,
+                        "properties": {
+                            "secretRef": {
+                                "description": "The contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
+                                "properties": {
+                                    "name": {
+                                        "description": "Name of a Secret.",
+                                        "type": "string"
+                                    },
+                                    "tpl": {
+                                        "description": "Flag which tells whether the name is a template string or not.",
+                                        "type": "boolean",
+                                        "default": false
+                                    }
+                                },
+                                "required": [ "name" ],
+                                "additionalProperties": false,
+                                "type": "object"
+                            }
+                        },
+                        "required": [ "secretRef" ]
+                    }
+                ]
+            }
         },
         "expose": {
             "$id": "#/properties/expose",

package/lib/init/template/helm/subchart/values.yaml

@@ -43,7 +43,7 @@ ha:
 #     ephemeral-storage: 1G
 #     memory: 1G
 
-health_check:
+health:
   liveness:
     path: /healthz
   readiness:
@@ -51,7 +51,11 @@ health_check:
 
 startupTimeout: 30
 
-envSecretNames: []
+envFrom: []
+# - configMapRef:
+#     name: my-configmap1
+# - secretRef:
+#     name: my-secret-ref1
 
 env: {}
 # env:

package/lib/init/template/html5-repo/index.js

@@ -1,7 +1,8 @@
-const path = require('path')
-const { exists, copy } = require('../../../cds').utils
+const { join } = require('path')
+const { exists } = require('../../../cds').utils
 const ProjectReader = require('../../util/projectReader')
 const { mergeYAML } = require('../../util/merge')
+const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5Tracking')
 const { OPTION_DESTINATIONS } = require('../../constants')
 
 module.exports = class Html5RepoTemplate extends require('../templateBase') {
@@ -10,26 +11,42 @@ module.exports = class Html5RepoTemplate extends require('../templateBase') {
         this.projectReader = new ProjectReader(projectPath)
     }
 
-    async getDependencies() {
+    getDependencies() {
         return [OPTION_DESTINATIONS]
     }
 
+    async canRun() {
+        const projectDescriptor = await this.projectReader.read(this.options)
+        const { hasMta, hasHelm } = projectDescriptor.cap
+        if (!hasHelm && hasMta) {
+            throw `'cds add html5-repo' is not available for Cloud Foundry yet`
+        }
+        return true
+    }
+
     static hasFacet(_, projectPath) {
         // REVISIT: Should be detectable without helm charts
-        return exists(path.join(projectPath, 'chart', 'templates', 'html5-apps-repo-host.yaml'))
+        return exists(join(projectPath, 'chart', 'templates', 'html5-apps-repo-host.yaml'))
     }
 
     async run() {
         await this.runDependentMerging()
     }
 
-    async runDependentMerging() {
+    async runDependentMerging(context = {}) {
         const projectDescriptor = await this.projectReader.read(this.options)
         const { appName, hasHelm } = projectDescriptor.cap
 
         if (hasHelm) {
+            //in case facet is being added to the already exisiting charts folder
+            let isIndependentCommand = false
+            if(Object.keys(context).length == 0){
+                isIndependentCommand = true
+                context.projectPath = this.projectPath
+                context.oldTrackingData = context.newTrackingData = await parseMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'))
+            }
             await mergeYAML(
-                path.join(this.projectPath, 'chart', 'values.yaml'),
+                join(this.projectPath, 'chart', 'values.yaml'),
                 {
                     html5_apps_repo_host: {
                         serviceOfferingName: 'html5-apps-repo',
@@ -52,12 +69,12 @@ module.exports = class Html5RepoTemplate extends require('../templateBase') {
                             requests: { cpu: '1000m', memory: '1G' }
                         }
                     }
-                },
-                null, { forceOverwrite: true }
+                }
             )
-            await copy(path.join(__dirname, 'files', '_html5_deployment_helpers.tpl'), path.join(this.projectPath, 'chart', 'templates', '_html5_deployment_helpers.tpl'))
-            await copy(path.join(__dirname, 'files', 'html5-apps-deployer-job.yaml'), path.join(this.projectPath, 'chart', 'templates', 'html5-apps-deployer-job.yaml'))
-            await copy(path.join(__dirname, 'files', 'html5-apps-repo-host.yaml'), path.join(this.projectPath, 'chart', 'templates', 'html5-apps-repo-host.yaml'))
+            await copyAndTrack(join(__dirname, 'files', '_html5_deployment_helpers.tpl'), join(this.projectPath, 'chart', 'templates', '_html5_deployment_helpers.tpl'), context)
+            await copyAndTrack(join(__dirname, 'files', 'html5-apps-deployer-job.yaml'), join(this.projectPath, 'chart', 'templates', 'html5-apps-deployer-job.yaml'), context)
+            await copyAndTrack(join(__dirname, 'files', 'html5-apps-repo-host.yaml'), join(this.projectPath, 'chart', 'templates', 'html5-apps-repo-host.yaml'), context)
+            if(isIndependentCommand) await writeMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'), context.newTrackingData)
         }
     }
 }

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

@@ -1,6 +1,6 @@
 const fs = require('fs').promises;
 const os = require('os');
-const path = require('path');
+const { join, relative } = require('path');
 
 const commandUtil = require('../../util/commandUtil');
 const mvnArchetypeUtil = require('../../util/mvnArchetypeUtil');
@@ -17,7 +17,7 @@ module.exports = class JavaTemplate extends require('../templateBase') {
     }
 
     static hasFacet(_, projectPath) {
-        return exists(path.join(projectPath, 'pom.xml'))
+        return exists(join(projectPath, 'pom.xml'))
     }
 
     async canRun() {
@@ -38,13 +38,13 @@ module.exports = class JavaTemplate extends require('../templateBase') {
 
         LOG.info(`Using Maven archetype version ${archetypeVersion}`);
 
-        const tempFolder = await fs.mkdtemp(path.join(os.tmpdir(), `${this.projectName}_`));
+        const tempFolder = await fs.mkdtemp(join(os.tmpdir(), `${this.projectName}_`));
         try {
             await commandUtil.spawnCommand('mvn', cmdLine, {
                 cwd: tempFolder
             });
 
-            await copy(path.join(tempFolder, artifactId), this.projectPath);
+            await copy(join(tempFolder, artifactId), this.projectPath);
         } catch (err) {
             if (err.code === 'ENOENT' && err.path === 'mvn') {
                 throw new Error(`Maven executable 'mvn' not found, follow ${term.info(URLS.MAVEN_INSTALL_HELP)} and install Maven on your machine.`);
@@ -56,7 +56,7 @@ module.exports = class JavaTemplate extends require('../templateBase') {
     }
 
     async finalize() {
-        const relativeProjectPath = path.relative(this.cwd, this.projectPath);
+        const relativeProjectPath = relative(this.cwd, this.projectPath);
         if (relativeProjectPath && relativeProjectPath !== '.') {
             LOG.info(`Continue with 'cd ${relativeProjectPath}'`);
         }

package/lib/init/template/kibana-logging/index.js

@@ -1,4 +1,4 @@
-const path = require('path')
+const { join } = require('path')
 const cds = require('../../../cds')
 const ProjectReader = require('../../util/projectReader')
 const { mergeJSON, mergeYAML } = require('../../util/merge')
@@ -17,6 +17,7 @@ module.exports = class KibanaTemplate extends require('../templateBase') {
         if (hasHelm && !hasMta) {
             throw `'cds add kibana-logging' is not available for Kyma yet`
         }
+        return true
     }
 
     async run() {
@@ -32,8 +33,8 @@ module.exports = class KibanaTemplate extends require('../templateBase') {
                 const projectDescriptor = await this.projectReader.read(this.options);
                 const { for: forProfile } = projectDescriptor.cap
                 const cdsTemplateFile = forProfile ? 'cds.profile.package.json.hbs' : 'cds.package.json'
-                const cdsTemplatePath = path.join(__dirname, 'files', cdsTemplateFile)
-                await mergeJSON(path.join(this.projectPath, 'package.json'), cdsTemplatePath, projectDescriptor)
+                const cdsTemplatePath = join(__dirname, 'files', cdsTemplateFile)
+                await mergeJSON(join(this.projectPath, 'package.json'), cdsTemplatePath, projectDescriptor)
             }
         }
         await this.runDependentMerging()
@@ -46,7 +47,7 @@ module.exports = class KibanaTemplate extends require('../templateBase') {
         if (hasMta) {
             const srv = isNodejs ? srvNode : srvJava
 
-            const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml')
+            const mtaYAMLPath = join(this.projectPath, 'mta.yaml')
             await mergeYAML(
                 mtaYAMLPath,
                 `${__dirname}/files/mta.yaml.hbs`,

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

@@ -1,5 +1,5 @@
 const { join } = require('path');
-const { exists, path } = require('../../../cds').utils
+const { exists } = require('../../../cds').utils
 const { copyFiles } = require('../../util/templateUtil')
 const ProjectReader = require('../../util/projectReader');
 
@@ -17,7 +17,7 @@ module.exports = class MtaTemplate extends require('../templateBase') {
     async run() {
         const projectDescriptor = await this.projectReader.read()
         if (!exists(join(this.projectPath, 'mta.yaml'))) {
-            await copyFiles(path.join(__dirname, 'files'), this.projectPath, projectDescriptor);
+            await copyFiles(join(__dirname, 'files'), this.projectPath, projectDescriptor);
         }
 
         // Re-applying the dependent merging part of other facets if necessary.

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

@@ -7,7 +7,7 @@ module.exports = class MtxTemplate extends require('../templateBase') {
         this.projectReader = new ProjectReader(projectPath)
     }
 
-    async getDependencies() {
+    getDependencies() {
         return [OPTION_MULTITENANCY, OPTION_TOGGLES, OPTION_EXTENSIBILITY]
     }
 }

package/lib/init/template/multitenancy/files/chart.yaml

@@ -0,0 +1,4 @@
+dependencies:
+  - name: web-application
+    alias: sidecar
+    version: 0.1.0

package/lib/init/template/multitenancy/files/java/mtxs-configmap.yaml

@@ -0,0 +1,20 @@
+# Please do not modify this file. This file may be overwritten.
+
+{{- $approuterDeployment := .Values.approuter }}
+{{- $ := merge (dict "name" "approuter" "deployment" .Values.approuter ) . }}
+{{- $approuterUrl := (include "cap.deploymentHostFull" $ )}}
+
+{{- $sidecarDeployment := .Values.sidecar }}
+{{- $ = merge (dict "name" "sidecar" "deployment" .Values.sidecar ) . }}
+{{- $sidecarUrl := (include "cap.deploymentHostFull" $ )}}
+
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: "{{ .Release.Name }}-mtxs-configmap"
+  namespace: "{{ .Release.Namespace }}"
+data:
+  CDS_MULTITENANCY_APPUI_TENANTSEPARATOR: "-"
+  CDS_MULTITENANCY_MTXS_ENABLED: "true"
+  CDS_MULTITENANCY_APPUI_URL: {{ printf "https://%s" $approuterUrl }}
+  CDS_MULTITENANCY_SIDECAR_URL: {{ printf "https://%s" $sidecarUrl }}

package/lib/init/template/multitenancy/files/java/package.json

@@ -1,21 +1,18 @@
 {
   "name": "cap-mtx-sidecar",
   "dependencies": {
-    "@sap/cds": "^6.0.2",
-    "@sap/cds-mtxs": "^1.0.1",
-    "@sap/hdi-deploy": "^4.4.1",
-    "@sap/xssec": "^3.2.13",
-    "express": "^4.18.1",
-    "hdb": "^0.19.3",
+    "@sap/cds": "^6.3.1",
+    "@sap/cds-mtxs": "^1.3.1",
+    "@sap/hdi-deploy": "^4.5.1",
+    "@sap/xssec": "^3.2.14",
+    "express": "^4.18.2",
+    "hdb": "^0.19.5",
     "passport": "^0.6.0"
   },
   "scripts": {
     "start": "cds run",
     "build": "npm ci && npx -p @sap/cds-dk@^6 cds build ../.. --for mtx-sidecar --production && cd gen && npm ci"
   },
-  "engines": {
-    "node": "^16.15.0"
-  },
   "cds": {
     "requires": {
       "db": "sql-mt",

package/lib/init/template/multitenancy/files/mtxs-configmap.yaml

@@ -0,0 +1,15 @@
+# Please do not modify this file. This file may be overwritten.
+
+{{- $approuterDeployment := .Values.approuter }}
+{{- $ := merge (dict "name" "approuter" "deployment" .Values.approuter ) . }}
+{{- $approuterUrl := (include "cap.deploymentHostFull" $ )}}
+
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: "{{ .Release.Name }}-mtxs-configmap"
+  namespace: "{{ .Release.Namespace }}"
+data:
+  CDS_MULTITENANCY_APPUI_TENANTSEPARATOR: "-"
+  CDS_MULTITENANCY_APPUI_URL: {{ printf "https://%s" $approuterUrl }}
+  SUBSCRIPTION_URL: {{ printf "https://${tenant_subdomain}-%s" $approuterUrl }}

package/lib/init/template/multitenancy/files/saas-registry.yaml

@@ -1,19 +1,17 @@
-{{- if (default dict .Values.multitenancy).enabled }}
-  {{- $srvHostFull := include "cap.deploymentHostFull" (merge (dict "name" "srv" "deployment" .Values.srv) . ) }}
-  {{- $defaultAppUrls := dict
-    "getDependencies" (print "https://" $srvHostFull "/-/cds/saas-provisioning/dependencies")
-    "onSubscription" (print "https://" $srvHostFull "/-/cds/saas-provisioning/tenant/{tenantId}")
-    "onSubscriptionAsync" false
-    "onUnSubscriptionAsync" false
-    "callbackTimeoutMillis" 300000
-  }}
-  {{- $defaultParameters := dict
-      "xsappname" .Values.xsuaa.parameters.xsappname
-      "appName" .Values.xsuaa.parameters.xsappname
-      "displayName" .Chart.Name
-      "description" .Chart.Description
-      "category" "CAP Application"
-      "appUrls" $defaultAppUrls
-  }}
-  {{- include "cap.service-instance" (merge (dict "defaultParameters" $defaultParameters . )) }}
-{{ end }}
+{{- $srvHostFull := include "cap.deploymentHostFull" (merge (dict "name" "srv" "deployment" .Values.srv) . ) }}
+{{- $defaultAppUrls := dict
+  "getDependencies" (printf "https://%s%s" $srvHostFull .Values.saas_registry.getDependencies)
+  "onSubscription" (printf "https://%s%s" $srvHostFull .Values.saas_registry.onSubscription)
+  "onSubscriptionAsync" false
+  "onUnSubscriptionAsync" false
+  "callbackTimeoutMillis" 300000
+}}
+{{- $defaultParameters := dict
+    "xsappname" .Values.xsuaa.parameters.xsappname
+    "appName" .Values.xsuaa.parameters.xsappname
+    "displayName" .Chart.Name
+    "description" .Chart.Description
+    "category" "CAP Application"
+    "appUrls" $defaultAppUrls
+}}
+{{- include "cap.service-instance" (merge (dict "defaultParameters" $defaultParameters ) .) }}

package/lib/init/template/multitenancy/files/values.yaml.hbs

@@ -0,0 +1,47 @@
+---
+srv:
+  bindings:
+    saas-registry:
+      serviceInstanceName: saas-registry
+    service-manager:
+      fromSecret: null
+{{#cap.hasXsuaa}}
+xsuaa:
+  parameters:
+    tenant-mode: shared
+{{/cap.hasXsuaa}}
+saas_registry:
+  serviceOfferingName: saas-registry
+  servicePlanName: application
+{{#cap.isNodejs}}
+  getDependencies: "/-/cds/saas-provisioning/dependencies"
+  onSubscription: "/-/cds/saas-provisioning/tenant/{tenantId}"
+{{/cap.isNodejs}}
+{{#cap.isJava}}
+  getDependencies: "/mt/v1.0/subscriptions/dependencies"
+  onSubscription: "/mt/v1.0/subscriptions/tenants/{tenantId}"
+sidecar:
+  bindings:
+{{#cap.hasXsuaa}}
+    auth:
+      serviceInstanceName: xsuaa
+{{/cap.hasXsuaa}}
+    service-manager:
+      fromSecret: null
+  image:
+    repository: <your-container-registry>/{{cap.appName}}-sidecar
+    tag: latest
+  resources:
+    limits:
+      ephemeral-storage: 1G
+      memory: 500M
+    requests:
+      ephemeral-storage: 1G
+      cpu: 500m
+      memory: 500M
+  health_check:
+    liveness:
+      path: /
+    readiness:
+      path: /
+{{/cap.isJava}}

package/lib/init/template/multitenancy/files/xs-security.json.hbs

@@ -6,13 +6,6 @@
       "grant-as-authority-to-apps": [
         "$XSAPPNAME(application,sap-provisioning,tenant-onboarding)"
       ]
-    },
-    {
-      "name": "$XSAPPNAME.cds.Subscriber",
-      "description": "Subscribe to applications"
     }
-  ],
-  "authorities": [
-    "$XSAPPNAME.cds.Subscriber"
   ]
 }