@sap/cds-dk 7.4.0 → 7.5.0

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

@@ -1,49 +1,43 @@
 const YAML = require('@sap/cds-foss')('yaml')
-const { join } = require('path')
 const cds = require('../../../cds')
 const { read } = cds.utils
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON, mergeYAML } = require('../../util/merge')
-const { parseMd5File, writeMd5File } = require('../../util/md5')
-const { srvNode4, srvJava4, enterpriseMessaging } = require('../_merging/registry-mta')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { srv4, enterpriseMessaging } = require('../../registries/mta')
 
-module.exports = class EnterpriseMessagingTemplate extends require('../templateBase') {
+module.exports = class EnterpriseMessagingTemplate extends require('../../plugin') {
 
   async canRun() {
-    const { isJava } = await readProject()
+    const { isJava } = readProject()
     if (isJava) throw `'cds add enterprise-messaging' is not available for Java yet`
     return true
   }
 
-  static hasFacet(env) {
+  static hasInProduction(env) {
     return env.requires?.messaging?.kind === 'enterprise-messaging-http'
   }
 
   async run() {
-    const project = await readProject()
+    const project = readProject()
     const { configFile } = project
-    await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
-    await mergeJSON('event-mesh.json', join(__dirname, 'files', 'event-mesh.json.hbs'), project)
+    await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project })
+    await merge(__dirname, 'files/event-mesh.json.hbs').into('event-mesh.json', { with: project })
   }
 
-  async runDependentMerging(context = {}) {
-    const project = await readProject()
-    const { hasXsuaa, hasHelm, hasMta, isNodejs, srvPath, appName } = project
+  async combine() {
+    const project = readProject()
+    const { hasXsuaa, hasHelm, hasHelmUnifiedRuntime, hasMta, srvPath, appName } = project
 
     if (hasMta) {
-      const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)
-      await mergeYAML(
-          'mta.yaml',
-          join(__dirname, 'files', 'mta.yaml.hbs'),
+      const srv = srv4(srvPath)
+      await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
           project,
-          {
-              additions: [srv, enterpriseMessaging],
-              relationships: [{
-                  insert: [enterpriseMessaging, 'name'],
-                  into: [srv, 'requires', 'name']
-              }]
-          }
-      )
+          additions: [srv, enterpriseMessaging],
+          relationships: [{
+              insert: [enterpriseMessaging, 'name'],
+              into: [srv, 'requires', 'name']
+          }]
+      })
     }
 
     if (hasXsuaa) {
@@ -52,41 +46,15 @@ module.exports = class EnterpriseMessagingTemplate extends require('../templateB
       } else {
         project['em-service-name'] = `${appName}-messaging`
       }
-      await mergeJSON(
-        'xs-security.json',
-        join(__dirname, 'files', 'xs-security.json.hbs'),
+      await merge(__dirname, 'files/xs-security.json.hbs').into('xs-security.json', {
         project,
-        {
-          additions: [{
-            in: 'scopes',
-            where: [{ property: 'name', isEqualTo: '$XSAPPNAME.emcallback' }],
-          }, {
-            in: 'scopes',
-            where: [{ property: 'name', isEqualTo: '$XSAPPNAME.emmanagement' }],
-          }]
-        }
-      )
+        additions: [{ in: 'scopes', where: { name: '$XSAPPNAME.emcallback' }},
+                    { in: 'scopes', where: { name: '$XSAPPNAME.emmanagement' }}]
+      })
     }
 
-    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.oldTrackingData = context.newTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'))
-      }
-
-      await mergeYAML(join('chart', 'values.yaml'), join(__dirname, 'files', 'values.yaml'))
-
-      // copy service instance chart if it is not present
-      const HelmTemplate = require(`../helm`);
-      const helmTemplate = new HelmTemplate(context.oldTrackingData, context.newTrackingData);
-      isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('service-instance');
-
-      // add dependency entry in chart.yaml
-      await helmTemplate.addDependency('service-instance', 'event-mesh');
-
-      if(isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData)
+    if (hasHelm || hasHelmUnifiedRuntime) {
+      await merge(__dirname, 'files', 'values.yaml').into('chart/values.yaml')
     }
   }
 }

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

@@ -1,63 +1,47 @@
-const { join } = require('path')
 const cds = require('../../../cds')
 const { read } = cds.utils
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON, mergeYAML } = require('../../util/merge')
-const { parseMd5File, writeMd5File } = require('../../util/md5')
-const { srvNode4, srvJava4, enterpriseMessaging } = require('../_merging/registry-mta')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { srv4, enterpriseMessaging } = require('../../registries/mta')
 
-module.exports = class EnterpriseMessagingSharedTemplate extends require('../templateBase') {
+module.exports = class EnterpriseMessagingSharedTemplate extends require('../../plugin') {
 
   async canRun() {
-    const { isJava } = await readProject()
+    const { isJava } = readProject()
     if (isJava) throw `'cds add enterprise-messaging-shared' is not available for Java yet`
     return true
   }
 
-  static hasFacet(env) {
+  static hasInProduction(env) {
     return env.requires?.messaging?.kind === 'enterprise-messaging-amqp'
   }
 
   async run() {
-    const project = await readProject()
+    const project = readProject()
     const { configFile } = project
     project.shortcut = !(await read(configFile)).cds?.requires?.messaging?.kind
-    await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
-    await mergeJSON('event-mesh.json', join(__dirname, 'files', 'event-mesh.json.hbs'), project)
+    await merge(__dirname, 'files/package.json.hbs').into(configFile, { project })
+    await merge(__dirname, 'files/event-mesh.json.hbs').into('event-mesh.json', { project })
   }
 
-  async runDependentMerging(context = {}) {
-    const project = await readProject()
-    const { hasMta, hasHelm, isNodejs, srvPath } = project
+  async combine() {
+    const project = readProject()
+    const { hasMta, hasHelm, hasHelmUnifiedRuntime, srvPath } = project
 
     if (hasMta) {
-      const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)
-      await mergeYAML(
-          'mta.yaml',
-          join(__dirname, 'files', 'mta.yaml.hbs'),
-          project,
-          {
-              additions: [srv, enterpriseMessaging],
-              relationships: [{
-                  insert: [enterpriseMessaging, 'name'],
-                  into: [srv, 'requires', 'name']
-              }]
-          }
-      )
+      const srv = srv4(srvPath)
+      await merge(__dirname, 'files', 'mta.yaml.hbs').into('mta.yaml', {
+        project,
+        additions: [srv, enterpriseMessaging],
+        relationships: [{
+            insert: [enterpriseMessaging, 'name'],
+            into: [srv, 'requires', 'name']
+        }]
+      })
     }
 
-    if (hasHelm) {
-      let isIndependentCommand = false
-      if (Object.keys(context).length == 0){
-          isIndependentCommand = true
-          context.oldTrackingData = context.newTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'))
-      }
-      await mergeYAML(join('chart', 'values.yaml'), join(__dirname, 'files', 'values.yaml'))
-      const HelmTemplate = require(`../helm`);
-      const helmTemplate = new HelmTemplate(context.oldTrackingData, context.newTrackingData);
-      isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('service-instance');
-      await helmTemplate.addDependency('service-instance', 'event-mesh');
-      if (isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData)
+    if (hasHelm || hasHelmUnifiedRuntime) {
+      await merge(__dirname, 'files/values.yaml').into('chart/values.yaml')
     }
   }
 }

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

@@ -1,52 +1,38 @@
 const cds = require('../../../cds')
 const { exists } = cds.utils
-const { join } = require('path')
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON } = require('../../util/merge')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
 const { MULTITENANCY } = require('../../constants').OPTIONS
 
-module.exports = class ExtensibilityTemplate extends require('../templateBase') {
+module.exports = class ExtensibilityTemplate extends require('../../plugin') {
 
 
-  getDependencies() {
+  requires() {
     return exists('pom.xml') ? [MULTITENANCY] : [] // REVISIT: Remove this dependency
   }
 
-  getRelatedFacets() {
-    return ['approuter']
-  }
-
-  static hasFacet(env) {
+  static hasInProduction(env) {
     return !!env.requires?.extensibility
   }
 
   async run() {
-    const project = await readProject()
+    const project = readProject()
     const { configFile } = project
-    await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
+    await merge(__dirname, 'files/package.json.hbs').into(configFile, { project })
   }
 
-  async runDependentMerging() {
-    const project = await readProject()
+  async combine() {
+    const project = readProject()
     const { hasXsuaa } = project
     if (hasXsuaa) {
-      await mergeJSON(
-        'xs-security.json',
-        join(__dirname, 'files', 'xs-security.json.hbs'),
+      await merge(__dirname, 'files', 'xs-security.json.hbs').into('xs-security.json', {
         project,
-        {
-          additions: [{
-            in: 'scopes',
-            where: [{ property: 'name', isEqualTo: '$XSAPPNAME.cds.ExtensionDeveloper' }],
-          }, {
-            in: 'scopes',
-            where: [{ property: 'name', isEqualTo: '$XSAPPNAME.cds.UIFlexDeveloper' }],
-          }, {
-            in: 'role-templates',
-            where: [{ property: 'name', isEqualTo: 'ExtensionDeveloper' }],
-          }]
-        }
-      )
+        additions: [
+          { in: 'scopes', where: { name: '$XSAPPNAME.cds.ExtensionDeveloper' }},
+          { in: 'scopes', where: { name: '$XSAPPNAME.cds.UIFlexDeveloper' }},
+          { in: 'role-templates', where: { name: 'ExtensionDeveloper' }}
+        ]
+      })
     }
   }
 }

package/lib/init/template/file-based-messaging/index.js

@@ -1,24 +1,23 @@
-const { join } = require('path')
 const cds = require('../../../cds'), { read } = cds.utils
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON } = require('../../util/merge')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
 
-module.exports = class FileBasedMessagingTemplate extends require('../templateBase') {
+module.exports = class FileBasedMessagingTemplate extends require('../../plugin') {
 
   async canRun() {
-    const { isJava } = await readProject()
+    const { isJava } = readProject()
     if (isJava) throw `'cds add file-based-messaging' is not available for Java yet`
     return true
   }
 
-  static hasFacet(env) {
+  static hasInProduction(env) {
     return env.requires?.messaging?.kind === 'file-based-messaging'
   }
 
   async run() {
-    const project = await readProject()
+    const project = readProject()
     const { configFile } = project
     project.shortcut = !(await read(configFile)).cds?.requires?.messaging?.kind
-    await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
+    await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project })
   }
 }

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

@@ -1,11 +1,11 @@
-const mvn = require('../../util/mvn')
-const { readProject } = require('../../util/projectReader')
+const mvn = require('../../mvn')
+const { readProject } = require('../../projectReader')
 const { H2 } = require('../../constants').OPTIONS
 
-module.exports = class H2Template extends require('../templateBase') {
+module.exports = class H2Template extends require('../../plugin') {
 
   async canRun() {
-    const { isNodejs } = await readProject()
+    const { isNodejs } = readProject()
     if (isNodejs) throw `'cds add ${H2}' is not available for Node.js`
     return true
   }

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

@@ -6,7 +6,7 @@ modules:
     requires:
       - name: {{appName}}-db
 
-{{^isMultitenant}}
+{{^hasMultitenancy}}
   - name: {{appName}}-db-deployer
     type: hdb
     path: {{& db.path}}
@@ -20,27 +20,27 @@ modules:
 {{/isJava}}
     requires:
       - name: {{appName}}-db
-{{/isMultitenant}}
+{{/hasMultitenancy}}
 
-{{#isMultitenant}}
+{{#hasMultitenancy}}
   - name: {{appName}}-mtx
     type: nodejs
     path: {{#isNodejs}}gen/{{/isNodejs}}mtx/sidecar
     requires:
       - name: {{appName}}-db
-{{/isMultitenant}}
+{{/hasMultitenancy}}
 
 resources:
   - name: {{appName}}-db
-    {{^isMultitenant}}
+    {{^hasMultitenancy}}
     type: com.sap.xs.hdi-container
     parameters:
       service: hana
       service-plan: hdi-shared
-    {{/isMultitenant}}
-    {{#isMultitenant}}
+    {{/hasMultitenancy}}
+    {{#hasMultitenancy}}
     type: org.cloudfoundry.managed-service
     parameters:
       service: service-manager
       service-plan: container
-    {{/isMultitenant}}
+    {{/hasMultitenancy}}

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

@@ -1,35 +1,28 @@
 const { join } = require('path')
 const cds = require('../../../cds')
-const { read, write, exists, rmdir, copy } = cds.utils
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON, mergeYAML, removeFromYAML, removeFromYAMLArray } = require('../../util/merge')
-const mvn = require('../../util/mvn')
-const { parseMd5File, writeMd5File } = require('../../util/md5')
+const { read, write, exists, copy, rimraf } = cds.utils
+const { readProject } = require('../../projectReader')
+const { merge, removeFromYAML, removeFromYAMLArray } = require('../../merge')
+const mvn = require('../../mvn')
 
 const { OPTIONS: { JAVA } } = require('../../constants')
 
-const { srvNode4, srvJava4, hdbDeployer, serviceManager, hdiContainer, mtxSidecar4 } = require('../_merging/registry-mta')
+const { srv4, hdbDeployer, serviceManager, hdiContainer, mtxSidecar4 } = require('../../registries/mta')
 
-module.exports = class HanaTemplate extends require('../templateBase') {
+module.exports = class HanaTemplate extends require('../../plugin') {
 
-    static hasFacet(env) {
+    static hasInProduction(env) {
         return env.requires?.db?.kind === 'hana'
     }
 
     async run() {
-        const project = await readProject()
+        const project = readProject()
         const { isJava, configFile, db } = project
         project.shortcut = !(await read(configFile)).cds?.requires?.db?.kind
 
-        // REVISIT: Let cds build generate by default
-        const hdiConfigPath = join(db.folder, 'src', '.hdiconfig')
-        const hdiConfigTemplatePath = join(__dirname, 'files', 'src', '.hdiconfig')
-        await mergeJSON(hdiConfigPath, hdiConfigTemplatePath)
-
-        // REVISIT: Let csd build generate by default
-        const undeployJSONPath = join(db.folder, 'undeploy.json')
-        const undeployJSONTemplatePath = join(__dirname, 'files', 'undeploy.json')
-        await mergeJSON(undeployJSONPath, undeployJSONTemplatePath)
+        // REVISIT: Let cds build generate those by default
+        await merge(__dirname, 'files/src/.hdiconfig').into(join(db.folder, 'src/.hdiconfig'))
+        await merge(__dirname, 'files/undeploy.json').into(join(db.folder, 'undeploy.json'))
 
         if (isJava) {
             await copy(join(__dirname, 'files', 'db')).to(db.folder)
@@ -38,7 +31,7 @@ module.exports = class HanaTemplate extends require('../templateBase') {
             if (!cds.cli.options.add.has(JAVA)) await mvn.execMvn(mvn.getAddHanaCmdArgs())
         }
 
-        await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project, { forceOverwrite: true }) // REVISIT: forceOverwrite: true as default?
+        await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project, forceOverwrite: true }) // REVISIT: forceOverwrite: true as default?
 
         const packageJson = exists('package.json') ? await read('package.json') : null
         if (packageJson?.dependencies) {
@@ -47,14 +40,14 @@ module.exports = class HanaTemplate extends require('../templateBase') {
         }
     }
 
-    async runDependentMerging(context = {}) {
-        const project = await readProject()
-        const { hasMta, hasHelm, hasHtml5Repo, isJava, isMultitenant, srvPath } = project
+    async combine() {
+        const project = readProject()
+        const { hasMta, hasHelm, hasHelmUnifiedRuntime, hasHtml5Repo, isJava, hasMultitenancy, srvPath } = project
 
         if (hasMta) {
-            const srv = (isJava ? srvJava4 : srvNode4)(srvPath)
-            const db = isMultitenant ? serviceManager : hdiContainer
-            const deletions = isMultitenant ? [{
+            const srv = srv4(srvPath)
+            const db = hasMultitenancy ? serviceManager : hdiContainer
+            const deletions = hasMultitenancy ? [{
                 item: hdbDeployer,
                 relationships: [{
                     removeProperty: 'name',
@@ -73,7 +66,7 @@ module.exports = class HanaTemplate extends require('../templateBase') {
                 into: [srv, 'requires', 'name']
             }]
 
-            if (isMultitenant) {
+            if (hasMultitenancy) {
                 relationships.push({
                     insert: [serviceManager, 'name'],
                     into: [mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar'), 'requires', 'name']
@@ -85,104 +78,25 @@ module.exports = class HanaTemplate extends require('../templateBase') {
                 })
             }
 
-            const modules = isMultitenant ? [srv] : [srv, hdbDeployer]
+            const modules = hasMultitenancy ? [srv] : [srv, hdbDeployer]
 
-            await mergeYAML('mta.yaml', join(__dirname, 'files', 'mta.yaml.hbs'), project, {
+            await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project,
                 additions: [...modules, db].filter(a => a), deletions, relationships
             })
         }
 
-        if (hasHelm) {
-            //in case facet is being added to the already exisiting charts folder
-            let shouldUpdateTrackingFile = false;
-            if(Object.keys(context).length == 0){
-                shouldUpdateTrackingFile = true;
-                context.oldTrackingData = context.newTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'));
-            }
-
-            const HelmTemplate = require(`../helm`);
-            const helmTemplate = new HelmTemplate(context.oldTrackingData, context.newTrackingData);
-
-            if(isMultitenant){
-                shouldUpdateTrackingFile = true;
-
-                // remove hana entries from values.yaml
-                await removeFromYAML(join('chart', 'values.yaml'), ['hana-deployer', 'srv.bindings.db', 'hana']);
+        if (hasHelm || hasHelmUnifiedRuntime) {
+            if (hasMultitenancy) {
+                await removeFromYAML(join('chart', 'values.yaml'), ['hana-deployer', 'srv.bindings.db', 'hana'])
+                await removeFromYAMLArray(join('chart', 'Chart.yaml'), 'dependencies', 'hana')
+                await removeFromYAMLArray(join('chart', 'Chart.yaml'), 'dependencies', 'hana-deployer')
 
-                // remove hana entries from Chart.yaml
-                await removeFromYAMLArray(join('chart', 'Chart.yaml'), 'dependencies', 'hana-deployer');
-
-                // remove content-deployment subchart if html5Repo doesn't exist
-                if(!hasHtml5Repo) {
-                    const contentDeploymentEntriesPattern = "charts/content-deployment/"
-                    this.removeEntriesFromContext(context, contentDeploymentEntriesPattern);
-
-                    const contentDeploymentSubchartPath = join('chart', 'charts', 'content-deployment');
-                    if(exists(contentDeploymentSubchartPath)) {
-                        await rmdir(contentDeploymentSubchartPath);
-                    }
+                if (!hasHtml5Repo) {
+                    await rimraf('chart/charts/content-deployment') // REVISIT: Move to build task
                 }
-
-                //remove dependency since mtx plugin is added
-                const isInternal = await helmTemplate.isInternal();
-                await mergeYAML(
-                    join('chart', 'Chart.yaml'),
-                    {
-                        dependencies: [
-                            {
-                                name: 'service-instance',
-                                alias: 'hana',
-                                version: '>0.0.0',
-                                ...(isInternal) && { repository: 'https://int.repositories.cloud.sap/artifactory/virtual-unified-runtime-helm-dmz' }
-                            }
-                        ]
-                    },
-                    project,
-                    { deletions: [{
-                        item: {
-                            in: `dependencies`,
-                            where: [{
-                                property: 'alias',
-                                isEqualTo: 'hana'
-                            }]
-                        }
-                    }]}
-                )
             } else {
-                await mergeYAML(
-                    join('chart', 'values.yaml'),
-                    join(__dirname, 'files', 'values.yaml.hbs'),
-                    project
-                )
-
-                // copy content deployment chart if it is not present
-                shouldUpdateTrackingFile = shouldUpdateTrackingFile | await helmTemplate.addSubChart('content-deployment');
-
-                // add dependency entry in chart.yaml
-                await helmTemplate.addDependency('content-deployment', 'hana-deployer');
-
-                // add service instance chart if it is not present
-                shouldUpdateTrackingFile = shouldUpdateTrackingFile | await helmTemplate.addSubChart('service-instance');
-
-                // add dependency entry in chart.yaml
-                await helmTemplate.addDependency('service-instance', 'hana');
+                await merge(__dirname, 'files', 'values.yaml.hbs').into('chart/values.yaml', { with: project })
             }
-            if(shouldUpdateTrackingFile) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData);
         }
     }
-
-    // REVISIT: tracking data massaging is getting too much -> revisit md5 tracking
-    removeEntriesFromContext(context, key) {
-        Object.keys(context.oldTrackingData).forEach(fileName => {
-            if (fileName.startsWith(key)) {
-              delete context.oldTrackingData[fileName]
-            }
-        })
-
-        Object.keys(context.newTrackingData).forEach(fileName => {
-            if (fileName.startsWith(key)) {
-              delete context.newTrackingData[fileName]
-            }
-        })
-    }
 }

package/lib/init/template/helm/files/chart/templates/NOTES.txt

@@ -0,0 +1,12 @@
+{{- printf "Thank you for installing %s version %s." .Chart.Name .Chart.Version }}
+
+{{ printf "The release %s is installed in namespace %s." .Release.Name .Release.Namespace }}
+
+Your services are available at:
+{{- $root := . }}
+{{- range $name := include "cap.deploymentNames" . | split ";" }}
+  {{- $deployment := (get $root.Values $name) }}
+  {{- $ := merge (dict "name" $name "deployment" $deployment) $root }}
+  {{- $url := include "cap.deploymentHostFull" $ }}
+  {{ printf "%s - https://%s" $name $url }}
+{{- end }}