@sap/cds-dk 4.5.0 → 4.6.0

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() {
@@ -45,13 +46,15 @@ module.exports = class LintTemplate extends TemplateBase {
     const globalPath = path.join(cdsdkPath, "../..");
 
     // Require ESLint v>=7.0.0
-    this._checkEslint(globalPath);
+    if (!this.isTest) {
+      this._checkEslint(globalPath);
+    }
 
     // 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
@@ -101,15 +104,19 @@ module.exports = class LintTemplate extends TemplateBase {
               this.logger.log("\n");
             }
           });
-
           this._promptInstallDependencies(task);
         }
       }
     }
+
   }
 
   _checkEslint(globalPath) {
-    const eslintCmd = checks.resolveEslint(this.projectPath, globalPath);
+    const eslintInfo = checks.resolveEslint(this.projectPath, globalPath);
+    let eslintCmd;
+    if (eslintInfo) {
+      eslintCmd = eslintInfo.cmd;
+    }
     if (!eslintCmd) {
       this.missingNpmDependencies["names"].push("eslint");
       this.missingNpmDependencies["msgs"].push("ESLint v>=7.0.0");
@@ -144,9 +151,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/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/
@@ -27,3 +28,5 @@ mta_archives/
 # IDEs
 # .vscode
 # .idea
+
+.cdsrc-private.json

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

@@ -21,6 +21,7 @@ class Linter {
     this.eslintCmdOpts = {};
     this.eslintCmdOptsIndex = 0;
     this.eslintCmdFileExpr = "";
+    this.formatter = false;
     this.isFile = false;
     this.help = "";
     this.debug = "";
@@ -44,7 +45,11 @@ class Linter {
    * @returns object continaing help, options, flags and shortcuts
    */
   init(help = "", options = [], flags = [], shortcuts = []) {
-    this.eslintCmd = checks.resolveEslint(this.cdsdkPath, this.globalPath);
+    const eslintInfo = checks.resolveEslint(this.cdsdkPath, this.globalPath);
+    if (eslintInfo) {
+      this.eslintCmd = eslintInfo.cmd;
+    }
+    this.addFormatter = eslintInfo.addFormatter;
     if (this.eslintCmd) {
       help = generators.genEslintHelp(this.eslintCmd);
       flags = generators.genEslintFlags(help);
@@ -75,7 +80,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,12 +93,12 @@ class Linter {
           "rules"
         );
         if (overwriteRules) {
-          this._overwriteRuleSeverities();
+          await this._overwriteRuleSeverities();
         }
       }
 
       // Limit to CDS file extensions
-      this._addExtensions();
+      this._addExtensions(this.addFormatter);
       // Run ESLint with collected options
       try {
         await this._runEslint();
@@ -136,23 +141,25 @@ class Linter {
     return;
   }
 
-  _addExtensions() {
+  _addExtensions(addFormatter) {
     // Add CDS file extensions to lint
     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)
-    );
+    // Add custom CDS formatter (for ESLint v<8)
+    if (addFormatter) {
+      const formatterPath = this.pluginPath.replace(
+        "index.js",
+        "../api/formatter.js"
+      );
+      this.eslintCmdOpts = io.mergeWithUserOpts(
+        this.eslintCmdOpts,
+        "format",
+        path.relative(".", formatterPath)
+      );
+    }
     // Enable colored output
     if (process.stdout.isTTY) {
       this.eslintCmdOpts = io.mergeWithUserOpts(this.eslintCmdOpts, "color");
@@ -217,10 +224,14 @@ class Linter {
       eslintCmdOpts.unshift(eslintCmdSplit[1]);
       eslintCmdOpts.push(input);
       // Run ESLint with given cmd line options
+      // - Show 'eslint' instead of 'node ...eslint.js' cmd
+      // - Remove debug flag for printed cmd
       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.slice(1).join(' ')}`)}\n`
         );
+        eslintCmdOpts.push('--debug');
       }
       if (!dryRun) {
         return commandUtil.spawnCommand(this.eslintCmd, eslintCmdOpts, {
@@ -245,7 +256,7 @@ class Linter {
     return;
   }
 
-  _getConfigFileAndSetProjectPath(args) {
+  async _getConfigFileAndSetProjectPath(args) {
     let input;
     // Only resolve the first input argument
     //
@@ -269,7 +280,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 +306,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/checks.js

@@ -21,6 +21,7 @@ module.exports = {
     let cmd;
     let version;
     let errMessage;
+    let addFormatter = false;
     try {
       const eslintPath = require.resolve("eslint/package.json", {
         paths: [inputPath, globalPath],
@@ -28,6 +29,9 @@ module.exports = {
       const packageJson = require(eslintPath);
       if (packageJson.version > "7") {
         version = packageJson.version;
+        if (version < "8") {
+          addFormatter = true;
+        }
       } else {
         errMessage =
           `ESLint v>=6.0.0 required!\n\n` +
@@ -51,7 +55,7 @@ module.exports = {
         )}\n`;
     }
     if (cmd && version) {
-      return cmd;
+      return  { cmd, addFormatter };
     }
     if (logger) {
       logger.error(errMessage);

package/lib/lint/generators.js

@@ -36,7 +36,7 @@ module.exports = {
     eslintOpts[0] = `
         # SYNOPSIS
     
-            ${cdslintCmd}
+            ${cdslintCmd} [beta]
     
             Runs environment checks and/or checks the specified models
             based on the ESLint framework

package/lib/lint/io.js

@@ -1,7 +1,8 @@
 const os = require("os");
-const fs = require("fs");
+const fsp = require("fs").promises;
 const path = require("path");
 const yaml = require("@sap/cds-foss")("yaml");
+const term = require("../util/term");
 const FsUtil = require("../init/util/fsUtil");
 const fsUtil = new FsUtil();
 
@@ -13,23 +14,28 @@ module.exports = {
    * @param {*} configPath config file path to read from
    * @returns config file contents
    */
-  readEslintConfig(configPath) {
+  async readEslintConfig(configPath) {
     let config;
     let configFile = path.basename(configPath);
+    let configString = await fsp.readFile(configPath, "utf8");
     switch (configFile) {
       case ".eslintrc.js":
       case ".eslintrc.cjs":
-        config = require(configPath);
+        try {
+          config = JSON.parse(configString.replace(/^module\.exports =/, ""));
+        } catch (err) {
+          config = {};
+        }
         break;
       case ".eslintrc.yaml":
       case ".eslintrc.yml":
-        config = yaml.parse(fs.readFileSync(configPath, "utf8"));
+        config = yaml.parse(await fsp.readFile(configPath, "utf8"));
         break;
       case ".eslintrc.json":
       case ".eslintrc":
       case "package.json":
         try {
-          config = JSON.parse(fs.readFileSync(configPath, "utf8"));
+          config = JSON.parse(await fsp.readFile(configPath, "utf8"));
           if (configFile === "package.json" && "eslintConfig" in config) {
             config = config["eslintConfig"];
           }
@@ -52,8 +58,11 @@ module.exports = {
    * @param {*} configPath ESLint config file
    * @returns {void}
    */
-  async sanitizeEslintConfig(configPath, customRuleExample=false) {
-    let configContents = this.readEslintConfig(configPath) || {};
+  async sanitizeEslintConfig(configPath, customRuleExample = false, logger = console) {
+    let configContents = {};
+    if (await fsUtil.pathExists(configPath)) {
+      configContents = (await this.readEslintConfig(configPath)) || {};
+    }
     const configType = "recommended";
     const extendsValue = `plugin:@sap/cds/${configType}`;
     if ("extends" in configContents) {
@@ -79,7 +88,7 @@ module.exports = {
         configContents["rules"] = { [ruleName]: ruleValue };
       }
     }
-    await this.writeEslintConfig(configContents, configPath);
+    await this.writeEslintConfig(configPath, configContents, logger);
     return;
   },
 
@@ -89,16 +98,37 @@ module.exports = {
    * @param {*} configPath config file path to write to
    * @returns {void}
    */
-  async writeEslintConfig(configContents, configPath) {
+  async writeEslintConfig(configPath, configContents, logger=console) {
+    const configType = "recommended";
+    const extendsValue = `plugin:@sap/cds/${configType}`;
     let contents = {};
     let configFile = path.basename(configPath);
+    let configToAdd = {};
     switch (configFile) {
       case ".eslintrc.js":
       case ".eslintrc.cjs":
-        await fsUtil.writeFile(
-          configPath,
-          `module.exports = ${JSON.stringify(configContents, null, 2)}`
-        );
+        try {
+          configContents = await this.readEslintConfig(configPath);
+        } catch (err) {
+          configContents = {};
+        }
+        if (configContents && configContents["extends"]) {
+          if (
+            !configContents["extends"] === extendsValue ||
+            !configContents["extends"].includes(extendsValue)
+          ) {
+            configToAdd["extends"] = extendsValue;
+          }
+        } else {
+          configToAdd["extends"] = extendsValue;
+        }
+        if (configToAdd["extends"]) {
+          logger.log(
+            `${term.warn(
+              `\n\nPlease add the following to your "${configFile}":\n\nmodule.exports = ${JSON.stringify(configToAdd, null, 2)}`
+            )}\n`
+          );
+        }
         break;
       case ".eslintrc.yaml":
       case ".eslintrc.yml":
@@ -108,25 +138,19 @@ module.exports = {
       case ".eslintrc":
       case "package.json":
         if (configFile === "package.json") {
-          if (fs.existsSync(configPath)) {
-            contents = JSON.parse(fs.readFileSync(configPath, "utf8"));
+          if (await fsp.access(configPath)) {
+            contents = JSON.parse(await fsp.readFile(configPath, "utf8"));
           } else {
             contents = {};
           }
           if (!("eslintConfig" in configContents)) {
             contents["eslintConfig"] = configContents;
           } else {
-            contents["eslintConfig"] = [
-              ...configContents,
-              ...contents["eslintConfig"],
-            ];
+            contents["eslintConfig"] = [...configContents, ...contents["eslintConfig"]];
           }
           configContents = contents;
         }
-        await fsUtil.writeFile(
-          configPath,
-          `${JSON.stringify(configContents, null, 2)}`
-        );
+        await fsUtil.writeFile(configPath, `${JSON.stringify(configContents, null, 2)}`);
         break;
       default:
         break;
@@ -141,8 +165,12 @@ module.exports = {
    */
   async readVscodeSettings(settingsPath) {
     let settings;
-    if (fs.existsSync(settingsPath)) {
-      settings = await fsUtil.readJSONC(settingsPath);
+    if (fsUtil.pathExists(settingsPath)) {
+      try {
+        settings = await fsUtil.readJSONC(settingsPath);
+      } catch (err) {
+        settings = {};
+      }
     }
     return settings;
   },
@@ -186,10 +214,7 @@ module.exports = {
     }
 
     if (settings["eslint.validate"]) {
-      settings["eslint.validate"] = this.mergeArrays(
-        settings["eslint.validate"],
-        lintFileTypes
-      );
+      settings["eslint.validate"] = this.mergeArrays(settings["eslint.validate"], lintFileTypes);
     } else {
       settings["eslint.validate"] = lintFileTypes;
     }
@@ -208,7 +233,7 @@ module.exports = {
       }
     }
 
-    await this.writeVscodeSettings(settings, settingsPath);
+    await this.writeVscodeSettings(settingsPath, settings);
   },
 
   /**
@@ -217,7 +242,7 @@ module.exports = {
    * @param {*} settingsPath settings file path to write to
    * @returns {void}
    */
-  async writeVscodeSettings(settings, settingsPath) {
+  async writeVscodeSettings(settingsPath, settings) {
     if (!settings) {
       await fsUtil.mkdirp(path.dirname(settingsPath));
     }
@@ -236,10 +261,9 @@ module.exports = {
     if (propsToAdd) {
       if (Object.keys(userOpts).includes(propKey)) {
         if (!["config", "format"].includes(propKey)) {
-          propsToAdd = this.mergeArrays(
-            userOpts[propKey].split(","),
-            propsToAdd.split(",")
-          ).join(",");
+          propsToAdd = this.mergeArrays(userOpts[propKey].split(","), propsToAdd.split(",")).join(
+            ","
+          );
         }
       }
       userOpts[propKey] = propsToAdd;

package/lib/util/term.js

@@ -8,6 +8,7 @@ const t = module.exports.codes = {
   link: '\x1b[4m', // underline
   red: '\x1b[91m', // Bright Foreground Red
   green: '\x1b[32m', // Foreground Green
+  blue: '\x1b[34m', // Foreground Blue
   orange: '\x1b[38;2;255;140;0m' // darker orange, works with bright and dark background
 }
 
@@ -24,6 +25,7 @@ module.exports.warn  = o => as(t.orange, o)
 module.exports.info  = o => as(t.green, o)
 module.exports.link  = o => as(t.link, o)
 module.exports.bold  = o => as(t.bold, o)
+module.exports.highlight  = o => as(t.blue,as(t.bold, o))
 
 const format = module.exports.format = (o, severity='Error', asInternalError=false, withStack=false) => {
   switch (severity) {