@sap/cds-dk 7.4.0 → 7.5.0

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

@@ -1,28 +1,10 @@
 const { join } = require('path');
 const cds = require('../../../cds')
-const { exists, rimraf } = cds.utils
-const { readProject } = require('../../util/projectReader');
-const { mergeYAML } = require('../../util/merge')
-const { parseMd5File, writeMd5File, copyAndTrack } = require('../../util/md5')
+const { exists, rimraf, copy } = cds.utils
+const { readProject } = require('../../projectReader');
+const { merge } = require('../../merge')
 
-module.exports = class HelmTemplate extends require('../templateBase') {
-
-    constructor(oldTrackingData = undefined, newTrackingData = {}) {
-        super()
-        this.oldTrackingData = oldTrackingData;
-        this.newTrackingData = newTrackingData;
-    }
-
-    getRelatedFacets() {
-        return ['hana', 'xsuaa', 'enterprise-messaging', 'enterprise-messaging-shared', 'destination' , 'multitenancy', 'extensibility', 'approuter', 'connectivity']
-    }
-
-    static hasFacet() {
-        // REVISIT: this works, but could be semantically nicer with a 'shouldRunDependentMerging' or the like
-        const { add } = cds.cli.options
-        if (add.has('mta') && !add.has('helm')) return false
-        return exists(join('chart', 'values.yaml'))
-    }
+module.exports = class HelmTemplate extends require('../../plugin') {
 
     async canRun() {
         if (cds.cli.options.force) {
@@ -32,76 +14,93 @@ module.exports = class HelmTemplate extends require('../templateBase') {
         return true
     }
 
-    async addSubChart(subchart, force = false) {
-        const subchartPath = join('chart', 'charts', subchart);
-        const isInternal = !force && await this.isInternal();
-        if(!exists(subchartPath) && !isInternal) {
-            await copyAndTrack(
-                join(__dirname, 'subcharts', subchart),
-                subchartPath,
-                this
-            )
-
-            return true;
-        }
-
-        return false;
+    static hasInProduction() {
+        const { add } = cds.cli.options
+        return exists(join('chart', 'charts', 'web-application')) && exists(join('chart', 'values.yaml') || add.has('helm'))
     }
 
-    async isInternal() {
-        return !exists(join('chart', 'charts', 'web-application')) || cds.cli.options['internal-unified-runtime-charts'];
-    }
+    async run() {
+        const project = readProject()
+        await copy(join(__dirname, 'files', 'chart')).to('chart')
+        await merge(__dirname, 'files/Chart.yaml.hbs').into('chart/Chart.yaml', { with: project })
+        await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project })
+        await this._mergeDependency('web-application', 'srv')
 
-    async addDependency(name, alias){
-        const project = await readProject();
-        const isInternal = await this.isInternal();
-        await mergeYAML(
-            join('chart', 'Chart.yaml'),
-            {
-                dependencies: [
-                    {
-                        name,
-                        alias,
-                        version: '>0.0.0',
-                        ...(isInternal) && { repository: 'https://int.repositories.cloud.sap/artifactory/virtual-unified-runtime-helm-dmz' }
-                    }
-                ]
-            },
-            project,
-            { additions: [{
-                in: `dependencies`,
-                where: [{
-                    property: 'alias',
-                    isEqualTo: alias
-                }]
-            }]}
-        )
+        await copy(join(__dirname, 'files', 'web-application')).to('chart/charts/web-application')
     }
 
-    async run() {
-        const project = await readProject()
-        const isInternal = cds.cli.options['internal-unified-runtime-charts'] !== undefined && cds.cli.options['internal-unified-runtime-charts'];
-        this.oldTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'));
-        await this.addSubChart('web-application', !isInternal);
-        await copyAndTrack(
-            join(__dirname, 'chart'),
-            join('chart'),
-            this
-        )
+    async combine() {
+        const { hasDestination, hasEnterpriseMessaging, hasHana, hasMultitenancy, hasXsuaa, hasHtml5Repo, hasApprouter } = readProject()
+        let hasContentDeployment = false
 
-        await mergeYAML(
-            join('chart', 'Chart.yaml'),
-            join(__dirname, 'files', 'Chart.yaml.hbs'),
-            project
-        )
+        if (!exists('chart/charts/service-instance') && (hasHtml5Repo || hasMultitenancy || hasDestination || hasEnterpriseMessaging || hasXsuaa || hasHana)) {
+            await copy(join(__dirname, 'files', 'service-instance')).to('chart/charts/service-instance')
+        }
+        if (hasApprouter) {
+            await this._mergeDependency('web-application', 'approuter')
+        }
 
-        await this.addDependency('web-application', 'srv');
+        if (hasHtml5Repo) {
+            hasContentDeployment = true
+            await this._mergeDependency('service-instance', 'html5-apps-repo-host')
+            await this._mergeDependency('content-deployment', 'html5-apps-deployer')
 
-        await mergeYAML(
-            join('chart', 'values.yaml'),
-            join(__dirname, 'files', 'values.yaml.hbs'),
-            project
-        )
-        await writeMd5File(join('chart', '.cds-add-helm-files.md5'), this.newTrackingData);
+            if (hasApprouter) {
+                await this._mergeDependency('service-instance', 'html5-apps-repo-runtime')
+                await merge({
+                    'html5-apps-repo-runtime': {
+                        serviceOfferingName: 'html5-apps-repo',
+                        servicePlanName: 'app-runtime'
+                    },
+                    approuter: {
+                        bindings: {
+                            'html5-apps-repo-runtime': { serviceInstanceName: 'html5-apps-repo-runtime' }
+                        }
+                    },
+                }).into('chart/values.yaml')
+            }
+        }
+        if (hasMultitenancy) {
+            await this._mergeDependency('web-application', 'sidecar')
+            await this._mergeDependency('service-instance', 'saas-registry')
+        }
+        if (hasDestination) {
+            await this._mergeDependency('service-instance', 'destination')
+        }
+        if (hasEnterpriseMessaging) {
+            await this._mergeDependency('service-instance', 'event-mesh')
+        }
+        if (hasXsuaa) {
+            await this._mergeDependency('service-instance', 'xsuaa')
+        }
+        if (hasHana) {
+            if (hasMultitenancy) {
+                await this._mergeDependency('service-instance', 'service-manager')
+            } else {
+                hasContentDeployment = true
+                await this._mergeDependency('service-instance', 'hana')
+                await this._mergeDependency('content-deployment', 'hana-deployer')
+            }
+        }
+        if(!exists('chart/charts/content-deployment') && hasContentDeployment) {
+            await copy(join(__dirname, 'files', 'content-deployment')).to('chart/charts/content-deployment')
+        }
+    }
+
+    async _mergeDependency(name, alias) {
+        const project = readProject()
+        await merge({
+            dependencies: [{
+                name,
+                alias,
+                version: '>0.0.0'
+            }]
+        }).into('chart/Chart.yaml', {
+            project,
+            additions: [{
+                in: 'dependencies',
+                where: { alias }
+            }]
+        })
     }
 }

package/lib/init/template/helm-unified-runtime/files/Chart.yaml.hbs

@@ -0,0 +1,10 @@
+---
+#
+# This file is generated by "cds add helm"
+apiVersion: v2
+name: {{appName}}
+description: {{appDescription}}
+type: application
+version: {{appVersion}}
+appVersion: {{appVersion}}
+

package/lib/init/template/helm-unified-runtime/files/values.yaml.hbs

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

package/lib/init/template/helm-unified-runtime/index.js

@@ -0,0 +1,91 @@
+const cds = require('../../..')
+const { copy, rimraf, exists } = cds.utils
+const { join } = require('path')
+
+// cds.build?.register('helm-unified-runtime', {
+//   impl: '@cap-js-community/helm-unified-runtime/lib/build.js'
+// })
+
+const { merge, readProject } = cds.add ?? {}
+
+module.exports = class HelmUnifiedRuntimeTemplate extends cds.add.Plugin {
+
+  async canRun() {
+    if (cds.cli.options.force) {
+        await rimraf(join('chart'))
+        return true
+    }
+    return true
+  }
+
+  static hasInProduction() {
+      return exists(join('chart', 'values.yaml')) && !exists(join('chart', 'charts', 'web-application')) || cds.cli.options.add.has('helm-unified-runtime')
+  }
+
+  async run() {
+    const project = readProject()
+
+    await merge(__dirname, 'files/Chart.yaml.hbs').into('chart/Chart.yaml', { with: project })
+    await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project })
+
+    await copy(join(__dirname, 'files', 'templates')).to('chart/templates') // REVISIT: Move to build
+    await copy(join(__dirname, 'files', 'values.schema.json')).to('chart/values.schema.json') // REVISIT: Move to build (if possible)
+    await copy(join(__dirname, 'files', 'values.root.schema.json')).to('chart/values.root.schema.json') // REVISIT: Move to build (if possible)
+
+    await this._mergeDependency('web-application', 'srv')
+  }
+
+  async combine() {
+    const { hasDestination, hasEnterpriseMessaging, hasHana, hasMultitenancy, hasXsuaa, hasHtml5Repo, hasApprouter } = readProject()
+
+    if (hasApprouter) {
+      await this._mergeDependency('web-application', 'approuter')
+    }
+    if (hasHtml5Repo) {
+      await this._mergeDependency('service-instance', 'html5-apps-repo-host')
+      await this._mergeDependency('content-deployment', 'html5-apps-deployer')
+      if (hasApprouter) {
+        await this._mergeDependency('service-instance', 'html5-apps-repo-runtime')
+      }
+    }
+    if (hasMultitenancy) {
+      await this._mergeDependency('web-application', 'sidecar')
+      await this._mergeDependency('service-instance', 'saas-registry')
+    }
+    if (hasDestination) {
+      await this._mergeDependency('service-instance', 'destination')
+    }
+    if (hasEnterpriseMessaging) {
+      await this._mergeDependency('service-instance', 'event-mesh')
+    }
+    if (hasXsuaa) {
+      await this._mergeDependency('service-instance', 'xsuaa')
+    }
+    if (hasHana) {
+      if (hasMultitenancy) {
+        await this._mergeDependency('service-instance', 'service-manager')
+      } else {
+        await this._mergeDependency('service-instance', 'hana')
+        await this._mergeDependency('content-deployment', 'hana-deployer')
+      }
+    }
+  }
+
+  async _mergeDependency(name, alias) {
+    const project = readProject()
+    await merge({
+      dependencies: [{
+          name,
+          alias,
+          version: '>0.0.0',
+          repository: 'https://int.repositories.cloud.sap/artifactory/virtual-unified-runtime-helm-dmz'
+      }]
+    }).into('chart/Chart.yaml', {
+      with: project,
+      additions: [{
+          in: 'dependencies',
+          where: { alias }
+      }]}
+    )
+  }
+}

package/lib/init/template/helm-unified-runtime/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@cap-js-community/helm-unified-runtime",
+  "version": "1.0.0"
+}

package/lib/init/template/html5-repo/files/values.yaml.hbs

@@ -0,0 +1,28 @@
+---
+html5-apps-repo-host:
+  serviceOfferingName: html5-apps-repo
+  servicePlanName: app-host
+html5-apps-deployer:
+  env:
+    SAP_CLOUD_SERVICE: null
+  image:
+    repository: "<your-container-registry>/{{appName}}-html5-deployer"
+    tag: latest
+  bindings:
+    xsuaa:
+      serviceInstanceName: xsuaa
+    destination:
+      serviceInstanceName: destination
+    html5-apps-repo:
+      serviceInstanceName: html5-apps-repo-host
+  resources:
+    limits:
+      cpu: 2000m
+      memory: 1G
+    requests:
+      cpu: 1000m
+      memory: 1G
+backendDestinations: {}
+destination:
+  parameters:
+    HTML5Runtime_enabled: true

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

@@ -1,117 +1,43 @@
 const { join } = require('path')
-const { exists } = require('../../../cds').utils
-const { readProject } = require('../../util/projectReader')
-const { mergeYAML } = require('../../util/merge')
-const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5')
-const { DESTINATION } = require('../../constants').OPTIONS
+const { exists, copy } = require('../../../cds').utils
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
 
-module.exports = class Html5RepoTemplate extends require('../templateBase') {
+module.exports = class Html5RepoTemplate extends require('../../plugin') {
 
-
-    getDependencies() {
-        return [DESTINATION]
+    requires() {
+        return ['destination']
     }
 
     async canRun() {
-        const project = await readProject()
-        const { hasMta, hasHelm } = project
-        if (!hasHelm && hasMta) {
+        const project = readProject()
+        const { hasMta, hasHelm, hasHelmUnifiedRuntime } = project
+        if (!(hasHelm || hasHelmUnifiedRuntime) && hasMta) {
             throw `'cds add html5-repo' is not available for Cloud Foundry yet`
         }
         return true
     }
 
-    static hasFacet() {
+    static hasInProduction() {
         // REVISIT: Should be detectable without helm charts
         return exists(join('chart', 'templates', 'html5-apps-deployer-configmap.yaml'))
     }
 
-    async runDependentMerging(context = {}) {
-        const { appName, hasHelm, hasApprouter} = await readProject()
-
-        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'),
-                {
-                    'html5-apps-repo-host': {
-                        serviceOfferingName: 'html5-apps-repo',
-                        servicePlanName: 'app-host'
-                    },
-                    'html5-apps-deployer': {
-                        env: {
-                            SAP_CLOUD_SERVICE: null
-                        },
-                        envFrom: [
-                            {
-                              configMapRef: {
-                                name: "{{ .Release.Name }}-html5-apps-deployer-configmap"
-                              }
-                            }
-                        ],
-                        image: {
-                            repository: `<your-container-registry>/${appName}-html5-deployer`,
-                            tag: 'latest'
-                        },
-                        bindings: {
-                            xsuaa:           { serviceInstanceName: 'xsuaa' },
-                            destination:     { serviceInstanceName: 'destination' },
-                            'html5-apps-repo': { serviceInstanceName: 'html5-apps-repo-host' }
-                        },
-                        resources: {
-                            limits:   { cpu: '2000m', memory: '1G' },
-                            requests: { cpu: '1000m', memory: '1G' }
+    async combine() {
+        const project = readProject()
+        const { hasHelm, hasHelmUnifiedRuntime } = project
+        if (hasHelm || hasHelmUnifiedRuntime) {
+            await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project })
+            await merge({
+                'html5-apps-deployer': {
+                    envFrom: [{
+                        configMapRef: {
+                            name: '{{ .Release.Name }}-html5-apps-deployer-configmap'
                         }
-                    },
-                    backendDestinations: {},
-                    destination: {
-                        parameters: {
-                            HTML5Runtime_enabled: true
-                        }
-                    }
+                    }]
                 }
-            )
-            
-            // copy content deployment chart if it is not present
-            const HelmTemplate = require(`../helm`);
-            const helmTemplate = new HelmTemplate(context.oldTrackingData, context.newTrackingData);
-
-            if (hasApprouter) {
-                await mergeYAML(
-                    join('chart', 'values.yaml'),
-                    {
-                        'html5-apps-repo-runtime': {
-                            serviceOfferingName: 'html5-apps-repo',
-                            servicePlanName: 'app-runtime'
-                        },
-                        approuter: {
-                            bindings: {
-                                'html5-apps-repo-runtime': { serviceInstanceName: 'html5-apps-repo-runtime' }
-                            }
-                        },
-                    }
-                )
-                await helmTemplate.addDependency('service-instance', 'html5-apps-repo-runtime');
-            }
-
-            isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('content-deployment');
-            
-            // add dependency entry in chart.yaml
-            await helmTemplate.addDependency('content-deployment', 'html5-apps-deployer');
-
-            // copy service-instance chart
-            isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('service-instance');
-
-            // add dependency entry in chart.yaml
-            await helmTemplate.addDependency('service-instance', 'html5-apps-repo-host');
-
-            await copyAndTrack(join(__dirname, 'files', 'html5-apps-deployer-configmap.yaml'), join('chart', 'templates', 'html5-apps-deployer-configmap.yaml'), context)
-            if(isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData)
+            }).into('chart/values.yaml')
+            await copy(join(__dirname, 'files', 'html5-apps-deployer-configmap.yaml')).to('chart', 'templates', 'html5-apps-deployer-configmap.yaml')
         }
     }
 }

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

@@ -2,13 +2,13 @@ const os = require('os')
 const cds = require('../../../cds')
 const { exists, copy, rimraf, fs, path } = cds.utils, { join } = path
 const cmd = require('../../../util/command')
-const mvn = require('../../util/mvn')
+const mvn = require('../../mvn')
 const term = require('../../../util/term')
 const { URLS, OPTIONS: { NODEJS, JAVA }, COMMAND_ADD } = require('../../constants')
 
-module.exports = class JavaTemplate extends require('../templateBase') {
+module.exports = class JavaTemplate extends require('../../plugin') {
 
-    static hasFacet() {
+    static hasInProduction() {
         return exists('pom.xml') || cds.cli.options?.add?.has(JAVA)
     }
 

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

@@ -5,7 +5,7 @@ const term = require("../../../util/term");
 const checks = require("../../../lint/checks");
 const io = require("../../../lint/io");
 const readline = require("readline");
-const { renderAndCopy } = require('../../util/template')
+const { renderAndCopy } = require('../../template')
 const { LINT_DEV, LINT_GLOBAL } = require("../../constants").OPTIONS;
 const { getConfigPath, getFileExtensions } = require("@sap/eslint-plugin-cds/lib/api");
 const cds = require("../../../cds");
@@ -17,7 +17,7 @@ const VSCODE_FILE_ASSOCIATIONS = {
   "csv": [ "csv", "csv (semicolon)", "tsv", "tab" ]
 }
 
-module.exports = class LintTemplate extends require('../templateBase') {
+module.exports = class LintTemplate extends require('../../plugin') {
   constructor() {
     super();
     this.customPath = path.join(cds.root, ".eslint");

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

@@ -0,0 +1,16 @@
+const mvn = require('../../mvn')
+const { readProject } = require('../../projectReader')
+
+module.exports = class LiquibaseTemplate extends require('../../plugin') {
+
+   async canRun() {
+      const { isNodejs } = readProject()
+      if (isNodejs) throw `'cds add liquibase' is not available for Node.js yet`
+      return true
+    }
+
+    async run() {
+      const { isJava } = readProject()
+      if (isJava) await mvn.add('liquibase')
+    }
+}

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

@@ -1,25 +1,24 @@
-const { join } = require('path')
 const cds = require('../../../cds')
 const { read } = cds.utils
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON } = require('../../util/merge')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
 
-module.exports = class LocalMessagingTemplate extends require('../templateBase') {
+module.exports = class LocalMessagingTemplate extends require('../../plugin') {
 
   async canRun() {
-    const { isJava } = await readProject()
+    const { isJava } = readProject()
     if (isJava) throw `'cds add local-messaging' is not available for Java yet`
     return true
   }
 
-  static hasFacet(env) {
+  static hasInProduction(env) {
     return env.requires?.messaging?.kind === 'local-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/mta/index.js

@@ -2,33 +2,21 @@ const { join } = require('path')
 const cds = require('../../../cds')
 const { exists } = cds.utils
 const { copyRenderedYAML } = require('../../../util/fs')
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON, sort } = require('../../util/merge')
-const {
-    APPROUTER, XSUAA, MULTITENANCY, EXTENSIBILITY,
-    MTA, HELM,
-    HANA, POSTGRES,
-    ENTERPRISE_MESSAGING, ENTERPRISE_MESSAGING_SHARED, REDIS_MESSAGING,
-    CONNECTIVITY, DESTINATION, NOTIFICATIONS
-} = require('../../constants').OPTIONS
-module.exports = class MtaTemplate extends require('../templateBase') {
+const { readProject } = require('../../projectReader')
+const { merge, sort } = require('../../merge')
 
-    static hasFacet() {
-        const { options } = cds.cli
-        if (!options?.add.has(MTA) && options?.add.has(HELM)) return false
-        return exists('mta.yaml')
-    }
+module.exports = class MtaTemplate extends require('../../plugin') {
 
-    getRelatedFacets() {
-        return [APPROUTER, XSUAA, MULTITENANCY, HANA, POSTGRES, EXTENSIBILITY, ENTERPRISE_MESSAGING, ENTERPRISE_MESSAGING_SHARED, REDIS_MESSAGING, CONNECTIVITY, DESTINATION, NOTIFICATIONS]
+    static hasInProduction() {
+        return exists('mta.yaml')
     }
 
     async run() {
-        const project = await readProject()
+        const project = readProject()
         if (!exists('mta.yaml')) {
             await copyRenderedYAML(join(__dirname, 'files', 'mta.yaml.hbs'), 'mta.yaml', project)
         }
-        await mergeJSON('package.json', join(__dirname, 'files', 'package.json'))
+        await merge(__dirname, 'files/package.json').into('package.json')
         await sort('package.json', 'devDependencies')
     }
 }

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

@@ -1,8 +1,8 @@
 const { MULTITENANCY, TOGGLES, EXTENSIBILITY } = require('../../constants').OPTIONS
 
-module.exports = class MtxTemplate extends require('../templateBase') {
+module.exports = class MtxTemplate extends require('../../plugin') {
 
-    getDependencies() {
+    requires() {
         return [MULTITENANCY, TOGGLES, EXTENSIBILITY]
     }
 }