@sap/cds-dk 4.7.1 → 4.8.1

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

@@ -1,14 +1,28 @@
 {
-  "xsappname": "{{cap.appName}}-${space}",
-  "tenant-mode": "shared",
   "scopes": [
-    { "name": "$XSAPPNAME.ExtendCDS", "description": "Extend CDS application" },
-    { "name": "$XSAPPNAME.ExtendCDSdelete", "description": "Extend CDS application with undeploy" },
-    { "name": "$XSAPPNAME.MtxDiagnose", "description": "Diagnose MTX sidecar" },
-    { "name": "$XSAPPNAME.mtdeployment", "description": "Deploy applications" },
-    { "name": "$XSAPPNAME.mtcallback", "description": "Subscribe to applications", "grant-as-authority-to-apps": [
-      "$XSAPPNAME(application,sap-provisioning,tenant-onboarding)"
-    ]}
+    {
+      "name": "$XSAPPNAME.ExtendCDS",
+      "description": "Extend CDS applications"
+    },
+    {
+      "name": "$XSAPPNAME.ExtendCDSdelete",
+      "description": "Extend CDS applications with undeployments"
+    },
+    {
+      "name": "$XSAPPNAME.MtxDiagnose",
+      "description": "Diagnose MTX"
+    },
+    {
+      "name": "$XSAPPNAME.mtdeployment",
+      "description": "Deploy applications"
+    },
+    {
+      "name": "$XSAPPNAME.mtcallback",
+      "description": "Subscribe to applications",
+      "grant-as-authority-to-apps": [
+        "$XSAPPNAME(application,sap-provisioning,tenant-onboarding)"
+      ]
+    }
   ],
   "authorities": [
     "$XSAPPNAME.MtxDiagnose",

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

@@ -1,45 +1,142 @@
-const TemplateBase = require('../templateBase');
-const ProjectReader = require('../mta/projectReader');
-const { COMMAND_ADD, OPTION_HANA } = require('../../constants');
-
+const TemplateBase = require('../templateBase')
+const ProjectReader = require('../../util/projectReader')
+const { fse } = require('@sap/cds-foss')
+const path = require('path')
+const { OPTION_HANA, OPTION_XSUAA } = require('../../constants')
+const { srvNode, srvJava, saasRegistry, mtxSidecar, mtxAPI, srvAPI, hdiContainer, xsuaa } = require('../_merging/existences');
 
 module.exports = class MtxTemplate extends TemplateBase {
     constructor(projectPath, generator) {
-        super(projectPath, generator, __dirname);
-        this.projectReader = new ProjectReader(this);
+        super(projectPath, generator, __dirname)
+        this.projectReader = new ProjectReader(this)
     }
 
     async getDependencies() {
-        return [OPTION_HANA];
+        return [OPTION_HANA, OPTION_XSUAA]
     }
 
-    async checkEnabled() {
-        if (this.options._cmd === COMMAND_ADD) {
-            throw new Error(`You can't add multitenancy to an existing project.`);
+    async runMTAMerging() {
+        const projectDescriptor = await this.projectReader.read()
+
+        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
+        if (!fse.existsSync(mtaYAMLPath)) {
+            console.warn(`There is no MTA file in your project. Run \`cds add mta\` to add an MTA file or create the MTX services yourself.`)
+            return;
         }
 
-        return true;
-    }
+        const mergingRules = projectDescriptor.cap.isNodejs ?
+        {
+            existences: [srvNode, saasRegistry, mtxAPI, xsuaa],
+            overwrites: [{
+                in: xsuaa.ref,
+                keyPath: ["parameters", "config", "tenant-mode"],
+                replacement: "shared"
+            }],
+            deletions: [hdiContainer],
+            relationships: [{
+                in: srvNode.ref,
+                inKeyPath: ["requires"],
+                into: "name",
+                existences: [saasRegistry.ref],
+                existenceKeyPath: ["name"],
+            }],
+        }
+        :
+        {
+            existences: [srvJava, srvAPI, mtxSidecar, saasRegistry],
+            relationships: [{
+                in: srvJava.ref,
+                inKeyPath: ["requires"],
+                into: "name",
+                existences: [saasRegistry.ref, mtxSidecar.ref],
+                existenceKeyPath: ["name"],
+            }],
+        }
 
-    async run() {
-        await this._writePackageJson();
-        const projectDescriptor = await this.projectReader.read();
-        await this.templateUtil.copyFiles('.', this.projectPath, projectDescriptor);
+        await this.templateUtil.mergeYAML(
+            mtaYAMLPath,
+            path.join(__dirname, `files`, `mta.yaml.hbs`),
+            projectDescriptor,
+            mergingRules
+        )
     }
 
-    async _writePackageJson() {
-        const packageJSONPath = `${this.projectPath}/package.json`;
-        const packageJSON = await this.fsUtil.readJSON(packageJSONPath);
-        const filePaths = await this.fsUtil.readdir(`${__dirname}/package/`);
-        const templatePaths = filePaths.filter(path => path.endsWith(`.package.json`));
-
-        for (const fileName of templatePaths) {
-            const key = fileName.split(`.package.json`)[0];
-            const templateJSON = await this.fsUtil.readJSON(`${__dirname}/package/${fileName}`);
-            packageJSON[key] = packageJSON[key] || {};
-            Object.assign(packageJSON[key], templateJSON);
-        }
+    async runXSSecurityMerging() {
+        const projectDescriptor = await this.projectReader.read()
+        const mtxPath = projectDescriptor.cap.isJava ? 'mtx-sidecar' : ''
+        await this.templateUtil.mergeJSON(
+            path.join(this.projectPath, mtxPath, 'xs-security.json'),
+            path.join(__dirname, 'files', 'xs-security.json.hbs'),
+            projectDescriptor,
+            {
+                existences: [{
+                    ref: "scope-diagnose",
+                    keyPath: ["scopes"],
+                    constraints: [{
+                        comparisonKeyPath: ["name"],
+                        value: "$XSAPPNAME.MtxDiagnose"
+                    }],
+                }, {
+                    ref: "scope-subscription",
+                    keyPath: ["scopes"],
+                    constraints: [{
+                        comparisonKeyPath: ["name"],
+                        value: "$XSAPPNAME.mtcallback"
+                    }],
+                }, {
+                    ref: "scope-update",
+                    keyPath: ["scopes"],
+                    constraints: [{
+                        comparisonKeyPath: ["name"],
+                        value: "$XSAPPNAME.mtdeployment"
+                    }],
+                }, {
+                    ref: "scope-extend",
+                    keyPath: ["scopes"],
+                    constraints: [{
+                        comparisonKeyPath: ["name"],
+                        value: "$XSAPPNAME.ExtendCDS"
+                    }],
+                }, {
+                    ref: "scope-extend-delete",
+                    keyPath: ["scopes"],
+                    constraints: [{
+                        comparisonKeyPath: ["name"],
+                        value: "$XSAPPNAME.ExtendCDSdelete"
+                    }],
+                }, {
+                    ref: "template-mt-administrator",
+                    keyPath: ["role-templates"],
+                    constraints: [{
+                        comparisonKeyPath: ["name"],
+                        value: "MultitenancyAdministrator"
+                    }],
+                }, {
+                    ref: "template-extension-developer",
+                    keyPath: ["role-templates"],
+                    constraints: [{
+                        comparisonKeyPath: ["name"],
+                        value: "ExtensionDeveloper"
+                    }],
+                }, {
+                    ref: "template-extension-developer-undeploy",
+                    keyPath: ["role-templates"],
+                    constraints: [{
+                        comparisonKeyPath: ["name"],
+                        value: "ExtensionDeveloperUndeploy"
+                    }],
+                }],
+            }
+        )
+    }
 
-        await this.fsUtil.writeJSON(packageJSONPath, JSON.parse(JSON.stringify(packageJSON)));
+    async run() {
+        const projectDescriptor = await this.projectReader.read()
+        const mtxPath = projectDescriptor.cap.isJava ? 'mtx-sidecar' : ''
+        const packageJsonPath = path.join(this.projectPath, mtxPath, 'package.json')
+        await this.templateUtil.mergeJSON(packageJsonPath, path.join(__dirname, 'files', 'cds.package.json'))
+        await this.templateUtil.mergeJSON(packageJsonPath, path.join(__dirname, 'files', 'dependencies.package.json'))
+        await this.runXSSecurityMerging()
+        await this.runMTAMerging()
     }
 }

package/lib/init/template/templateBase.js

@@ -57,6 +57,20 @@ module.exports = class TemplateBase {
         return Config.for('cds', projectPath);
     }
 
+    /**
+     * @abstract
+     * Executes the given template's merging steps.
+     * The separation from `run()` is necessary to preserve templating associativity,
+     * i.e. the order in which you apply them does not matter.
+     * Ex.: Assume `cds add hana` is called before `cds add mta`. We want `cds add mta`
+     * to create the base mta.yaml template and merge the hana mta.yaml in, but _don't_
+     * want any other steps from the hana template performed (e.g. creating the .hdiconfig).
+     * Separating the two let's us run this _only_ the merging part of the template.
+     */
+     async runMTAMerging() {
+
+     }
+
     /**
      * @abstract
      * Executes the given template.

package/lib/init/template/xsuaa/files/cds.package.json

@@ -0,0 +1,9 @@
+{
+  "cds": {
+    "requires": {
+      "uaa": {
+        "kind": "xsuaa"
+      }
+    }
+  }
+}

package/lib/init/template/xsuaa/files/dependencies.package.json

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "@sap/xssec": "^3",
+    "passport": "^0"
+  }
+}

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

@@ -0,0 +1,17 @@
+---
+modules:
+  - name: {{cap.appName}}-srv
+    type: {{cap.pLanguage}}
+    requires:
+      - name: {{cap.appName}}-uaa
+
+resources:
+  - name: {{cap.appName}}-uaa{{#cap.isMultitenant}}-mt{{/cap.isMultitenant}}
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: xsuaa
+      service-plan: application
+      path: ./xs-security.json
+      config:
+        xsappname: {{cap.appName}}-${org}-${space}
+        tenant-mode: {{#cap.isMultitenant}}shared{{/cap.isMultitenant}}{{^cap.isMultitenant}}dedicated{{/cap.isMultitenant}}

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

@@ -0,0 +1,75 @@
+const TemplateBase = require('../templateBase')
+const ProjectReader = require('../../util/projectReader')
+const { fse } = require('@sap/cds-foss')
+const path = require('path')
+const { srvNode, srvJava, xsuaa } = require('../_merging/existences');
+
+module.exports = class XsuaaTemplate extends TemplateBase {
+    constructor(projectPath, generator) {
+        super(projectPath, generator, __dirname)
+        this.projectReader = new ProjectReader(this)
+    }
+
+    async runMTAMerging() {
+        const projectDescriptor = await this.projectReader.read(this.options)
+        const {projectPath} = this
+        const mtaYAMLPath = path.join(projectPath, 'mta.yaml')
+        if (!fse.existsSync(mtaYAMLPath)) {
+            console.warn(`There is no MTA file in your project. Run \`cds add mta\` to add an MTA file or create the XSUAA services yourself.`)
+            return
+        }
+        const srv = projectDescriptor.cap.isNodejs ? srvNode : srvJava
+        await this.templateUtil.mergeYAML(
+            mtaYAMLPath,
+            `${__dirname}/files/mta.yaml.hbs`,
+            projectDescriptor,
+            {
+                existences: [srv, xsuaa],
+                relationships: [{
+                    in: srv.ref,
+                    inKeyPath: ["requires"],
+                    into: "name",
+                    existences: [xsuaa.ref],
+                    existenceKeyPath: ["name"],
+                }],
+            }
+        )
+
+        // Re-applying the merging part of `cds add mtx` because cds.compile.to.xsuaa
+        // has overwritten the existing `xs-security.json`.
+        // TODO: Find a generic solution for situation like these.
+        if (projectDescriptor.cap.isMultitenant) {
+            const MtxTemplate = require(`../mtx`)
+            const mtxTemplate = new MtxTemplate(this.projectPath, this.generator)
+            await mtxTemplate.runMTAMerging()
+        }
+    }
+
+    async run() {
+        const {projectPath} = this
+        const templatePath = path.join(__dirname, 'files')
+        const packageJSONPath = path.join(projectPath, 'package.json')
+        await this.templateUtil.mergeJSON(packageJSONPath, `${templatePath}/cds.package.json`)
+        await this.templateUtil.mergeJSON(packageJSONPath, `${templatePath}/dependencies.package.json`)
+        const xsSecurityPath = path.join(projectPath, 'xs-security.json')
+        const cds = require('../../../../lib/compile')
+        const xsuaa = await (async () => { try {
+            const models = await cds.load(`${projectPath}/srv`)
+            return cds.compile.to.xsuaa(models)
+        } catch (error) { /* ignore */ }
+        })() || { scopes: [], attributes: [], 'role-templates': [] }
+        const projectDescriptor = await this.projectReader.read(this.options)
+        await this.fsUtil.writeJSON(xsSecurityPath, xsuaa)
+
+        // TODO: Get rid of this by auto-creating a merging definition from
+        // the current xs-security.json. This should also solve role-templates
+        // being thrown out
+        if (projectDescriptor.cap.isMultitenant) {
+            const MtxTemplate = require(`../mtx`)
+            const mtxTemplate = new MtxTemplate(this.projectPath, this.generator)
+            await mtxTemplate.runXSSecurityMerging()
+        }
+
+        await this.runMTAMerging()
+    }
+}

package/lib/init/util/fsUtil.js

@@ -1,6 +1,6 @@
 const path = require('path');
 
-const {fse} = require('@sap/cds-foss')
+const {fse, yaml} = require('@sap/cds-foss')
 const JSONC = require('../../util/jsonc');
 
 const UTF_8 = 'utf-8';
@@ -25,6 +25,10 @@ module.exports = class FsUtil {
         await fse.outputJSON(filepath, object, options);
     }
 
+    async writeYAML(filepath, yaml, skipFileLog = false) {
+        await this.writeFile(filepath, String(yaml), skipFileLog);
+    }
+
     async readFile(src) {
         return await fse.readFile(src, UTF_8);
     }
@@ -34,8 +38,18 @@ module.exports = class FsUtil {
     }
 
     async readJSONC(src) {
-        const fileConents = await this.readFile(src);
-        return JSONC.parse(fileConents);
+        const fileContents = await this.readFile(src);
+        return JSONC.parse(fileContents);
+    }
+
+    async readYAML(src, projectDescriptor) {
+        const file = await this.readFile(src);
+        if (projectDescriptor) {
+            const Mustache = require('mustache');
+            const renderedFile = Mustache.render(file, projectDescriptor);
+            return yaml.parseDocument(renderedFile);
+        }
+        return yaml.parseDocument(file);
     }
 
     async copy(source, destination, options = {}, skipFileLog = false) {

package/lib/init/util/logger.js

@@ -12,7 +12,9 @@ const defaultLogger = {
     },
 
     log: (message = '') => {
-        LOG.log(message);
+        if (typeof LOG.level !== 'number' || LOG.level > 0) {
+            console.log(message);
+        }
     },
 
     warn: (message = '') => {

package/lib/init/util/mvnArchetypeUtil.js

@@ -31,7 +31,9 @@ class MvnArchetypeUtil {
 
         params.set('-B');
 
-        defaultLogger.isDebug && params.set('-X');
+        if (defaultLogger.isDebug) {
+            params.set('-X'); params.set('-e');
+        }
 
         return Array.from(params, (e) => {
             let result = e[0];

package/lib/init/{template/mta → util}/projectReader.js

@@ -1,5 +1,5 @@
 const path = require('path')
-const { nullLogger } = require('../../util/logger')
+const { nullLogger } = require('../util/logger')
 const { BuildTaskFactory } = require('@sap/cds/bin/build')
 const P_LANGUAGE_JAVA = 'java'
 const P_LANGUAGE_NODEJS = 'nodejs'
@@ -41,11 +41,11 @@ module.exports = class ProjectReader {
         return this.template.projectPath
     }
 
-    async read() {
+    async read(options) {
         const env = await this.getEnv();
         this.logger.isDebug && this.logger.debug(JSON.stringify(env, null, 1))
 
-        const capDescriptor = await this._getCapDescriptor(env)
+        const capDescriptor = await this._getCapDescriptor(env, options)
         const uiDescriptor = await this._getUiDescriptor(env)
         const projectDescriptor = {
             cap: capDescriptor,
@@ -58,14 +58,14 @@ module.exports = class ProjectReader {
         return projectDescriptor
     }
 
-    async _getCapDescriptor(env) {
+    async _getCapDescriptor(env, options) {
         let capDescriptor = {
             pLanguage: DEFAULT_P_LANGUAGE,
             srv: {},
             db: [],
             requires: [],
             get isMultitenant() {
-                return env.requires.multitenancy || env.requires.db && env.requires.db.multiTenant || false
+                return options && options.add.has('mtx') || env.requires.multitenancy || env.requires.db && env.requires.db.multiTenant || false
             },
             get isNodejs() {
                 return this.pLanguage === P_LANGUAGE_NODEJS
@@ -79,10 +79,15 @@ module.exports = class ProjectReader {
             get hasRequiresDb() {
                 return this.db.length > 0
             },
-            get needsSidecar() {
-                // {{#if (and (gt cap.db.length 0) (or (eq cap.pLanguage 'java') (ne cap.isMultitenant true) ) ) }}
-                return this.db.length > 0 && (this.isJava || !this.isMultitenant)
+            get hasHana() {
+                return this.requires.some(({resource}) => resource.isHana)
+            },
+            get hasXsuaa() {
+                return this.requires.some(({resource}) => resource.isXsuaa)
             },
+            get needsSidecar() {
+                return (options && options.add.has('hana') || this.db.length > 0) && (this.isJava || !this.isMultitenant)
+            }
         }
 
         // setting the effective env as it might have changed by already executed 'add' commands, e.g. cds init foo --add hana,mta
@@ -169,9 +174,19 @@ module.exports = class ProjectReader {
             appPath: null
         }
 
-        if (await this.fsUtil.pathExists(path.join(this.projectPath, env.folders.app))) {
+        const absoluteAppPath = path.join(this.projectPath, env.folders.app)
+        if (await this.fsUtil.pathExists(absoluteAppPath)) {
             uiDescriptor.appPath = env.folders.app
         }
+
+        const packageJson = await (async () => { try {
+            return await this.fsUtil.readFile(absoluteAppPath+'package.json')
+        } catch(error) { /* ignore */ }
+        })()
+
+        if (packageJson && packageJson.dependencies) {
+            uiDescriptor.appRouterEnabled = packageJson.dependencies['@sap/approuter'] !== undefined
+        }
         return uiDescriptor
     }
 
@@ -366,7 +381,7 @@ module.exports = class ProjectReader {
                 // use different service name to avoid conflicts when switching from single tenant to multitenant
                 // otherwise we would enforce that users have to delete the db container first
                 if (resource.isMultitenant) {
-                    resource.name += '-mt'
+                    //resource.name += '-mt'
                     resource.service = 'service-manager'
                     resource.vcap.plan = 'container'
                 } else {
@@ -459,7 +474,7 @@ module.exports = class ProjectReader {
                 }))
             }
         } else {
-            this.logger.warn(`No SAP HANA service binding defined in the requires section of the project's package.json. Database module omitted`) //NOSONAR
+            //this.logger.warn(`No SAP HANA service binding defined in the requires section of the project's package.json. Database module omitted`) //NOSONAR
         }
     }