@sap/cds-dk 6.2.3 → 6.3.1

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

@@ -1,36 +1,29 @@
 const path = require('path');
-
+const cds = require('../../../cds')
+const { fs, read, write } = cds.utils
 const commandUtil = require('../../util/commandUtil');
 const mvnArchetypes = require('../../util/mvnArchetypeUtil');
 const term = require('../../../util/term');
+const { mergeJSON, mergeYAML } = require('../../util/merge')
+const { copyFiles } = require('../../util/templateUtil')
 const ProjectReader = require('../../util/projectReader');
-
-const TemplateBase = require('../templateBase');
 const versionCompare = require('../../util/versionCompare');
 
 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 {
+module.exports = class HanaTemplate extends require('../templateBase') {
     constructor(projectPath, generator) {
         super(projectPath, generator, __dirname);
-        this.projectReader = new ProjectReader(this);
+        this.projectReader = new ProjectReader(projectPath);
     }
 
-    // read env from project
-    async getEnv() {
-        const cdsEnvVar = process.env.CDS_ENV;
-        process.env.CDS_ENV = 'production'
-        try {
-            return await super.getEnv();
-        } finally {
-            cdsEnvVar ? process.env.CDS_ENV = cdsEnvVar : delete process.env.CDS_ENV
-        }
+    static hasFacet(env) {
+        return env.requires?.db?.kind === 'hana'
     }
 
-    async checkEnabled() {
+    async canRun() {
         const cds = require('../../../cds')
         if (versionCompare(cds.version, '5.9.0') < 0) {
             cds.error('The added configuration requires @sap/cds 5.9.0 or higher. Please update @sap/cds to the latest version and run \x1b[1mcds add hana\x1b[0m again.')
@@ -38,15 +31,44 @@ module.exports = class HanaTemplate extends TemplateBase {
         return true
     }
 
+    async run() {
+        const env = await this.getEnv();
+
+        const hdiConfigPath = path.join(this.projectPath, env.folders.db, 'src', '.hdiconfig');
+        const hdiConfigTemplatePath = path.join(__dirname, 'files', 'common', 'src', '.hdiconfig');
+        await mergeJSON(hdiConfigPath, hdiConfigTemplatePath);
+
+        const undeployJSONPath = path.join(this.projectPath, env.folders.db, 'undeploy.json');
+        const undeployJSONTemplatePath = path.join(__dirname, 'files', 'common', 'undeploy.json');
+        await mergeJSON(undeployJSONPath, undeployJSONTemplatePath);
+
+        const projectType = await this.getProjectType();
+        switch (projectType) {
+            case PROJECT_TYPE.java: {
+                await copyFiles(path.join(__dirname, 'files', 'java', 'db'), path.join(this.projectPath, env.folders.db), {}, this.options.force);
+                await this._updatePomXml();
+                await this._updateCdsConfiguration();
+                break;
+            }
+            case PROJECT_TYPE.nodejs: {
+                await this._updatePackageJson()
+                break;
+            }
+            default: break;
+        }
+        await this.runDependentMerging()
+    }
+
+
     async runDependentMerging() {
         const projectDescriptor = await this.projectReader.read(this.options)
-        const { hasMtaDeployment, hasHelmDeployment, isNodejs, isJava, isMultitenant } = projectDescriptor.cap
+        const { hasMta, hasHelm, isNodejs, isJava, isMultitenant } = projectDescriptor.cap
 
         if (isMultitenant) {
             await this._updateCdsConfiguration()
         }
 
-        if (hasMtaDeployment) {
+        if (hasMta) {
             const srv = isNodejs ? srvNode : srvJava
             const db = isMultitenant ? serviceManager : hdiContainer
             const deletions = isMultitenant ? [{
@@ -86,7 +108,7 @@ module.exports = class HanaTemplate extends TemplateBase {
 
             const modules = !isMultitenant ? [srv, hdbDeployer] : [srv]
 
-            await this.templateUtil.mergeYAML(
+            await mergeYAML(
                 mtaYAMLPath,
                 `${__dirname}/files/mta.yaml.hbs`,
                 projectDescriptor,
@@ -94,8 +116,8 @@ module.exports = class HanaTemplate extends TemplateBase {
             )
         }
 
-        if (hasHelmDeployment) {
-            await this.templateUtil.mergeYAML(
+        if (hasHelm) {
+            await mergeYAML(
                 path.join(this.projectPath, 'chart', 'values.yaml'),
                 path.join(__dirname, 'files', 'values.yaml.hbs'),
                 projectDescriptor, { forceOverwrite: true })
@@ -106,34 +128,6 @@ module.exports = class HanaTemplate extends TemplateBase {
         }
     }
 
-    async run() {
-        const env = await this.getEnv();
-
-        const hdiConfigPath = path.join(this.projectPath, env.folders.db, 'src', '.hdiconfig');
-        const hdiConfigTemplatePath = path.join(__dirname, 'files', 'common', 'src', '.hdiconfig');
-        await this.templateUtil.mergeJSON(hdiConfigPath, hdiConfigTemplatePath);
-
-        const undeployJSONPath = path.join(this.projectPath, env.folders.db, 'undeploy.json');
-        const undeployJSONTemplatePath = path.join(__dirname, 'files', 'common', 'undeploy.json');
-        await this.templateUtil.mergeJSON(undeployJSONPath, undeployJSONTemplatePath);
-
-        const projectType = await this.getProjectType();
-        switch (projectType) {
-            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._updateCdsConfiguration();
-                break;
-            }
-            case PROJECT_TYPE.nodejs: {
-                await this._updatePackageJson()
-                break;
-            }
-            default: break;
-        }
-        await this.runDependentMerging()
-    }
-
     async _updatePomXml() {
         // if called during cds init the project generation call to AT will add settings
         if (!this.options.add.has(OPTION_JAVA)) {
@@ -141,7 +135,7 @@ module.exports = class HanaTemplate extends TemplateBase {
             try {
                 await commandUtil.spawnCommand('mvn', mvnAddHanaArgs, {
                     cwd: this.projectPath
-                }, (this.logger.isDebug ? this.logger : nullLogger));
+                });
             } 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.`);
@@ -154,12 +148,12 @@ module.exports = class HanaTemplate extends TemplateBase {
     async _updatePackageJson() {
         const packageJsonPath = path.join(this.projectPath, 'package.json')
         const dependenciesTemplatePath = path.join(__dirname, 'files', 'nodejs', 'dependencies.package.json');
-        await this.templateUtil.mergeJSON(packageJsonPath, dependenciesTemplatePath);
+        await mergeJSON(packageJsonPath, dependenciesTemplatePath);
 
-        const packageJson = await this.fsUtil.readJSON(packageJsonPath);
-        if (packageJson.dependencies['@sap/hana-client']) {
+        const packageJson = await read(packageJsonPath);
+        if ('@sap/hana-client' in packageJson.dependencies) {
             delete packageJson.dependencies['@sap/hana-client'];
-            await this.fsUtil.writeJSON(packageJsonPath, packageJson);
+            await write(packageJsonPath, packageJson, { spaces: 2 });
         }
 
         await this._updateCdsConfiguration()
@@ -171,13 +165,13 @@ module.exports = class HanaTemplate extends TemplateBase {
         configPath = configPath ?? path.join(this.projectPath, configFile)
         const projectDescriptor = await this.projectReader.read(this.options);
         const { for: forProfile } = projectDescriptor.cap;
-        let json; try { json = await this.fsUtil.readJSON(configPath) } catch { /* ignore */ }
+        let json; try { json = await read(configPath, 'utf8') } 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 })
+        await mergeJSON(configPath, cdsTemplatePath, projectDescriptor, { forceOverwrite: true })
     }
 }

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

@@ -1,54 +1,53 @@
-/* eslint-disable no-unused-vars */
-/* eslint-disable no-unreachable */
 const path = require('path');
-const TemplateBase = require('../templateBase');
+const { exists, read, copy, rimraf } = require('../../../cds').utils;
 const ProjectReader = require('../../util/projectReader');
-const { fs, rimraf } = require('../../../cds').utils;
-const { yaml } = require('@sap/cds-foss')
+const { mergeYAML } = require('../../util/merge')
+//const { yaml } = require('@sap/cds-foss')
 
-module.exports = class HelmTemplate extends TemplateBase {
+module.exports = class HelmTemplate extends require('../templateBase') {
     constructor(projectPath, generator) {
         super(projectPath, generator, __dirname);
-        this.projectReader = new ProjectReader(this);
+        this.projectReader = new ProjectReader(projectPath);
     }
 
-    async checkEnabled() {
+    static hasFacet(_, projectPath, options) {
+        // REVISIT: this works, but could be semantically nicer with a 'shouldRunDependentMerging' or the like
+        if (options?.add.has('mta') && !options?.add.has('helm')) return false
+        return exists(path.join(projectPath, 'chart', 'values.yaml'))
+    }
+
+    async canRun() {
         if (this.options.force) {
-            await rimraf(this.chartPath)
+            await rimraf(path.join(this.projectPath, 'chart'))
             return true;
         }
         return true;
     }
 
-    get chartPath() {
-        return path.join(this.projectPath, 'chart');
-    }
-
     async run() {
         const projectDescriptor = await this.projectReader.read(this.options)
-        const { appName, appDescription, appVersion, isJava } = projectDescriptor.cap
 
-        await fs.copy(
+        await copy(
             path.join(__dirname, 'subchart'),
             path.join(this.projectPath, 'chart', 'charts', 'web-application'),
         )
-        await fs.copy(
+        await copy(
             path.join(__dirname, 'chart'),
-            path.join(this.chartPath),
+            path.join(this.projectPath, 'chart')
         )
 
-        const webApplicationChartPath = process.env.WEB_APPLICATION_CHART || path.join(__dirname, 'subchart')
+        const webApplicationChartPath = process.env.WEB_APPLICATION_CHART ?? path.join(__dirname, 'subchart')
         const chartFilePath = path.join(webApplicationChartPath, 'Chart.yaml')
-        const chartFile = await fs.promises.readFile(chartFilePath, { encoding: 'utf-8' })
-        const { version } = yaml.parse(chartFile)
+        const chartFile = await read(chartFilePath)
+        //const { version } = yaml.parse(chartFile)
 
-        await this.templateUtil.mergeYAML(
+        await mergeYAML(
             path.join(this.projectPath, 'chart', 'Chart.yaml'),
             path.join(__dirname, 'files', 'Chart.yaml.hbs'),
             projectDescriptor, { forceOverwrite: true }
         )
 
-        await this.templateUtil.mergeYAML(
+        await mergeYAML(
             path.join(this.projectPath, 'chart', 'values.yaml'),
             path.join(__dirname, 'files', 'values.yaml.hbs'),
             projectDescriptor, { forceOverwrite: true }
@@ -57,43 +56,12 @@ module.exports = class HelmTemplate extends TemplateBase {
     }
 
     async runDependentMerging() {
-        const projectDescriptor = await this.projectReader.read()
-        const { hasHana, hasXsuaa, isMultitenant, isExtensible, hasMessaging, hasAuditlog, hasDestination } = projectDescriptor.cap
-
-        if (hasHana) {
-            const HanaTemplate = require(`../hana`)
-            const template = new HanaTemplate(this.projectPath, this.generator)
-            await template.runDependentMerging()
-        }
-        if (hasAuditlog) {
-            const AuditlogTemplate = require(`../auditlog`)
-            const template = new AuditlogTemplate(this.projectPath, this.generator)
-            await template.runDependentMerging()
-        }
-        if (hasMessaging) {
-            const EnterpriseMessagingTemplate = require(`../enterprise-messaging`)
-            const template = new EnterpriseMessagingTemplate(this.projectPath, this.generator)
-            await template.runDependentMerging()
-        }
-        if (hasDestination) {
-            const DestinationsTemplate = require(`../destinations`)
-            const template = new DestinationsTemplate(this.projectPath, this.generator)
-            await template.runDependentMerging()
-        }
-        if (hasXsuaa) {
-            const XsuaaTemplate = require(`../xsuaa`)
-            const template = new XsuaaTemplate(this.projectPath, this.generator)
-            await template.runDependentMerging()
-        }
-        if (isMultitenant) {
-            const MultitenancyTemplate = require(`../multitenancy`)
-            const template = new MultitenancyTemplate(this.projectPath, this.generator)
-            await template.runDependentMerging()
-        }
-        if (isExtensible) {
-            const ExtensibilityTemplate = require(`../extensibility`)
-            const template = new ExtensibilityTemplate(this.projectPath, this.generator)
-            await template.runDependentMerging()
+        // Re-applying the dependent merging part of other facets if necessary.
+        const dependentFacets = ['hana', 'xsuaa', 'auditlog', 'enterprise-messaging', 'destinations' , 'multitenancy', 'extensibility']
+        for (const facet of dependentFacets) {
+            const Template = require('../'+facet)
+            const template = new Template(this.projectPath, this.generator)
+            if (Template.hasFacet(await this.getEnv(), this.projectPath, this.options)) await template.runDependentMerging()
         }
     }
 };

package/lib/init/template/helm/subchart/templates/_helpers.tpl

@@ -165,3 +165,41 @@ If release name contains chart name it will be used as service insatnce name.
     {{- $name }}
   {{- end }}
 {{- end }}
+
+{{- define "web-application.processEnv" -}}
+{{- $result := dict }}
+{{- $variables := list }}
+{{- range $k, $v := . }}
+  {{- $variable := dict }}
+  {{- if (kindIs "string" $k) }}
+    {{- if eq "APPLICATION_NAME" $k }}
+      {{- $_ := set $result "appName" true }}
+    {{- end }}
+    {{- if eq "APPLICATION_URI" $k }}
+      {{- $_ := set $result "appURI" true }}
+    {{- end }}
+    {{- $_ := set $variable "name" $k -}}
+    {{- if (kindIs "map" $v)}}
+    {{- $_ := set $variable "valueFrom" $v}}
+    {{- else }}
+    {{- $_ := set $variable "value" ($v | toString) }}
+    {{- end }}
+  {{- else }}
+    {{- if eq "APPLICATION_NAME" $v.name }}
+      {{- $_ := set $result "appName" true }}
+    {{- end }}
+    {{- if eq "APPLICATION_URI" $v.name }}
+      {{- $_ := set $result "appURI" true }}
+    {{- end }}
+    {{- $_ := set $variable "name" $v.name }}
+    {{- if $v.value }}
+      {{- $_ := set $variable "value" ($v.value | toString)}}
+    {{- else }}
+      {{- $_ := set $variable "valueFrom" (omit $v "name")}}
+    {{- end }}
+  {{- end }}
+  {{- $variables = append $variables $variable}}
+{{- end }}
+{{- $_ := set $result "vars" $variables }}
+{{- $result | mustToJson }}
+{{- end }}

package/lib/init/template/helm/subchart/templates/deployment.yaml

@@ -30,18 +30,6 @@ spec:
             name: {{ $secretName }}
         {{- end }}
         env:
-        {{- range $k, $v := .Values.env }}
-        - name: {{ $k }}
-          value: {{ $v | quote }}
-        {{- end }}
-        {{- if not .Values.env.APPLICATION_NAME }}
-        - name: APPLICATION_NAME
-          value: {{ include "web-application.fullname" . }}
-        {{- end }}
-        {{- if not .Values.env.APPLICATION_URI }}
-        - name: APPLICATION_URI
-          value: {{ include "web-application.applicationUri" . }}
-        {{- end }}
         {{- if .Values.bindings }}
         - name: SERVICE_BINDING_ROOT
           value: /bindings
@@ -50,6 +38,18 @@ spec:
           value: {{ .Values.port | quote }}
         - name: TMPDIR
           value: /tmp
+        {{- $envVars := (include "web-application.processEnv" .Values.env | fromJson) }}
+        {{- if not (eq (len $envVars.vars) 0) }}
+        {{- $envVars.vars | toYaml | nindent 8}}
+        {{- end }}
+        {{- if not $envVars.appName}}
+        - name: APPLICATION_NAME
+          value: {{ include "web-application.fullname" . }}
+        {{- end }}
+        {{- if not $envVars.appURI}}
+        - name: APPLICATION_URI
+          value: {{ include "web-application.applicationUri" . }}
+        {{- end }}
         livenessProbe:
         {{- if .Values.health_check.liveness.path }}
           httpGet: