@sap/cds-dk 4.5.3 → 4.6.3

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

@@ -13,8 +13,6 @@ const { nullLogger } = require('../../util/logger');
 module.exports = class HanaTemplate extends TemplateBase {
     constructor(projectPath, generator) {
         super(projectPath, generator, __dirname);
-
-        this.env = null;
     }
 
     async checkEnabled() {
@@ -22,11 +20,11 @@ module.exports = class HanaTemplate extends TemplateBase {
             return true;
         }
 
-        this.env = await this.getEnv(true);
+        const env = await this.getEnv();
 
-        const hdiConfigPath = path.join(this.projectPath, this.env.folders.db, 'src/.hdiconfig');
+        const hdiConfigPath = path.join(this.projectPath, env.folders.db, 'src/.hdiconfig');
         if (await this.fsUtil.pathExists(hdiConfigPath)) {
-            const configFilePath = path.join(this.env.folders.db, 'src/.hdiconfig');
+            const configFilePath = path.join(env.folders.db, 'src/.hdiconfig');
             throw new Error(`Database config file ${configFilePath} already exists. Use --force to overwrite.`);
         }
 
@@ -34,22 +32,20 @@ module.exports = class HanaTemplate extends TemplateBase {
     }
 
     // read env from project
-    async getEnv(force) {
+    async getEnv() {
         const cdsEnvVar = process.env.CDS_ENV;
         process.env.CDS_ENV = 'production'
-        let env
         try {
-            env = await super.getEnv(force);
+            return await super.getEnv();
         } finally {
             cdsEnvVar ? process.env.CDS_ENV = cdsEnvVar : delete process.env.CDS_ENV
         }
-        return env
     }
 
     async run() {
-        this.env = await this.getEnv(true);
+        const env = await this.getEnv();
 
-        await this.templateUtil.copyFiles('common', path.join(this.projectPath, this.env.folders.db), {
+        await this.templateUtil.copyFiles('common', path.join(this.projectPath, env.folders.db), {
             projectName: this.projectName
         }, this.options.force);
 
@@ -57,13 +53,13 @@ module.exports = class HanaTemplate extends TemplateBase {
         const projectType = await this.getProjectType();
         switch (projectType) {
             case PROJECT_TYPE.java:
-                await this.templateUtil.copyFiles('java', path.join(this.projectPath, this.env.folders.db), {}, this.options.force);
+                await this.templateUtil.copyFiles('java', path.join(this.projectPath, env.folders.db), {}, this.options.force);
                 await this._updatePomXml();
-                await this._updateCdsrcJson(cdsrcJsonPath, this.env.folders.db);
+                await this._updateCdsrcJson(cdsrcJsonPath, env.folders.db, env);
                 break;
 
             case PROJECT_TYPE.nodejs:
-                await this._updatePackageJson(path.join(this.projectPath, 'package.json'), this.env.folders.db);
+                await this._updatePackageJson(path.join(this.projectPath, 'package.json'), env.folders.db, env);
                 break;
 
             default: break;
@@ -87,7 +83,7 @@ module.exports = class HanaTemplate extends TemplateBase {
         }
     }
 
-    async _updatePackageJson(packageJsonPath, modelName) { //NOSONAR
+    async _updatePackageJson(packageJsonPath, modelName, env) { //NOSONAR
         modelName = path.basename(modelName);
 
         if (!await this.fsUtil.pathExists(packageJsonPath)) {
@@ -109,7 +105,7 @@ module.exports = class HanaTemplate extends TemplateBase {
             changed = true
         }
 
-        if (!this._isUsingHana(modelName)) {
+        if (!this._isUsingHana(modelName, env)) {
             packageJson.cds = packageJson.cds || {};
             packageJson.cds.requires = packageJson.cds.requires || {};
             packageJson.cds.requires[modelName] = packageJson.cds.requires[modelName] || {};
@@ -130,7 +126,7 @@ module.exports = class HanaTemplate extends TemplateBase {
         }
     }
 
-    async _updateCdsrcJson(cdsrcJsonPath, modelName) {
+    async _updateCdsrcJson(cdsrcJsonPath, modelName, env) {
         modelName = path.basename(modelName);
 
         let changed;
@@ -143,7 +139,7 @@ module.exports = class HanaTemplate extends TemplateBase {
 
         this.logger.isDebug && this.logger.debug(`_updateCdsrcJson before: ${JSON.stringify(cdsrcJson, null, 2)}`);
 
-        if (!this._isUsingHana(modelName)) {
+        if (!this._isUsingHana(modelName, env)) {
             cdsrcJson.requires = cdsrcJson.requires || {};
             cdsrcJson.requires[modelName] = cdsrcJson.requires[modelName] || {};
             cdsrcJson.requires[modelName].kind = KIND_SQL;
@@ -161,7 +157,7 @@ module.exports = class HanaTemplate extends TemplateBase {
         }
     }
 
-    _isUsingHana(db) {
-        return this.env.get(`requires.${db}.kind`) === KIND_HANA || this.env.get(`requires.${db}.dialect`) === KIND_HANA || this.env.get(`requires.${db}.use`) === KIND_HANA;
+    _isUsingHana(db, env) {
+        return env.get(`requires.${db}.kind`) === KIND_HANA || env.get(`requires.${db}.dialect`) === KIND_HANA || env.get(`requires.${db}.use`) === KIND_HANA;
     }
 }

package/lib/init/template/lint/files/.eslint/rules/no-entity-moo.js

@@ -1,56 +1,40 @@
-const cdsLint = require("@sap/eslint-plugin-cds/lib/api");
-
-module.exports = cdsLint.createRule(
-  // Rule meta data
-  {
+module.exports = require("@sap/eslint-plugin-cds/lib/api").createRule({
+  meta: {
     docs: {
-      description: `Demonstrates how to implement a model validation check. This check does not allow any entities named 'Moo'.
-
-             ________________________
-            < No entity Moo allowed! >
-             ------------------------
-                    \   ^__^
-                     \  (oo)\_______
-                        (__)\       )\/\
-                            ||----w |
-                            ||     ||`,
-      category: "Model Validation",
+      description: `Demonstrates how to implement a model validation check.
+
+           __________________-_______
+          < Entity 'Moo' not allowed! >
+           --------------------------
+                  \   ^__^
+                   \  (oo)\_______
+                      (__)\       )\/\
+                          ||----w |
+                          ||     ||`,
+      version: "1.0.0",
     },
     fixable: "code",
-    type: "problem",
-    version: "1.0.0",
   },
-
-  // Rule (cds) logic
-  (cds, context) => {
-    let report = [];
-
-    const filepath = context.getFilename();
-    if (filepath.endsWith(".cds")) {
-      // Always get model CSN from 'cds.model'
-      const m = cds.reflect(cds.model);
-
-      // Browse all entities of reflected model
-      m.forall("entity", (d) => {
-        // strip namespace from entity, assuming its name doesn't contain dots
-        const entityName = d.name.split('.').pop()
-
-        // If entity name is "Moo"
-        if (entityName === "Moo") {
-
-          // Get ESLint properties $loc
-          const loc = cds.getLocation(entityName, d);
-          const sourcecode = context.getSourceCode();
-
-          // Apply fix by changing "Moo" to "Moon"
-          const fix = (fixer) => {
-            const rangeEnd = sourcecode.getIndexFromLoc({line: loc.end.line, column: loc.end.column});
-            return fixer.insertTextAfterRange([0, rangeEnd], "n");
-          };
-          report.push({ message: "Entity 'Moo' not allowed!", loc, fix, file: d.$location.file });
-        }
-      });
-      return report;
-    }
-  }
-);
+  create: function (context) {
+    const m = context.cds.model;
+    m.forall("entity", (d) => {
+      const entityName = d.name.split(".").pop();
+      if (entityName === "Moo") {
+        const loc = context.cds.getLocation(entityName, d);
+        const fix = (fixer) => {
+          const rangeEnd = context.sourcecode.getIndexFromLoc({
+            line: loc.end.line,
+            column: loc.end.column,
+          });
+          return fixer.insertTextAfterRange([0, rangeEnd], "n");
+        };
+        context.report({
+          message: "Entity 'Moo' not allowed!",
+          loc,
+          fix,
+          file: d.$location.file,
+        });
+      }
+    });
+  },
+})

package/lib/init/template/lint/files/.eslint/tests/no-entity-moo/rule.test.js

@@ -0,0 +1,15 @@
+const { runRuleTester } = require("@sap/eslint-plugin-cds/lib/api");
+
+runRuleTester({
+  root: __dirname,
+  filename: "schema.cds",
+  errors: [
+    {
+      message: "Entity 'Moo' not allowed!",
+      line: 2,
+      column: 8,
+      endLine: 2,
+      endColumn: 11,
+    },
+  ],
+});

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

@@ -24,6 +24,7 @@ module.exports = class LintTemplate extends TemplateBase {
     this.lintType = "local";
     this.customRuleExample = false;
     this.missingNpmDependencies = { names: [], msgs: [] };
+    this.isTest = false;
   }
 
   async checkEnabled() {
@@ -41,17 +42,16 @@ module.exports = class LintTemplate extends TemplateBase {
   }
 
   async run() {
-    const cdsdkPath = path.join(__dirname, "../../../..");
-    const globalPath = path.join(cdsdkPath, "../..");
-
     // Require ESLint v>=7.0.0
-    this._checkEslint(globalPath);
+    if (!this.isTest) {
+      this._checkEslint();
+    }
 
     // To enable custom lint rules ('lint' or 'lint:dev')
     if (this.lintType === "local") {
       // Require local ESLint plugin installation and corresponding config
       this._checkEslintPlugin();
-      this._addEslintPluginConfig();
+      await this._addEslintPluginConfig();
       // Include custom lint sample rule and test ('lint:dev')
       if (this.customRuleExample) {
         // Generate custom lint rules dirs
@@ -66,15 +66,16 @@ module.exports = class LintTemplate extends TemplateBase {
         // Generate custom lint rules docs
         await generators.genDocs(this.projectPath);
       }
+
+      // Generate VS Code extension settings
+      await io.sanitizeVscodeSettings(
+        this.projectPath,
+        path.join(this.projectPath, ".vscode/settings.json"),
+        this.lintType,
+        this.customRuleExample
+      );
     }
 
-    // Generate VS Code extension settings
-    await io.sanitizeVscodeSettings(
-      this.projectPath,
-      path.join(this.projectPath, ".vscode/settings.json"),
-      this.lintType,
-      this.customRuleExample
-    );
   }
 
   async finalize() {
@@ -101,15 +102,15 @@ module.exports = class LintTemplate extends TemplateBase {
               this.logger.log("\n");
             }
           });
-
           this._promptInstallDependencies(task);
         }
       }
     }
+
   }
 
-  _checkEslint(globalPath) {
-    const eslintCmd = checks.resolveEslint(this.projectPath, globalPath);
+  _checkEslint() {
+    const eslintCmd = checks.resolveEslint(this.projectPath, '');
     if (!eslintCmd) {
       this.missingNpmDependencies["names"].push("eslint");
       this.missingNpmDependencies["msgs"].push("ESLint v>=7.0.0");
@@ -144,9 +145,10 @@ module.exports = class LintTemplate extends TemplateBase {
 
   async _addEslintPluginConfig() {
     let configPath = getConfigPath(this.projectPath, this.logger);
-    if (configPath) {
-      await io.sanitizeEslintConfig(configPath, this.customRuleExample);
+    if (!configPath) {
+      configPath = path.join(this.projectPath, ".eslintrc");
     }
+    await io.sanitizeEslintConfig(configPath, this.customRuleExample, this.logger);
     return;
   }
 

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

@@ -38,7 +38,6 @@ modules:
 {{#cap.isJava}}
 {{#cap.isMultitenant}}
    properties:
-     SAP_JWT_TRUST_ACL: [{"clientid":"*","identityzone":"sap-provisioning"}]  # Trust between server and SaaS Manager
      SPRING_PROFILES_ACTIVE: cloud
 {{/cap.isMultitenant}}
 {{^cap.isMultitenant}}
@@ -50,12 +49,6 @@ modules:
      commands: [ mvn clean package ]
      build-result: "target/*-exec.[wj]ar"
 {{/cap.isJava}}
-{{#cap.isNodejs}}
-{{#cap.isMultitenant}}
-   properties:
-     SAP_JWT_TRUST_ACL: [{"clientid":"*","identityzone":"sap-provisioning"}]  # Trust between server and SaaS Manager
-{{/cap.isMultitenant}}
-{{/cap.isNodejs}}
 {{#cap.hasRequires}}
    requires:
 {{#cap.isJava}}

package/lib/init/template/mta/projectReader.js

@@ -22,13 +22,11 @@ module.exports = class ProjectReader {
     async getEnv(profile = 'production') {
         const cdsEnvVar = process.env.CDS_ENV
         process.env.CDS_ENV = profile
-        let env
         try {
-            env = await this.template.getEnv(true);
+            return await this.template.getEnv();
         } finally {
             cdsEnvVar ? process.env.CDS_ENV = cdsEnvVar : delete process.env.CDS_ENV
         }
-        return env
     }
 
     get fsUtil() {

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

@@ -11,7 +11,9 @@
     ]}
   ],
   "authorities": [
-    "$XSAPPNAME.MtxDiagnose"
+    "$XSAPPNAME.MtxDiagnose",
+    "$XSAPPNAME.mtdeployment",
+    "$XSAPPNAME.mtcallback"
   ],
   "role-templates": [
     {

package/lib/init/template/mtx/package/dependencies.package.json

@@ -3,7 +3,7 @@
   "@sap/cds-mtx": "^2",
   "@sap/hana-client": "^2",
   "@sap/hdi-deploy": "^4",
-  "@sap/instance-manager": "^2",
+  "@sap/instance-manager": "^3",
   "@sap/xssec": "^3",
   "passport": "^0"
 }

package/lib/init/template/nodejs/files/.gitignore.hbs

@@ -3,6 +3,7 @@ _out
 *.db
 connection.properties
 default-*.json
+.cdsrc-private.json
 gen/
 node_modules/
 target/

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

@@ -58,7 +58,7 @@ module.exports = class SamplesTemplate extends TemplateBase {
     }
 
     async _addNodejsSamples() {
-        const folders = (await this.getEnv(true)).folders;
+        const folders = (await this.getEnv()).folders;
         const dbFolder = path.join(this.projectPath, folders.db);
         await this.templateUtil.copyFiles('nodejs/db', dbFolder, {}, this.options.force);
 

package/lib/init/template/templateBase.js

@@ -1,11 +1,9 @@
 const path = require('path');
-const cds = require('@sap/cds/lib');
+const Config = require('@sap/cds/lib/env');
 
 const TemplateUtil = require('../util/templateUtil');
-const commandUtil = require('../util/commandUtil');
-const { nullLogger } = require('../util/logger');
 
-const { IS_WIN, PROJECT_TYPE } = require('../constants');
+const { PROJECT_TYPE } = require('../constants');
 
 
 module.exports = class TemplateBase {
@@ -43,49 +41,20 @@ module.exports = class TemplateBase {
         return true;
     }
 
-    getCdsModulePath() {
-        return path.join(__dirname, '../../../bin/cds.js');
-    }
-
     /**
      * calls cds env and caches result
      * @param {boolean} force, ignore cached value
      * @returns {object} the current cds env
      */
-    async getEnv(force = false) {
-        if (!this.env || force) {
-            let projectPath;
-            if (await this.fsUtil.pathExists(this.projectPath)) {
-                projectPath = this.projectPath;
-            } else {
-                projectPath = this.cwd;
-            }
-
-            const logger = (this.logger.isDebug ? this.logger : nullLogger);
-
-            let modPath = this.getCdsModulePath();
-            if (IS_WIN) {
-                modPath = `"${modPath}"`;
-            }
-
-            let envJsonOutput = await commandUtil.spawnCommand('node', [modPath, 'env', 'json'], {
-                cwd: projectPath,
-                env: process.env
-            }, logger, true);
-
-            if (envJsonOutput) {
-                // cheap check to see if json is valid
-                if (envJsonOutput.indexOf('":') < 0) {
-                    // eslint-disable-next-line no-control-regex
-                    envJsonOutput = envJsonOutput.replace(/'/g, '"').replace(/\s(\w+):\s/g, ' "$1": ').replace(/\x1b\[\w+m/g, '');
-                }
-
-                this.env = JSON.parse(envJsonOutput);
-                // env has additional getters and setters
-                Object.setPrototypeOf(this.env, cds.env.__proto__);
-            }
+    async getEnv() {
+        let projectPath;
+        if (await this.fsUtil.pathExists(this.projectPath)) {
+            projectPath = this.projectPath;
+        } else {
+            projectPath = this.cwd;
         }
-        return this.env;
+
+        return Config.for('cds', projectPath);
     }
 
     /**

package/lib/init/util/commandUtil.js

@@ -50,12 +50,17 @@ class CommandUtil {
                     resolve(stdLogBuffer.getResult());
                 } else {
                     const errorLog = errLogBuffer.getResult();
+
                     const error = new Error(`${cmd} ${args.join(' ')} failed with code ${code}, ${errorLog}`)
                     // add code ENOENT on Win if command not found
                     if (IS_WIN && errorLog.includes(cmd) && /not recognized/i.exec(errorLog)) {
                         error.code = 'ENOENT';
                         error.path = cmd;
                     }
+
+                    error.errLog = errorLog;
+                    error.stdLog = stdLogBuffer.getResult();
+
                     reject(error);
                 }
             });

package/lib/lint/Linter.js

@@ -14,6 +14,8 @@ const {
 } = require("@sap/eslint-plugin-cds/lib/api");
 
 const IS_WIN = os.platform() === "win32";
+const ALLOWED_FILE_EXTENSIONS = getFileExtensions();
+
 class Linter {
   constructor() {
     this.eslintCmd = "";
@@ -21,6 +23,7 @@ class Linter {
     this.eslintCmdOpts = {};
     this.eslintCmdOptsIndex = 0;
     this.eslintCmdFileExpr = "";
+    this.formatter = false;
     this.isFile = false;
     this.help = "";
     this.debug = "";
@@ -75,7 +78,7 @@ class Linter {
       this._printHelp();
     } else {
       // Determine if case "local" or "global" and resolve plugin accordingly
-      this._getConfigFileAndSetProjectPath(args);
+      await this._getConfigFileAndSetProjectPath(args);
 
       if (this.lintType === "local") {
         await this._addRulePaths();
@@ -88,7 +91,7 @@ class Linter {
           "rules"
         );
         if (overwriteRules) {
-          this._overwriteRuleSeverities();
+          await this._overwriteRuleSeverities();
         }
       }
 
@@ -138,25 +141,14 @@ class Linter {
 
   _addExtensions() {
     // Add CDS file extensions to lint
+    const extensions = ALLOWED_FILE_EXTENSIONS.map((ext) => ext.replace('*.', '.'));
     this.eslintCmdOpts = io.mergeWithUserOpts(
       this.eslintCmdOpts,
       "ext",
-      ".cds,.csn"
-    );
-    // Add custom CDS formatter
-    const formatterPath = this.pluginPath.replace(
-      "index.js",
-      "../api/formatter.js"
-    );
-    this.eslintCmdOpts = io.mergeWithUserOpts(
-      this.eslintCmdOpts,
-      "format",
-      path.relative(".", formatterPath)
+      extensions.join(',')
     );
     // Enable colored output
-    if (process.stdout.isTTY) {
-      this.eslintCmdOpts = io.mergeWithUserOpts(this.eslintCmdOpts, "color");
-    }
+    this.eslintCmdOpts = io.mergeWithUserOpts(this.eslintCmdOpts, "color");
     return;
   }
 
@@ -186,7 +178,6 @@ class Linter {
         }
       }
       // Only lint file extensions prescribed by plugin
-      const fileExtensions = getFileExtensions();
       eslintCmdOpts.push("--ignore-pattern");
       let ignorePattern = "*.*";
       if (IS_WIN) {
@@ -195,7 +186,7 @@ class Linter {
         ignorePattern = `'${ignorePattern}'`;
       }
       eslintCmdOpts.push(ignorePattern);
-      fileExtensions.forEach((ext) => {
+      ALLOWED_FILE_EXTENSIONS.forEach((ext) => {
         eslintCmdOpts.push("--ignore-pattern");
         ignorePattern = `!${ext}`;
         if (IS_WIN) {
@@ -212,18 +203,18 @@ class Linter {
       } else {
         input = `'${this.eslintCmdFileExpr.join("' '")}'`;
       }
-      const eslintCmdSplit = this.eslintCmd.split(" ");
-      this.eslintCmd = eslintCmdSplit[0];
-      eslintCmdOpts.unshift(eslintCmdSplit[1]);
-      eslintCmdOpts.push(input);
       // Run ESLint with given cmd line options
+      // - Show 'eslint' instead of actual eslint cmd ('node .../.eslint.js')
+      // - Remove debug flag for printed cmd line
       if (this.eslintCmdOpts.debug) {
+        eslintCmdOpts.splice(eslintCmdOpts.indexOf('--debug'), 1);
         console.log(
-          `Linting:\n ${term.info(`${this.eslintCmd} ${eslintCmdOpts.join(' ')}`)}`
+          `Linting:\n ${term.info(`eslint ${eslintCmdOpts.concat(input).join(' ')}`)}\n`
         );
+        eslintCmdOpts.push('--debug');
       }
       if (!dryRun) {
-        return commandUtil.spawnCommand(this.eslintCmd, eslintCmdOpts, {
+        return commandUtil.spawnCommand(this.eslintCmd, eslintCmdOpts.concat(input), {
           cwd: process.cwd(),
           shell: true,
           stdio: process.env.NODE_ENV === 'test' ? 'pipe' : 'inherit',
@@ -245,7 +236,7 @@ class Linter {
     return;
   }
 
-  _getConfigFileAndSetProjectPath(args) {
+  async _getConfigFileAndSetProjectPath(args) {
     let input;
     // Only resolve the first input argument
     //
@@ -269,7 +260,7 @@ class Linter {
       this.configPath = this.configGlobalPath;
       this.lintType === "global";
     } else {
-      this.configContents = io.readEslintConfig(this.configPath);
+      this.configContents = await io.readEslintConfig(this.configPath);
       if (this.configContents) {
         if ("extends" in this.configContents) {
           this.extendsPlugin = checks.hasEslintConfigContent(
@@ -295,8 +286,8 @@ class Linter {
     return;
   }
 
-  _overwriteRuleSeverities() {
-    let configContents = io.readEslintConfig(this.configPath) || {};
+  async _overwriteRuleSeverities() {
+    let configContents = (await io.readEslintConfig(this.configPath)) || {};
     let rules = configContents.rules;
     // Allow recommended plugin rules in cds-dk to be overwritten
     // by user by adding rule to cmd line (because of precedence)

package/lib/lint/generators.js

@@ -3,6 +3,7 @@ const os = require("os");
 const cp = require("child_process");
 const path = require("path");
 const { mkdirp } = require("@sap/cds/lib/utils");
+const term = require("../util/term");
 
 const IS_WIN = os.platform() === "win32";
 
@@ -35,12 +36,12 @@ module.exports = {
     let cdslintCmd = eslintOpts[0].replace("eslint", "*cds lint*");
     eslintOpts[0] = `
         # SYNOPSIS
-    
+
             ${cdslintCmd} [beta]
-    
+
             Runs environment checks and/or checks the specified models
             based on the ESLint framework
-    
+
         # OPTIONS`;
     return `${eslintOpts.join("\n    ")}\n`;
   },
@@ -97,7 +98,7 @@ module.exports = {
   },
 
   /**
-   * Generates custom rules documentation for user 
+   * Generates custom rules documentation for user
    * according to contents of rules files
    * @param {*} projectPath
    */