@sap/cds-dk 6.1.4 → 6.2.0

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

@@ -0,0 +1,41 @@
+const path = require('path')
+const TemplateBase = require('../templateBase')
+const ProjectReader = require('../../util/projectReader')
+const cds = require('../../../cds'), { fs } = cds.utils
+
+module.exports = class ConnectivityTemplate extends TemplateBase {
+    constructor(projectPath, generator) {
+        super(projectPath, generator, __dirname)
+        this.projectReader = new ProjectReader(this)
+    }
+
+    async run() {
+        await this.runDependentMerging()
+    }
+
+    async runDependentMerging() {
+        const projectDescriptor = await this.projectReader.read(this.options)
+        const { hasHelmDeployment } = projectDescriptor.cap
+
+        if (hasHelmDeployment) {
+            await this.templateUtil.mergeYAML(
+                path.join(this.projectPath, 'chart', 'values.yaml'),
+                path.join(__dirname, 'files', 'values.yaml.hbs'),
+                projectDescriptor,
+                { additions: [{
+                    ref: `srv-additional-volumes`,
+                    in: `srv.additionalVolumes`,
+                    where: [{
+                        property: 'name',
+                        isEqualTo: 'connectivity-secret'
+                    }]
+                }]}
+            )
+            const filesPath = path.join(__dirname, 'files')
+            const templatesPath = path.join(this.projectPath, 'chart', 'templates')
+            await fs.copy(path.join(filesPath, 'connectivity-binding.yaml'), path.join(templatesPath, 'connectivity-binding.yaml'))
+            await fs.copy(path.join(filesPath, 'connectivity-proxy-info.yaml'), path.join(templatesPath, 'connectivity-proxy-info.yaml'))
+            await fs.copy(path.join(filesPath, 'connectivity.yaml'), path.join(templatesPath, 'connectivity.yaml'))
+        }
+    }
+}

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

@@ -127,14 +127,14 @@ function createDataFile (isFileExists, dataFilePath, dest, projectPath, force, e
 }
 
 function prepareDataFileContent (entity) {
-  const persistenceKeyNames = Object.values(entity.keys||[]).map(element => element['@cds.persistence.name']);
-  return Object.values(entity.elements)
-    .filter(element => !(element instanceof cds.Association)) // exclude associations+compositions
-    .filter(element => !!element['@cds.persistence.name']) // exclude no-persistence elements, e.g. virtual ones
-    .map (element => element['@cds.persistence.name'])
-    .sort((e1, e2) => { // sort with keys first
-      if (persistenceKeyNames.includes(e1)  && !persistenceKeyNames.includes(e2)) return -1
-      if (!persistenceKeyNames.includes(e1) && persistenceKeyNames.includes(e2))  return 1
+  const persistenceKeyNames = Object.keys(entity.keys||[])
+  return Object.entries(entity.elements)
+    .filter(([,element]) => !(element instanceof cds.Association)) // exclude associations+compositions
+    .filter(([,element]) => !!element['@cds.persistence.name']) // exclude no-persistence elements, e.g. virtual ones
+    .map (([key]) => key)
+    .sort((k1, k2) => { // sort with keys first
+      if (persistenceKeyNames.includes(k1)  && !persistenceKeyNames.includes(k2)) return -1
+      if (!persistenceKeyNames.includes(k1) && persistenceKeyNames.includes(k2))  return 1
       return 0 // preserve original order otherwise
     })
     .join(';')

package/lib/init/template/destinations/files/destination.yaml

@@ -0,0 +1 @@
+{{- include "cap.service-instance" . }}

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

@@ -0,0 +1,44 @@
+const path = require('path')
+const TemplateBase = require('../templateBase')
+const ProjectReader = require('../../util/projectReader')
+const cds = require('../../../cds'), { fs } = cds.utils
+
+module.exports = class DestinationsTemplate extends TemplateBase {
+    constructor(projectPath, generator) {
+        super(projectPath, generator, __dirname)
+        this.projectReader = new ProjectReader(this)
+    }
+
+    async run() {
+        await this.runDependentMerging()
+    }
+
+    async runDependentMerging() {
+        const projectDescriptor = await this.projectReader.read(this.options)
+        const { hasHelmDeployment, hasDestination, hasHtml5Repo } = projectDescriptor.cap
+
+        if (hasHelmDeployment) {
+            const env = await this.getEnv()
+            const binding = hasDestination && { srv: { bindings: { destination: { serviceInstanceName: 'destinations' }}}}
+            const html5Binding = hasHtml5Repo && { html5_apps_deployer: { bindings: { destination: { serviceInstanceName: 'destination' }}}}
+
+            await this.templateUtil.mergeYAML(
+                path.join(this.projectPath, 'chart', 'values.yaml'),
+                {
+                    ...binding,
+                    ...html5Binding,
+                    destination: {
+                        serviceOfferingName: 'destination',
+                        servicePlanName: 'lite',
+                        parameters: {
+                            version: '1.0.0',
+                            ...(hasHtml5Repo) && { HTML5Runtime_enabled: true }
+                        }
+                    }
+                },
+                null, { forceOverwrite: true }
+            )
+            await fs.copy(path.join(__dirname, 'files', 'destination.yaml'), path.join(this.projectPath, 'chart', 'templates', 'destination.yaml'))
+        }
+    }
+}

package/lib/init/template/enterprise-messaging/files/cds.package.json

@@ -0,0 +1,10 @@
+{
+  "cds": {
+    "requires": {
+      "messaging": {
+        "kind": "enterprise-messaging",
+        "format": "cloudevents"
+      }
+    }
+  }
+}

package/lib/init/template/enterprise-messaging/files/cds.profile.package.json.hbs

@@ -0,0 +1,12 @@
+{
+  "cds": {
+    "requires": {
+      "[{{cap.for}}]": {
+        "messaging": {
+          "kind": "enterprise-messaging",
+          "format": "cloudevents"
+        }
+      }
+    }
+  }
+}

package/lib/init/template/enterprise-messaging/files/cdsrc.json

@@ -0,0 +1,8 @@
+{
+  "requires": {
+    "messaging": {
+      "kind": "enterprise-messaging",
+      "format": "cloudevents"
+    }
+  }
+}

package/lib/init/template/enterprise-messaging/files/cdsrc.json.hbs

@@ -0,0 +1,10 @@
+{
+  "requires": {
+    "[{{cap.for}}]": {
+      "messaging": {
+        "kind": "enterprise-messaging",
+        "format": "cloudevents"
+      }
+    }
+  }
+}

package/lib/init/template/enterprise-messaging/files/event-mesh.yaml

@@ -0,0 +1 @@
+{{- include "cap.service-instance" . }}

package/lib/init/template/enterprise-messaging/files/mta.yaml.hbs

@@ -0,0 +1,13 @@
+---
+modules:
+ - name: {{cap.appName}}-srv
+   type: {{cap.pLanguage}}
+   requires:
+    - name: {{cap.appName}}-messaging
+
+resources:
+  - name: {{cap.appName}}-messaging
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: enterprise-messaging
+      service-plan: default

package/lib/init/template/enterprise-messaging/files/values.yaml

@@ -0,0 +1,8 @@
+srv:
+  bindings:
+    messaging:
+      serviceInstanceName: event-mesh
+event_mesh:
+  serviceOfferingName: enterprise-messaging
+  servicePlanName: default
+  config: event-mesh.json

package/lib/init/template/enterprise-messaging/index.js

@@ -0,0 +1,56 @@
+const path = require('path')
+const cds = require('../../../cds'), { fs } = cds.utils
+const ProjectReader = require('../../util/projectReader')
+const { srvNode, srvJava, enterpriseMessaging } = require('../_merging/registry-mta')
+
+module.exports = class EnterpriseMessagingTemplate extends require('../templateBase') {
+  constructor(projectPath, generator) {
+    super(projectPath, generator, __dirname)
+    this.projectReader = new ProjectReader(this)
+  }
+
+  async run() {
+    const projectDescriptor = await this.projectReader.read(this.options)
+    const { for: forProfile, isNodejs } = projectDescriptor.cap
+    const templatePath = path.join(__dirname, 'files')
+    const cdsTemplateFile = (isNodejs ? 'cds.package.json' : 'cdsrc.json') + (forProfile ? '.hbs' : '')
+    const cdsTemplatePath = path.join(templatePath, cdsTemplateFile)
+    const configPath = path.join(this.projectPath, isNodejs ? 'package.json' : '.cdsrc.json')
+    await this.templateUtil.mergeJSON(configPath, cdsTemplatePath, projectDescriptor)
+    await this.runDependentMerging()
+  }
+
+  async runDependentMerging() {
+    const projectDescriptor = await this.projectReader.read(this.options)
+    const { hasHelmDeployment, hasMtaDeployment, isNodejs } = projectDescriptor.cap
+
+    if (hasMtaDeployment) {
+      const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml')
+      const srv = isNodejs ? srvNode : srvJava
+      await this.templateUtil.mergeYAML(
+          mtaYAMLPath,
+          `${__dirname}/files/mta.yaml.hbs`,
+          projectDescriptor,
+          {
+              additions: [srv, enterpriseMessaging],
+              relationships: [{
+                  insert: [enterpriseMessaging, 'name'],
+                  into: [srv, 'requires', 'name']
+              }]
+          }
+      )
+    }
+
+    if (hasHelmDeployment) {
+      await this.templateUtil.mergeYAML(
+        path.join(this.projectPath, 'chart', 'values.yaml'),
+        path.join(__dirname, 'files', 'values.yaml'),
+        null, { forceOverwrite: true }
+      )
+      await fs.copy(
+         path.join(__dirname, 'files', 'event-mesh.yaml'),
+         path.join(this.projectPath, 'chart', 'templates', 'event-mesh.yaml')
+      )
+    }
+  }
+}

package/lib/init/template/extensibility/files/cdsrc.json

@@ -0,0 +1,5 @@
+{
+  "requires": {
+    "extensibility": true
+  }
+}

package/lib/init/template/extensibility/files/cdsrc.json.hbs

@@ -0,0 +1,7 @@
+{
+  "requires": {
+    "[{{cap.for}}]": {
+      "extensibility": true
+    }
+  }
+}

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

@@ -1,4 +1,4 @@
-const cds = require('../../../cds'), { path } = cds.utils
+const cds = require('../../../cds'), { fs, path } = cds.utils
 const TemplateBase = require('../templateBase')
 const ProjectReader = require('../../util/projectReader')
 
@@ -8,9 +8,18 @@ module.exports = class ExtensibilityTemplate extends TemplateBase {
     this.projectReader = new ProjectReader(this)
   }
 
+  async run() {
+    const projectDescriptor = await this.projectReader.read(this.options)
+    const { for: forProfile, isJava } = projectDescriptor.cap
+    const cdsConfigPath = path.join(this.projectPath, isJava ? '.cdsrc.json' : 'package.json')
+    const cdsTemplateFile = forProfile ? (isJava ? 'cdsrc.json.hbs' : 'cds.package.json.hbs') : (isJava ? 'cdsrc.json' : 'cds.package.json')
+    await this.templateUtil.mergeJSON(cdsConfigPath, path.join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
+    await this.runDependentMerging()
+  }
+
   async runDependentMerging() {
     const projectDescriptor = await this.projectReader.read()
-    const { hasXsuaa } = projectDescriptor.cap
+    const { hasXsuaa, hasHelmDeployment } = projectDescriptor.cap
     if (hasXsuaa) {
       await this.templateUtil.mergeJSON(
         path.join(this.projectPath, 'xs-security.json'),
@@ -33,16 +42,12 @@ module.exports = class ExtensibilityTemplate extends TemplateBase {
         }
       )
     }
-  }
-
-  async run() {
-    const projectDescriptor = await this.projectReader.read(this.options)
-    const { for: forProfile, isJava } = projectDescriptor.cap
-    const basePath = isJava ? path.join(this.projectPath, 'mtx', 'sidecar') : this.projectPath
-    const packageJSONPath = path.join(basePath, 'package.json')
-    const cdsTemplateFile = forProfile ? 'cds.package.json.hbs' : 'cds.package.json'
-    await this.templateUtil.mergeJSON(packageJSONPath, path.join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
-    await this.templateUtil.sortDependencies(packageJSONPath)
-    await this.runDependentMerging()
+    if (hasXsuaa && hasHelmDeployment) {
+      // REVISIT: Shared xs-security.json location for Helm and MTA?
+      await fs.copy(
+        path.join(this.projectPath, 'xs-security.json'),
+        path.join(this.projectPath, 'chart', 'xs-security.json')
+      )
+    }
   }
 }

package/lib/init/template/hana/files/java/cds.shortcut.json.hbs

@@ -0,0 +1,5 @@
+{
+  "requires": {
+    "db": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}"
+  }
+}

package/lib/init/template/hana/files/java/cds.shortcut.profile.json.hbs

@@ -0,0 +1,8 @@
+{
+  "requires": {
+    "[{{cap.for}}]": {
+      "db": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}"
+    },
+    "db": "{{#cap.isMultitenant}}sqlite{{/cap.isMultitenant}}{{^cap.isMultitenant}}sql{{/cap.isMultitenant}}"
+  }
+}

package/lib/init/template/hana/files/java/db/package.json

@@ -7,6 +7,7 @@
     "node": "^16"
   },
   "scripts": {
-    "start": "node node_modules/@sap/hdi-deploy/deploy.js"
+    "start": "node node_modules/@sap/hdi-deploy/deploy.js",
+    "build": "npm i && npx -p @sap/cds-dk@^6 cds build .. --for hana --production"
   }
 }

package/lib/init/template/hana/files/mta.yaml.hbs

@@ -11,6 +11,12 @@ modules:
     path: {{& cap.db.0.path}}
     parameters:
       buildpack: nodejs_buildpack
+{{#cap.isJava}}
+    build-parameters:
+      builder: custom
+      commands:
+        - npm run build
+{{/cap.isJava}}
     requires:
       - name: {{cap.appName}}-db
 {{/cap.isMultitenant}}

package/lib/init/template/hana/files/nodejs/cds.shortcut.json.hbs

@@ -0,0 +1,7 @@
+{
+  "cds": {
+    "requires": {
+      "db": "{{#cap.isMultitenant}}sql-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}"
+    }
+  }
+}

package/lib/init/template/hana/files/nodejs/cds.shortcut.profile.json.hbs

@@ -0,0 +1,10 @@
+{
+  "cds": {
+    "requires": {
+      "[{{cap.for}}]": {
+        "db": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}"
+      },
+      "db": "{{#cap.isMultitenant}}sqlite{{/cap.isMultitenant}}{{^cap.isMultitenant}}sql{{/cap.isMultitenant}}"
+    }
+  }
+}

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

@@ -0,0 +1,19 @@
+---
+srv:
+  bindings:
+    db:
+      fromSecret: null
+hana_deployer:
+  image:
+    repository: <your-container-registry>/{{cap.appName}}-hana-deployer
+    tag: latest
+  bindings:
+    hana:
+      fromSecret: null
+  resources:
+    limits:
+      cpu: 2000m
+      memory: 1G
+    requests:
+      cpu: 1000m
+      memory: 1G

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

@@ -1,4 +1,3 @@
-const fs = require('fs');
 const path = require('path');
 
 const commandUtil = require('../../util/commandUtil');
@@ -9,9 +8,10 @@ const ProjectReader = require('../../util/projectReader');
 const TemplateBase = require('../templateBase');
 const versionCompare = require('../../util/versionCompare');
 
-const { PROJECT_TYPE, OPTION_JAVA, URLS, OPTION_HELM_UPDATE } = require('../../constants');
+const { PROJECT_TYPE, OPTION_JAVA, URLS } = require('../../constants');
 const { nullLogger } = require('../../util/logger');
 const { srvNode, srvJava, hdbDeployer, serviceManager, hdiContainer, mtxSidecar } = require('../_merging/registry-mta');
+const cds = require('../../../cds'), { fs } = cds.utils
 
 module.exports = class HanaTemplate extends TemplateBase {
     constructor(projectPath, generator) {
@@ -19,10 +19,6 @@ module.exports = class HanaTemplate extends TemplateBase {
         this.projectReader = new ProjectReader(this);
     }
 
-    async getDependencies() {
-        return [OPTION_HELM_UPDATE];
-    }
-
     // read env from project
     async getEnv() {
         const cdsEnvVar = process.env.CDS_ENV;
@@ -44,12 +40,10 @@ module.exports = class HanaTemplate extends TemplateBase {
 
     async runDependentMerging() {
         const projectDescriptor = await this.projectReader.read(this.options)
-        const { hasMtaDeployment, isNodejs, isJava, isMultitenant, hasHana } = projectDescriptor.cap
+        const { hasMtaDeployment, hasHelmDeployment, isNodejs, isJava, isMultitenant } = projectDescriptor.cap
 
-        if (isNodejs && isMultitenant) {
+        if (isMultitenant) {
             await this._updateCdsConfiguration()
-        } else if (isJava && isMultitenant) {
-            await this._updateCdsrcJson()
         }
 
         if (hasMtaDeployment) {
@@ -99,6 +93,17 @@ module.exports = class HanaTemplate extends TemplateBase {
                 { additions: [...modules, db].filter(a => a), deletions, relationships }
             )
         }
+
+        if (hasHelmDeployment) {
+            await this.templateUtil.mergeYAML(
+                path.join(this.projectPath, 'chart', 'values.yaml'),
+                path.join(__dirname, 'files', 'values.yaml.hbs'),
+                projectDescriptor, { forceOverwrite: true })
+            await fs.copy(
+                path.join(__dirname, 'files', 'hana-deployer-job.yaml'),
+                path.join(this.projectPath, 'chart', 'templates', 'hana-deployer-job.yaml')
+            )
+        }
     }
 
     async run() {
@@ -117,7 +122,7 @@ module.exports = class HanaTemplate extends TemplateBase {
             case PROJECT_TYPE.java: {
                 await this.templateUtil.copyFiles(path.join('java', 'db'), path.join(this.projectPath, env.folders.db), {}, this.options.force);
                 await this._updatePomXml();
-                await this._updateCdsrcJson();
+                await this._updateCdsConfiguration();
                 break;
             }
             case PROJECT_TYPE.nodejs: {
@@ -157,27 +162,22 @@ module.exports = class HanaTemplate extends TemplateBase {
             await this.fsUtil.writeJSON(packageJsonPath, packageJson);
         }
 
-        await this._updateCdsConfiguration(packageJsonPath)
+        await this._updateCdsConfiguration()
     }
 
-    async _updateCdsConfiguration() {
-        const packageJsonPath = path.join(this.projectPath, 'package.json')
-        const projectDescriptor = await this.projectReader.read(this.options);
-        const { for: forProfile } = projectDescriptor.cap;
-        const cdsTemplateFile = forProfile ? 'cds.profile.package.json.hbs' : 'cds.package.json.hbs';
-        const cdsTemplatePath = path.join(__dirname, 'files', 'nodejs', cdsTemplateFile);
-        await this.templateUtil.mergeJSON(packageJsonPath, cdsTemplatePath, projectDescriptor, { forceOverwrite: true })
-    }
-
-    async _updateCdsrcJson() {
-        const cdsrcJsonPath = path.join(this.projectPath, '.cdsrc.json');
+    async _updateCdsConfiguration(configPath) {
+        const projectType = await this.getProjectType();
+        const configFile = projectType === PROJECT_TYPE.nodejs ? 'package.json' : '.cdsrc.json';
+        configPath = configPath ?? path.join(this.projectPath, configFile)
         const projectDescriptor = await this.projectReader.read(this.options);
         const { for: forProfile } = projectDescriptor.cap;
-        const cdsTemplateFile = forProfile ? 'profile.cdsrc.json.hbs' : 'cdsrc.json.hbs';
-        const cdsTemplatePath = path.join(__dirname, 'files', 'java', cdsTemplateFile);
-        if (!fs.existsSync(cdsrcJsonPath)) {
-            this.fsUtil.writeJSON(cdsrcJsonPath, {})
-        }
-        await this.templateUtil.mergeJSON(cdsrcJsonPath, cdsTemplatePath, projectDescriptor, { forceOverwrite: true });
+        let json; try { json = await this.fsUtil.readJSON(configPath) } catch { /* ignore */ }
+        const _cds = projectType === PROJECT_TYPE.nodejs ? json?.cds : json;
+        const shortcut = typeof _cds?.requires?.db === 'string' || !json ? 'shortcut.' : '';
+        const profile = forProfile ? 'profile.' : '';
+        const cdsTemplateFile = `cds.${shortcut}${profile}json.hbs`
+        const { pLanguage } = projectDescriptor.cap;
+        const cdsTemplatePath = path.join(__dirname, 'files', pLanguage, cdsTemplateFile);
+        await this.templateUtil.mergeJSON(configPath, cdsTemplatePath, projectDescriptor, { forceOverwrite: true })
     }
 }

package/lib/{k8s/resources → init/template}/helm/chart/templates/_helpers.tpl

@@ -23,15 +23,14 @@ Check for mandatory configuration options
 Labels for a component
 */}}
 {{- define "cap.labels" -}}
-helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}
+helm.sh/revision: {{ .Release.Revision | quote }}
+helm.sh/chart: {{ printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
 app.kubernetes.io/name: {{ .name }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 app.kubernetes.io/instance: {{ .Release.Name }}
+{{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion }}
-{{- end -}}
-{{- define "cap.labelsWithRevision" -}}
-{{- include "cap.labels" . }}
-revision: "{{ .Release.Revision }}"
+{{- end }}
 {{- end -}}
 
 {{/*

package/lib/init/template/helm/files/Chart.yaml.hbs

@@ -0,0 +1,13 @@
+---
+#
+# This file is generated by "cds add helm"
+apiVersion: v2
+name: {{cap.appName}}
+description: {{cap.appDescription}}
+type: application
+version: {{cap.appVersion}}
+appVersion: {{cap.appVersion}}
+dependencies:
+  - name: web-application
+    alias: srv
+    version: 0.1.0

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

@@ -0,0 +1,26 @@
+---
+global:
+  domain: null
+  imagePullSecret: {}
+srv:
+  bindings: {}
+  image:
+    repository: <your-container-registry>/{{cap.appName}}-srv
+    tag: latest
+  {{#cap.isJava}}
+  env:
+    SPRING_PROFILES_ACTIVE: cloud
+  {{/cap.isJava}}
+  resources:
+    limits:
+      ephemeral-storage: 1G
+      memory: {{#cap.isJava}}1G{{/cap.isJava}}{{^cap.isJava}}500M{{/cap.isJava}}
+    requests:
+      ephemeral-storage: 1G
+      cpu: {{#cap.isJava}}1000m{{/cap.isJava}}{{^cap.isJava}}500m{{/cap.isJava}}
+      memory: {{#cap.isJava}}1G{{/cap.isJava}}{{^cap.isJava}}500M{{/cap.isJava}}
+  health_check:
+    liveness:
+      path: /
+    readiness:
+      path: /