@sap/cds-dk 7.1.1 → 7.2.0

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

@@ -16,7 +16,8 @@ const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5')
 module.exports = class ApprouterTemplate extends require('../templateBase') {
 
     static hasFacet(env) {
-        return exists(join(env.folders.app, 'xs-app.json'))
+        return exists(join(env.folders.app, 'router', 'xs-app.json')) ||
+               exists(join(env.folders.app, 'xs-app.json'))
     }
 
     getDependencies() {
@@ -28,16 +29,16 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
     }
 
     async run() {
-        const { appPath = 'app' } = await readProject()
-        const appPackageJSONPath = join(appPath, 'package.json')
+        const { approuterPath } = await readProject()
+        const appPackageJSONPath = join(approuterPath, 'package.json')
         await mergeJSON(appPackageJSONPath, join(__dirname, 'files', 'package.json'))
         await sort(appPackageJSONPath, 'dependencies')
-        await mergeJSON(join(appPath, 'default-env.json'), join(__dirname, 'files', 'default-env.json'))
+        await mergeJSON(join(approuterPath, 'default-env.json'), join(__dirname, 'files', 'default-env.json'))
     }
 
     async runDependentMerging(context = {}) {
         const project = await readProject()
-        const { isNodejs, isJava, isExtensible, isMultitenant, hasMta, hasHelm, srvPath, appPath } = project
+        const { isNodejs, isJava, isExtensible, isMultitenant, hasMta, hasHelm, srvPath, approuterPath } = project
 
         if (hasMta) {
             const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)
@@ -116,7 +117,7 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
             if (isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData);
         }
 
-        const xsAppPath = join(appPath, 'xs-app.json')
+        const xsAppPath = join(approuterPath, 'xs-app.json')
         const additions = isExtensible ? [{ ...approuterExtensibility, at: 0 }] : []
         await mergeJSON(xsAppPath, join(__dirname, 'files', 'xs-app.json.hbs'), project, { additions })
     }

package/lib/init/template/cf-manifest/files/services-manifest.yml.hbs

@@ -20,8 +20,3 @@ create-services:
     plan: application
     parameters: xs-security.json
 {{/hasXsuaa}}
-{{#hasAuditlog}}
-  - name: {{appName}}-auditlog
-    broker: auditlog
-    plan: application
-{{/hasAuditlog}}

package/lib/init/template/cf-manifest/index.js

@@ -2,7 +2,7 @@ const { join } = require('path')
 const cds = require('../../../cds')
 const { exists } = require('../../../cds').utils
 const { readProject } = require('../../util/projectReader')
-const { copyFiles } = require('../../util/template')
+const { renderAndCopy } = require('../../util/template')
 const MANIFEST_FILE = 'manifest.yml'
 const SERVICES_MANIFEST_FILE = 'services-manifest.yml'
 
@@ -20,6 +20,6 @@ module.exports = class CfManifestTemplate extends require('../templateBase') {
 
     async run() {
         const project = await readProject()
-        await copyFiles(join(__dirname, 'files'), cds.root, project, true)
+        await renderAndCopy(join(__dirname, 'files'), cds.root, project)
     }
 }

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

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

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

@@ -1,11 +1,10 @@
 const { join } = require('path')
 const cds = require('../../../cds')
-const { read, write, exists, rmdir } = cds.utils
+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 { copyFiles } = require('../../util/template')
 
 const { OPTIONS: { JAVA } } = require('../../constants')
 
@@ -33,7 +32,7 @@ module.exports = class HanaTemplate extends require('../templateBase') {
         await mergeJSON(undeployJSONPath, undeployJSONTemplatePath)
 
         if (isJava) {
-            await copyFiles(join(__dirname, 'files', 'db'), db.folder, {}, cds.cli.options.force)
+            await copy(join(__dirname, 'files', 'db')).to(db.folder)
             // REVISIT: shouldn't behave differently during cds init
             // if called during cds init the project generation call to AT will add settings
             if (!cds.cli.options.add.has(JAVA)) await mvn.execMvn(mvn.getAddHanaCmdArgs())

package/lib/init/template/helm/chart/values.root.schema.json

@@ -37,11 +37,6 @@
             "description": "Service Instance",
             "$ref": "./charts/service-instance/values.schema.json"
         },
-        "auditlog": {
-            "$id": "#/properties/auditlog",
-            "description": "Service Instance",
-            "$ref": "./charts/service-instance/values.schema.json"
-        },
         "destination": {
             "$id": "#/properties/destination",
             "description": "Service Instance",

package/lib/init/template/helm/chart/values.schema.json

@@ -66,10 +66,6 @@
             "$id": "#/properties/xsuaa",
             "description": "Service Instance"
         },
-        "auditlog": {
-            "$id": "#/properties/auditlog",
-            "description": "Service Instance"
-        },
         "destination": {
             "$id": "#/properties/destination",
             "description": "Service Instance"

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

@@ -14,7 +14,7 @@ module.exports = class HelmTemplate extends require('../templateBase') {
     }
 
     getRelatedFacets() {
-        return ['hana', 'xsuaa', 'auditlog', 'enterprise-messaging', 'destination' , 'multitenancy', 'extensibility', 'approuter', 'connectivity']
+        return ['hana', 'xsuaa', 'enterprise-messaging', 'destination' , 'multitenancy', 'extensibility', 'approuter', 'connectivity']
     }
 
     static hasFacet() {

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 { copyFiles } = require('../../util/template')
+const { renderAndCopy } = require('../../util/template')
 const { LINT_DEV, LINT_GLOBAL } = require("../../constants").OPTIONS;
 const { getConfigPath, getFileExtensions } = require("@sap/eslint-plugin-cds/lib/api");
 const cds = require("../../../cds");
@@ -62,10 +62,10 @@ module.exports = class LintTemplate extends require('../templateBase') {
         await this._generateEslintDirs();
 
         if (!exists(".eslint/rules/no-entity-moo.js")) {
-          await this._copyFromTemplate(".eslint/rules", this.rulesPath);
+          await renderAndCopy(".eslint/rules", this.rulesPath);
         }
         if (!exists(".eslint/tests/no-entity-moo.test.js")) {
-          await this._copyFromTemplate(".eslint/tests", this.testsPath);
+          await renderAndCopy(".eslint/tests", this.testsPath);
         }
       }
 
@@ -150,10 +150,6 @@ module.exports = class LintTemplate extends require('../templateBase') {
     await mkdirp(this.testsPath);
   }
 
-  async _copyFromTemplate(source, dest) {
-    await copyFiles(source, dest, {}, true);
-  }
-
   async _addEslintPluginConfig() {
     let configPath = getConfigPath(cds.root);
     if (!configPath) {

package/lib/init/template/multitenancy/files/package.json.hbs

@@ -7,9 +7,6 @@
   {{/isNodejs}}
     {{#isJava}}
     "profiles": ["with-mtx-sidecar", "java"],
-    "build": {
-      "target": "."
-    },
     {{/isJava}}
     {{#isNodejs}}
     "profile": "with-mtx-sidecar",

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

@@ -2,6 +2,7 @@ const { join } = require('path')
 const cds = require('../../../cds')
 const { exists, read, write } = cds.utils
 const { APPROUTER, HANA, KIBANA } = require('../../constants').OPTIONS
+const mvn = require('../../util/mvn')
 const { readProject } = require('../../util/projectReader')
 const { mergeJSON, mergeYAML, sort } = require('../../util/merge')
 const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5')
@@ -35,6 +36,7 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
       const packageJson = await read('package.json')
       packageJson.workspaces = ['mtx/sidecar']
       await write('package.json', packageJson, { spaces: 2 })
+      await mvn.execMvn(mvn.getAddArgs('mtx'))
     }
     if (isNodejs) await sort('package.json', 'dependencies')
     await copyRenderedJSON(join(__dirname, 'files', 'package.sidecar.json.hbs'), join('mtx', 'sidecar', 'package.json'), project)

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

@@ -3,12 +3,12 @@ const cds = require('../../../cds')
 const { exists, mkdirp, path } = cds.utils
 const { URLS, OPTIONS: { NODEJS, JAVA }, COMMAND_ADD } = require('../../constants')
 const term = require('../../../util/term')
-const { copyFiles } = require('../../util/template')
+const { renderAndCopy } = require('../../util/template')
 
 module.exports = class NodejsTemplate extends require('../templateBase') {
 
     static hasFacet() {
-        return !exists('pom.xml') || cds.cli.options?.add?.has(NODEJS)
+        return !exists('pom.xml') && !cds.cli.options?.add?.has(JAVA)
     }
 
     async canRun() {
@@ -23,7 +23,7 @@ module.exports = class NodejsTemplate extends require('../templateBase') {
 
     async run() {
         const { db, srv, app } = (await this.getEnv()).folders
-        await copyFiles(join(__dirname, 'files'), cds.root, { projectName: path.basename(cds.root) }, cds.cli.options.force)
+        await renderAndCopy(join(__dirname, 'files'), cds.root, { projectName: path.basename(cds.root) })
         await Promise.all([db, srv, app].map(p => mkdirp(p)))
     }
 

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

@@ -1,12 +1,10 @@
 const { join } = require('path');
 const cds = require('../../../cds')
-const { exists } = cds.utils
-const { copyFiles } = require('../../util/template')
+const { exists, copy } = cds.utils
 const { URLS } = require('../../constants')
 
 module.exports = class PipelineTemplate extends require('../templateBase') {
 
-
     async canRun() {
         if (cds.cli.options.force) {
             return true;
@@ -20,7 +18,7 @@ module.exports = class PipelineTemplate extends require('../templateBase') {
     }
 
     async run() {
-        await copyFiles(join(__dirname, 'files'), cds.root, {}, true);
+        await copy(join(__dirname, 'files')).to(cds.root)
     }
 
     async finalize() {

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

@@ -1,7 +1,6 @@
 const { join } = require('path')
-const cds = require('../../../cds'), { exists } = cds.utils
+const cds = require('../../../cds'), { exists, copy } = cds.utils
 const { readProject } = require('../../util/projectReader')
-const { copyFiles } = require('../../util/template')
 
 module.exports = class SampleTemplate extends require('../templateBase') {
 
@@ -14,12 +13,11 @@ module.exports = class SampleTemplate extends require('../templateBase') {
     async run() {
         const { db, srv, app } = (await this.getEnv()).folders
         const language = exists('pom.xml') ? 'java' : 'nodejs'
-        const { force } = cds.cli.options
         await Promise.all([
-          copyFiles(join(__dirname, 'files', 'db'),  db, {}, force),
-          copyFiles(join(__dirname, 'files', 'app'), app, {}, force),
-          copyFiles(join(__dirname, 'files', 'srv'), srv, {}, force),
-          copyFiles(join(__dirname, 'files', language), srv, {}, force)
+          copy(join(__dirname, 'files', 'db')).to(db),
+          copy(join(__dirname, 'files', 'app')).to(app),
+          copy(join(__dirname, 'files', 'srv')).to(srv),
+          copy(join(__dirname, 'files', language)).to(srv)
         ])
     }
 }

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

@@ -1,6 +1,7 @@
 const { join } = require('path')
 const cds = require('../../../cds')
 const { read } = cds.utils
+const mvn = require('../../util/mvn')
 const { readProject } = require('../../util/projectReader')
 const { mergeJSON } = require('../../util/merge')
 
@@ -8,8 +9,12 @@ module.exports = class SQLiteTemplate extends require('../templateBase') {
 
     async run() {
       const project = await readProject()
-      const { configFile } = project
-      project.shortcut = !(await read(configFile)).cds?.requires?.db?.kind
-      await mergeJSON(configFile, join(__dirname, 'files', `package.json.hbs`), project)
+      const { isNodejs, isJava, configFile } = project
+      if (isNodejs) {
+        project.shortcut = !(await read(configFile)).cds?.requires?.db?.kind
+        await mergeJSON(configFile, join(__dirname, 'files', `package.json.hbs`), project)
+      } else if (isJava) {
+        await mvn.add('sqlite')
+      }
     }
 }

package/lib/init/template/tiny-sample/index.js

@@ -1,39 +1,25 @@
 const { join } = require('path')
-const cds = require('../../../cds')
-const { copyFiles } = require('../../util/template')
-const commandUtil = require('../../../util/command')
-const mvnArchetypes = require('../../util/mvn')
-const term = require('../../../util/term')
-const { PROJECT_TYPE: { java, nodejs }, OPTIONS: { JAVA }, URLS } = require('../../constants')
+const cds = require('../../../../lib/cds'), { copy } = cds.utils
+const { renderAndCopy } = require('../../util/template')
+const mvn = require('../../util/mvn')
+const { readProject } = require('../../util/projectReader')
+const { JAVA } = require('../../constants')
 
 module.exports = class TinySampleTemplate extends require('../templateBase') {
 
     async run() {
-        switch (this.getProjectType()) {
-            case java:   return this._addJavaSamples()
-            case nodejs: return this._addNodejsSamples()
-        }
-    }
-
-    async _addJavaSamples() {
-        if (!cds.cli.options.add.has(JAVA)) {
-            const mvnAddSamplesArgs = mvnArchetypes.getAddSamplesCmdArgs()
-            try {
-                await commandUtil.spawnCommand('mvn', mvnAddSamplesArgs, { cwd: cds.root })
-                const mvnAddTestsArgs = mvnArchetypes.getAddTestsCmdArgs()
-                await commandUtil.spawnCommand('mvn', mvnAddTestsArgs, { cwd: cds.root })
-            } catch (err) {
-                if (err.code === 'ENOENT' && err.path === 'mvn') {
-                    throw `Maven executable 'mvn' not found, follow ${term.info(URLS.MAVEN_INSTALL_HELP)} and install Maven on your machine.`
-                }
-                throw err
+        const { isJava } = await readProject()
+        if (isJava) {
+            if (!cds.cli.options.add.has(JAVA)) {
+                await mvn.execMvn(mvn.getAddSamplesCmdArgs())
+                await mvn.execMvn(mvn.getAddTestsCmdArgs())
             }
+        } else {
+            const { db, srv } = (await this.getEnv()).folders
+            await Promise.all([
+                copy(join(__dirname, 'files', 'nodejs', 'db')).to(db),
+                renderAndCopy(join(__dirname, 'files', 'nodejs', 'srv'), srv, { dbFolder: db.replace(/[\\/]+$/, '') })
+            ])
         }
     }
-
-    async _addNodejsSamples() {
-        const { db, srv } = (await this.getEnv()).folders
-        await copyFiles(join(__dirname, 'files', 'nodejs', 'db'), db, {}, cds.cli.options.force)
-        await copyFiles(join(__dirname, 'files', 'nodejs', 'srv'), srv, { dbFolder: db.replace(/[\\/]+$/, '') }, cds.cli.options.force)
-    }
 }

package/lib/init/util/mvn.js

@@ -33,7 +33,6 @@ class MvnArchetypeUtil {
     }
 
     _finalize(params) {
-        // `-DcdsVersion=3.0.0`,
         params.set(`-Dstyle.color`, `always`);
 
         params.set('-B');
@@ -48,6 +47,31 @@ class MvnArchetypeUtil {
         return Array.from(params, ([arg, val]) => val !== null && val !== undefined ? `${arg}=${val}` : arg)
     }
 
+    // REVISIT: make this only public API once mvn:addSample etc. have been moved to generic mvn:add
+    async add(feature) {
+        return this.execMvn(this.getAddArgs(feature))
+    }
+
+    getAddArgs(feature) {
+        const params = new Map();
+
+        params.set(`com.sap.cds:cds-maven-plugin:${MAVEN_ARCHETYPE_VERSION}:add`);
+        params.set(`-Dfeature`, feature)
+        const profile = cds.cli.options.for
+        params.set(`-Dprofile`, profile === 'production' ? 'cloud' : profile)
+
+        const { options } = cds.cli
+        if (options[JAVA_MVN]) {
+            this._scanMvnParams(options[JAVA_MVN], params);
+        }
+
+        if (options.force) {
+            params.set(`-Doverwrite`, true);
+        }
+
+        return this._finalize(params);
+    }
+
     getAddSamplesCmdArgs() {
         const params = new Map();
 

package/lib/init/util/projectReader.js

@@ -2,6 +2,7 @@ const cds = require('../../cds')
 const { join, resolve, basename } = require('path')
 const { fs, exists } = cds.utils
 const { parseXml } = require('./xml')
+const { REGEX_JAVA_VERSION } = require('../constants')
 const DEBUG = cds.debug('cli')
 
 module.exports = new class ProjectReader {
@@ -18,12 +19,7 @@ module.exports = new class ProjectReader {
         if (exists('pom.xml')) {
             const { artifactId = [], description = [], version = [], properties = [] } = parseXml(resolve(cds.root, 'pom.xml')) ?? {}
             const v = version[0] === '${revision}' ? properties[0]?.revision[0] : version[0]
-            if (v) {
-                // check compliance with mta version format - copied from mbt error message
-                if (/^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$/.test(v)) {
-                    this.appVersion = v
-                }
-            }
+            if (v && REGEX_JAVA_VERSION.test(v)) this.appVersion = v
             if (artifactId[0])  this.appName = this.appId = artifactId[0].split(/-parent/)[0]
             if (description[0]) this.appDescription = description[0]
         }
@@ -79,13 +75,13 @@ module.exports = new class ProjectReader {
             get isExtensible()   { return _hasFacet('extensibility') },
             get hasHana()        { return _hasFacet('hana') },
             get hasXsuaa()       { return _hasFacet('xsuaa') },
-            get hasAuditlog()    { return _hasFacet('auditlog') },
             get hasApprouter()   { return _hasFacet('approuter') },
             get hasDestination() { return _hasFacet('destination') },
             get hasHtml5Repo()   { return _hasFacet('html5-repo') },
             get hasMta()         { return _hasFacet('mta') },
             get hasHelm()        { return _hasFacet('helm') },
             get appPath()        { return env.folders.app ?? 'app' },
+            get approuterPath()  { return join(env.folders.app ?? 'app', 'router') },
             get appVersion()     { return appVersion },
             get appName()        { return appName },
             get appId()          { return appId },

package/lib/init/util/template.js

@@ -1,7 +1,8 @@
 const Mustache = require('mustache')
-const { copy, read, write, exists, readdir, path, isdir } = require('../../cds').utils
+const cds = require('../../cds')
+const { copy, read, write, exists, readdir, path, isdir } = cds.utils
 
-async function copyFiles(from, into, replacements, overwrite = false) {
+async function renderAndCopy(from, into, replacements, overwrite = cds.cli.options.force) {
     const dirents = await readdir(from)
     await Promise.all(dirents.map(async dirent => {
         const fileNew = Mustache.render(dirent, replacements)
@@ -9,7 +10,7 @@ async function copyFiles(from, into, replacements, overwrite = false) {
         const dest = path.join(into, fileNew)
 
         if (isdir(src)) {
-            return copyFiles(path.join(from, dirent), dest, replacements, overwrite)
+            return renderAndCopy(path.join(from, dirent), dest, replacements, overwrite)
         } else if (path.extname(dirent) === '.hbs') {
             const destinationPath = dest.replace('.hbs', '')
             if (overwrite || !exists(destinationPath)) {
@@ -23,11 +24,11 @@ async function copyFiles(from, into, replacements, overwrite = false) {
 }
 
 async function render(src, templateValues) {
-    const content = await read(src, 'utf-8');
-    return Mustache.render(content, templateValues);
+    const content = await read(src, 'utf-8')
+    return Mustache.render(content, templateValues)
 }
 
 module.exports = {
     render,
-    copyFiles
+    renderAndCopy
 }

package/lib/watch/node-watch.js

@@ -1,5 +1,6 @@
 const cds = require ('../cds')
 const DEBUG = cds.debug('cli|watch')
+const { relative } = require('path')
 
 module.exports = ({ cwd, script, ext, includes=RegExp(), ignore=RegExp(), env={}, delay=200, options={} })=>{
 
@@ -52,7 +53,11 @@ module.exports = ({ cwd, script, ext, includes=RegExp(), ignore=RegExp(), env={}
   // Watching for touched files...
   const watch = require('node-watch')
   const include = RegExp(`\\.(${ext.replace(/,/g,'|')})$|${includes.source}`)
-  const filter = f => !ignore.test(f) && include.test(f)
+  const filter = f => {
+    const isIn = !ignore.test(f) && include.test(f)
+    if (!isIn)  DEBUG?. (`ignored: ${relative(cwd||process.cwd(), f)}`)
+    return isIn
+  }
   const watcher = watch (cwd||process.cwd(),{ recursive:true, filter, delay:0 })
   if (DEBUG) watcher.on('close', ()=> DEBUG('⚡️', 'cds watch - file watcher closed'))
   watcher.on('change', restart)