@eui/tools 6.15.1 → 6.15.2

package/.version.properties

@@ -1 +1 @@
-6.15.1
+6.15.2

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 6.15.2 (2023-12-16)
+
+##### Chores
+
+* **other:**
+  * remove app-history metadata storage - adapt pipeline config location to root - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([0b05424a](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/0b05424a61740d383afb052b887895b59080e7f6))
+
+* * *
+* * *
 ## 6.15.1 (2023-12-15)
 
 ##### Bug Fixes

package/package.json

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

package/sandbox.js

@@ -1469,11 +1469,11 @@ const publishUtils = require('./scripts/utils/publish/publish-utils');
 //   .then(() => {
 //     const dPath = path.join(process.cwd(), 'packages', 'devops-metadata');
 //     let files = tools.getFiles(dPath);
-//     files = files.filter(f => f.indexOf('-lib-') > -1);
+//     files = files.filter(f => f.indexOf('-ui-history-metadata.json') > -1);
 //     console.log(files.length);
 //     files.forEach(f => {
 //       console.log(f);
-//       // tools.remove(path.join(dPath, f));
+//       tools.remove(path.join(dPath, f));
 //     });
 //   })
 
@@ -1488,16 +1488,25 @@ const publishUtils = require('./scripts/utils/publish/publish-utils');
 //   })
 
 
+// Promise.resolve()
+//   .then(() => {
+//     const remote = configUtils.remotes.getRemote('cc-pmm-participants-eui15-remote-el-ui');
+//     return metadataUtils.remoteHistory.generateDiffCommitsMetadataReport(remote, 'TRN');
+//   })
+
+//   .then((finalOutput) => {
+//     console.log(finalOutput);
+//   })
+
+//   .catch((e) => {
+//     console.log(e);
+//   })
+
 Promise.resolve()
   .then(() => {
-    const remote = configUtils.remotes.getRemote('cc-pmm-participants-eui15-remote-el-ui');
-    return metadataUtils.remoteHistory.generateDiffCommitsMetadataReport(remote, 'TRN');
-  })
-
-  .then((finalOutput) => {
-    console.log(finalOutput);
-  })
+    const config = configUtils.global.getConfig();
+    console.log(config);
 
-  .catch((e) => {
-    console.log(e);
+    const isSonarEnabled = metadataUtils.common.isSonarEnabled();
+    console.log(isSonarEnabled);
   })

package/scripts/csdr/config/global.js

@@ -143,7 +143,7 @@ const getGeneratedConfig = (euircBaseFile) => {
 }
 
 
-module.exports.getConfig = () => {
+const getConfig = module.exports.getConfig = () => {
   let configFile;
   let isCsdr;
 
@@ -157,7 +157,7 @@ module.exports.getConfig = () => {
 
   if (!tools.isFileExists(configFile)) {
     tools.logError('ERROR!!! .euirc file missing - use npm run init to generate it ');
-    throw 'CONFIG_FILE_NOT_FOUND';
+    throw new Error('CONFIG_FILE_NOT_FOUND');
   }
 
   if (isCsdr) {
@@ -241,7 +241,6 @@ module.exports.getConfigOptions = () => {
     DEVOPS_METADATA_LOCKS_REPOSITORY: null,
     DEVOPS_METADATA_PATH: null,
     DEVOPS_METADATA_LOCKS_PATH: null,
-    DEVOPS_CONFIG_JSON: '.devops-config.json',
     CSDR_REMOTES_CONFIG_REPOSITORY: null,
     CSDR_REMOTES_CONFIG_PATH: null,
     ISSUES_MANAGER_HOST: null,
@@ -489,3 +488,48 @@ module.exports.getCustomConfig = () => {
     return null;
   }
 }
+
+
+
+const checkPipelineEnabled = (assetName, pipelineType) => {
+  tools.logTitle(`Checking pipeline enabled flags for - ${pipelineType}`);
+  const pipelineConfig = getConfig().pipeline;
+  console.log(pipelineConfig);
+
+  if (pipelineConfig && pipelineConfig.enabledFlags && pipelineConfig.enabledFlags[pipelineType]) {
+    return;
+  } else {
+    if (assetName && pipelineConfig.enabledFlags.bypassPackages && pipelineConfig.enabledFlags.bypassPackages[assetName]) {
+      tools.logInfo(`Package : [${assetName}] enabled bypass activated`);
+      return;
+    } else {
+      throw new Error('GLOBAL_PIPELINE_DISABLED');
+    }
+  }
+}
+
+module.exports.isPipelineEnabled = (pkg) => {
+  if (pkg) {
+    if (pkg.backend) {
+      return checkPipelineEnabled(pkg.name, 'backend');
+    } else {
+      return checkPipelineEnabled(pkg.name, 'frontend');
+    }
+
+  } else {
+    return checkPipelineEnabled(null, 'app');
+  }
+}
+
+
+module.exports.isSonarEnabled = () => {
+    tools.logTitle(`Checking sonar enabled flag`);
+    const pipelineConfig = getConfig().pipeline;
+    console.log(pipelineConfig);
+
+    if (pipelineConfig && pipelineConfig.sonarEnabled) {
+      return true;
+    }
+
+    return false;
+}

package/scripts/csdr/metadata/app-envs.js

@@ -3,7 +3,6 @@
 // GLOBAL
 const path = require('path');
 const moment = require('moment');
-// const sanitizeHtml = require('sanitize-html');
 
 // LOCAL
 const tools = require('../../utils/tools');
@@ -43,7 +42,8 @@ const storeMetadata = (project, newVersion, metadata, envTarget) => {
 
       const metadataFile = path.join(DEVOPS_METADATA_PATH, project.devopsEnvsMetadataFile);
 
-      var generatedMetadata;
+      let generatedMetadata;
+
       if (tools.isFileExists(metadataFile)) {
         generatedMetadata = require(metadataFile);
       } else {

package/scripts/csdr/metadata/app-history.js

@@ -3,7 +3,6 @@
 // GLOBAL
 const path = require('path');
 const execa = require('execa');
-// const sanitizeHtml = require('sanitize-html');
 const moment = require('moment');
 const semver = require('semver');
 
@@ -55,24 +54,24 @@ const storeMetadata = (project, diffMetadata, newVersion, envTarget) => {
 
   return Promise.resolve()
 
-    // flatten jira key list from diffMetadata extracted
-    .then(() => {
-      diffMetadata.forEach((pkg) => {
-        pkg.gitMetadata.forEach((gitMetadata) => {
-          gitMetadata.forEach((v) => {
-            if (v.issue) flatJiraList.push(v.issue);
-          })
-        })
-      })
+    // // flatten jira key list from diffMetadata extracted
+    // .then(() => {
+    //   diffMetadata.forEach((pkg) => {
+    //     pkg.gitMetadata.forEach((gitMetadata) => {
+    //       gitMetadata.forEach((v) => {
+    //         if (v.issue) flatJiraList.push(v.issue);
+    //       })
+    //     })
+    //   })
 
-      flatJiraList = tools.removeArrayDuplicates(flatJiraList);
-    })
+    //   flatJiraList = tools.removeArrayDuplicates(flatJiraList);
+    // })
 
     // store the history file
     .then(() => {
       const historyFile = path.join(DEVOPS_METADATA_PATH, project.devopsHistoryMetadataFile);
 
-      var versions = [];
+      let versions = [];
 
       if (tools.isFileExists(historyFile)) {
         historyMetadata = require(historyFile);
@@ -84,14 +83,14 @@ const storeMetadata = (project, diffMetadata, newVersion, envTarget) => {
           name: newVersion,
           diffs: diffMetadata,
           envTarget: envTarget,
-          issues: flatJiraList
+          // issues: flatJiraList
         });
 
       } else {
         versions.push({
           name: newVersion,
           diffs: diffMetadata,
-          issues: flatJiraList
+          // issues: flatJiraList
         });
       }
 
@@ -103,20 +102,20 @@ const storeMetadata = (project, diffMetadata, newVersion, envTarget) => {
 
     })
 
-    // storing issuesList gathered into gitlab variables for post CI processing
-    .then(() => {
-      if (!flatJiraList) {
-        tools.logWarning('No issues found for this release');
+    // // storing issuesList gathered into gitlab variables for post CI processing
+    // .then(() => {
+    //   if (!flatJiraList) {
+    //     tools.logWarning('No issues found for this release');
 
-      } else {
-        const issuesList = flatJiraList.join(',');
-        tools.logInfo(`Unique issues found for this version : ${issuesList}`);
+    //   } else {
+    //     const issuesList = flatJiraList.join(',');
+    //     tools.logInfo(`Unique issues found for this version : ${issuesList}`);
 
-        if (!dryRun) {
-          return pipelineUtils.setVariables(project.paths.rootPath, `export ISSUES_LIST=${issuesList}\n`);
-        }
-      }
-    })
+    //     if (!dryRun) {
+    //       return pipelineUtils.setVariables(project.paths.rootPath, `export ISSUES_LIST=${issuesList}\n`);
+    //     }
+    //   }
+    // })
 
 
     .then(() => {
@@ -140,8 +139,6 @@ const getDiffBetweenBuildVersions = (fromBuildMetadata, toBuildMetadata, hasHist
 
   tools.logInfo(`Fetching diffs between ${fromBuildMetadata.name} and ${toBuildMetadata.name}`);
 
-  const DEVOPS_METADATA_PATH = configUtils.global.getConfigOptions().DEVOPS_METADATA_PATH;
-
   return Promise.resolve()
     .then(() => {
       // get differences from old in previous major release to new currently generated
@@ -159,48 +156,7 @@ const getDiffBetweenBuildVersions = (fromBuildMetadata, toBuildMetadata, hasHist
                item.package.indexOf('@eui') === -1;
       })
 
-      // Iterate over the
-      const mappedPkg = cleanDiffs.map((item) => {
-
-        tools.logInfo(`parsing item : ${item.package}`);
-
-        // getting the package name from the devops central metadata
-        const pkg = configUtils.packages.getPackageByNpmPkg(item.package, true);
-        let pkgName;
-        if (pkg) {
-          pkgName = pkg.name;
-        }
-
-        tools.logInfo('checking package : ' + pkgName);
-
-        // getting package file metadata
-        const packageMetadataFile = path.join(DEVOPS_METADATA_PATH, pkgName + '-build-metadata.json');
-
-        if (tools.isFileExists(packageMetadataFile)) {
-
-          const packageMetadata = require(packageMetadataFile);
-
-          // extracting versions history arry
-          const fromVersionIdx = packageMetadata.versions.findIndex(v => v.name === item.old);
-          const toVersionIdx = packageMetadata.versions.findIndex(v => v.name === item.new);
-
-          // slice the array with only the versions changed
-          const diffVersions = packageMetadata.versions.slice(fromVersionIdx + 1, toVersionIdx + 1);
-
-          // accumulate git metadata for the versions found for the release
-          var accGitMetadata = diffVersions.reduce((acc, k) => {
-            const gitCommits = k.gitMetadata.commits.map((item) => {
-              return { issue: item.issue, subject: item.subject }
-            })
-            acc.push(gitCommits);
-            return acc;
-          }, []);
-
-          return { name: pkgName, old: item.old, new: item.new, gitMetadata: accGitMetadata };
-        }
-      })
-
-      return mappedPkg;
+      return cleanDiffs;
     })
 
     .catch((e) => {
@@ -227,7 +183,6 @@ const getDiffByEnvTarget = (project, envTarget) => {
 
       if (!fromVersion || !toVersion) {
         tools.logWarning('WARNING: could not find versions matching for generating diff report');
-        return;
       } else {
         return getDiffBetweenBuildVersions(fromVersion, toVersion, hasHistory);
       }
@@ -264,8 +219,8 @@ const getDiffBetweenMajors = (project, fromVersion, toVersion, isSupportBranch)
       })
 
       // Getting the version objects, by default if not provided take the latest previous
-      var fromMajorVersionIdx;
-      var toMajorVersionIdx;
+      let fromMajorVersionIdx;
+      let toMajorVersionIdx;
 
       if (fromVersion) {
         fromMajorVersionIdx = appMajorVersions.findIndex(v => v.name === fromVersion);
@@ -332,7 +287,7 @@ const flattenDiffMetadata = (metadata) => {
   return Promise.resolve()
     .then(() => {
       return metadata.map((item) => {
-        return { package: item.name, fromVersion: item.old, toVersion: item.new };
+        return { package: item.package, fromVersion: item.old, toVersion: item.new };
       });
     })
 

package/scripts/csdr/metadata/app-versions.js

@@ -33,18 +33,17 @@ module.exports.getMetadata = (project) => {
 
 module.exports.storeMetadata = (project, newVersion, envTarget) => {
   const appReleaseDate = moment(new Date()).format("DD/MM/YYYY HH:mm");
-  const appInfos = `${newVersion} - ${appReleaseDate}`;
   const DEVOPS_METADATA_PATH = configUtils.global.getConfigOptions().DEVOPS_METADATA_PATH;
 
   return Promise.resolve()
     .then(() => {
       tools.logTitle('Storing application versions metadata...');
 
-
       const metadataFile = path.join(DEVOPS_METADATA_PATH, project.devopsVersionsMetadataFile);
 
-      var generatedMetadata;
-      var versions;
+      let generatedMetadata;
+      let versions;
+
       if (tools.isFileExists(metadataFile)) {
         generatedMetadata = require(metadataFile);
         versions = generatedMetadata.versions;

package/scripts/csdr/metadata/app.js

@@ -41,8 +41,8 @@ const storeMetadata = (project, newVersion, metadata, envTarget) => {
     .then(() => {
       tools.logTitle('Storing application metadata...');
 
-      var generatedMetadata;
-      var versions;
+      let generatedMetadata;
+      let versions;
 
       const metadataFile = path.join(DEVOPS_METADATA_PATH, project.devopsMetadataFile);
 

package/scripts/csdr/metadata/commit.js

@@ -25,10 +25,6 @@ const getMetadata = (pkg, opts) => {
       buildMetadata.commits = commits;
 
       if (commits.length !== 0) {
-        // tools.logInfo('Extracted commits : ');
-        // commits.forEach((commit) => {
-        //   tools.logInfo('commit : ' + JSON.stringify(commit));
-        // });
         tools.logSuccess();
       } else {
         tools.logInfo('No valid commit found');
@@ -94,7 +90,7 @@ const extractCommits = (pkg, opts) => {
 
   return Promise.resolve()
     .then(() => {
-      var tag;
+      let tag;
 
       if (opts.fromTag) {
         tag = opts.fromTag;
@@ -108,7 +104,7 @@ const extractCommits = (pkg, opts) => {
       return tag;
     })
     .then((tag) => {
-      var revisions;
+      let revisions;
 
       if (tag) {
         tag = tag.toString().trim();
@@ -130,9 +126,8 @@ const extractCommits = (pkg, opts) => {
           return null;
         }
 
-        var lines = raw.split('\n');
-        var commit = {};
-        var parsedMessage;
+        let lines = raw.split('\n');
+        let commit = {};
 
         commit.hash = lines[0];
         commit.subject = lines[1];
@@ -143,7 +138,7 @@ const extractCommits = (pkg, opts) => {
         commit.breakingChange = false;
 
         if (commit.body) {
-          var parsedIssueBody = commit.body.match(ISSUE_PATTERN);
+          let parsedIssueBody = commit.body.match(ISSUE_PATTERN);
           if (parsedIssueBody) {
             commit.issue = parsedIssueBody[0];
           }
@@ -156,8 +151,8 @@ const extractCommits = (pkg, opts) => {
 
         commit.originalSubject = commit.subject;
 
-        var parsed = commit.subject.match(COMMIT_PATTERN);
-        var parsedIssue = commit.subject.match(ISSUE_PATTERN);
+        let parsed = commit.subject.match(COMMIT_PATTERN);
+        let parsedIssue = commit.subject.match(ISSUE_PATTERN);
 
         if (!parsed || !parsed[1]) {
           if (commit.subject.indexOf('Merge pull request') === -1 &&
@@ -239,7 +234,7 @@ const checkCommitsMetadata = (metadata) => {
       if (!metadata.commits || metadata.commits.length === 0) {
         tools.logError('ERROR : no valid commit found since last release');
         if (!skipCommitChecks) {
-          throw 'NO_VALID_COMMIT_FOUND';
+          throw new Error('NO_VALID_COMMIT_FOUND');
         }
       }
 
@@ -247,7 +242,7 @@ const checkCommitsMetadata = (metadata) => {
       if (!metadata.issues || metadata.issues.length === 0) {
         tools.logError('ERROR : no issue found since last release');
         if (!skipCommitChecks) {
-          throw 'NO_ISSUE_FOUND';
+          throw new Error('NO_ISSUE_FOUND');
         }
       }
 

package/scripts/csdr/metadata/common.js

@@ -52,89 +52,3 @@ module.exports.cloneMetadataLocksRepo = () => {
       })
   }
 }
-
-
-const getDevopsConfig = () => {
-  const configOptions = configUtils.global.getConfigOptions();
-  const DEVOPS_METADATA_PATH = configOptions.DEVOPS_METADATA_PATH;
-  const DEVOPS_CONFIG_JSON = configOptions.DEVOPS_CONFIG_JSON;
-
-  return Promise.resolve()
-    .then(() => {
-      if (!DEVOPS_METADATA_PATH) {
-        throw new Error(`Devops metadata folder ${DEVOPS_METADATA_PATH} NOT FOUND`);
-      }
-
-      return tools.getJsonFileContent(
-        path.join(DEVOPS_METADATA_PATH, DEVOPS_CONFIG_JSON)
-      );
-    })
-    .catch((e) => {
-      throw e;
-    })
-}
-
-
-const checkPipelineEnabled = (assetName, pipelineType) => {
-  return Promise.resolve()
-    .then(() => {
-      return getDevopsConfig();
-    })
-
-    .then((config) => {
-      tools.logTitle(`Checking pipeline enabled flags for - ${pipelineType}`);
-      console.log(config);
-
-      if (config && config.enabledFlags && config.enabledFlags[pipelineType]) {
-        return;
-      } else {
-        if (assetName && config.enabledFlags.bypassPackages && config.enabledFlags.bypassPackages[assetName]) {
-          tools.logInfo(`Package : [${assetName}] enabled bypass activated`);
-          return;
-        } else {
-          throw 'GLOBAL_PIPELINE_DISABLED';
-        }
-      }
-    })
-
-    .catch((e) => {
-      throw e;
-    })
-}
-
-
-module.exports.isPipelineEnabled = (pkg) => {
-  if (pkg) {
-    if (pkg.backend) {
-      return checkPipelineEnabled(pkg.name, 'backend');
-    } else {
-      return checkPipelineEnabled(pkg.name, 'frontend');
-    }
-
-  } else {
-    return checkPipelineEnabled(null, 'app');
-  }
-}
-
-
-module.exports.isSonarEnabled = () => {
-  return Promise.resolve()
-  .then(() => {
-    return getDevopsConfig();
-  })
-
-  .then((config) => {
-    tools.logTitle(`Checking sonar enabled flag`);
-    console.log(config);
-
-    if (config && config.sonarEnabled) {
-      return true;
-    } else {
-      return false;
-    }
-  })
-
-  .catch((e) => {
-    throw e;
-  })
-}

package/scripts/csdr/metadata/remote-history.js

@@ -309,7 +309,7 @@ module.exports.storeMetadataHistory = (pkg, metadata, newVersion) => {
     .then(() => {
       const historyFile = path.join(DEVOPS_METADATA_PATH, pkg.devopsHistoryMetadataFile);
 
-      var versions = [];
+      let versions = [];
 
       if (tools.isFileExists(historyFile)) {
         historyMetadata = require(historyFile);

package/scripts/csdr/release/app/release-app-group.js

@@ -76,7 +76,7 @@ module.exports.run = () => {
       // *****************************************************************
       .then(() => {
         // check if global flag is enabled, if not enabled, this will throw a GLOBAL_PIPELINE_DISABLED exception
-        return metadataUtils.common.isPipelineEnabled();
+        return configUtils.global.isPipelineEnabled();
       })
 
       // *****************************************************************

package/scripts/csdr/release/app/release-app.js

@@ -107,7 +107,7 @@ module.exports.run = () => {
       // *****************************************************************
       .then(() => {
         // check if global flag is enabled, if not enabled, this will throw a GLOBAL_PIPELINE_DISABLED exception
-        return metadataUtils.common.isPipelineEnabled();
+        return configUtils.global.isPipelineEnabled();
       })
 
       // *****************************************************************
@@ -199,18 +199,6 @@ module.exports.run = () => {
             .then((flatDiffMetadata) => {
               return utils.notification.project.sendProjectDiffReportMessage(project, flatDiffMetadata);
             })
-
-            .then(() => {
-              // process v1
-              if (!isSnapshot && !envTarget) {
-                return metadataUtils.appHistory.storeMetadata(project, diffMetadata, newVersion);
-              }
-
-              // process v2
-              if (envTarget && envTarget !== 'DEV') {
-                return metadataUtils.appHistory.storeMetadata(project, diffMetadata, newVersion, envTarget);
-              }
-            });
         }
       })
 

package/scripts/csdr/release/package/common.js

@@ -164,6 +164,25 @@ module.exports.cloneMetadataRepos = (pkg) => {
 }
 
 
+module.exports.cloneMetadataLocksRepos = (pkg) => {
+  utils.tools.logBanner('CLONE METADATA LOCKS REPOS');
+
+  return Promise.resolve()
+  // CLONE METADATA LOCKS REPO
+  .then(() => {
+    if (pkg.build && pkg.build.skipLock) {
+      utils.tools.logInfo('Package has lock de-activated...skipping cloning of devops-metadata-locks repository');
+
+    } else {
+      return metadataUtils.common.cloneMetadataLocksRepo();
+    }
+  })
+  .catch((e) => {
+    throw e;
+  })
+}
+
+
 module.exports.preReleaseChecks = (pkg) => {
   if (dryRun) {
     return;
@@ -176,7 +195,7 @@ module.exports.preReleaseChecks = (pkg) => {
   // GET AND CHECK DEVOPS CONFIG
   .then(() => {
     // check if global flag is enabled, if not enabled, this will throw a GLOBAL_PIPELINE_DISABLED exception
-    return metadataUtils.common.isPipelineEnabled(pkg);
+    return configUtils.global.isPipelineEnabled(pkg);
   })
 
   // CHECK BRANCH VALIDITY

package/scripts/csdr/release/package/release-ui.js

@@ -48,9 +48,10 @@ module.exports.run = () => {
         return innerCommon.init(pkg, envTarget);
       })
 
-      // FOR UI and REMOTES clone metadata repositories
+      // TODO for UI PKG, to store and avoid race-conditions between similar pkg build, find a better way to handle this avoiding this repo
+      // clone metadata locks repo repositories
       .then(() => {
-        return innerCommon.cloneMetadataRepos(pkg);
+        return innerCommon.cloneMetadataLocksRepos(pkg);
       })
 
       // PRE-RELEASE & COMMON CHECKS

package/scripts/utils/sonar/sonar-utils.js

@@ -12,7 +12,6 @@ const notificationUtils = require('../notification/notification-utils');
 // CSDR RELATED
 const templateUtils = require('../../csdr/templates/template-utils');
 const configUtils = require('../../csdr/config/config-utils');
-const metadataUtils = require('../../csdr/metadata/metadata-utils');
 
 // FETCH ARGS
 const { branch, dryRun, sonarQubeToken } = tools.getArgs();
@@ -22,7 +21,7 @@ const { branch, dryRun, sonarQubeToken } = tools.getArgs();
 const runCore = (pkg, isMaster) => {
 
   // check at metadata global flag level if enabled
-  if (!metadataUtils.common.isSonarEnabled) {
+  if (!configUtils.global.isSonarEnabled()) {
     tools.logInfo('Sonar scanner globally disabled');
     return Promise.resolve();
   }