@eui/tools 6.1.0 → 6.1.1

package/.version.properties

@@ -1 +1 @@
-6.1.0
+6.1.1

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 6.1.1 (2022-11-06)
+
+##### Chores
+
+* **other:**
+  * cleanup sandbox add audit pc score - EUI-6448 [EUI-6448](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-6448)  ([71addfb8](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/71addfb8f8b2cc4f392e1efb8a49c98948bd1a87))
+  * audit final testing - EUI-6448 [EUI-6448](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-6448)  ([e2c35c10](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/e2c35c10bbea2445a67b89934d210843b7c6bc00))
+  * refactoring / cleanup - added audit specific - EUI-6448 [EUI-6448](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-6448)  ([0dc58643](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/0dc58643aa52cfdf2126275ecefa38fbe30e9f97))
+##### Bug Fixes
+
+* **other:**
+  * wrong method call  ([de9642f5](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/de9642f59c7683c3605a9876e412c50589f474cb))
+
+* * *
+* * *
 ## 6.1.0 (2022-11-04)
 
 ##### Chores

package/bin/eui-scripts.js

@@ -8,6 +8,7 @@ const args = process.argv.slice(2);
 const scriptIndex = args.findIndex(
     x => x === 'clean-package' ||
     x === 'clean-all' ||
+    x === 'audit-package' ||
     x === 'build-package' ||
     x === 'build-package-pr-scan' ||
     x === 'build-package-sub' ||
@@ -47,6 +48,7 @@ const nodeArgs = scriptIndex > 0 ? args.slice(0, scriptIndex) : [];
 switch (script) {
     case 'clean-package':
     case 'clean-all':
+    case 'audit-package':
     case 'build-package':
     case 'build-package-pr-scan':
     case 'build-package-sub':

package/bin/scripts/audit-package.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const auditUtils = require('../../scripts/csdr/audit/audit-utils');
+const configUtils = require('../../scripts/csdr/config/config-utils');
+
+Promise.resolve()
+  .then(() => {
+    const pkg = configUtils.packages.getPackage();
+    return auditUtils.styles.audit(pkg);
+  })

package/bin/scripts/csdr-upgrade-deps.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const installUtils = require('../../scripts/csdr/install/install-utils');
-const configUtils = require('../../scripts/csdr/config/config-utils');
 const tools = require('../../scripts/utils/tools');
 
 const { pkg } = tools.getArgs();
@@ -9,10 +8,8 @@ const { pkg } = tools.getArgs();
 Promise.resolve()
   .then(() => {
 
-    const resolvedPkg = configUtils.packages.getPackage(pkg, false, true);
-
     if (pkg) {
-      return installUtils.localDev.install(resolvedPkg);
+      return installUtils.localDev.installPackage(pkg);
     } else {
       return installUtils.localDev.install();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@eui/tools",
-    "version": "6.1.0",
+    "version": "6.1.1",
     "tag": "latest",
     "license": "EUPL-1.1",
     "description": "eUI common tools and scripts",

package/sandbox.js

@@ -1,6 +1,8 @@
 'use strict';
 const path = require('path');
 const fs = require('fs');
+const moment = require('moment');
+const execa = require('execa');
 const glob = require('glob');
 const tools = require('./scripts/utils/tools');
 const semver = require('semver');
@@ -586,14 +588,7 @@ const versionUtils = require('./scripts/csdr/version/version-utils');
 
 //   })
 
-// return Promise.resolve()
-//   .then(() => {
-//     const a = configUtils.packages.getCsdrRemotePackages()
-//                 .map((p) => {
-//                   return { name: p.name, npmPkg: p.npmPkg }
-//                 });
-//     console.log(tools.sortArray(a, 'name'));
-//   })
+
 // return Promise.resolve()
 //   .then(() => {
 //     console.log('t1')
@@ -774,16 +769,6 @@ const versionUtils = require('./scripts/csdr/version/version-utils');
 
 
 
-// const pkg = configUtils.packages.getPackage('opsys-epc-esub-bo-ui', true);
-
-// Promise.resolve()
-//   .then(() => {
-//     return metadataUtils.package.getPackageVersionsByMajor(pkg, '9', false)
-//   })
-//   .then((versions) => {
-//     console.log(versions);
-//     console.log(versions.splice(-1)[0].version);
-//   })
 
 
 // PROJECT VERSION CSDR BUILD TESTING (à la carte way === MWP / PMO MOBILE / SEDIA)
@@ -908,3 +893,137 @@ const versionUtils = require('./scripts/csdr/version/version-utils');
 // }
 
 // migrateConfig();
+
+
+
+// const pkg = configUtils.packages.getPackage('ppxms-core-ui', true);
+
+// Promise.resolve()
+//   .then(() => {
+//     return metadataUtils.package.getPackageVersionsByMajor(pkg, '1')
+//   })
+//   .then((versions) => {
+//     console.log(versions);
+//     console.log(versions.splice(-1)[0].version);
+//   })
+
+// return Promise.resolve()
+//   .then(() => {
+//     const a = configUtils.packages.getCsdrRemotePackages(10, 'sedia')
+//                 .map((p) => {
+//                   return { name: p.name, npmPkg: p.npmPkg }
+//                 });
+//     console.log(tools.sortArray(a, 'name'));
+//   })
+
+// Promise.resolve()
+//   .then(() => {
+//     const prj = configUtils.projects.getCsdrProject('my-workplace-host-playground');
+//     return installUtils.projects.getLocalProjectRemoteDeps(prj);
+//   })
+
+// Promise.resolve()
+//   .then(() => {
+
+//   })
+
+
+
+
+
+
+// STYLES AUDIT TESTS
+
+Promise.resolve()
+  .then(() => {
+    const { pkg } = tools.getArgs();
+    const p = configUtils.packages.getPackage(pkg, true);
+    return auditUtils.styles.audit(p);
+  })
+
+// const installPackages = async packages => {
+//   const promises = packages.map(async p => {
+//     const pkg = configUtils.packages.getPackageByNpmPkg(p.npmPkg, true);
+//     await gitUtils.cloneRepo(pkg.repository, pkg.paths.root, false, true);
+//   })
+
+//   await Promise.all(promises);
+// }
+
+
+// Promise.resolve()
+//   .then(() => {
+//     return metadataUtils.common.getDevopsMetadata();
+//   })
+//   .then((metadata) => {
+//     let packages = metadata.packages.filter((p) => {
+//       return moment(p.date, 'YYYYMMDD-H24:mm') > moment().subtract(12, 'months');
+//     }).filter((p) => {
+//       return p.name.indexOf('ui') > -1 &&
+//              p.name.indexOf('remote') === -1 && p.npmPkg !== undefined &&
+//              p.name.indexOf('sfc') === -1 && p.name.indexOf('sedia') === -1;
+//     })
+
+//     console.log(packages);
+//     console.log(packages.length);
+
+//     packages = packages.filter((p) => {
+//       return !tools.isDirExists(path.join(process.cwd(), 'packages', p.name));
+//     })
+
+//     console.log(packages.length);
+
+//     // installPackages(packages);
+//   })
+
+// Promise.resolve()
+//   .then(() => {
+//     let folders = tools.getFolders(path.join(process.cwd(), 'packages'));
+//     folders = folders.filter((f) => {
+//       const scopes = ['cc','csdr','eac','opsys','mywp','sygma','redress','ppams','ppxms','urf'];
+//       return scopes.some((s) => {
+//         return f.includes(s);
+//       })
+//     })
+//     .filter((f) => {
+//       return tools.isFileExists(path.join(process.cwd(), 'packages', f, 'dependencies-composite.json'));
+//     })
+
+//     const JSONResult = [];
+//     folders.forEach((f) => {
+//       const pkg = configUtils.packages.getPackage(f, true);
+//       const report = auditUtils.styles.runStylesAudit(pkg);
+//       JSONResult.push(report);
+//     })
+
+//     const sumarryResult = JSONResult.map((p) => {
+//       return {
+//         package: p.package,
+//         score: p.score,
+//         total: p.total,
+//         pcScore: p.pcScore
+//       }
+//     })
+
+//     const finalResult = {
+//       summary: tools.sortArray(sumarryResult, 'pcScore', 'desc'),
+//       details: JSONResult
+//     }
+
+//     tools.writeJsonFileSync(path.join(process.cwd(), 'audit-styles.json'), finalResult);
+//     tools.writeJsonFileSync(path.join(process.cwd(), 'audit-styles-summary.json'), sumarryResult);
+
+
+//     // folders.forEach((f) => {
+//     //   try {
+//     //     const pPath = path.join(process.cwd(), 'packages', f);
+//     //     console.log(pPath);
+
+//     //     execa.shellSync(`git pull`, { cwd: pPath, stdio: 'inherit' });
+//     //     execa.shellSync(`git checkout next/eui10`, { cwd: pPath, stdio: 'inherit' });
+//     //   } catch(e) {
+//     //     console.log(e);
+//     //   }
+//     // })
+
+//   })

package/scripts/csdr/audit/audit-utils.js

@@ -1,100 +1,5 @@
 'use strict';
 
-// GLOBAL
-const path = require('path');
-const execa = require('execa');
-
-// LOCAL
-const tools = require('../../utils/tools');
-const notificationUtils = require('../../utils/notification/notification-utils');
-
-const { dryRun } = tools.getArgs();
-
-const getVulnerabilitiesList = () => {
-  let auditContent;
-  const auditFile = path.join(process.cwd(), 'audit.json');
-
-  if (tools.isFileExists(auditFile)) {
-    auditContent = tools.getFileContent(auditFile);
-  } else {
-    tools.logWarning(`${auditFile} not found... unable to precess audit content`);
-    return null;
-  }
-
-  let auditContentArray = [];
-  let vulnerabilitiesFound = {};
-
-  // yarn audit output uses a specific json-lines format, we need to split it first
-  auditContentArray = auditContent.split('\n');
-
-  // extracting the audit summary lines
-  auditContentArray.forEach((c) => {
-    try {
-      const parsedContent = JSON.parse(c);
-      if (parsedContent && parsedContent.type === 'auditSummary') {
-        vulnerabilitiesFound = parsedContent.data.vulnerabilities;
-      }
-    } catch(e) {} // it can fail
-  })
-
-  return vulnerabilitiesFound;
-}
-
-
-module.exports.audit = (pkg) => {
-  if (dryRun) return;
-
-  return Promise.resolve()
-
-    // first pass to display the visual report into the CI logs
-    .then(() => {
-      return Promise.resolve()
-        .then(() => {
-          return execa.shellSync('yarn audit --level high', { cwd: process.cwd(), stdio: 'inherit' });
-        })
-        .catch((e) => {}) // it can fail
-    })
-
-    // second pass to extract the audit summary lines
-    .then(() => {
-      return Promise.resolve()
-        .then(() => {
-          const auditFile = path.join(process.cwd(), 'audit.json');
-          tools.logInfo(`Creating audit file`)
-          return execa.shellSync(`yarn audit --level high --json > ${auditFile}`, { cwd: process.cwd(), stdio: 'inherit' });
-        })
-        .then(() => {
-          tools.logSuccess();
-          return null;
-        })
-        .catch((e) => {
-          tools.logError('Auditing detected vulnerabilities in dependencies');
-          return getVulnerabilitiesList();
-        })
-    })
-
-    // sending output to slack channel
-    .then((vulnerabilityReport) => {
-      if (!vulnerabilityReport) {
-        tools.logSuccess('OK, no vulnerabilities detected');
-
-        return notificationUtils.package.sendPackageMessage({
-          package: pkg,
-          text: 'Dependencies audit : NO vulnerabilities detected'
-        });
-
-      } else {
-        tools.logWarning(JSON.stringify(vulnerabilityReport));
-
-        let message = '';
-        Object.entries(vulnerabilityReport).forEach((v) => {
-          message += `${v[0]}:*${v[1]}* `;
-        });
-
-        return notificationUtils.package.sendPackageMessage({
-          package: pkg,
-          text: `Dependencies audit detected vulnerabilities : ${message}`
-        });
-      }
-    })
-}
+module.exports.yarn = require('./yarn');
+module.exports.deps = require('./deps');
+module.exports.styles = require('./styles');

package/scripts/csdr/audit/deps.js

@@ -0,0 +1,89 @@
+'use strict';
+
+// GLOBAL
+const path = require('path');
+const glob = require('glob');
+
+// LOCAL
+const tools = require('../../utils/tools');
+const notificationUtils = require('../../utils/notification/notification-utils');
+
+
+module.exports.audit = (pkg) => {
+  tools.logTitle('Auditiing package internal dependencies complexity');
+
+  return Promise.resolve()
+   .then(() => {
+     var depsFound = [];
+     var files = glob.sync('**/*.ts', { cwd: pkg.paths.pkgLibFolder, nodir: true, follow: true, dot: true });
+     files.forEach(file => {
+       const filePath = path.join(pkg.paths.pkgLibFolder, file);
+       const fileContent = tools.getFileContent(filePath);
+       var regex = /@cc\/|@mywp\/|@opsys\/|@sfc\//gi, result, indices = [];
+       while ( (result = regex.exec(fileContent)) ) {
+           indices.push(result.index);
+       }
+       if (indices.length !== 0) {
+         // tools.logInfo(`Number of occurences found : ${indices.length}`);
+         indices.forEach((i) => {
+           const endPos = fileContent.substr(i, 40).indexOf("'");
+           const dep = fileContent.substr(i, endPos);
+           if (endPos > -1) {
+             // tools.logInfo(`dep found on : ${dep}`);
+             depsFound.push(dep);
+
+           } else {
+             tools.logInfo(`Potential wrong import detected on file : ${file}`);
+             const subContent = fileContent.substr(i, 40);
+             const detectMultiSlashes = subContent.match(/\//g);
+             if (detectMultiSlashes.length > 0) {
+               tools.logError('Multislashes on import : ');
+               console.log(subContent);
+             }
+           }
+         })
+       }
+     });
+     depsFound = tools.removeArrayDuplicates(depsFound);
+     tools.logWarning(`Dependencies found : ${depsFound.length}`);
+     console.log(depsFound);
+
+     return depsFound;
+   })
+
+   .then((depsFound) => {
+     var depsLevel;
+
+     switch(true) {
+         case (depsFound.length === 1):
+           depsLevel = 'LOW (1)';
+           break;
+         case (depsFound.length > 1 && depsFound.length <= 3):
+           depsLevel = 'MEDIUM (between 1 and 3)';
+           break;
+         case (depsFound.length > 3 && depsFound.length <= 5):
+           depsLevel = 'HIGH (between 3 and 5)';
+           break;
+         case (depsFound.length > 5):
+           depsLevel = 'VERY HIGH (>5)';
+           break;
+         default:
+           depsLevel = 'NONE';
+     }
+
+     var message = `Internal dependencies detected : ${depsFound.length} - deps level: ${depsLevel}\n`;
+     message += depsFound.join('\n');
+
+
+     return notificationUtils.package.sendPackageMessage({
+      package: pkg,
+      text: message
+     });
+   })
+
+   .catch((e) => {
+     console.log(e);
+   })
+
+ }
+