@eui/tools 6.4.2 → 6.4.4

package/.version.properties

@@ -1 +1 @@
-6.4.2
+6.4.4

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 6.4.4 (2023-02-23)
+
+##### Chores
+
+* **other:**
+  * send msteams channel email to gitlab vars for XLR processing - EUI-7146 [EUI-7146](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7146)  ([665f70bb](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/665f70bb7fea498c15577810deb129bb2ba2a287))
+
+* * *
+* * *
+## 6.4.3 (2023-02-23)
+
+##### Chores
+
+* **other:**
+  * limit the number of commit output for MS Teams message - EUI-7146 [EUI-7146](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7146)  ([616070b3](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/616070b3daaaae67fc5753c490290c14f9790738))
+  * adapted teams notification message for exception and commits outpuy - EUI-7146 [EUI-7146](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7146)  ([58f0f958](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/58f0f9587af636311c43d9a979ea3d4acb5c5511))
+
+* * *
+* * *
 ## 6.4.2 (2023-02-22)
 
 ##### Chores

package/package.json

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

package/sandbox.js

@@ -1181,9 +1181,33 @@ const versionUtils = require('./scripts/csdr/version/version-utils');
 //   })
 
 
-const teamsUtils = require('./scripts/utils/notification/teams-utils');
+// const teamsUtils = require('./scripts/utils/notification/teams-utils');
+
+// Promise.resolve()
+//   .then(() => {
+//     console.log(teamsUtils.getChannelHook('pipeline-ui-edui'));
+//   })
+
+// Promise.resolve()
+//   .then(() => {
+
+//     var startTime = moment('03-01-2021 01:01:01', 'DD-MM-YYYY hh:mm:ss');
+//     var endTime = moment('03-01-2021 01:04:53', 'DD-MM-YYYY hh:mm:ss');
+
+//     var secondsDiff = endTime.diff(startTime, 's');
+
+//     const getMinSec = (s) => { return(s-(s%=60))/60+'m'+(9<s?':':':0')+s+'s'; }
+//     const minSec = getMinSec(secondsDiff);
+//     console.log(minSec);
+//   })
 
 Promise.resolve()
   .then(() => {
-    console.log(teamsUtils.getChannelHook('pipeline-ui-edui'));
+    const options = configUtils.global.getConfigOptions();
+    console.log(options);
+
+    const pkg = configUtils.packages.getPackage('mapar-administration-ui');
+    const config = notificationUtils.config.getPackageConfig(pkg);
+
+    console.log(config);
   })

package/scripts/csdr/cli/skeletons/virtual-remote/15.x/dependencies.json

@@ -4,6 +4,7 @@
     "composite": {
         "@eui/deps-base": "^15.0.0",
         "@module.scope@/@module.name@": "^1.0.0",
+        "@cc/shared": "^4.0.0",
         "@csdr/core": "^4.0.0",
         "@csdr/integration": "^3.0.0"
     },

package/scripts/csdr/config/global.js

@@ -229,13 +229,11 @@ module.exports.getConfigOptions = () => {
     SLACK_CHANNEL_FRONTEND: null,
     SLACK_CHANNEL_BACKEND: null,
     SLACK_CHANNEL_PROJECT: null,
-    MAIL_ADDRESS_FRONTEND: null,
-    MAIL_ADDRESS_BACKEND: null,
-    MAIL_ADDRESS_PROJECT: null,
     MSTEAMS_HOST: null,
     MSTEAMS_FRONTEND_CHANNEL: null,
     MSTEAMS_BACKEND_CHANNEL: null,
     MSTEAMS_PROJECT_CHANNEL: null,
+    MSTEAMS_CHANNELS_EMAILS: null,
     API_HOST: null,
     AUDIT_DEPENDENCIES_GATES: null,
   }
@@ -327,22 +325,6 @@ module.exports.getConfigOptions = () => {
       }
     }
 
-    const mail = notification.mail;
-
-    if (mail) {
-      if (mail.channels) {
-        if (mail.channels.frontend) {
-          configOptions.MAIL_ADDRESS_FRONTEND = this.getNotificationMailAddress(mail.channels.frontend);
-        }
-        if (mail.channels.backend) {
-          configOptions.MAIL_ADDRESS_BACKEND = this.getNotificationMailAddress(mail.channels.backend);
-        }
-        if (mail.channels.project) {
-          configOptions.MAIL_ADDRESS_PROJECT = this.getNotificationMailAddress(mail.channels.project);
-        }
-      }
-    }
-
     const msteams = notification.msteams;
 
     if (msteams) {
@@ -361,6 +343,10 @@ module.exports.getConfigOptions = () => {
           configOptions.MSTEAMS_PROJECT_CHANNEL = msteams.channels.project;
         }
       }
+
+      if (msteams.channelsEmails) {
+        configOptions.MSTEAMS_CHANNELS_EMAILS = msteams.channelsEmails;
+      }
     }
   }
 
@@ -395,42 +381,6 @@ module.exports.getConfigOptions = () => {
 }
 
 
-module.exports.getNotificationMailChannel = (channelName) => {
-  const config = this.getConfig();
-  var channelPrefix;
-
-  if (config && config.notification && config.notification.mail && config.notification.mail.channelsMap) {
-    channelPrefix = config.notification.mail.channelsMap[channelName];
-    if (!channelPrefix) {
-      channelPrefix = config.notification.mail.channelsMap[config.notification.mail.defaultChannel];
-    }
-  }
-
-  return channelPrefix;
-}
-
-module.exports.getNotificationMailAddress = (channelName) => {
-  const config = this.getConfig();
-
-  const getChannel = (channelName) => {
-    let channelPrefix;
-
-    if (config && config.notification && config.notification.mail && config.notification.mail.channelsMap) {
-      channelPrefix = config.notification.mail.channelsMap[channelName];
-      if (!channelPrefix) {
-        channelPrefix = config.notification.mail.channelsMap[config.notification.mail.defaultChannel];
-      }
-    }
-
-    return channelPrefix;
-  }
-
-  const channelPrefix = getChannel(channelName);
-
-  return channelPrefix + config.notification.mail.addressSuffix;
-}
-
-
 module.exports.getLocalEuiVersion = () => {
   let euiVersionsLocal = [
     ...innerPackages.getLocalPackagesEuiVersion(),

package/scripts/index.js

@@ -31,7 +31,6 @@ module.exports.cleanUtils = require('./utils/clean/clean-utils');
 // utils - notification
 module.exports.notificationCommon = require('./utils/notification/common');
 module.exports.notificationConfig = require('./utils/notification/config');
-module.exports.notificationMailUtils = require('./utils/notification/mail-utils');
 module.exports.notificationMessageStack = require('./utils/notification/message-stack');
 module.exports.notificationUtils = require('./utils/notification/notification-utils');
 module.exports.notificationPackage = require('./utils/notification/package');

package/scripts/utils/notification/common.js

@@ -12,6 +12,7 @@ module.exports.getMessage = (options) => {
     mainText: null,
     detailTitle: null,
     detailText: null,
+    detailTextArray: [],
     text: options.text || null,
     status: null,
     statusColor: null
@@ -41,55 +42,57 @@ module.exports.getMessage = (options) => {
     switch (options.exception) {
       case 'NO_VALID_COMMIT_FOUND':
         message.detailTitle = 'NO VALID COMMIT FOUND!';
-        message.detailText = 'No valid commit found since last release tag\n' + '...Check trace file for details';
+        message.detailTextArray.push('No valid commit found since last release tag');
         break;
 
       case 'NO_ISSUE_FOUND':
         message.detailTitle = 'NO ISSUE FOUND!';
-        message.detailText = 'No issue found on commits since last release tag\n' + '...Check trace file for details\n';
+        message.detailTextArray.push('No issue found on commits since last release tag');
+        message.detailTextArray.push('Commit details:');
         if (options.metadata.commits && options.metadata.commits.length !== 0) {
-          message.detailText += options.metadata.commits.map((commit) => {
+          const commits = options.metadata.commits.map((commit) => {
             return metadataUtils.commit.formatCommit(commit);
-          }).join('\n');
+          });
+          message.detailTextArray = [...message.detailTextArray, ...commits];
         }
         break;
 
       case 'GLOBAL_PIPELINE_DISABLED':
         message.detailTitle = 'PIPELINE GLOBALLY DISABLED!';
-        message.detailText = 'Due to maintenance, all pipeline jobs have been temporary disabled - retry later';
+        message.detailTextArray.push('Due to maintenance, all pipeline jobs have been temporary disabled - retry later');
         break;
 
       case 'PACKAGE_LOCKED':
         message.detailTitle = 'CONCURRENT BUILD DETECTED FOR PACKAGE - ABORTING!';
-        message.detailText = 'Another build has been detected for the current package being build\n Retry again this build after 15m, lock will be auto-cleared';
+        message.detailTextArray.push('Another build has been detected for the current package being build\n Retry again this build after 15m, lock will be auto-cleared');
         break;
 
       case 'MULTIPLE_LOCAL_EUI_VERSIONS_FOUND':
         message.detailTitle = 'MULTIPLE eUI VERSIONS FOUND IN LOCAL PROJECT - ABORTING!';
-        message.detailText = 'Uncompatible version of eUI found installed in the local CSDR project, please adjust and keep same compatible versions of eUI packages and projects';
+        message.detailTextArray.push('Uncompatible version of eUI found installed in the local CSDR project, please adjust and keep same compatible versions of eUI packages and projects');
         break;
 
       case 'BRANCH_NOT_PROVIDED':
         message.detailTitle = 'RELEASE BRANCH missing - ABORTING!';
-        message.detailText = 'Package release needs to have a branch to build from as parameter from Bamboo';
+        message.detailTextArray.push('Package release needs to have a branch to build from as parameter from Bamboo');
         break;
 
       case 'REMOTE_ENVTARGET_NOT_MASTER_BRANCH':
         message.detailTitle = 'REMOTE envTarget type branchis different from master - ABORTING!';
-        message.detailText = 'For envTarget remote delivery or "à la carte", only the master branch is allowed for build, contact support if any question';
+        message.detailTextArray.push('For envTarget remote delivery or "à la carte", only the master branch is allowed for build, contact support if any question');
         break;
 
       case 'AUDIT_DEPENDENCIES_GATES_FAILED':
-        message.detailTitle = 'Audit dependencies gates for current eUI version contains blocking vulnerabilities - ABORTING!';
-        message.detailText = 'Check logs for more info or contact eUI support for detailed checks';
+        message.detailTitle = 'AUDIT DEPENDENCIES GATES FAILED';
+        message.detailTextArray.push('Audit dependencies gates for current eUI version contains blocking vulnerabilities - ABORTING!');
         break;
 
       default:
         message.detailTitle = 'GENERAL ERROR!';
-        message.detailText = options.exception;
+        message.detailTextArray.push(options.exception);
     };
 
-
+    message.detailText = message.detailTextArray.join('\n');
 
   } else {
 
@@ -106,12 +109,16 @@ module.exports.getMessage = (options) => {
 
       if (options.metadata && options.metadata.commits && options.metadata.commits.length !== 0) {
         message.detailTitle = 'Commit history since last release tag';
-        message.detailText = options.metadata.commits.map((commit) => {
+        const formattedCommits = options.metadata.commits.map((commit) => {
           return metadataUtils.commit.formatCommit(commit);
-        }).join('\n ');
+        });
+        message.detailText = formattedCommits.join('\n ');
+        message.detailTextArray = formattedCommits;
 
         if (options.metadata.issues && options.metadata.issues.length !== 0) {
-          message.detailText += '\nExtracted issues : ' + options.metadata.issues;
+          const extractedIssuesText = 'Extracted issues : ' + options.metadata.issues;
+          message.detailText += '\n' + extractedIssuesText;
+          message.detailTextArray.push(extractedIssuesText);
         }
       }
     }

package/scripts/utils/notification/config.js

@@ -12,15 +12,14 @@ module.exports.getPackageConfig = (pkg) => {
   // Fetching global config - default if not overriden in package own config
   const globalConfig = configUtils.global.getConfigOptions();
 
-  var slackChannel, mailAdress, msTeamsChannel, msTeamsHook;
+  let slackChannel, msTeamsChannel;
+
 
   if (pkg.backend) {
     slackChannel = globalConfig.SLACK_CHANNEL_BACKEND;
-    mailAdress = globalConfig.MAIL_ADDRESS_BACKEND;
     msTeamsChannel = globalConfig.MSTEAMS_BACKEND_CHANNEL;
   } else {
     slackChannel = globalConfig.SLACK_CHANNEL_FRONTEND;
-    mailAdress = globalConfig.MAIL_ADDRESS_FRONTEND;
     msTeamsChannel = globalConfig.MSTEAMS_FRONTEND_CHANNEL;
   }
 
@@ -32,15 +31,11 @@ module.exports.getPackageConfig = (pkg) => {
         SLACK_HOOK: globalConfig.SLACK_HOOK,
         SLACK_CHANNEL: slackChannel
       }
-    } else if (globalConfig.NOTIFICATION_CLIENT === 'MAIL') {
-      return {
-        CLIENT: globalConfig.NOTIFICATION_CLIENT,
-        MAIL_ADDRESS: mailAdress
-      }
     } else if (globalConfig.NOTIFICATION_CLIENT === 'SLACK') {
       return {
         CLIENT: globalConfig.NOTIFICATION_CLIENT,
         MSTEAMS_CHANNEL: msTeamsChannel,
+        MSTEAMS_CHANNEL_EMAIL: globalConfig.MSTEAMS_CHANNELS_EMAILS[msTeamsChannel]
       }
     }
 
@@ -61,15 +56,11 @@ module.exports.getPackageConfig = (pkg) => {
           SLACK_HOOK: globalConfig.SLACK_HOOK,
           SLACK_CHANNEL: pkg.notification.channel
         }
-      } else if (pkg.notification.client === 'MAIL') {
-        return {
-          CLIENT: pkg.notification.client,
-          MAIL_ADDRESS: configUtils.global.getNotificationMailAddress(pkg.notification.channel)
-        }
       } else if (pkg.notification.client === 'MSTEAMS') {
         return {
           CLIENT: pkg.notification.client,
           MSTEAMS_CHANNEL: pkg.notification.channel,
+          MSTEAMS_CHANNEL_EMAIL: globalConfig.MSTEAMS_CHANNELS_EMAILS[pkg.notification.channel]
         }
       }
     }
@@ -88,15 +79,11 @@ module.exports.getProjectConfig = (project) => {
         SLACK_HOOK: globalConfig.SLACK_HOOK,
         SLACK_CHANNEL: globalConfig.SLACK_CHANNEL_PROJECT
       }
-    } else if (globalConfig.NOTIFICATION_CLIENT === 'MAIL') {
-      return {
-        CLIENT: globalConfig.NOTIFICATION_CLIENT,
-        MAIL_ADDRESS: globalConfig.MAIL_ADDRESS_PROJECT
-      }
     } else if (globalConfig.NOTIFICATION_CLIENT === 'MSTEAMS') {
       return {
         CLIENT: globalConfig.NOTIFICATION_CLIENT,
         MSTEAMS_CHANNEL: globalConfig.MSTEAMS_PROJECT_CHANNEL,
+        MSTEAMS_CHANNEL_EMAIL: globalConfig.MSTEAMS_CHANNELS_EMAILS[globalConfig.MSTEAMS_PROJECT_CHANNEL]
       }
     }
 
@@ -117,15 +104,11 @@ module.exports.getProjectConfig = (project) => {
           SLACK_HOOK: globalConfig.SLACK_HOOK,
           SLACK_CHANNEL: project.notification.channel
         }
-      } else if (project.notification.client === 'MAIL') {
-        return {
-          CLIENT: project.notification.client,
-          MAIL_ADDRESS: configUtils.global.getNotificationMailAddress(project.notification.channel)
-        }
       } else if (project.notification.client === 'MSTEAMS') {
         return {
           CLIENT: globalConfig.NOTIFICATION_CLIENT,
           MSTEAMS_CHANNEL: project.notification.channel,
+          MSTEAMS_CHANNEL_EMAIL: globalConfig.MSTEAMS_CHANNELS_EMAILS[project.notification.channel]
         }
       }
     }
@@ -133,14 +116,14 @@ module.exports.getProjectConfig = (project) => {
 }
 
 
-module.exports.storeConfig = (rootPath, slackHook, slackChannel, mailAddress, msTeamsChannel) => {
+module.exports.storeConfig = (rootPath, slackHook, slackChannel, msTeamsChannel, msTeamsChannelEmail) => {
   return Promise.resolve()
     .then(() => {
       var content = '';
       content += `export SLACK_HOOK=${slackHook}\n`;
       content += `export SLACK_CHANNEL=${slackChannel}\n`;
-      content += `export MAIL_ADDRESS=${mailAddress}\n`;
       content += `export MSTEAMS_CHANNEL=${msTeamsChannel}\n`;
+      content += `export MSTEAMS_CHANNEL_EMAIL=${msTeamsChannelEmail}\n`;
       return pipelineUtils.setVariables(rootPath, content);
     })
 
@@ -153,8 +136,11 @@ module.exports.storePackageConfig = (pkg) => {
   return Promise.resolve()
     .then(() => {
       const config = this.getPackageConfig(pkg);
+
       return this.storeConfig(
-        process.cwd(), config.SLACK_HOOK, config.SLACK_CHANNEL, config.MAIL_ADDRESS, config.MSTEAMS_CHANNEL
+        process.cwd(),
+        config.SLACK_HOOK, config.SLACK_CHANNEL,
+        config.MSTEAMS_CHANNEL, config.MSTEAMS_CHANNEL_EMAIL
       );
     })
 
@@ -167,8 +153,11 @@ module.exports.storeProjectConfig = (project) => {
   return Promise.resolve()
     .then(() => {
       const config = this.getProjectConfig(project);
+
       return this.storeConfig(
-        project.paths.rootPath, config.SLACK_HOOK, config.SLACK_CHANNEL, config.MAIL_ADDRESS, config.MSTEAMS_CHANNEL
+        project.paths.rootPath,
+        config.SLACK_HOOK, config.SLACK_CHANNEL,
+        config.MSTEAMS_CHANNEL, config.MSTEAMS_CHANNEL_EMAIL
       );
     })
 

package/scripts/utils/notification/message-stack.js

@@ -22,6 +22,7 @@ const messageContent = {
   startTimestamp: null,
   endTimestamp: null,
   duration: null,
+  durationSeconds: null,
   durationMinSec: null
 };
 
@@ -33,7 +34,9 @@ module.exports.endStack = () => {
   messageContent.endTimestamp = moment();
   messageContent.duration = messageContent.endTimestamp - messageContent.startTimestamp;
   const start = messageContent.startTimestamp, end = messageContent.endTimestamp;
-  messageContent.durationMinSec = `${end.diff(start, 'm')}m:${end.diff(start, 's')}s`;
+  messageContent.durationSeconds = end.diff(start, 's');
+  const getMinSec = (s) => { return(s-(s%=60))/60+'m'+(9<s?':':':0')+s+'s'; }
+  messageContent.durationMinSec = getMinSec(messageContent.durationSeconds);
 }
 
 module.exports.pushMessage = (message) => {
@@ -50,9 +53,6 @@ const sendMessage = (config) => {
     .then(() => {
       if (config.CLIENT === 'MSTEAMS') {
         return innerTeamsUtils.sendMessage(config, messageContent);
-
-      } else if (config.CLIENT === 'MAIL') {
-        // TODO IF MAIL NOTIF IS NEEDED...
       }
     })
     .catch((e) => {

package/scripts/utils/notification/teams-utils.js

@@ -54,11 +54,19 @@ const createPayload = (messageContent) => {
   const version = finalMessage.version;
 
   // set commit history
-  const commitHistory = "```" + finalMessage.detailText;
+  let commitHistory = [], exceptionDetails = [];
+  if (status === statuses.success) {
+    commitHistory = finalMessage.detailTextArray;
+  } else {
+    exceptionDetails = finalMessage.detailTextArray;
+  }
 
   // set summary
   const itemName = messageContent.buffer[0].scope;
-  const summary = `${status.emoji} :: ${status.text} - ${itemName} - ${version}`;
+  let summary = `${status.emoji} :: ${status.text} - ${itemName}`;
+  if (version) {
+    summary +=  ` - ${version}`;
+  }
 
   // set release sections
   const publications = messageContent.buffer.filter(m => m.text !== null && m.text.indexOf(':rocket:') > -1);
@@ -71,11 +79,29 @@ const createPayload = (messageContent) => {
     }
   });
 
-  sections.push({
-    "startGroup": true,
-    "activityTitle": "Commit history since last release tag",
-    "activityText": commitHistory
-  });
+  if (commitHistory.length > 0) {
+    sections.push({
+      "startGroup": true,
+      "activityTitle": "Commit history since last release tag"
+    });
+    commitHistory.slice(0, 5).forEach((commit) => {
+      sections.push({
+        "activityText": commit
+      });
+    });
+  }
+
+  if (exceptionDetails.length > 0) {
+    sections.push({
+      "startGroup": true,
+      "activityTitle": finalMessage.detailTitle
+    });
+    exceptionDetails.forEach((exd) => {
+      sections.push({
+        "activityText": exd
+      });
+    });
+  }
 
   sections.push({
     "startGroup": true,

package/scripts/utils/tools.js

@@ -78,8 +78,8 @@ function getArgs() {
           const newItem = {};
           newItem[subItemSplit[0].trim()] = subItemSplit[1].trim();
           array.push(newItem);
-          args[item.split(':')[0]] = array;
         })
+        args[item.split(':')[0]] = array;
 
       // otherwise normal key/value pairs - example format : test1:test1,test2:test2
       } else {

package/scripts/utils/notification/mail-utils.js

@@ -1,59 +0,0 @@
-'use strict';
-
-
-// LOCALS
-const tools = require('../tools');
-
-let { dryRun, debug} = tools.getArgs();
-
-
-const sendCore = (subject, body, recipient) => {
-  const sendmail = require('sendmail')(); // if used in the future and needed this deps is required : "sendmail": "1.6.1"
-
-  tools.logInfo(`Sending mail to : ${recipient}`);
-  tools.logInfo('Message subject / body :');
-  console.log(subject);
-  console.log(body);
-
-  if (dryRun) {
-    console.log('----------------------------------------------');
-    console.log('----------------------------------------------');
-    console.log(subject);
-    console.log('----------------------------------------------');
-    console.log(body);
-    console.log('----------------------------------------------');
-    console.log(recipient);
-    console.log('----------------------------------------------');
-    console.log('----------------------------------------------');
-
-  } else {
-
-    return new Promise((resolve, reject) => {
-      sendmail({
-        from: 'automated-notifications@nomail.ec.europa.eu',
-        to: recipient,
-        subject: subject,
-        html: body
-      }, function (err, reply) {
-        if (err) {
-          console.log(err && err.stack);
-          reject(err);
-        } else {
-          console.dir(reply);
-          resolve();
-        }
-      })
-    })
-
-  }
-}
-
-module.exports.sendMessage = (subject, message, recipient) => {
-  return Promise.resolve()
-    .then(() => {
-      return sendCore(subject, message, recipient);
-    })
-    .catch(e => {
-      throw e;
-    })
-}